]>
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())
447 chdir(StartDir
.c_str());
452 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
453 // ---------------------------------------------------------------------
454 /* This is the total number of bytes needed */
455 double pkgAcquire::TotalNeeded()
458 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
459 Total
+= (*I
)->FileSize
;
463 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
464 // ---------------------------------------------------------------------
465 /* This is the number of bytes that is not local */
466 double pkgAcquire::FetchNeeded()
469 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
470 if ((*I
)->Local
== false)
471 Total
+= (*I
)->FileSize
;
475 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
476 // ---------------------------------------------------------------------
477 /* This is the number of bytes that is not local */
478 double pkgAcquire::PartialPresent()
481 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
482 if ((*I
)->Local
== false)
483 Total
+= (*I
)->PartialSize
;
487 // Acquire::UriBegin - Start iterator for the uri list /*{{{*/
488 // ---------------------------------------------------------------------
490 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
492 return UriIterator(Queues
);
495 // Acquire::UriEnd - End iterator for the uri list /*{{{*/
496 // ---------------------------------------------------------------------
498 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
500 return UriIterator(0);
504 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
505 // ---------------------------------------------------------------------
507 pkgAcquire::MethodConfig::MethodConfig()
509 SingleInstance
= false;
518 // Queue::Queue - Constructor /*{{{*/
519 // ---------------------------------------------------------------------
521 pkgAcquire::Queue::Queue(string Name
,pkgAcquire
*Owner
) : Name(Name
),
531 // Queue::~Queue - Destructor /*{{{*/
532 // ---------------------------------------------------------------------
534 pkgAcquire::Queue::~Queue()
546 // Queue::Enqueue - Queue an item to the queue /*{{{*/
547 // ---------------------------------------------------------------------
549 bool pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
552 // move to the end of the queue and check for duplicates here
553 for (; *I
!= 0; I
= &(*I
)->Next
)
554 if (Item
.URI
== (*I
)->URI
)
556 Item
.Owner
->Status
= Item::StatDone
;
561 QItem
*Itm
= new QItem
;
566 Item
.Owner
->QueueCounter
++;
567 if (Items
->Next
== 0)
572 // Queue::Dequeue - Remove an item from the queue /*{{{*/
573 // ---------------------------------------------------------------------
574 /* We return true if we hit something */
575 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
577 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
578 return _error
->Error("Tried to dequeue a fetching object");
585 if ((*I
)->Owner
== Owner
)
589 Owner
->QueueCounter
--;
600 // Queue::Startup - Start the worker processes /*{{{*/
601 // ---------------------------------------------------------------------
602 /* It is possible for this to be called with a pre-existing set of
604 bool pkgAcquire::Queue::Startup()
609 pkgAcquire::MethodConfig
*Cnf
= Owner
->GetConfig(U
.Access
);
613 Workers
= new Worker(this,Cnf
,Owner
->Log
);
615 if (Workers
->Start() == false)
618 /* When pipelining we commit 10 items. This needs to change when we
619 added other source retry to have cycle maintain a pipeline depth
621 if (Cnf
->Pipeline
== true)
630 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
631 // ---------------------------------------------------------------------
632 /* If final is true then all workers are eliminated, otherwise only workers
633 that do not need cleanup are removed */
634 bool pkgAcquire::Queue::Shutdown(bool Final
)
636 // Delete all of the workers
637 pkgAcquire::Worker
**Cur
= &Workers
;
640 pkgAcquire::Worker
*Jnk
= *Cur
;
641 if (Final
== true || Jnk
->GetConf()->NeedsCleanup
== false)
643 *Cur
= Jnk
->NextQueue
;
648 Cur
= &(*Cur
)->NextQueue
;
654 // Queue::FindItem - Find a URI in the item list /*{{{*/
655 // ---------------------------------------------------------------------
657 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
659 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
660 if (I
->URI
== URI
&& I
->Worker
== Owner
)
665 // Queue::ItemDone - Item has been completed /*{{{*/
666 // ---------------------------------------------------------------------
667 /* The worker signals this which causes the item to be removed from the
668 queue. If this is the last queue instance then it is removed from the
670 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
673 if (Itm
->Owner
->Status
== pkgAcquire::Item::StatFetching
)
674 Itm
->Owner
->Status
= pkgAcquire::Item::StatDone
;
676 if (Itm
->Owner
->QueueCounter
<= 1)
677 Owner
->Dequeue(Itm
->Owner
);
687 // Queue::Cycle - Queue new items into the method /*{{{*/
688 // ---------------------------------------------------------------------
689 /* This locates a new idle item and sends it to the worker. If pipelining
690 is enabled then it keeps the pipe full. */
691 bool pkgAcquire::Queue::Cycle()
693 if (Items
== 0 || Workers
== 0)
697 return _error
->Error("Pipedepth failure");
699 // Look for a queable item
701 while (PipeDepth
< (signed)MaxPipeDepth
)
703 for (; I
!= 0; I
= I
->Next
)
704 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
707 // Nothing to do, queue is idle.
712 I
->Owner
->Status
= pkgAcquire::Item::StatFetching
;
714 if (Workers
->QueueItem(I
) == false)
721 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
722 // ---------------------------------------------------------------------
723 /* This is called when an item in multiple queues is dequeued */
724 void pkgAcquire::Queue::Bump()
730 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
731 // ---------------------------------------------------------------------
733 pkgAcquireStatus::pkgAcquireStatus() : Update(true), MorePulses(false)
738 // AcquireStatus::Pulse - Called periodically /*{{{*/
739 // ---------------------------------------------------------------------
740 /* This computes some internal state variables for the derived classes to
741 use. It generates the current downloaded bytes and total bytes to download
742 as well as the current CPS estimate. */
743 bool pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
750 // Compute the total number of bytes to fetch
751 unsigned int Unknown
= 0;
752 unsigned int Count
= 0;
753 for (pkgAcquire::ItemCIterator I
= Owner
->ItemsBegin(); I
!= Owner
->ItemsEnd();
757 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
760 // Totally ignore local items
761 if ((*I
)->Local
== true)
764 TotalBytes
+= (*I
)->FileSize
;
765 if ((*I
)->Complete
== true)
766 CurrentBytes
+= (*I
)->FileSize
;
767 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
771 // Compute the current completion
772 unsigned long ResumeSize
= 0;
773 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
774 I
= Owner
->WorkerStep(I
))
775 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
777 CurrentBytes
+= I
->CurrentSize
;
778 ResumeSize
+= I
->ResumePoint
;
780 // Files with unknown size always have 100% completion
781 if (I
->CurrentItem
->Owner
->FileSize
== 0 &&
782 I
->CurrentItem
->Owner
->Complete
== false)
783 TotalBytes
+= I
->CurrentSize
;
786 // Normalize the figures and account for unknown size downloads
789 if (Unknown
== Count
)
790 TotalBytes
= Unknown
;
792 // Wha?! Is not supposed to happen.
793 if (CurrentBytes
> TotalBytes
)
794 CurrentBytes
= TotalBytes
;
797 struct timeval NewTime
;
798 gettimeofday(&NewTime
,0);
799 if ((NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
) ||
800 NewTime
.tv_sec
- Time
.tv_sec
> 6)
802 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
803 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
805 // Compute the CPS value
809 CurrentCPS
= ((CurrentBytes
- ResumeSize
) - LastBytes
)/Delta
;
810 LastBytes
= CurrentBytes
- ResumeSize
;
811 ElapsedTime
= (unsigned long)Delta
;
815 int fd
= _config
->FindI("APT::Status-Fd",-1);
818 ostringstream status
;
821 long i
= CurrentItems
< TotalItems
? CurrentItems
+ 1 : CurrentItems
;
823 (unsigned long)((TotalBytes
- CurrentBytes
) / CurrentCPS
);
825 // only show the ETA if it makes sense
826 if (ETA
> 0 && ETA
< 172800 /* two days */ )
827 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li (%s remaining)"), i
, TotalItems
, TimeToStr(ETA
).c_str());
829 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li"), i
, TotalItems
);
833 // build the status str
834 status
<< "dlstatus:" << i
835 << ":" << (CurrentBytes
/float(TotalBytes
)*100.0)
838 write(fd
, status
.str().c_str(), status
.str().size());
844 // AcquireStatus::Start - Called when the download is started /*{{{*/
845 // ---------------------------------------------------------------------
846 /* We just reset the counters */
847 void pkgAcquireStatus::Start()
849 gettimeofday(&Time
,0);
850 gettimeofday(&StartTime
,0);
861 // AcquireStatus::Stop - Finished downloading /*{{{*/
862 // ---------------------------------------------------------------------
863 /* This accurately computes the elapsed time and the total overall CPS. */
864 void pkgAcquireStatus::Stop()
866 // Compute the CPS and elapsed time
867 struct timeval NewTime
;
868 gettimeofday(&NewTime
,0);
870 double Delta
= NewTime
.tv_sec
- StartTime
.tv_sec
+
871 (NewTime
.tv_usec
- StartTime
.tv_usec
)/1000000.0;
873 // Compute the CPS value
877 CurrentCPS
= FetchedBytes
/Delta
;
878 LastBytes
= CurrentBytes
;
879 ElapsedTime
= (unsigned int)Delta
;
882 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
883 // ---------------------------------------------------------------------
884 /* This is used to get accurate final transfer rate reporting. */
885 void pkgAcquireStatus::Fetched(unsigned long Size
,unsigned long Resume
)
887 FetchedBytes
+= Size
- Resume
;