]>
git.saurik.com Git - apt.git/blob - apt-pkg/acquire.cc
1 // -*- mode: cpp; mode: fold -*-
3 // $Id: acquire.cc,v 1.50 2004/03/17 05:17:11 mdz Exp $
4 /* ######################################################################
6 Acquire - File Acquiration
8 The core element for the schedual system is the concept of a named
9 queue. Each queue is unique and each queue has a name derived from the
10 URI. The degree of paralization can be controled by how the queue
11 name is derived from the URI.
13 ##################################################################### */
15 // Include Files /*{{{*/
16 #include <apt-pkg/acquire.h>
17 #include <apt-pkg/acquire-item.h>
18 #include <apt-pkg/acquire-worker.h>
19 #include <apt-pkg/configuration.h>
20 #include <apt-pkg/error.h>
21 #include <apt-pkg/strutl.h>
36 // Acquire::pkgAcquire - Constructor /*{{{*/
37 // ---------------------------------------------------------------------
38 /* We grab some runtime state from the configuration space */
39 pkgAcquire::pkgAcquire(pkgAcquireStatus
*Log
) : Log(Log
)
47 string Mode
= _config
->Find("Acquire::Queue-Mode","host");
48 if (strcasecmp(Mode
.c_str(),"host") == 0)
49 QueueMode
= QueueHost
;
50 if (strcasecmp(Mode
.c_str(),"access") == 0)
51 QueueMode
= QueueAccess
;
53 Debug
= _config
->FindB("Debug::pkgAcquire",false);
55 // This is really a stupid place for this
57 if (stat((_config
->FindDir("Dir::State::lists") + "partial/").c_str(),&St
) != 0 ||
58 S_ISDIR(St
.st_mode
) == 0)
59 _error
->Error(_("Lists directory %spartial is missing."),
60 _config
->FindDir("Dir::State::lists").c_str());
61 if (stat((_config
->FindDir("Dir::Cache::Archives") + "partial/").c_str(),&St
) != 0 ||
62 S_ISDIR(St
.st_mode
) == 0)
63 _error
->Error(_("Archive directory %spartial is missing."),
64 _config
->FindDir("Dir::Cache::Archives").c_str());
67 // Acquire::~pkgAcquire - Destructor /*{{{*/
68 // ---------------------------------------------------------------------
69 /* Free our memory, clean up the queues (destroy the workers) */
70 pkgAcquire::~pkgAcquire()
76 MethodConfig
*Jnk
= Configs
;
77 Configs
= Configs
->Next
;
82 // Acquire::Shutdown - Clean out the acquire object /*{{{*/
83 // ---------------------------------------------------------------------
85 void pkgAcquire::Shutdown()
87 while (Items
.size() != 0)
89 if (Items
[0]->Status
== Item::StatFetching
)
90 Items
[0]->Status
= Item::StatError
;
97 Queues
= Queues
->Next
;
102 // Acquire::Add - Add a new item /*{{{*/
103 // ---------------------------------------------------------------------
104 /* This puts an item on the acquire list. This list is mainly for tracking
106 void pkgAcquire::Add(Item
*Itm
)
108 Items
.push_back(Itm
);
111 // Acquire::Remove - Remove a item /*{{{*/
112 // ---------------------------------------------------------------------
113 /* Remove an item from the acquire list. This is usually not used.. */
114 void pkgAcquire::Remove(Item
*Itm
)
118 for (ItemIterator I
= Items
.begin(); I
!= Items
.end();)
130 // Acquire::Add - Add a worker /*{{{*/
131 // ---------------------------------------------------------------------
132 /* A list of workers is kept so that the select loop can direct their FD
134 void pkgAcquire::Add(Worker
*Work
)
136 Work
->NextAcquire
= Workers
;
140 // Acquire::Remove - Remove a worker /*{{{*/
141 // ---------------------------------------------------------------------
142 /* A worker has died. This can not be done while the select loop is running
143 as it would require that RunFds could handling a changing list state and
145 void pkgAcquire::Remove(Worker
*Work
)
150 Worker
**I
= &Workers
;
154 *I
= (*I
)->NextAcquire
;
156 I
= &(*I
)->NextAcquire
;
160 // Acquire::Enqueue - Queue an URI for fetching /*{{{*/
161 // ---------------------------------------------------------------------
162 /* This is the entry point for an item. An item calls this function when
163 it is constructed which creates a queue (based on the current queue
164 mode) and puts the item in that queue. If the system is running then
165 the queue might be started. */
166 void pkgAcquire::Enqueue(ItemDesc
&Item
)
168 // Determine which queue to put the item in
169 const MethodConfig
*Config
;
170 string Name
= QueueName(Item
.URI
,Config
);
171 if (Name
.empty() == true)
174 // Find the queue structure
176 for (; I
!= 0 && I
->Name
!= Name
; I
= I
->Next
);
179 I
= new Queue(Name
,this);
187 // See if this is a local only URI
188 if (Config
->LocalOnly
== true && Item
.Owner
->Complete
== false)
189 Item
.Owner
->Local
= true;
190 Item
.Owner
->Status
= Item::StatIdle
;
192 // Queue it into the named queue
199 clog
<< "Fetching " << Item
.URI
<< endl
;
200 clog
<< " to " << Item
.Owner
->DestFile
<< endl
;
201 clog
<< " Queue is: " << Name
<< endl
;
205 // Acquire::Dequeue - Remove an item from all queues /*{{{*/
206 // ---------------------------------------------------------------------
207 /* This is called when an item is finished being fetched. It removes it
208 from all the queues */
209 void pkgAcquire::Dequeue(Item
*Itm
)
213 for (; I
!= 0; I
= I
->Next
)
214 Res
|= I
->Dequeue(Itm
);
217 clog
<< "Dequeuing " << Itm
->DestFile
<< endl
;
222 // Acquire::QueueName - Return the name of the queue for this URI /*{{{*/
223 // ---------------------------------------------------------------------
224 /* The string returned depends on the configuration settings and the
225 method parameters. Given something like http://foo.org/bar it can
226 return http://foo.org or http */
227 string
pkgAcquire::QueueName(string Uri
,MethodConfig
const *&Config
)
231 Config
= GetConfig(U
.Access
);
235 /* Single-Instance methods get exactly one queue per URI. This is
236 also used for the Access queue method */
237 if (Config
->SingleInstance
== true || QueueMode
== QueueAccess
)
240 return U
.Access
+ ':' + U
.Host
;
243 // Acquire::GetConfig - Fetch the configuration information /*{{{*/
244 // ---------------------------------------------------------------------
245 /* This locates the configuration structure for an access method. If
246 a config structure cannot be found a Worker will be created to
248 pkgAcquire::MethodConfig
*pkgAcquire::GetConfig(string Access
)
250 // Search for an existing config
252 for (Conf
= Configs
; Conf
!= 0; Conf
= Conf
->Next
)
253 if (Conf
->Access
== Access
)
256 // Create the new config class
257 Conf
= new MethodConfig
;
258 Conf
->Access
= Access
;
259 Conf
->Next
= Configs
;
262 // Create the worker to fetch the configuration
264 if (Work
.Start() == false)
267 /* if a method uses DownloadLimit, we switch to SingleInstance mode */
268 if(_config
->FindI("Acquire::"+Access
+"::DlLimit",0) > 0)
269 Conf
->SingleInstance
= true;
274 // Acquire::SetFds - Deal with readable FDs /*{{{*/
275 // ---------------------------------------------------------------------
276 /* Collect FDs that have activity monitors into the fd sets */
277 void pkgAcquire::SetFds(int &Fd
,fd_set
*RSet
,fd_set
*WSet
)
279 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
281 if (I
->InReady
== true && I
->InFd
>= 0)
285 FD_SET(I
->InFd
,RSet
);
287 if (I
->OutReady
== true && I
->OutFd
>= 0)
291 FD_SET(I
->OutFd
,WSet
);
296 // Acquire::RunFds - Deal with active FDs /*{{{*/
297 // ---------------------------------------------------------------------
298 /* Dispatch active FDs over to the proper workers. It is very important
299 that a worker never be erased while this is running! The queue class
300 should never erase a worker except during shutdown processing. */
301 void pkgAcquire::RunFds(fd_set
*RSet
,fd_set
*WSet
)
303 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
305 if (I
->InFd
>= 0 && FD_ISSET(I
->InFd
,RSet
) != 0)
307 if (I
->OutFd
>= 0 && FD_ISSET(I
->OutFd
,WSet
) != 0)
312 // Acquire::Run - Run the fetch sequence /*{{{*/
313 // ---------------------------------------------------------------------
314 /* This runs the queues. It manages a select loop for all of the
315 Worker tasks. The workers interact with the queues and items to
316 manage the actual fetch. */
317 pkgAcquire::RunResult
pkgAcquire::Run(int PulseIntervall
)
321 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
327 bool WasCancelled
= false;
329 // Run till all things have been acquired
332 tv
.tv_usec
= PulseIntervall
;
340 SetFds(Highest
,&RFds
,&WFds
);
345 Res
= select(Highest
+1,&RFds
,&WFds
,0,&tv
);
347 while (Res
< 0 && errno
== EINTR
);
351 _error
->Errno("select","Select has failed");
356 if (_error
->PendingError() == true)
359 // Timeout, notify the log class
360 if (Res
== 0 || (Log
!= 0 && Log
->Update
== true))
362 tv
.tv_usec
= PulseIntervall
;
363 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
365 if (Log
!= 0 && Log
->Pulse(this) == false)
376 // Shut down the acquire bits
378 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
381 // Shut down the items
382 for (ItemIterator I
= Items
.begin(); I
!= Items
.end(); I
++)
385 if (_error
->PendingError())
392 // Acquire::Bump - Called when an item is dequeued /*{{{*/
393 // ---------------------------------------------------------------------
394 /* This routine bumps idle queues in hopes that they will be able to fetch
396 void pkgAcquire::Bump()
398 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
402 // Acquire::WorkerStep - Step to the next worker /*{{{*/
403 // ---------------------------------------------------------------------
404 /* Not inlined to advoid including acquire-worker.h */
405 pkgAcquire::Worker
*pkgAcquire::WorkerStep(Worker
*I
)
407 return I
->NextAcquire
;
410 // Acquire::Clean - Cleans a directory /*{{{*/
411 // ---------------------------------------------------------------------
412 /* This is a bit simplistic, it looks at every file in the dir and sees
413 if it is part of the download set. */
414 bool pkgAcquire::Clean(string Dir
)
416 DIR *D
= opendir(Dir
.c_str());
418 return _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
420 string StartDir
= SafeGetCWD();
421 if (chdir(Dir
.c_str()) != 0)
424 return _error
->Errno("chdir",_("Unable to change to %s"),Dir
.c_str());
427 for (struct dirent
*Dir
= readdir(D
); Dir
!= 0; Dir
= readdir(D
))
430 if (strcmp(Dir
->d_name
,"lock") == 0 ||
431 strcmp(Dir
->d_name
,"partial") == 0 ||
432 strcmp(Dir
->d_name
,".") == 0 ||
433 strcmp(Dir
->d_name
,"..") == 0)
436 // Look in the get list
437 ItemCIterator I
= Items
.begin();
438 for (; I
!= Items
.end(); I
++)
439 if (flNotDir((*I
)->DestFile
) == Dir
->d_name
)
442 // Nothing found, nuke it
443 if (I
== Items
.end())
448 if (chdir(StartDir
.c_str()) != 0)
449 return _error
->Errno("chdir",_("Unable to change to %s"),StartDir
.c_str());
453 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
454 // ---------------------------------------------------------------------
455 /* This is the total number of bytes needed */
456 double pkgAcquire::TotalNeeded()
459 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
460 Total
+= (*I
)->FileSize
;
464 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
465 // ---------------------------------------------------------------------
466 /* This is the number of bytes that is not local */
467 double pkgAcquire::FetchNeeded()
470 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
471 if ((*I
)->Local
== false)
472 Total
+= (*I
)->FileSize
;
476 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
477 // ---------------------------------------------------------------------
478 /* This is the number of bytes that is not local */
479 double pkgAcquire::PartialPresent()
482 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
483 if ((*I
)->Local
== false)
484 Total
+= (*I
)->PartialSize
;
488 // Acquire::UriBegin - Start iterator for the uri list /*{{{*/
489 // ---------------------------------------------------------------------
491 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
493 return UriIterator(Queues
);
496 // Acquire::UriEnd - End iterator for the uri list /*{{{*/
497 // ---------------------------------------------------------------------
499 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
501 return UriIterator(0);
505 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
506 // ---------------------------------------------------------------------
508 pkgAcquire::MethodConfig::MethodConfig()
510 SingleInstance
= false;
519 // Queue::Queue - Constructor /*{{{*/
520 // ---------------------------------------------------------------------
522 pkgAcquire::Queue::Queue(string Name
,pkgAcquire
*Owner
) : Name(Name
),
532 // Queue::~Queue - Destructor /*{{{*/
533 // ---------------------------------------------------------------------
535 pkgAcquire::Queue::~Queue()
547 // Queue::Enqueue - Queue an item to the queue /*{{{*/
548 // ---------------------------------------------------------------------
550 bool pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
553 // move to the end of the queue and check for duplicates here
554 for (; *I
!= 0; I
= &(*I
)->Next
)
555 if (Item
.URI
== (*I
)->URI
)
557 Item
.Owner
->Status
= Item::StatDone
;
562 QItem
*Itm
= new QItem
;
567 Item
.Owner
->QueueCounter
++;
568 if (Items
->Next
== 0)
573 // Queue::Dequeue - Remove an item from the queue /*{{{*/
574 // ---------------------------------------------------------------------
575 /* We return true if we hit something */
576 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
578 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
579 return _error
->Error("Tried to dequeue a fetching object");
586 if ((*I
)->Owner
== Owner
)
590 Owner
->QueueCounter
--;
601 // Queue::Startup - Start the worker processes /*{{{*/
602 // ---------------------------------------------------------------------
603 /* It is possible for this to be called with a pre-existing set of
605 bool pkgAcquire::Queue::Startup()
610 pkgAcquire::MethodConfig
*Cnf
= Owner
->GetConfig(U
.Access
);
614 Workers
= new Worker(this,Cnf
,Owner
->Log
);
616 if (Workers
->Start() == false)
619 /* When pipelining we commit 10 items. This needs to change when we
620 added other source retry to have cycle maintain a pipeline depth
622 if (Cnf
->Pipeline
== true)
631 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
632 // ---------------------------------------------------------------------
633 /* If final is true then all workers are eliminated, otherwise only workers
634 that do not need cleanup are removed */
635 bool pkgAcquire::Queue::Shutdown(bool Final
)
637 // Delete all of the workers
638 pkgAcquire::Worker
**Cur
= &Workers
;
641 pkgAcquire::Worker
*Jnk
= *Cur
;
642 if (Final
== true || Jnk
->GetConf()->NeedsCleanup
== false)
644 *Cur
= Jnk
->NextQueue
;
649 Cur
= &(*Cur
)->NextQueue
;
655 // Queue::FindItem - Find a URI in the item list /*{{{*/
656 // ---------------------------------------------------------------------
658 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
660 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
661 if (I
->URI
== URI
&& I
->Worker
== Owner
)
666 // Queue::ItemDone - Item has been completed /*{{{*/
667 // ---------------------------------------------------------------------
668 /* The worker signals this which causes the item to be removed from the
669 queue. If this is the last queue instance then it is removed from the
671 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
674 if (Itm
->Owner
->Status
== pkgAcquire::Item::StatFetching
)
675 Itm
->Owner
->Status
= pkgAcquire::Item::StatDone
;
677 if (Itm
->Owner
->QueueCounter
<= 1)
678 Owner
->Dequeue(Itm
->Owner
);
688 // Queue::Cycle - Queue new items into the method /*{{{*/
689 // ---------------------------------------------------------------------
690 /* This locates a new idle item and sends it to the worker. If pipelining
691 is enabled then it keeps the pipe full. */
692 bool pkgAcquire::Queue::Cycle()
694 if (Items
== 0 || Workers
== 0)
698 return _error
->Error("Pipedepth failure");
700 // Look for a queable item
702 while (PipeDepth
< (signed)MaxPipeDepth
)
704 for (; I
!= 0; I
= I
->Next
)
705 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
708 // Nothing to do, queue is idle.
713 I
->Owner
->Status
= pkgAcquire::Item::StatFetching
;
715 if (Workers
->QueueItem(I
) == false)
722 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
723 // ---------------------------------------------------------------------
724 /* This is called when an item in multiple queues is dequeued */
725 void pkgAcquire::Queue::Bump()
731 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
732 // ---------------------------------------------------------------------
734 pkgAcquireStatus::pkgAcquireStatus() : Update(true), MorePulses(false)
739 // AcquireStatus::Pulse - Called periodically /*{{{*/
740 // ---------------------------------------------------------------------
741 /* This computes some internal state variables for the derived classes to
742 use. It generates the current downloaded bytes and total bytes to download
743 as well as the current CPS estimate. */
744 bool pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
751 // Compute the total number of bytes to fetch
752 unsigned int Unknown
= 0;
753 unsigned int Count
= 0;
754 for (pkgAcquire::ItemCIterator I
= Owner
->ItemsBegin(); I
!= Owner
->ItemsEnd();
758 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
761 // Totally ignore local items
762 if ((*I
)->Local
== true)
765 TotalBytes
+= (*I
)->FileSize
;
766 if ((*I
)->Complete
== true)
767 CurrentBytes
+= (*I
)->FileSize
;
768 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
772 // Compute the current completion
773 unsigned long ResumeSize
= 0;
774 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
775 I
= Owner
->WorkerStep(I
))
776 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
778 CurrentBytes
+= I
->CurrentSize
;
779 ResumeSize
+= I
->ResumePoint
;
781 // Files with unknown size always have 100% completion
782 if (I
->CurrentItem
->Owner
->FileSize
== 0 &&
783 I
->CurrentItem
->Owner
->Complete
== false)
784 TotalBytes
+= I
->CurrentSize
;
787 // Normalize the figures and account for unknown size downloads
790 if (Unknown
== Count
)
791 TotalBytes
= Unknown
;
793 // Wha?! Is not supposed to happen.
794 if (CurrentBytes
> TotalBytes
)
795 CurrentBytes
= TotalBytes
;
798 struct timeval NewTime
;
799 gettimeofday(&NewTime
,0);
800 if ((NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
) ||
801 NewTime
.tv_sec
- Time
.tv_sec
> 6)
803 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
804 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
806 // Compute the CPS value
810 CurrentCPS
= ((CurrentBytes
- ResumeSize
) - LastBytes
)/Delta
;
811 LastBytes
= CurrentBytes
- ResumeSize
;
812 ElapsedTime
= (unsigned long)Delta
;
816 int fd
= _config
->FindI("APT::Status-Fd",-1);
819 ostringstream status
;
822 long i
= CurrentItems
< TotalItems
? CurrentItems
+ 1 : CurrentItems
;
824 (unsigned long)((TotalBytes
- CurrentBytes
) / CurrentCPS
);
826 // only show the ETA if it makes sense
827 if (ETA
> 0 && ETA
< 172800 /* two days */ )
828 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li (%s remaining)"), i
, TotalItems
, TimeToStr(ETA
).c_str());
830 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li"), i
, TotalItems
);
834 // build the status str
835 status
<< "dlstatus:" << i
836 << ":" << (CurrentBytes
/float(TotalBytes
)*100.0)
839 write(fd
, status
.str().c_str(), status
.str().size());
845 // AcquireStatus::Start - Called when the download is started /*{{{*/
846 // ---------------------------------------------------------------------
847 /* We just reset the counters */
848 void pkgAcquireStatus::Start()
850 gettimeofday(&Time
,0);
851 gettimeofday(&StartTime
,0);
862 // AcquireStatus::Stop - Finished downloading /*{{{*/
863 // ---------------------------------------------------------------------
864 /* This accurately computes the elapsed time and the total overall CPS. */
865 void pkgAcquireStatus::Stop()
867 // Compute the CPS and elapsed time
868 struct timeval NewTime
;
869 gettimeofday(&NewTime
,0);
871 double Delta
= NewTime
.tv_sec
- StartTime
.tv_sec
+
872 (NewTime
.tv_usec
- StartTime
.tv_usec
)/1000000.0;
874 // Compute the CPS value
878 CurrentCPS
= FetchedBytes
/Delta
;
879 LastBytes
= CurrentBytes
;
880 ElapsedTime
= (unsigned int)Delta
;
883 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
884 // ---------------------------------------------------------------------
885 /* This is used to get accurate final transfer rate reporting. */
886 void pkgAcquireStatus::Fetched(unsigned long Size
,unsigned long Resume
)
888 FetchedBytes
+= Size
- Resume
;