]>
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 /*{{{*/
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>
38 // Acquire::pkgAcquire - Constructor /*{{{*/
39 // ---------------------------------------------------------------------
40 /* We grab some runtime state from the configuration space */
41 pkgAcquire::pkgAcquire(pkgAcquireStatus
*Log
) : Log(Log
)
49 string Mode
= _config
->Find("Acquire::Queue-Mode","host");
50 if (strcasecmp(Mode
.c_str(),"host") == 0)
51 QueueMode
= QueueHost
;
52 if (strcasecmp(Mode
.c_str(),"access") == 0)
53 QueueMode
= QueueAccess
;
55 Debug
= _config
->FindB("Debug::pkgAcquire",false);
57 // This is really a stupid place for this
59 if (stat((_config
->FindDir("Dir::State::lists") + "partial/").c_str(),&St
) != 0 ||
60 S_ISDIR(St
.st_mode
) == 0)
61 _error
->Error(_("Lists directory %spartial is missing."),
62 _config
->FindDir("Dir::State::lists").c_str());
63 if (stat((_config
->FindDir("Dir::Cache::Archives") + "partial/").c_str(),&St
) != 0 ||
64 S_ISDIR(St
.st_mode
) == 0)
65 _error
->Error(_("Archive directory %spartial is missing."),
66 _config
->FindDir("Dir::Cache::Archives").c_str());
69 // Acquire::~pkgAcquire - Destructor /*{{{*/
70 // ---------------------------------------------------------------------
71 /* Free our memory, clean up the queues (destroy the workers) */
72 pkgAcquire::~pkgAcquire()
78 MethodConfig
*Jnk
= Configs
;
79 Configs
= Configs
->Next
;
84 // Acquire::Shutdown - Clean out the acquire object /*{{{*/
85 // ---------------------------------------------------------------------
87 void pkgAcquire::Shutdown()
89 while (Items
.size() != 0)
91 if (Items
[0]->Status
== Item::StatFetching
)
92 Items
[0]->Status
= Item::StatError
;
99 Queues
= Queues
->Next
;
104 // Acquire::Add - Add a new item /*{{{*/
105 // ---------------------------------------------------------------------
106 /* This puts an item on the acquire list. This list is mainly for tracking
108 void pkgAcquire::Add(Item
*Itm
)
110 Items
.push_back(Itm
);
113 // Acquire::Remove - Remove a item /*{{{*/
114 // ---------------------------------------------------------------------
115 /* Remove an item from the acquire list. This is usually not used.. */
116 void pkgAcquire::Remove(Item
*Itm
)
120 for (ItemIterator I
= Items
.begin(); I
!= Items
.end();)
132 // Acquire::Add - Add a worker /*{{{*/
133 // ---------------------------------------------------------------------
134 /* A list of workers is kept so that the select loop can direct their FD
136 void pkgAcquire::Add(Worker
*Work
)
138 Work
->NextAcquire
= Workers
;
142 // Acquire::Remove - Remove a worker /*{{{*/
143 // ---------------------------------------------------------------------
144 /* A worker has died. This can not be done while the select loop is running
145 as it would require that RunFds could handling a changing list state and
147 void pkgAcquire::Remove(Worker
*Work
)
152 Worker
**I
= &Workers
;
156 *I
= (*I
)->NextAcquire
;
158 I
= &(*I
)->NextAcquire
;
162 // Acquire::Enqueue - Queue an URI for fetching /*{{{*/
163 // ---------------------------------------------------------------------
164 /* This is the entry point for an item. An item calls this function when
165 it is constructed which creates a queue (based on the current queue
166 mode) and puts the item in that queue. If the system is running then
167 the queue might be started. */
168 void pkgAcquire::Enqueue(ItemDesc
&Item
)
170 // Determine which queue to put the item in
171 const MethodConfig
*Config
;
172 string Name
= QueueName(Item
.URI
,Config
);
173 if (Name
.empty() == true)
176 // Find the queue structure
178 for (; I
!= 0 && I
->Name
!= Name
; I
= I
->Next
);
181 I
= new Queue(Name
,this);
189 // See if this is a local only URI
190 if (Config
->LocalOnly
== true && Item
.Owner
->Complete
== false)
191 Item
.Owner
->Local
= true;
192 Item
.Owner
->Status
= Item::StatIdle
;
194 // Queue it into the named queue
201 clog
<< "Fetching " << Item
.URI
<< endl
;
202 clog
<< " to " << Item
.Owner
->DestFile
<< endl
;
203 clog
<< " Queue is: " << Name
<< endl
;
207 // Acquire::Dequeue - Remove an item from all queues /*{{{*/
208 // ---------------------------------------------------------------------
209 /* This is called when an item is finished being fetched. It removes it
210 from all the queues */
211 void pkgAcquire::Dequeue(Item
*Itm
)
215 for (; I
!= 0; I
= I
->Next
)
216 Res
|= I
->Dequeue(Itm
);
219 clog
<< "Dequeuing " << Itm
->DestFile
<< endl
;
224 // Acquire::QueueName - Return the name of the queue for this URI /*{{{*/
225 // ---------------------------------------------------------------------
226 /* The string returned depends on the configuration settings and the
227 method parameters. Given something like http://foo.org/bar it can
228 return http://foo.org or http */
229 string
pkgAcquire::QueueName(string Uri
,MethodConfig
const *&Config
)
233 Config
= GetConfig(U
.Access
);
237 /* Single-Instance methods get exactly one queue per URI. This is
238 also used for the Access queue method */
239 if (Config
->SingleInstance
== true || QueueMode
== QueueAccess
)
242 return U
.Access
+ ':' + U
.Host
;
245 // Acquire::GetConfig - Fetch the configuration information /*{{{*/
246 // ---------------------------------------------------------------------
247 /* This locates the configuration structure for an access method. If
248 a config structure cannot be found a Worker will be created to
250 pkgAcquire::MethodConfig
*pkgAcquire::GetConfig(string Access
)
252 // Search for an existing config
254 for (Conf
= Configs
; Conf
!= 0; Conf
= Conf
->Next
)
255 if (Conf
->Access
== Access
)
258 // Create the new config class
259 Conf
= new MethodConfig
;
260 Conf
->Access
= Access
;
261 Conf
->Next
= Configs
;
264 // Create the worker to fetch the configuration
266 if (Work
.Start() == false)
272 // Acquire::SetFds - Deal with readable FDs /*{{{*/
273 // ---------------------------------------------------------------------
274 /* Collect FDs that have activity monitors into the fd sets */
275 void pkgAcquire::SetFds(int &Fd
,fd_set
*RSet
,fd_set
*WSet
)
277 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
279 if (I
->InReady
== true && I
->InFd
>= 0)
283 FD_SET(I
->InFd
,RSet
);
285 if (I
->OutReady
== true && I
->OutFd
>= 0)
289 FD_SET(I
->OutFd
,WSet
);
294 // Acquire::RunFds - Deal with active FDs /*{{{*/
295 // ---------------------------------------------------------------------
296 /* Dispatch active FDs over to the proper workers. It is very important
297 that a worker never be erased while this is running! The queue class
298 should never erase a worker except during shutdown processing. */
299 void pkgAcquire::RunFds(fd_set
*RSet
,fd_set
*WSet
)
301 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
303 if (I
->InFd
>= 0 && FD_ISSET(I
->InFd
,RSet
) != 0)
305 if (I
->OutFd
>= 0 && FD_ISSET(I
->OutFd
,WSet
) != 0)
310 // Acquire::Run - Run the fetch sequence /*{{{*/
311 // ---------------------------------------------------------------------
312 /* This runs the queues. It manages a select loop for all of the
313 Worker tasks. The workers interact with the queues and items to
314 manage the actual fetch. */
315 pkgAcquire::RunResult
pkgAcquire::Run()
319 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
325 bool WasCancelled
= false;
327 // Run till all things have been acquired
338 SetFds(Highest
,&RFds
,&WFds
);
343 Res
= select(Highest
+1,&RFds
,&WFds
,0,&tv
);
345 while (Res
< 0 && errno
== EINTR
);
349 _error
->Errno("select","Select has failed");
354 if (_error
->PendingError() == true)
357 // Timeout, notify the log class
358 if (Res
== 0 || (Log
!= 0 && Log
->Update
== true))
361 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
363 if (Log
!= 0 && Log
->Pulse(this) == false)
374 // Shut down the acquire bits
376 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
379 // Shut down the items
380 for (ItemIterator I
= Items
.begin(); I
!= Items
.end(); I
++)
383 if (_error
->PendingError())
390 // Acquire::Bump - Called when an item is dequeued /*{{{*/
391 // ---------------------------------------------------------------------
392 /* This routine bumps idle queues in hopes that they will be able to fetch
394 void pkgAcquire::Bump()
396 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
400 // Acquire::WorkerStep - Step to the next worker /*{{{*/
401 // ---------------------------------------------------------------------
402 /* Not inlined to advoid including acquire-worker.h */
403 pkgAcquire::Worker
*pkgAcquire::WorkerStep(Worker
*I
)
405 return I
->NextAcquire
;
408 // Acquire::Clean - Cleans a directory /*{{{*/
409 // ---------------------------------------------------------------------
410 /* This is a bit simplistic, it looks at every file in the dir and sees
411 if it is part of the download set. */
412 bool pkgAcquire::Clean(string Dir
)
414 DIR *D
= opendir(Dir
.c_str());
416 return _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
418 string StartDir
= SafeGetCWD();
419 if (chdir(Dir
.c_str()) != 0)
422 return _error
->Errno("chdir",_("Unable to change to %s"),Dir
.c_str());
425 for (struct dirent
*Dir
= readdir(D
); Dir
!= 0; Dir
= readdir(D
))
428 if (strcmp(Dir
->d_name
,"lock") == 0 ||
429 strcmp(Dir
->d_name
,"partial") == 0 ||
430 strcmp(Dir
->d_name
,".") == 0 ||
431 strcmp(Dir
->d_name
,"..") == 0)
434 // Look in the get list
435 ItemCIterator I
= Items
.begin();
436 for (; I
!= Items
.end(); I
++)
437 if (flNotDir((*I
)->DestFile
) == Dir
->d_name
)
440 // Nothing found, nuke it
441 if (I
== Items
.end())
445 chdir(StartDir
.c_str());
450 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
451 // ---------------------------------------------------------------------
452 /* This is the total number of bytes needed */
453 double pkgAcquire::TotalNeeded()
456 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
457 Total
+= (*I
)->FileSize
;
461 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
462 // ---------------------------------------------------------------------
463 /* This is the number of bytes that is not local */
464 double pkgAcquire::FetchNeeded()
467 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
468 if ((*I
)->Local
== false)
469 Total
+= (*I
)->FileSize
;
473 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
474 // ---------------------------------------------------------------------
475 /* This is the number of bytes that is not local */
476 double pkgAcquire::PartialPresent()
479 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
480 if ((*I
)->Local
== false)
481 Total
+= (*I
)->PartialSize
;
485 // Acquire::UriBegin - Start iterator for the uri list /*{{{*/
486 // ---------------------------------------------------------------------
488 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
490 return UriIterator(Queues
);
493 // Acquire::UriEnd - End iterator for the uri list /*{{{*/
494 // ---------------------------------------------------------------------
496 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
498 return UriIterator(0);
502 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
503 // ---------------------------------------------------------------------
505 pkgAcquire::MethodConfig::MethodConfig()
507 SingleInstance
= false;
516 // Queue::Queue - Constructor /*{{{*/
517 // ---------------------------------------------------------------------
519 pkgAcquire::Queue::Queue(string Name
,pkgAcquire
*Owner
) : Name(Name
),
529 // Queue::~Queue - Destructor /*{{{*/
530 // ---------------------------------------------------------------------
532 pkgAcquire::Queue::~Queue()
544 // Queue::Enqueue - Queue an item to the queue /*{{{*/
545 // ---------------------------------------------------------------------
547 void pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
550 for (; *I
!= 0; I
= &(*I
)->Next
);
553 QItem
*Itm
= new QItem
;
558 Item
.Owner
->QueueCounter
++;
559 if (Items
->Next
== 0)
563 // Queue::Dequeue - Remove an item from the queue /*{{{*/
564 // ---------------------------------------------------------------------
565 /* We return true if we hit something */
566 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
568 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
569 return _error
->Error("Tried to dequeue a fetching object");
576 if ((*I
)->Owner
== Owner
)
580 Owner
->QueueCounter
--;
591 // Queue::Startup - Start the worker processes /*{{{*/
592 // ---------------------------------------------------------------------
593 /* It is possible for this to be called with a pre-existing set of
595 bool pkgAcquire::Queue::Startup()
600 pkgAcquire::MethodConfig
*Cnf
= Owner
->GetConfig(U
.Access
);
604 Workers
= new Worker(this,Cnf
,Owner
->Log
);
606 if (Workers
->Start() == false)
609 /* When pipelining we commit 10 items. This needs to change when we
610 added other source retry to have cycle maintain a pipeline depth
612 if (Cnf
->Pipeline
== true)
621 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
622 // ---------------------------------------------------------------------
623 /* If final is true then all workers are eliminated, otherwise only workers
624 that do not need cleanup are removed */
625 bool pkgAcquire::Queue::Shutdown(bool Final
)
627 // Delete all of the workers
628 pkgAcquire::Worker
**Cur
= &Workers
;
631 pkgAcquire::Worker
*Jnk
= *Cur
;
632 if (Final
== true || Jnk
->GetConf()->NeedsCleanup
== false)
634 *Cur
= Jnk
->NextQueue
;
639 Cur
= &(*Cur
)->NextQueue
;
645 // Queue::FindItem - Find a URI in the item list /*{{{*/
646 // ---------------------------------------------------------------------
648 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
650 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
651 if (I
->URI
== URI
&& I
->Worker
== Owner
)
656 // Queue::ItemDone - Item has been completed /*{{{*/
657 // ---------------------------------------------------------------------
658 /* The worker signals this which causes the item to be removed from the
659 queue. If this is the last queue instance then it is removed from the
661 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
664 if (Itm
->Owner
->Status
== pkgAcquire::Item::StatFetching
)
665 Itm
->Owner
->Status
= pkgAcquire::Item::StatDone
;
667 if (Itm
->Owner
->QueueCounter
<= 1)
668 Owner
->Dequeue(Itm
->Owner
);
678 // Queue::Cycle - Queue new items into the method /*{{{*/
679 // ---------------------------------------------------------------------
680 /* This locates a new idle item and sends it to the worker. If pipelining
681 is enabled then it keeps the pipe full. */
682 bool pkgAcquire::Queue::Cycle()
684 if (Items
== 0 || Workers
== 0)
688 return _error
->Error("Pipedepth failure");
690 // Look for a queable item
692 while (PipeDepth
< (signed)MaxPipeDepth
)
694 for (; I
!= 0; I
= I
->Next
)
695 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
698 // Nothing to do, queue is idle.
703 I
->Owner
->Status
= pkgAcquire::Item::StatFetching
;
705 if (Workers
->QueueItem(I
) == false)
712 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
713 // ---------------------------------------------------------------------
714 /* This is called when an item in multiple queues is dequeued */
715 void pkgAcquire::Queue::Bump()
721 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
722 // ---------------------------------------------------------------------
724 pkgAcquireStatus::pkgAcquireStatus() : Update(true), MorePulses(false)
729 // AcquireStatus::Pulse - Called periodically /*{{{*/
730 // ---------------------------------------------------------------------
731 /* This computes some internal state variables for the derived classes to
732 use. It generates the current downloaded bytes and total bytes to download
733 as well as the current CPS estimate. */
734 bool pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
741 // Compute the total number of bytes to fetch
742 unsigned int Unknown
= 0;
743 unsigned int Count
= 0;
744 for (pkgAcquire::ItemCIterator I
= Owner
->ItemsBegin(); I
!= Owner
->ItemsEnd();
748 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
751 // Totally ignore local items
752 if ((*I
)->Local
== true)
755 TotalBytes
+= (*I
)->FileSize
;
756 if ((*I
)->Complete
== true)
757 CurrentBytes
+= (*I
)->FileSize
;
758 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
762 // Compute the current completion
763 unsigned long ResumeSize
= 0;
764 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
765 I
= Owner
->WorkerStep(I
))
766 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
768 CurrentBytes
+= I
->CurrentSize
;
769 ResumeSize
+= I
->ResumePoint
;
771 // Files with unknown size always have 100% completion
772 if (I
->CurrentItem
->Owner
->FileSize
== 0 &&
773 I
->CurrentItem
->Owner
->Complete
== false)
774 TotalBytes
+= I
->CurrentSize
;
777 // Normalize the figures and account for unknown size downloads
780 if (Unknown
== Count
)
781 TotalBytes
= Unknown
;
783 // Wha?! Is not supposed to happen.
784 if (CurrentBytes
> TotalBytes
)
785 CurrentBytes
= TotalBytes
;
788 struct timeval NewTime
;
789 gettimeofday(&NewTime
,0);
790 if (NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
||
791 NewTime
.tv_sec
- Time
.tv_sec
> 6)
793 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
794 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
796 // Compute the CPS value
800 CurrentCPS
= ((CurrentBytes
- ResumeSize
) - LastBytes
)/Delta
;
801 LastBytes
= CurrentBytes
- ResumeSize
;
802 ElapsedTime
= (unsigned long)Delta
;
809 // AcquireStatus::Start - Called when the download is started /*{{{*/
810 // ---------------------------------------------------------------------
811 /* We just reset the counters */
812 void pkgAcquireStatus::Start()
814 gettimeofday(&Time
,0);
815 gettimeofday(&StartTime
,0);
826 // AcquireStatus::Stop - Finished downloading /*{{{*/
827 // ---------------------------------------------------------------------
828 /* This accurately computes the elapsed time and the total overall CPS. */
829 void pkgAcquireStatus::Stop()
831 // Compute the CPS and elapsed time
832 struct timeval NewTime
;
833 gettimeofday(&NewTime
,0);
835 double Delta
= NewTime
.tv_sec
- StartTime
.tv_sec
+
836 (NewTime
.tv_usec
- StartTime
.tv_usec
)/1000000.0;
838 // Compute the CPS value
842 CurrentCPS
= FetchedBytes
/Delta
;
843 LastBytes
= CurrentBytes
;
844 ElapsedTime
= (unsigned int)Delta
;
847 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
848 // ---------------------------------------------------------------------
849 /* This is used to get accurate final transfer rate reporting. */
850 void pkgAcquireStatus::Fetched(unsigned long Size
,unsigned long Resume
)
852 FetchedBytes
+= Size
- Resume
;