]>
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>
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
)
243 return U
.Access
+ ':' + U
.Host
;
246 // Acquire::GetConfig - Fetch the configuration information /*{{{*/
247 // ---------------------------------------------------------------------
248 /* This locates the configuration structure for an access method. If
249 a config structure cannot be found a Worker will be created to
251 pkgAcquire::MethodConfig
*pkgAcquire::GetConfig(string Access
)
253 // Search for an existing config
255 for (Conf
= Configs
; Conf
!= 0; Conf
= Conf
->Next
)
256 if (Conf
->Access
== Access
)
259 // Create the new config class
260 Conf
= new MethodConfig
;
261 Conf
->Access
= Access
;
262 Conf
->Next
= Configs
;
265 // Create the worker to fetch the configuration
267 if (Work
.Start() == false)
273 // Acquire::SetFds - Deal with readable FDs /*{{{*/
274 // ---------------------------------------------------------------------
275 /* Collect FDs that have activity monitors into the fd sets */
276 void pkgAcquire::SetFds(int &Fd
,fd_set
*RSet
,fd_set
*WSet
)
278 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
280 if (I
->InReady
== true && I
->InFd
>= 0)
284 FD_SET(I
->InFd
,RSet
);
286 if (I
->OutReady
== true && I
->OutFd
>= 0)
290 FD_SET(I
->OutFd
,WSet
);
295 // Acquire::RunFds - Deal with active FDs /*{{{*/
296 // ---------------------------------------------------------------------
297 /* Dispatch active FDs over to the proper workers. It is very important
298 that a worker never be erased while this is running! The queue class
299 should never erase a worker except during shutdown processing. */
300 void pkgAcquire::RunFds(fd_set
*RSet
,fd_set
*WSet
)
302 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
304 if (I
->InFd
>= 0 && FD_ISSET(I
->InFd
,RSet
) != 0)
306 if (I
->OutFd
>= 0 && FD_ISSET(I
->OutFd
,WSet
) != 0)
311 // Acquire::Run - Run the fetch sequence /*{{{*/
312 // ---------------------------------------------------------------------
313 /* This runs the queues. It manages a select loop for all of the
314 Worker tasks. The workers interact with the queues and items to
315 manage the actual fetch. */
316 pkgAcquire::RunResult
pkgAcquire::Run(int PulseIntervall
)
320 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
326 bool WasCancelled
= false;
328 // Run till all things have been acquired
331 tv
.tv_usec
= PulseIntervall
;
339 SetFds(Highest
,&RFds
,&WFds
);
344 Res
= select(Highest
+1,&RFds
,&WFds
,0,&tv
);
346 while (Res
< 0 && errno
== EINTR
);
350 _error
->Errno("select","Select has failed");
355 if (_error
->PendingError() == true)
358 // Timeout, notify the log class
359 if (Res
== 0 || (Log
!= 0 && Log
->Update
== true))
361 tv
.tv_usec
= PulseIntervall
;
362 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
364 if (Log
!= 0 && Log
->Pulse(this) == false)
375 // Shut down the acquire bits
377 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
380 // Shut down the items
381 for (ItemIterator I
= Items
.begin(); I
!= Items
.end(); I
++)
384 if (_error
->PendingError())
391 // Acquire::Bump - Called when an item is dequeued /*{{{*/
392 // ---------------------------------------------------------------------
393 /* This routine bumps idle queues in hopes that they will be able to fetch
395 void pkgAcquire::Bump()
397 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
401 // Acquire::WorkerStep - Step to the next worker /*{{{*/
402 // ---------------------------------------------------------------------
403 /* Not inlined to advoid including acquire-worker.h */
404 pkgAcquire::Worker
*pkgAcquire::WorkerStep(Worker
*I
)
406 return I
->NextAcquire
;
409 // Acquire::Clean - Cleans a directory /*{{{*/
410 // ---------------------------------------------------------------------
411 /* This is a bit simplistic, it looks at every file in the dir and sees
412 if it is part of the download set. */
413 bool pkgAcquire::Clean(string Dir
)
415 DIR *D
= opendir(Dir
.c_str());
417 return _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
419 string StartDir
= SafeGetCWD();
420 if (chdir(Dir
.c_str()) != 0)
423 return _error
->Errno("chdir",_("Unable to change to %s"),Dir
.c_str());
426 for (struct dirent
*Dir
= readdir(D
); Dir
!= 0; Dir
= readdir(D
))
429 if (strcmp(Dir
->d_name
,"lock") == 0 ||
430 strcmp(Dir
->d_name
,"partial") == 0 ||
431 strcmp(Dir
->d_name
,".") == 0 ||
432 strcmp(Dir
->d_name
,"..") == 0)
435 // Look in the get list
436 ItemCIterator I
= Items
.begin();
437 for (; I
!= Items
.end(); I
++)
438 if (flNotDir((*I
)->DestFile
) == Dir
->d_name
)
441 // Nothing found, nuke it
442 if (I
== Items
.end())
446 chdir(StartDir
.c_str());
451 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
452 // ---------------------------------------------------------------------
453 /* This is the total number of bytes needed */
454 double pkgAcquire::TotalNeeded()
457 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
458 Total
+= (*I
)->FileSize
;
462 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
463 // ---------------------------------------------------------------------
464 /* This is the number of bytes that is not local */
465 double pkgAcquire::FetchNeeded()
468 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
469 if ((*I
)->Local
== false)
470 Total
+= (*I
)->FileSize
;
474 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
475 // ---------------------------------------------------------------------
476 /* This is the number of bytes that is not local */
477 double pkgAcquire::PartialPresent()
480 for (ItemCIterator I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
481 if ((*I
)->Local
== false)
482 Total
+= (*I
)->PartialSize
;
486 // Acquire::UriBegin - Start iterator for the uri list /*{{{*/
487 // ---------------------------------------------------------------------
489 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
491 return UriIterator(Queues
);
494 // Acquire::UriEnd - End iterator for the uri list /*{{{*/
495 // ---------------------------------------------------------------------
497 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
499 return UriIterator(0);
503 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
504 // ---------------------------------------------------------------------
506 pkgAcquire::MethodConfig::MethodConfig()
508 SingleInstance
= false;
517 // Queue::Queue - Constructor /*{{{*/
518 // ---------------------------------------------------------------------
520 pkgAcquire::Queue::Queue(string Name
,pkgAcquire
*Owner
) : Name(Name
),
530 // Queue::~Queue - Destructor /*{{{*/
531 // ---------------------------------------------------------------------
533 pkgAcquire::Queue::~Queue()
545 // Queue::Enqueue - Queue an item to the queue /*{{{*/
546 // ---------------------------------------------------------------------
548 void pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
551 for (; *I
!= 0; I
= &(*I
)->Next
);
554 QItem
*Itm
= new QItem
;
559 Item
.Owner
->QueueCounter
++;
560 if (Items
->Next
== 0)
564 // Queue::Dequeue - Remove an item from the queue /*{{{*/
565 // ---------------------------------------------------------------------
566 /* We return true if we hit something */
567 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
569 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
570 return _error
->Error("Tried to dequeue a fetching object");
577 if ((*I
)->Owner
== Owner
)
581 Owner
->QueueCounter
--;
592 // Queue::Startup - Start the worker processes /*{{{*/
593 // ---------------------------------------------------------------------
594 /* It is possible for this to be called with a pre-existing set of
596 bool pkgAcquire::Queue::Startup()
601 pkgAcquire::MethodConfig
*Cnf
= Owner
->GetConfig(U
.Access
);
605 Workers
= new Worker(this,Cnf
,Owner
->Log
);
607 if (Workers
->Start() == false)
610 /* When pipelining we commit 10 items. This needs to change when we
611 added other source retry to have cycle maintain a pipeline depth
613 if (Cnf
->Pipeline
== true)
622 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
623 // ---------------------------------------------------------------------
624 /* If final is true then all workers are eliminated, otherwise only workers
625 that do not need cleanup are removed */
626 bool pkgAcquire::Queue::Shutdown(bool Final
)
628 // Delete all of the workers
629 pkgAcquire::Worker
**Cur
= &Workers
;
632 pkgAcquire::Worker
*Jnk
= *Cur
;
633 if (Final
== true || Jnk
->GetConf()->NeedsCleanup
== false)
635 *Cur
= Jnk
->NextQueue
;
640 Cur
= &(*Cur
)->NextQueue
;
646 // Queue::FindItem - Find a URI in the item list /*{{{*/
647 // ---------------------------------------------------------------------
649 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
651 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
652 if (I
->URI
== URI
&& I
->Worker
== Owner
)
657 // Queue::ItemDone - Item has been completed /*{{{*/
658 // ---------------------------------------------------------------------
659 /* The worker signals this which causes the item to be removed from the
660 queue. If this is the last queue instance then it is removed from the
662 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
665 if (Itm
->Owner
->Status
== pkgAcquire::Item::StatFetching
)
666 Itm
->Owner
->Status
= pkgAcquire::Item::StatDone
;
668 if (Itm
->Owner
->QueueCounter
<= 1)
669 Owner
->Dequeue(Itm
->Owner
);
679 // Queue::Cycle - Queue new items into the method /*{{{*/
680 // ---------------------------------------------------------------------
681 /* This locates a new idle item and sends it to the worker. If pipelining
682 is enabled then it keeps the pipe full. */
683 bool pkgAcquire::Queue::Cycle()
685 if (Items
== 0 || Workers
== 0)
689 return _error
->Error("Pipedepth failure");
691 // Look for a queable item
693 while (PipeDepth
< (signed)MaxPipeDepth
)
695 for (; I
!= 0; I
= I
->Next
)
696 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
699 // Nothing to do, queue is idle.
704 I
->Owner
->Status
= pkgAcquire::Item::StatFetching
;
706 if (Workers
->QueueItem(I
) == false)
713 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
714 // ---------------------------------------------------------------------
715 /* This is called when an item in multiple queues is dequeued */
716 void pkgAcquire::Queue::Bump()
722 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
723 // ---------------------------------------------------------------------
725 pkgAcquireStatus::pkgAcquireStatus() : Update(true), MorePulses(false)
730 // AcquireStatus::Pulse - Called periodically /*{{{*/
731 // ---------------------------------------------------------------------
732 /* This computes some internal state variables for the derived classes to
733 use. It generates the current downloaded bytes and total bytes to download
734 as well as the current CPS estimate. */
735 bool pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
742 // Compute the total number of bytes to fetch
743 unsigned int Unknown
= 0;
744 unsigned int Count
= 0;
745 for (pkgAcquire::ItemCIterator I
= Owner
->ItemsBegin(); I
!= Owner
->ItemsEnd();
749 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
752 // Totally ignore local items
753 if ((*I
)->Local
== true)
756 TotalBytes
+= (*I
)->FileSize
;
757 if ((*I
)->Complete
== true)
758 CurrentBytes
+= (*I
)->FileSize
;
759 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
763 // Compute the current completion
764 unsigned long ResumeSize
= 0;
765 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
766 I
= Owner
->WorkerStep(I
))
767 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
769 CurrentBytes
+= I
->CurrentSize
;
770 ResumeSize
+= I
->ResumePoint
;
772 // Files with unknown size always have 100% completion
773 if (I
->CurrentItem
->Owner
->FileSize
== 0 &&
774 I
->CurrentItem
->Owner
->Complete
== false)
775 TotalBytes
+= I
->CurrentSize
;
778 // Normalize the figures and account for unknown size downloads
781 if (Unknown
== Count
)
782 TotalBytes
= Unknown
;
784 // Wha?! Is not supposed to happen.
785 if (CurrentBytes
> TotalBytes
)
786 CurrentBytes
= TotalBytes
;
789 struct timeval NewTime
;
790 gettimeofday(&NewTime
,0);
791 if (NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
||
792 NewTime
.tv_sec
- Time
.tv_sec
> 6)
794 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
795 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
797 // Compute the CPS value
801 CurrentCPS
= ((CurrentBytes
- ResumeSize
) - LastBytes
)/Delta
;
802 LastBytes
= CurrentBytes
- ResumeSize
;
803 ElapsedTime
= (unsigned long)Delta
;
807 int fd
= _config
->FindI("APT::Status-Fd",-1);
810 ostringstream status
;
813 long i
= CurrentItems
< TotalItems
? CurrentItems
+ 1 : CurrentItems
;
815 (unsigned long)((TotalBytes
- CurrentBytes
) / CurrentCPS
);
817 snprintf(msg
,sizeof(msg
), _("Downloading file %li of %li (%s remaining)"), i
, TotalItems
, TimeToStr(ETA
).c_str());
819 // build the status str
820 status
<< "dlstatus:" << i
821 << ":" << (CurrentBytes
/float(TotalBytes
)*100.0)
824 write(fd
, status
.str().c_str(), status
.str().size());
830 // AcquireStatus::Start - Called when the download is started /*{{{*/
831 // ---------------------------------------------------------------------
832 /* We just reset the counters */
833 void pkgAcquireStatus::Start()
835 gettimeofday(&Time
,0);
836 gettimeofday(&StartTime
,0);
847 // AcquireStatus::Stop - Finished downloading /*{{{*/
848 // ---------------------------------------------------------------------
849 /* This accurately computes the elapsed time and the total overall CPS. */
850 void pkgAcquireStatus::Stop()
852 // Compute the CPS and elapsed time
853 struct timeval NewTime
;
854 gettimeofday(&NewTime
,0);
856 double Delta
= NewTime
.tv_sec
- StartTime
.tv_sec
+
857 (NewTime
.tv_usec
- StartTime
.tv_usec
)/1000000.0;
859 // Compute the CPS value
863 CurrentCPS
= FetchedBytes
/Delta
;
864 LastBytes
= CurrentBytes
;
865 ElapsedTime
= (unsigned int)Delta
;
868 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
869 // ---------------------------------------------------------------------
870 /* This is used to get accurate final transfer rate reporting. */
871 void pkgAcquireStatus::Fetched(unsigned long Size
,unsigned long Resume
)
873 FetchedBytes
+= Size
- Resume
;