]>
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>
37 // Acquire::pkgAcquire - Constructor /*{{{*/
38 // ---------------------------------------------------------------------
39 /* We grab some runtime state from the configuration space */
40 pkgAcquire::pkgAcquire(pkgAcquireStatus
*Log
) : Log(Log
)
48 string Mode
= _config
->Find("Acquire::Queue-Mode","host");
49 if (strcasecmp(Mode
.c_str(),"host") == 0)
50 QueueMode
= QueueHost
;
51 if (strcasecmp(Mode
.c_str(),"access") == 0)
52 QueueMode
= QueueAccess
;
54 Debug
= _config
->FindB("Debug::pkgAcquire",false);
56 // This is really a stupid place for this
58 if (stat((_config
->FindDir("Dir::State::lists") + "partial/").c_str(),&St
) != 0 ||
59 S_ISDIR(St
.st_mode
) == 0)
60 _error
->Error(_("Lists directory %spartial is missing."),
61 _config
->FindDir("Dir::State::lists").c_str());
62 if (stat((_config
->FindDir("Dir::Cache::Archives") + "partial/").c_str(),&St
) != 0 ||
63 S_ISDIR(St
.st_mode
) == 0)
64 _error
->Error(_("Archive directory %spartial is missing."),
65 _config
->FindDir("Dir::Cache::Archives").c_str());
68 // Acquire::~pkgAcquire - Destructor /*{{{*/
69 // ---------------------------------------------------------------------
70 /* Free our memory, clean up the queues (destroy the workers) */
71 pkgAcquire::~pkgAcquire()
77 MethodConfig
*Jnk
= Configs
;
78 Configs
= Configs
->Next
;
83 // Acquire::Shutdown - Clean out the acquire object /*{{{*/
84 // ---------------------------------------------------------------------
86 void pkgAcquire::Shutdown()
88 while (Items
.size() != 0)
90 if (Items
[0]->Status
== Item::StatFetching
)
91 Items
[0]->Status
= Item::StatError
;
98 Queues
= Queues
->Next
;
103 // Acquire::Add - Add a new item /*{{{*/
104 // ---------------------------------------------------------------------
105 /* This puts an item on the acquire list. This list is mainly for tracking
107 void pkgAcquire::Add(Item
*Itm
)
109 Items
.push_back(Itm
);
112 // Acquire::Remove - Remove a item /*{{{*/
113 // ---------------------------------------------------------------------
114 /* Remove an item from the acquire list. This is usually not used.. */
115 void pkgAcquire::Remove(Item
*Itm
)
119 for (ItemIterator I
= Items
.begin(); I
!= Items
.end();)
131 // Acquire::Add - Add a worker /*{{{*/
132 // ---------------------------------------------------------------------
133 /* A list of workers is kept so that the select loop can direct their FD
135 void pkgAcquire::Add(Worker
*Work
)
137 Work
->NextAcquire
= Workers
;
141 // Acquire::Remove - Remove a worker /*{{{*/
142 // ---------------------------------------------------------------------
143 /* A worker has died. This can not be done while the select loop is running
144 as it would require that RunFds could handling a changing list state and
146 void pkgAcquire::Remove(Worker
*Work
)
151 Worker
**I
= &Workers
;
155 *I
= (*I
)->NextAcquire
;
157 I
= &(*I
)->NextAcquire
;
161 // Acquire::Enqueue - Queue an URI for fetching /*{{{*/
162 // ---------------------------------------------------------------------
163 /* This is the entry point for an item. An item calls this function when
164 it is constructed which creates a queue (based on the current queue
165 mode) and puts the item in that queue. If the system is running then
166 the queue might be started. */
167 void pkgAcquire::Enqueue(ItemDesc
&Item
)
169 // Determine which queue to put the item in
170 const MethodConfig
*Config
;
171 string Name
= QueueName(Item
.URI
,Config
);
172 if (Name
.empty() == true)
175 // Find the queue structure
177 for (; I
!= 0 && I
->Name
!= Name
; I
= I
->Next
);
180 I
= new Queue(Name
,this);
188 // See if this is a local only URI
189 if (Config
->LocalOnly
== true && Item
.Owner
->Complete
== false)
190 Item
.Owner
->Local
= true;
191 Item
.Owner
->Status
= Item::StatIdle
;
193 // Queue it into the named queue
200 clog
<< "Fetching " << Item
.URI
<< endl
;
201 clog
<< " to " << Item
.Owner
->DestFile
<< endl
;
202 clog
<< " Queue is: " << Name
<< endl
;
206 // Acquire::Dequeue - Remove an item from all queues /*{{{*/
207 // ---------------------------------------------------------------------
208 /* This is called when an item is finished being fetched. It removes it
209 from all the queues */
210 void pkgAcquire::Dequeue(Item
*Itm
)
214 for (; I
!= 0; I
= I
->Next
)
215 Res
|= I
->Dequeue(Itm
);
218 clog
<< "Dequeuing " << Itm
->DestFile
<< endl
;
223 // Acquire::QueueName - Return the name of the queue for this URI /*{{{*/
224 // ---------------------------------------------------------------------
225 /* The string returned depends on the configuration settings and the
226 method parameters. Given something like http://foo.org/bar it can
227 return http://foo.org or http */
228 string
pkgAcquire::QueueName(string Uri
,MethodConfig
const *&Config
)
232 Config
= GetConfig(U
.Access
);
236 /* Single-Instance methods get exactly one queue per URI. This is
237 also used for the Access queue method */
238 if (Config
->SingleInstance
== true || QueueMode
== QueueAccess
)
241 return U
.Access
+ ':' + U
.Host
;
244 // Acquire::GetConfig - Fetch the configuration information /*{{{*/
245 // ---------------------------------------------------------------------
246 /* This locates the configuration structure for an access method. If
247 a config structure cannot be found a Worker will be created to
249 pkgAcquire::MethodConfig
*pkgAcquire::GetConfig(string Access
)
251 // Search for an existing config
253 for (Conf
= Configs
; Conf
!= 0; Conf
= Conf
->Next
)
254 if (Conf
->Access
== Access
)
257 // Create the new config class
258 Conf
= new MethodConfig
;
259 Conf
->Access
= Access
;
260 Conf
->Next
= Configs
;
263 // Create the worker to fetch the configuration
265 if (Work
.Start() == false)
268 /* if a method uses DownloadLimit, we switch to SingleInstance mode */
269 if(_config
->FindI("Acquire::"+Access
+"::DlLimit",0) > 0)
270 Conf
->SingleInstance
= true;
275 // Acquire::SetFds - Deal with readable FDs /*{{{*/
276 // ---------------------------------------------------------------------
277 /* Collect FDs that have activity monitors into the fd sets */
278 void pkgAcquire::SetFds(int &Fd
,fd_set
*RSet
,fd_set
*WSet
)
280 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
282 if (I
->InReady
== true && I
->InFd
>= 0)
286 FD_SET(I
->InFd
,RSet
);
288 if (I
->OutReady
== true && I
->OutFd
>= 0)
292 FD_SET(I
->OutFd
,WSet
);
297 // Acquire::RunFds - Deal with active FDs /*{{{*/
298 // ---------------------------------------------------------------------
299 /* Dispatch active FDs over to the proper workers. It is very important
300 that a worker never be erased while this is running! The queue class
301 should never erase a worker except during shutdown processing. */
302 void pkgAcquire::RunFds(fd_set
*RSet
,fd_set
*WSet
)
304 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
306 if (I
->InFd
>= 0 && FD_ISSET(I
->InFd
,RSet
) != 0)
308 if (I
->OutFd
>= 0 && FD_ISSET(I
->OutFd
,WSet
) != 0)
313 // Acquire::Run - Run the fetch sequence /*{{{*/
314 // ---------------------------------------------------------------------
315 /* This runs the queues. It manages a select loop for all of the
316 Worker tasks. The workers interact with the queues and items to
317 manage the actual fetch. */
318 pkgAcquire::RunResult
pkgAcquire::Run(int PulseIntervall
)
322 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
328 bool WasCancelled
= false;
330 // Run till all things have been acquired
333 tv
.tv_usec
= PulseIntervall
;
341 SetFds(Highest
,&RFds
,&WFds
);
346 Res
= select(Highest
+1,&RFds
,&WFds
,0,&tv
);
348 while (Res
< 0 && errno
== EINTR
);
352 _error
->Errno("select","Select has failed");
357 if (_error
->PendingError() == true)
360 // Timeout, notify the log class
361 if (Res
== 0 || (Log
!= 0 && Log
->Update
== true))
363 tv
.tv_usec
= PulseIntervall
;
364 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
366 if (Log
!= 0 && Log
->Pulse(this) == false)
377 // Shut down the acquire bits
379 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
382 // Shut down the items
383 for (ItemIterator I
= Items
.begin(); I
!= Items
.end(); I
++)
386 if (_error
->PendingError())
393 // Acquire::Bump - Called when an item is dequeued /*{{{*/
394 // ---------------------------------------------------------------------
395 /* This routine bumps idle queues in hopes that they will be able to fetch
397 void pkgAcquire::Bump()
399 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
403 // Acquire::WorkerStep - Step to the next worker /*{{{*/
404 // ---------------------------------------------------------------------
405 /* Not inlined to advoid including acquire-worker.h */
406 pkgAcquire::Worker
*pkgAcquire::WorkerStep(Worker
*I
)
408 return I
->NextAcquire
;
411 // Acquire::Clean - Cleans a directory /*{{{*/
412 // ---------------------------------------------------------------------
413 /* This is a bit simplistic, it looks at every file in the dir and sees
414 if it is part of the download set. */
415 bool pkgAcquire::Clean(string Dir
)
417 DIR *D
= opendir(Dir
.c_str());
419 return _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
421 string StartDir
= SafeGetCWD();
422 if (chdir(Dir
.c_str()) != 0)
425 return _error
->Errno("chdir",_("Unable to change to %s"),Dir
.c_str());
428 for (struct dirent
*Dir
= readdir(D
); Dir
!= 0; Dir
= readdir(D
))
431 if (strcmp(Dir
->d_name
,"lock") == 0 ||
432 strcmp(Dir
->d_name
,"partial") == 0 ||
433 strcmp(Dir
->d_name
,".") == 0 ||
434 strcmp(Dir
->d_name
,"..") == 0)
437 // Look in the get list
438 ItemCIterator I
= Items
.begin();
439 for (; I
!= Items
.end(); I
++)
440 if (flNotDir((*I
)->DestFile
) == Dir
->d_name
)
443 // Nothing found, nuke it
444 if (I
== Items
.end())
449 if (chdir(StartDir
.c_str()) != 0)
450 return _error
->Errno("chdir",_("Unable to change to %s"),StartDir
.c_str());
454 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
455 // ---------------------------------------------------------------------
456 /* This is the total number of bytes needed */
457 double pkgAcquire::TotalNeeded()
460 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
461 Total
+= (*I
)->FileSize
;
465 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
466 // ---------------------------------------------------------------------
467 /* This is the number of bytes that is not local */
468 double pkgAcquire::FetchNeeded()
471 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
472 if ((*I
)->Local
== false)
473 Total
+= (*I
)->FileSize
;
477 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
478 // ---------------------------------------------------------------------
479 /* This is the number of bytes that is not local */
480 double pkgAcquire::PartialPresent()
483 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
484 if ((*I
)->Local
== false)
485 Total
+= (*I
)->PartialSize
;
489 // Acquire::UriBegin - Start iterator for the uri list /*{{{*/
490 // ---------------------------------------------------------------------
492 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
494 return UriIterator(Queues
);
497 // Acquire::UriEnd - End iterator for the uri list /*{{{*/
498 // ---------------------------------------------------------------------
500 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
502 return UriIterator(0);
506 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
507 // ---------------------------------------------------------------------
509 pkgAcquire::MethodConfig::MethodConfig()
511 SingleInstance
= false;
520 // Queue::Queue - Constructor /*{{{*/
521 // ---------------------------------------------------------------------
523 pkgAcquire::Queue::Queue(string Name
,pkgAcquire
*Owner
) : Name(Name
),
533 // Queue::~Queue - Destructor /*{{{*/
534 // ---------------------------------------------------------------------
536 pkgAcquire::Queue::~Queue()
548 // Queue::Enqueue - Queue an item to the queue /*{{{*/
549 // ---------------------------------------------------------------------
551 bool pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
554 // move to the end of the queue and check for duplicates here
555 for (; *I
!= 0; I
= &(*I
)->Next
)
556 if (Item
.URI
== (*I
)->URI
)
558 Item
.Owner
->Status
= Item::StatDone
;
563 QItem
*Itm
= new QItem
;
568 Item
.Owner
->QueueCounter
++;
569 if (Items
->Next
== 0)
574 // Queue::Dequeue - Remove an item from the queue /*{{{*/
575 // ---------------------------------------------------------------------
576 /* We return true if we hit something */
577 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
579 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
580 return _error
->Error("Tried to dequeue a fetching object");
587 if ((*I
)->Owner
== Owner
)
591 Owner
->QueueCounter
--;
602 // Queue::Startup - Start the worker processes /*{{{*/
603 // ---------------------------------------------------------------------
604 /* It is possible for this to be called with a pre-existing set of
606 bool pkgAcquire::Queue::Startup()
611 pkgAcquire::MethodConfig
*Cnf
= Owner
->GetConfig(U
.Access
);
615 Workers
= new Worker(this,Cnf
,Owner
->Log
);
617 if (Workers
->Start() == false)
620 /* When pipelining we commit 10 items. This needs to change when we
621 added other source retry to have cycle maintain a pipeline depth
623 if (Cnf
->Pipeline
== true)
624 MaxPipeDepth
= _config
->FindI("Acquire::Max-Pipeline-Depth",10);
632 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
633 // ---------------------------------------------------------------------
634 /* If final is true then all workers are eliminated, otherwise only workers
635 that do not need cleanup are removed */
636 bool pkgAcquire::Queue::Shutdown(bool Final
)
638 // Delete all of the workers
639 pkgAcquire::Worker
**Cur
= &Workers
;
642 pkgAcquire::Worker
*Jnk
= *Cur
;
643 if (Final
== true || Jnk
->GetConf()->NeedsCleanup
== false)
645 *Cur
= Jnk
->NextQueue
;
650 Cur
= &(*Cur
)->NextQueue
;
656 // Queue::FindItem - Find a URI in the item list /*{{{*/
657 // ---------------------------------------------------------------------
659 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
661 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
662 if (I
->URI
== URI
&& I
->Worker
== Owner
)
667 // Queue::ItemDone - Item has been completed /*{{{*/
668 // ---------------------------------------------------------------------
669 /* The worker signals this which causes the item to be removed from the
670 queue. If this is the last queue instance then it is removed from the
672 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
675 if (Itm
->Owner
->Status
== pkgAcquire::Item::StatFetching
)
676 Itm
->Owner
->Status
= pkgAcquire::Item::StatDone
;
678 if (Itm
->Owner
->QueueCounter
<= 1)
679 Owner
->Dequeue(Itm
->Owner
);
689 // Queue::Cycle - Queue new items into the method /*{{{*/
690 // ---------------------------------------------------------------------
691 /* This locates a new idle item and sends it to the worker. If pipelining
692 is enabled then it keeps the pipe full. */
693 bool pkgAcquire::Queue::Cycle()
695 if (Items
== 0 || Workers
== 0)
699 return _error
->Error("Pipedepth failure");
701 // Look for a queable item
703 while (PipeDepth
< (signed)MaxPipeDepth
)
705 for (; I
!= 0; I
= I
->Next
)
706 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
709 // Nothing to do, queue is idle.
714 I
->Owner
->Status
= pkgAcquire::Item::StatFetching
;
716 if (Workers
->QueueItem(I
) == false)
723 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
724 // ---------------------------------------------------------------------
725 /* This is called when an item in multiple queues is dequeued */
726 void pkgAcquire::Queue::Bump()
732 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
733 // ---------------------------------------------------------------------
735 pkgAcquireStatus::pkgAcquireStatus() : Update(true), MorePulses(false)
740 // AcquireStatus::Pulse - Called periodically /*{{{*/
741 // ---------------------------------------------------------------------
742 /* This computes some internal state variables for the derived classes to
743 use. It generates the current downloaded bytes and total bytes to download
744 as well as the current CPS estimate. */
745 bool pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
752 // Compute the total number of bytes to fetch
753 unsigned int Unknown
= 0;
754 unsigned int Count
= 0;
755 for (pkgAcquire::ItemCIterator I
= Owner
->ItemsBegin(); I
!= Owner
->ItemsEnd();
759 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
762 // Totally ignore local items
763 if ((*I
)->Local
== true)
766 TotalBytes
+= (*I
)->FileSize
;
767 if ((*I
)->Complete
== true)
768 CurrentBytes
+= (*I
)->FileSize
;
769 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
773 // Compute the current completion
774 unsigned long ResumeSize
= 0;
775 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
776 I
= Owner
->WorkerStep(I
))
777 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
779 CurrentBytes
+= I
->CurrentSize
;
780 ResumeSize
+= I
->ResumePoint
;
782 // Files with unknown size always have 100% completion
783 if (I
->CurrentItem
->Owner
->FileSize
== 0 &&
784 I
->CurrentItem
->Owner
->Complete
== false)
785 TotalBytes
+= I
->CurrentSize
;
788 // Normalize the figures and account for unknown size downloads
791 if (Unknown
== Count
)
792 TotalBytes
= Unknown
;
794 // Wha?! Is not supposed to happen.
795 if (CurrentBytes
> TotalBytes
)
796 CurrentBytes
= TotalBytes
;
799 struct timeval NewTime
;
800 gettimeofday(&NewTime
,0);
801 if ((NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
) ||
802 NewTime
.tv_sec
- Time
.tv_sec
> 6)
804 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
805 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
807 // Compute the CPS value
811 CurrentCPS
= ((CurrentBytes
- ResumeSize
) - LastBytes
)/Delta
;
812 LastBytes
= CurrentBytes
- ResumeSize
;
813 ElapsedTime
= (unsigned long)Delta
;
817 int fd
= _config
->FindI("APT::Status-Fd",-1);
820 ostringstream status
;
823 long i
= CurrentItems
< TotalItems
? CurrentItems
+ 1 : CurrentItems
;
825 (unsigned long)((TotalBytes
- CurrentBytes
) / CurrentCPS
);
827 // only show the ETA if it makes sense
828 if (ETA
> 0 && ETA
< 172800 /* two days */ )
829 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li (%s remaining)"), i
, TotalItems
, TimeToStr(ETA
).c_str());
831 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li"), i
, TotalItems
);
835 // build the status str
836 status
<< "dlstatus:" << i
837 << ":" << (CurrentBytes
/float(TotalBytes
)*100.0)
840 write(fd
, status
.str().c_str(), status
.str().size());
846 // AcquireStatus::Start - Called when the download is started /*{{{*/
847 // ---------------------------------------------------------------------
848 /* We just reset the counters */
849 void pkgAcquireStatus::Start()
851 gettimeofday(&Time
,0);
852 gettimeofday(&StartTime
,0);
863 // AcquireStatus::Stop - Finished downloading /*{{{*/
864 // ---------------------------------------------------------------------
865 /* This accurately computes the elapsed time and the total overall CPS. */
866 void pkgAcquireStatus::Stop()
868 // Compute the CPS and elapsed time
869 struct timeval NewTime
;
870 gettimeofday(&NewTime
,0);
872 double Delta
= NewTime
.tv_sec
- StartTime
.tv_sec
+
873 (NewTime
.tv_usec
- StartTime
.tv_usec
)/1000000.0;
875 // Compute the CPS value
879 CurrentCPS
= FetchedBytes
/Delta
;
880 LastBytes
= CurrentBytes
;
881 ElapsedTime
= (unsigned int)Delta
;
884 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
885 // ---------------------------------------------------------------------
886 /* This is used to get accurate final transfer rate reporting. */
887 void pkgAcquireStatus::Fetched(unsigned long Size
,unsigned long Resume
)
889 FetchedBytes
+= Size
- Resume
;