]>
git.saurik.com Git - apt-legacy.git/blob - apt-pkg/acquire.cc
b1463dc67fc2f0efa32520ba85c8684192200fd3
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 /*{{{*/
17 #pragma implementation "apt-pkg/acquire.h"
19 #include <apt-pkg/acquire.h>
20 #include <apt-pkg/acquire-item.h>
21 #include <apt-pkg/acquire-worker.h>
22 #include <apt-pkg/configuration.h>
23 #include <apt-pkg/error.h>
24 #include <apt-pkg/strutl.h>
39 // Acquire::pkgAcquire - Constructor /*{{{*/
40 // ---------------------------------------------------------------------
41 /* We grab some runtime state from the configuration space */
42 pkgAcquire::pkgAcquire(pkgAcquireStatus
*Log
) : Log(Log
)
50 string Mode
= _config
->Find("Acquire::Queue-Mode","host");
51 if (strcasecmp(Mode
.c_str(),"host") == 0)
52 QueueMode
= QueueHost
;
53 if (strcasecmp(Mode
.c_str(),"access") == 0)
54 QueueMode
= QueueAccess
;
56 Debug
= _config
->FindB("Debug::pkgAcquire",false);
58 // This is really a stupid place for this
60 if (stat((_config
->FindDir("Dir::State::lists") + "partial/").c_str(),&St
) != 0 ||
61 S_ISDIR(St
.st_mode
) == 0)
62 _error
->Error(_("Lists directory %spartial is missing."),
63 _config
->FindDir("Dir::State::lists").c_str());
64 if (stat((_config
->FindDir("Dir::Cache::Archives") + "partial/").c_str(),&St
) != 0 ||
65 S_ISDIR(St
.st_mode
) == 0)
66 _error
->Error(_("Archive directory %spartial is missing."),
67 _config
->FindDir("Dir::Cache::Archives").c_str());
70 // Acquire::~pkgAcquire - Destructor /*{{{*/
71 // ---------------------------------------------------------------------
72 /* Free our memory, clean up the queues (destroy the workers) */
73 pkgAcquire::~pkgAcquire()
79 MethodConfig
*Jnk
= Configs
;
80 Configs
= Configs
->Next
;
85 // Acquire::Shutdown - Clean out the acquire object /*{{{*/
86 // ---------------------------------------------------------------------
88 void pkgAcquire::Shutdown()
90 while (Items
.size() != 0)
92 if (Items
[0]->Status
== Item::StatFetching
)
93 Items
[0]->Status
= Item::StatError
;
100 Queues
= Queues
->Next
;
105 // Acquire::Add - Add a new item /*{{{*/
106 // ---------------------------------------------------------------------
107 /* This puts an item on the acquire list. This list is mainly for tracking
109 void pkgAcquire::Add(Item
*Itm
)
111 Items
.push_back(Itm
);
114 // Acquire::Remove - Remove a item /*{{{*/
115 // ---------------------------------------------------------------------
116 /* Remove an item from the acquire list. This is usually not used.. */
117 void pkgAcquire::Remove(Item
*Itm
)
121 for (ItemIterator I
= Items
.begin(); I
!= Items
.end();)
133 // Acquire::Add - Add a worker /*{{{*/
134 // ---------------------------------------------------------------------
135 /* A list of workers is kept so that the select loop can direct their FD
137 void pkgAcquire::Add(Worker
*Work
)
139 Work
->NextAcquire
= Workers
;
143 // Acquire::Remove - Remove a worker /*{{{*/
144 // ---------------------------------------------------------------------
145 /* A worker has died. This can not be done while the select loop is running
146 as it would require that RunFds could handling a changing list state and
148 void pkgAcquire::Remove(Worker
*Work
)
153 Worker
**I
= &Workers
;
157 *I
= (*I
)->NextAcquire
;
159 I
= &(*I
)->NextAcquire
;
163 // Acquire::Enqueue - Queue an URI for fetching /*{{{*/
164 // ---------------------------------------------------------------------
165 /* This is the entry point for an item. An item calls this function when
166 it is constructed which creates a queue (based on the current queue
167 mode) and puts the item in that queue. If the system is running then
168 the queue might be started. */
169 void pkgAcquire::Enqueue(ItemDesc
&Item
)
171 // Determine which queue to put the item in
172 const MethodConfig
*Config
;
173 string Name
= QueueName(Item
.URI
,Config
);
174 if (Name
.empty() == true)
177 // Find the queue structure
179 for (; I
!= 0 && I
->Name
!= Name
; I
= I
->Next
);
182 I
= new Queue(Name
,this);
190 // See if this is a local only URI
191 if (Config
->LocalOnly
== true && Item
.Owner
->Complete
== false)
192 Item
.Owner
->Local
= true;
193 Item
.Owner
->Status
= Item::StatIdle
;
195 // Queue it into the named queue
202 clog
<< "Fetching " << Item
.URI
<< endl
;
203 clog
<< " to " << Item
.Owner
->DestFile
<< endl
;
204 clog
<< " Queue is: " << Name
<< endl
;
208 // Acquire::Dequeue - Remove an item from all queues /*{{{*/
209 // ---------------------------------------------------------------------
210 /* This is called when an item is finished being fetched. It removes it
211 from all the queues */
212 void pkgAcquire::Dequeue(Item
*Itm
)
216 for (; I
!= 0; I
= I
->Next
)
217 Res
|= I
->Dequeue(Itm
);
220 clog
<< "Dequeuing " << Itm
->DestFile
<< endl
;
225 // Acquire::QueueName - Return the name of the queue for this URI /*{{{*/
226 // ---------------------------------------------------------------------
227 /* The string returned depends on the configuration settings and the
228 method parameters. Given something like http://foo.org/bar it can
229 return http://foo.org or http */
230 string
pkgAcquire::QueueName(string Uri
,MethodConfig
const *&Config
)
234 Config
= GetConfig(U
.Access
);
238 /* Single-Instance methods get exactly one queue per URI. This is
239 also used for the Access queue method */
240 if (Config
->SingleInstance
== true || QueueMode
== QueueAccess
)
242 string
name(U
.Access
+ ':' + U
.Host
);
244 int parallel(_config
->FindI("Acquire::"+U
.Access
+"::MaxParallel",0));
248 typedef map
<string
, int> indexmap
;
249 static indexmap indices
;
251 pair
<indexmap::iterator
, bool> cache(indices
.insert(indexmap::value_type(name
, -1)));
252 if (cache
.second
|| cache
.first
->second
== -1) {
253 int &index(indices
[U
.Access
]);
254 if (index
>= parallel
)
256 cache
.first
->second
= index
++;
260 value
<< U
.Access
<< "::" << cache
.first
->second
;
264 // Acquire::GetConfig - Fetch the configuration information /*{{{*/
265 // ---------------------------------------------------------------------
266 /* This locates the configuration structure for an access method. If
267 a config structure cannot be found a Worker will be created to
269 pkgAcquire::MethodConfig
*pkgAcquire::GetConfig(string Access
)
271 // Search for an existing config
273 for (Conf
= Configs
; Conf
!= 0; Conf
= Conf
->Next
)
274 if (Conf
->Access
== Access
)
277 // Create the new config class
278 Conf
= new MethodConfig
;
279 Conf
->Access
= Access
;
280 Conf
->Next
= Configs
;
283 // Create the worker to fetch the configuration
285 if (Work
.Start() == false)
288 /* if a method uses DownloadLimit, we switch to SingleInstance mode */
289 if(_config
->FindI("Acquire::"+Access
+"::Dl-Limit",0) > 0)
290 Conf
->SingleInstance
= true;
295 // Acquire::SetFds - Deal with readable FDs /*{{{*/
296 // ---------------------------------------------------------------------
297 /* Collect FDs that have activity monitors into the fd sets */
298 void pkgAcquire::SetFds(int &Fd
,fd_set
*RSet
,fd_set
*WSet
)
300 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
302 if (I
->InReady
== true && I
->InFd
>= 0)
306 FD_SET(I
->InFd
,RSet
);
308 if (I
->OutReady
== true && I
->OutFd
>= 0)
312 FD_SET(I
->OutFd
,WSet
);
317 // Acquire::RunFds - Deal with active FDs /*{{{*/
318 // ---------------------------------------------------------------------
319 /* Dispatch active FDs over to the proper workers. It is very important
320 that a worker never be erased while this is running! The queue class
321 should never erase a worker except during shutdown processing. */
322 void pkgAcquire::RunFds(fd_set
*RSet
,fd_set
*WSet
)
324 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
326 if (I
->InFd
>= 0 && FD_ISSET(I
->InFd
,RSet
) != 0)
328 if (I
->OutFd
>= 0 && FD_ISSET(I
->OutFd
,WSet
) != 0)
333 // Acquire::Run - Run the fetch sequence /*{{{*/
334 // ---------------------------------------------------------------------
335 /* This runs the queues. It manages a select loop for all of the
336 Worker tasks. The workers interact with the queues and items to
337 manage the actual fetch. */
338 pkgAcquire::RunResult
pkgAcquire::Run(int PulseIntervall
)
342 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
348 bool WasCancelled
= false;
350 // Run till all things have been acquired
353 tv
.tv_usec
= PulseIntervall
;
361 SetFds(Highest
,&RFds
,&WFds
);
366 Res
= select(Highest
+1,&RFds
,&WFds
,0,&tv
);
368 while (Res
< 0 && errno
== EINTR
);
372 _error
->Errno("select","Select has failed");
377 if (_error
->PendingError() == true)
380 // Timeout, notify the log class
381 if (Res
== 0 || (Log
!= 0 && Log
->Update
== true))
383 tv
.tv_usec
= PulseIntervall
;
384 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
386 if (Log
!= 0 && Log
->Pulse(this) == false)
397 // Shut down the acquire bits
399 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
402 // Shut down the items
403 for (ItemIterator I
= Items
.begin(); I
!= Items
.end(); I
++)
406 if (_error
->PendingError())
413 // Acquire::Bump - Called when an item is dequeued /*{{{*/
414 // ---------------------------------------------------------------------
415 /* This routine bumps idle queues in hopes that they will be able to fetch
417 void pkgAcquire::Bump()
419 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
423 // Acquire::WorkerStep - Step to the next worker /*{{{*/
424 // ---------------------------------------------------------------------
425 /* Not inlined to advoid including acquire-worker.h */
426 pkgAcquire::Worker
*pkgAcquire::WorkerStep(Worker
*I
)
428 return I
->NextAcquire
;
431 // Acquire::Clean - Cleans a directory /*{{{*/
432 // ---------------------------------------------------------------------
433 /* This is a bit simplistic, it looks at every file in the dir and sees
434 if it is part of the download set. */
435 bool pkgAcquire::Clean(string Dir
)
437 DIR *D
= opendir(Dir
.c_str());
439 return _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
441 string StartDir
= SafeGetCWD();
442 if (chdir(Dir
.c_str()) != 0)
445 return _error
->Errno("chdir",_("Unable to change to %s"),Dir
.c_str());
448 for (struct dirent
*Dir
= readdir(D
); Dir
!= 0; Dir
= readdir(D
))
451 if (strcmp(Dir
->d_name
,"lock") == 0 ||
452 strcmp(Dir
->d_name
,"partial") == 0 ||
453 strcmp(Dir
->d_name
,".") == 0 ||
454 strcmp(Dir
->d_name
,"..") == 0)
457 // Look in the get list
458 ItemCIterator I
= Items
.begin();
459 for (; I
!= Items
.end(); I
++)
460 if (flNotDir((*I
)->DestFile
) == Dir
->d_name
)
463 // Nothing found, nuke it
464 if (I
== Items
.end())
468 chdir(StartDir
.c_str());
473 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
474 // ---------------------------------------------------------------------
475 /* This is the total number of bytes needed */
476 double pkgAcquire::TotalNeeded()
479 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
480 Total
+= (*I
)->FileSize
;
484 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
485 // ---------------------------------------------------------------------
486 /* This is the number of bytes that is not local */
487 double pkgAcquire::FetchNeeded()
490 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
491 if ((*I
)->Local
== false)
492 Total
+= (*I
)->FileSize
;
496 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
497 // ---------------------------------------------------------------------
498 /* This is the number of bytes that is not local */
499 double pkgAcquire::PartialPresent()
502 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
503 if ((*I
)->Local
== false)
504 Total
+= (*I
)->PartialSize
;
508 // Acquire::UriBegin - Start iterator for the uri list /*{{{*/
509 // ---------------------------------------------------------------------
511 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
513 return UriIterator(Queues
);
516 // Acquire::UriEnd - End iterator for the uri list /*{{{*/
517 // ---------------------------------------------------------------------
519 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
521 return UriIterator(0);
525 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
526 // ---------------------------------------------------------------------
528 pkgAcquire::MethodConfig::MethodConfig()
530 SingleInstance
= false;
539 // Queue::Queue - Constructor /*{{{*/
540 // ---------------------------------------------------------------------
542 pkgAcquire::Queue::Queue(string Name
,pkgAcquire
*Owner
) : Name(Name
),
552 // Queue::~Queue - Destructor /*{{{*/
553 // ---------------------------------------------------------------------
555 pkgAcquire::Queue::~Queue()
567 // Queue::Enqueue - Queue an item to the queue /*{{{*/
568 // ---------------------------------------------------------------------
570 void pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
573 for (; *I
!= 0; I
= &(*I
)->Next
);
576 QItem
*Itm
= new QItem
;
581 Item
.Owner
->QueueCounter
++;
582 if (Items
->Next
== 0)
586 // Queue::Dequeue - Remove an item from the queue /*{{{*/
587 // ---------------------------------------------------------------------
588 /* We return true if we hit something */
589 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
591 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
592 return _error
->Error("Tried to dequeue a fetching object");
599 if ((*I
)->Owner
== Owner
)
603 Owner
->QueueCounter
--;
614 // Queue::Startup - Start the worker processes /*{{{*/
615 // ---------------------------------------------------------------------
616 /* It is possible for this to be called with a pre-existing set of
618 bool pkgAcquire::Queue::Startup()
623 pkgAcquire::MethodConfig
*Cnf
= Owner
->GetConfig(U
.Access
);
627 Workers
= new Worker(this,Cnf
,Owner
->Log
);
629 if (Workers
->Start() == false)
632 /* When pipelining we commit 10 items. This needs to change when we
633 added other source retry to have cycle maintain a pipeline depth
635 if (Cnf
->Pipeline
== true)
644 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
645 // ---------------------------------------------------------------------
646 /* If final is true then all workers are eliminated, otherwise only workers
647 that do not need cleanup are removed */
648 bool pkgAcquire::Queue::Shutdown(bool Final
)
650 // Delete all of the workers
651 pkgAcquire::Worker
**Cur
= &Workers
;
654 pkgAcquire::Worker
*Jnk
= *Cur
;
655 if (Final
== true || Jnk
->GetConf()->NeedsCleanup
== false)
657 *Cur
= Jnk
->NextQueue
;
662 Cur
= &(*Cur
)->NextQueue
;
668 // Queue::FindItem - Find a URI in the item list /*{{{*/
669 // ---------------------------------------------------------------------
671 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
673 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
674 if (I
->URI
== URI
&& I
->Worker
== Owner
)
679 // Queue::ItemDone - Item has been completed /*{{{*/
680 // ---------------------------------------------------------------------
681 /* The worker signals this which causes the item to be removed from the
682 queue. If this is the last queue instance then it is removed from the
684 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
687 if (Itm
->Owner
->Status
== pkgAcquire::Item::StatFetching
)
688 Itm
->Owner
->Status
= pkgAcquire::Item::StatDone
;
690 if (Itm
->Owner
->QueueCounter
<= 1)
691 Owner
->Dequeue(Itm
->Owner
);
701 // Queue::Cycle - Queue new items into the method /*{{{*/
702 // ---------------------------------------------------------------------
703 /* This locates a new idle item and sends it to the worker. If pipelining
704 is enabled then it keeps the pipe full. */
705 bool pkgAcquire::Queue::Cycle()
707 if (Items
== 0 || Workers
== 0)
711 return _error
->Error("Pipedepth failure");
713 // Look for a queable item
715 while (PipeDepth
< (signed)MaxPipeDepth
)
717 for (; I
!= 0; I
= I
->Next
)
718 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
721 // Nothing to do, queue is idle.
726 I
->Owner
->Status
= pkgAcquire::Item::StatFetching
;
728 if (Workers
->QueueItem(I
) == false)
735 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
736 // ---------------------------------------------------------------------
737 /* This is called when an item in multiple queues is dequeued */
738 void pkgAcquire::Queue::Bump()
744 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
745 // ---------------------------------------------------------------------
747 pkgAcquireStatus::pkgAcquireStatus() : Update(true), MorePulses(false)
752 // AcquireStatus::Pulse - Called periodically /*{{{*/
753 // ---------------------------------------------------------------------
754 /* This computes some internal state variables for the derived classes to
755 use. It generates the current downloaded bytes and total bytes to download
756 as well as the current CPS estimate. */
757 bool pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
764 // Compute the total number of bytes to fetch
765 unsigned int Unknown
= 0;
766 unsigned int Count
= 0;
767 for (pkgAcquire::ItemCIterator I
= Owner
->ItemsBegin(); I
!= Owner
->ItemsEnd();
771 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
774 // Totally ignore local items
775 if ((*I
)->Local
== true)
778 TotalBytes
+= (*I
)->FileSize
;
779 if ((*I
)->Complete
== true)
780 CurrentBytes
+= (*I
)->FileSize
;
781 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
785 // Compute the current completion
786 unsigned long ResumeSize
= 0;
787 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
788 I
= Owner
->WorkerStep(I
))
789 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
791 CurrentBytes
+= I
->CurrentSize
;
792 ResumeSize
+= I
->ResumePoint
;
794 // Files with unknown size always have 100% completion
795 if (I
->CurrentItem
->Owner
->FileSize
== 0 &&
796 I
->CurrentItem
->Owner
->Complete
== false)
797 TotalBytes
+= I
->CurrentSize
;
800 // Normalize the figures and account for unknown size downloads
803 if (Unknown
== Count
)
804 TotalBytes
= Unknown
;
806 // Wha?! Is not supposed to happen.
807 if (CurrentBytes
> TotalBytes
)
808 CurrentBytes
= TotalBytes
;
811 struct timeval NewTime
;
812 gettimeofday(&NewTime
,0);
813 if (NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
||
814 NewTime
.tv_sec
- Time
.tv_sec
> 6)
816 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
817 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
819 // Compute the CPS value
823 CurrentCPS
= ((CurrentBytes
- ResumeSize
) - LastBytes
)/Delta
;
824 LastBytes
= CurrentBytes
- ResumeSize
;
825 ElapsedTime
= (unsigned long)Delta
;
829 int fd
= _config
->FindI("APT::Status-Fd",-1);
832 ostringstream status
;
835 long i
= CurrentItems
< TotalItems
? CurrentItems
+ 1 : CurrentItems
;
837 (unsigned long)((TotalBytes
- CurrentBytes
) / CurrentCPS
);
839 // only show the ETA if it makes sense
840 if (ETA
> 0 && ETA
< 172800 /* two days */ )
841 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li (%s remaining)"), i
, TotalItems
, TimeToStr(ETA
).c_str());
843 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li"), i
, TotalItems
);
847 // build the status str
848 status
<< "dlstatus:" << i
849 << ":" << (CurrentBytes
/float(TotalBytes
)*100.0)
852 write(fd
, status
.str().c_str(), status
.str().size());
858 // AcquireStatus::Start - Called when the download is started /*{{{*/
859 // ---------------------------------------------------------------------
860 /* We just reset the counters */
861 void pkgAcquireStatus::Start()
863 gettimeofday(&Time
,0);
864 gettimeofday(&StartTime
,0);
875 // AcquireStatus::Stop - Finished downloading /*{{{*/
876 // ---------------------------------------------------------------------
877 /* This accurately computes the elapsed time and the total overall CPS. */
878 void pkgAcquireStatus::Stop()
880 // Compute the CPS and elapsed time
881 struct timeval NewTime
;
882 gettimeofday(&NewTime
,0);
884 double Delta
= NewTime
.tv_sec
- StartTime
.tv_sec
+
885 (NewTime
.tv_usec
- StartTime
.tv_usec
)/1000000.0;
887 // Compute the CPS value
891 CurrentCPS
= FetchedBytes
/Delta
;
892 LastBytes
= CurrentBytes
;
893 ElapsedTime
= (unsigned int)Delta
;
896 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
897 // ---------------------------------------------------------------------
898 /* This is used to get accurate final transfer rate reporting. */
899 void pkgAcquireStatus::Fetched(unsigned long Size
,unsigned long Resume
)
901 FetchedBytes
+= Size
- Resume
;