]>
git.saurik.com Git - apt.git/blob - apt-pkg/acquire.cc
1 // -*- mode: cpp; mode: fold -*-
3 // $Id: acquire.cc,v 1.31 1999/03/27 03:02:38 jgg 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>
31 // Acquire::pkgAcquire - Constructor /*{{{*/
32 // ---------------------------------------------------------------------
33 /* We grab some runtime state from the configuration space */
34 pkgAcquire::pkgAcquire(pkgAcquireStatus
*Log
) : Log(Log
)
42 string Mode
= _config
->Find("Acquire::Queue-Mode","host");
43 if (strcasecmp(Mode
.c_str(),"host") == 0)
44 QueueMode
= QueueHost
;
45 if (strcasecmp(Mode
.c_str(),"access") == 0)
46 QueueMode
= QueueAccess
;
48 Debug
= _config
->FindB("Debug::pkgAcquire",false);
51 // Acquire::~pkgAcquire - Destructor /*{{{*/
52 // ---------------------------------------------------------------------
53 /* Free our memory, clean up the queues (destroy the workers) */
54 pkgAcquire::~pkgAcquire()
56 while (Items
.size() != 0)
61 MethodConfig
*Jnk
= Configs
;
62 Configs
= Configs
->Next
;
69 Queues
= Queues
->Next
;
74 // Acquire::Add - Add a new item /*{{{*/
75 // ---------------------------------------------------------------------
76 /* This puts an item on the acquire list. This list is mainly for tracking
78 void pkgAcquire::Add(Item
*Itm
)
83 // Acquire::Remove - Remove a item /*{{{*/
84 // ---------------------------------------------------------------------
85 /* Remove an item from the acquire list. This is usually not used.. */
86 void pkgAcquire::Remove(Item
*Itm
)
88 for (vector
<Item
*>::iterator I
= Items
.begin(); I
< Items
.end(); I
++)
95 // Acquire::Add - Add a worker /*{{{*/
96 // ---------------------------------------------------------------------
97 /* A list of workers is kept so that the select loop can direct their FD
99 void pkgAcquire::Add(Worker
*Work
)
101 Work
->NextAcquire
= Workers
;
105 // Acquire::Remove - Remove a worker /*{{{*/
106 // ---------------------------------------------------------------------
107 /* A worker has died. This can not be done while the select loop is running
108 as it would require that RunFds could handling a changing list state and
110 void pkgAcquire::Remove(Worker
*Work
)
115 Worker
**I
= &Workers
;
119 *I
= (*I
)->NextAcquire
;
121 I
= &(*I
)->NextAcquire
;
125 // Acquire::Enqueue - Queue an URI for fetching /*{{{*/
126 // ---------------------------------------------------------------------
127 /* This is the entry point for an item. An item calls this function when
128 it is construction which creates a queue (based on the current queue
129 mode) and puts the item in that queue. If the system is running then
130 the queue might be started. */
131 void pkgAcquire::Enqueue(ItemDesc
&Item
)
133 // Determine which queue to put the item in
134 const MethodConfig
*Config
;
135 string Name
= QueueName(Item
.URI
,Config
);
136 if (Name
.empty() == true)
139 // Find the queue structure
141 for (; I
!= 0 && I
->Name
!= Name
; I
= I
->Next
);
144 I
= new Queue(Name
,this);
152 // See if this is a local only URI
153 if (Config
->LocalOnly
== true && Item
.Owner
->Complete
== false)
154 Item
.Owner
->Local
= true;
155 Item
.Owner
->Status
= Item::StatIdle
;
157 // Queue it into the named queue
164 clog
<< "Fetching " << Item
.URI
<< endl
;
165 clog
<< " to " << Item
.Owner
->DestFile
<< endl
;
166 clog
<< " Queue is: " << Name
<< endl
;
170 // Acquire::Dequeue - Remove an item from all queues /*{{{*/
171 // ---------------------------------------------------------------------
172 /* This is called when an item is finished being fetched. It removes it
173 from all the queues */
174 void pkgAcquire::Dequeue(Item
*Itm
)
178 for (; I
!= 0; I
= I
->Next
)
179 Res
|= I
->Dequeue(Itm
);
182 clog
<< "Dequeuing " << Itm
->DestFile
<< endl
;
187 // Acquire::QueueName - Return the name of the queue for this URI /*{{{*/
188 // ---------------------------------------------------------------------
189 /* The string returned depends on the configuration settings and the
190 method parameters. Given something like http://foo.org/bar it can
191 return http://foo.org or http */
192 string
pkgAcquire::QueueName(string Uri
,MethodConfig
const *&Config
)
196 Config
= GetConfig(U
.Access
);
200 /* Single-Instance methods get exactly one queue per URI. This is
201 also used for the Access queue method */
202 if (Config
->SingleInstance
== true || QueueMode
== QueueAccess
)
205 return U
.Access
+ ':' + U
.Host
;
208 // Acquire::GetConfig - Fetch the configuration information /*{{{*/
209 // ---------------------------------------------------------------------
210 /* This locates the configuration structure for an access method. If
211 a config structure cannot be found a Worker will be created to
213 pkgAcquire::MethodConfig
*pkgAcquire::GetConfig(string Access
)
215 // Search for an existing config
217 for (Conf
= Configs
; Conf
!= 0; Conf
= Conf
->Next
)
218 if (Conf
->Access
== Access
)
221 // Create the new config class
222 Conf
= new MethodConfig
;
223 Conf
->Access
= Access
;
224 Conf
->Next
= Configs
;
227 // Create the worker to fetch the configuration
229 if (Work
.Start() == false)
235 // Acquire::SetFds - Deal with readable FDs /*{{{*/
236 // ---------------------------------------------------------------------
237 /* Collect FDs that have activity monitors into the fd sets */
238 void pkgAcquire::SetFds(int &Fd
,fd_set
*RSet
,fd_set
*WSet
)
240 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
242 if (I
->InReady
== true && I
->InFd
>= 0)
246 FD_SET(I
->InFd
,RSet
);
248 if (I
->OutReady
== true && I
->OutFd
>= 0)
252 FD_SET(I
->OutFd
,WSet
);
257 // Acquire::RunFds - Deal with active FDs /*{{{*/
258 // ---------------------------------------------------------------------
259 /* Dispatch active FDs over to the proper workers. It is very important
260 that a worker never be erased while this is running! The queue class
261 should never erase a worker except during shutdown processing. */
262 void pkgAcquire::RunFds(fd_set
*RSet
,fd_set
*WSet
)
264 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
266 if (I
->InFd
>= 0 && FD_ISSET(I
->InFd
,RSet
) != 0)
268 if (I
->OutFd
>= 0 && FD_ISSET(I
->OutFd
,WSet
) != 0)
273 // Acquire::Run - Run the fetch sequence /*{{{*/
274 // ---------------------------------------------------------------------
275 /* This runs the queues. It manages a select loop for all of the
276 Worker tasks. The workers interact with the queues and items to
277 manage the actual fetch. */
278 bool pkgAcquire::Run()
282 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
288 // Run till all things have been acquired
299 SetFds(Highest
,&RFds
,&WFds
);
304 Res
= select(Highest
+1,&RFds
,&WFds
,0,&tv
);
306 while (Res
< 0 && errno
== EINTR
);
310 _error
->Errno("select","Select has failed");
315 if (_error
->PendingError() == true)
318 // Timeout, notify the log class
319 if (Res
== 0 || (Log
!= 0 && Log
->Update
== true))
322 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
332 // Shut down the acquire bits
334 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
337 return !_error
->PendingError();
340 // Acquire::Bump - Called when an item is dequeued /*{{{*/
341 // ---------------------------------------------------------------------
342 /* This routine bumps idle queues in hopes that they will be able to fetch
344 void pkgAcquire::Bump()
346 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
350 // Acquire::WorkerStep - Step to the next worker /*{{{*/
351 // ---------------------------------------------------------------------
352 /* Not inlined to advoid including acquire-worker.h */
353 pkgAcquire::Worker
*pkgAcquire::WorkerStep(Worker
*I
)
355 return I
->NextAcquire
;
358 // Acquire::Clean - Cleans a directory /*{{{*/
359 // ---------------------------------------------------------------------
360 /* This is a bit simplistic, it looks at every file in the dir and sees
361 if it is part of the download set. */
362 bool pkgAcquire::Clean(string Dir
)
364 DIR *D
= opendir(Dir
.c_str());
366 return _error
->Errno("opendir","Unable to read %s",Dir
.c_str());
368 string StartDir
= SafeGetCWD();
369 if (chdir(Dir
.c_str()) != 0)
372 return _error
->Errno("chdir","Unable to change to ",Dir
.c_str());
375 for (struct dirent
*Dir
= readdir(D
); Dir
!= 0; Dir
= readdir(D
))
378 if (strcmp(Dir
->d_name
,"lock") == 0 ||
379 strcmp(Dir
->d_name
,"partial") == 0 ||
380 strcmp(Dir
->d_name
,".") == 0 ||
381 strcmp(Dir
->d_name
,"..") == 0)
384 // Look in the get list
385 vector
<Item
*>::iterator I
= Items
.begin();
386 for (; I
!= Items
.end(); I
++)
387 if (flNotDir((*I
)->DestFile
) == Dir
->d_name
)
390 // Nothing found, nuke it
391 if (I
== Items
.end())
395 chdir(StartDir
.c_str());
400 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
401 // ---------------------------------------------------------------------
402 /* This is the total number of bytes needed */
403 unsigned long pkgAcquire::TotalNeeded()
405 unsigned long Total
= 0;
406 for (pkgAcquire::Item
**I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
407 Total
+= (*I
)->FileSize
;
411 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
412 // ---------------------------------------------------------------------
413 /* This is the number of bytes that is not local */
414 unsigned long pkgAcquire::FetchNeeded()
416 unsigned long Total
= 0;
417 for (pkgAcquire::Item
**I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
418 if ((*I
)->Local
== false)
419 Total
+= (*I
)->FileSize
;
423 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
424 // ---------------------------------------------------------------------
425 /* This is the number of bytes that is not local */
426 unsigned long pkgAcquire::PartialPresent()
428 unsigned long Total
= 0;
429 for (pkgAcquire::Item
**I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
430 if ((*I
)->Local
== false)
431 Total
+= (*I
)->PartialSize
;
435 // pkgAcquire::UriBegin - Start iterator for the uri list /*{{{*/
436 // ---------------------------------------------------------------------
438 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
440 return UriIterator(Queues
);
443 // pkgAcquire::UriEnd - End iterator for the uri list /*{{{*/
444 // ---------------------------------------------------------------------
446 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
448 return UriIterator(0);
452 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
453 // ---------------------------------------------------------------------
455 pkgAcquire::MethodConfig::MethodConfig()
457 SingleInstance
= false;
465 // Queue::Queue - Constructor /*{{{*/
466 // ---------------------------------------------------------------------
468 pkgAcquire::Queue::Queue(string Name
,pkgAcquire
*Owner
) : Name(Name
),
478 // Queue::~Queue - Destructor /*{{{*/
479 // ---------------------------------------------------------------------
481 pkgAcquire::Queue::~Queue()
493 // Queue::Enqueue - Queue an item to the queue /*{{{*/
494 // ---------------------------------------------------------------------
496 void pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
499 for (; *I
!= 0; I
= &(*I
)->Next
);
502 QItem
*Itm
= new QItem
;
507 Item
.Owner
->QueueCounter
++;
508 if (Items
->Next
== 0)
512 // Queue::Dequeue - Remove an item from the queue /*{{{*/
513 // ---------------------------------------------------------------------
514 /* We return true if we hit something */
515 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
517 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
518 return _error
->Error("Tried to dequeue a fetching object");
525 if ((*I
)->Owner
== Owner
)
529 Owner
->QueueCounter
--;
540 // Queue::Startup - Start the worker processes /*{{{*/
541 // ---------------------------------------------------------------------
543 bool pkgAcquire::Queue::Startup()
548 pkgAcquire::MethodConfig
*Cnf
= Owner
->GetConfig(U
.Access
);
552 Workers
= new Worker(this,Cnf
,Owner
->Log
);
554 if (Workers
->Start() == false)
557 /* When pipelining we commit 10 items. This needs to change when we
558 added other source retry to have cycle maintain a pipeline depth
560 if (Cnf
->Pipeline
== true)
568 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
569 // ---------------------------------------------------------------------
571 bool pkgAcquire::Queue::Shutdown()
573 // Delete all of the workers
576 pkgAcquire::Worker
*Jnk
= Workers
;
577 Workers
= Workers
->NextQueue
;
585 // Queue::FindItem - Find a URI in the item list /*{{{*/
586 // ---------------------------------------------------------------------
588 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
590 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
591 if (I
->URI
== URI
&& I
->Worker
== Owner
)
596 // Queue::ItemDone - Item has been completed /*{{{*/
597 // ---------------------------------------------------------------------
598 /* The worker signals this which causes the item to be removed from the
599 queue. If this is the last queue instance then it is removed from the
601 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
604 if (Itm
->Owner
->Status
== pkgAcquire::Item::StatFetching
)
605 Itm
->Owner
->Status
= pkgAcquire::Item::StatDone
;
607 if (Itm
->Owner
->QueueCounter
<= 1)
608 Owner
->Dequeue(Itm
->Owner
);
618 // Queue::Cycle - Queue new items into the method /*{{{*/
619 // ---------------------------------------------------------------------
620 /* This locates a new idle item and sends it to the worker. If pipelining
621 is enabled then it keeps the pipe full. */
622 bool pkgAcquire::Queue::Cycle()
624 if (Items
== 0 || Workers
== 0)
628 return _error
->Error("Pipedepth failure");
630 // Look for a queable item
632 while (PipeDepth
< (signed)MaxPipeDepth
)
634 for (; I
!= 0; I
= I
->Next
)
635 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
638 // Nothing to do, queue is idle.
643 I
->Owner
->Status
= pkgAcquire::Item::StatFetching
;
645 if (Workers
->QueueItem(I
) == false)
652 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
653 // ---------------------------------------------------------------------
654 /* This is called when an item in multiple queues is dequeued */
655 void pkgAcquire::Queue::Bump()
661 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
662 // ---------------------------------------------------------------------
664 pkgAcquireStatus::pkgAcquireStatus()
669 // AcquireStatus::Pulse - Called periodically /*{{{*/
670 // ---------------------------------------------------------------------
671 /* This computes some internal state variables for the derived classes to
672 use. It generates the current downloaded bytes and total bytes to download
673 as well as the current CPS estimate. */
674 void pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
681 // Compute the total number of bytes to fetch
682 unsigned int Unknown
= 0;
683 unsigned int Count
= 0;
684 for (pkgAcquire::Item
**I
= Owner
->ItemsBegin(); I
!= Owner
->ItemsEnd();
688 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
691 // Totally ignore local items
692 if ((*I
)->Local
== true)
695 TotalBytes
+= (*I
)->FileSize
;
696 if ((*I
)->Complete
== true)
697 CurrentBytes
+= (*I
)->FileSize
;
698 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
702 // Compute the current completion
703 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
704 I
= Owner
->WorkerStep(I
))
705 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
706 CurrentBytes
+= I
->CurrentSize
;
708 // Normalize the figures and account for unknown size downloads
711 if (Unknown
== Count
)
712 TotalBytes
= Unknown
;
714 TotalBytes
+= TotalBytes
/(Count
- Unknown
)*Unknown
;
717 struct timeval NewTime
;
718 gettimeofday(&NewTime
,0);
719 if (NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
||
720 NewTime
.tv_sec
- Time
.tv_sec
> 6)
722 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
723 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
725 // Compute the CPS value
729 CurrentCPS
= (CurrentBytes
- LastBytes
)/Delta
;
730 LastBytes
= CurrentBytes
;
731 ElapsedTime
= (unsigned long)Delta
;
736 // AcquireStatus::Start - Called when the download is started /*{{{*/
737 // ---------------------------------------------------------------------
738 /* We just reset the counters */
739 void pkgAcquireStatus::Start()
741 gettimeofday(&Time
,0);
742 gettimeofday(&StartTime
,0);
753 // AcquireStatus::Stop - Finished downloading /*{{{*/
754 // ---------------------------------------------------------------------
755 /* This accurately computes the elapsed time and the total overall CPS. */
756 void pkgAcquireStatus::Stop()
758 // Compute the CPS and elapsed time
759 struct timeval NewTime
;
760 gettimeofday(&NewTime
,0);
762 // Compute the delta time with full accuracy
763 long usdiff
= NewTime
.tv_usec
- StartTime
.tv_usec
;
764 long sdiff
= NewTime
.tv_sec
- StartTime
.tv_sec
;
773 // Compute the CPS value
774 if (sdiff
== 0 && usdiff
== 0)
777 CurrentCPS
= FetchedBytes
/(sdiff
+ usdiff
/1000000.0);
778 LastBytes
= CurrentBytes
;
782 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
783 // ---------------------------------------------------------------------
784 /* This is used to get accurate final transfer rate reporting. */
785 void pkgAcquireStatus::Fetched(unsigned long Size
,unsigned long Resume
)
787 FetchedBytes
+= Size
- Resume
;