]>
git.saurik.com Git - apt.git/blob - apt-pkg/acquire.cc
1 // -*- mode: cpp; mode: fold -*-
3 // $Id: acquire.cc,v 1.36 1999/06/13 05:06:40 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 pkgAcquire::RunResult
pkgAcquire::Run()
282 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
288 bool WasCancelled
= false;
290 // Run till all things have been acquired
301 SetFds(Highest
,&RFds
,&WFds
);
306 Res
= select(Highest
+1,&RFds
,&WFds
,0,&tv
);
308 while (Res
< 0 && errno
== EINTR
);
312 _error
->Errno("select","Select has failed");
317 if (_error
->PendingError() == true)
320 // Timeout, notify the log class
321 if (Res
== 0 || (Log
!= 0 && Log
->Update
== true))
324 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
326 if (Log
!= 0 && Log
->Pulse(this) == false)
337 // Shut down the acquire bits
339 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
342 // Shut down the items
343 for (Item
**I
= Items
.begin(); I
!= Items
.end(); I
++)
346 if (_error
->PendingError())
353 // Acquire::Bump - Called when an item is dequeued /*{{{*/
354 // ---------------------------------------------------------------------
355 /* This routine bumps idle queues in hopes that they will be able to fetch
357 void pkgAcquire::Bump()
359 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
363 // Acquire::WorkerStep - Step to the next worker /*{{{*/
364 // ---------------------------------------------------------------------
365 /* Not inlined to advoid including acquire-worker.h */
366 pkgAcquire::Worker
*pkgAcquire::WorkerStep(Worker
*I
)
368 return I
->NextAcquire
;
371 // Acquire::Clean - Cleans a directory /*{{{*/
372 // ---------------------------------------------------------------------
373 /* This is a bit simplistic, it looks at every file in the dir and sees
374 if it is part of the download set. */
375 bool pkgAcquire::Clean(string Dir
)
377 DIR *D
= opendir(Dir
.c_str());
379 return _error
->Errno("opendir","Unable to read %s",Dir
.c_str());
381 string StartDir
= SafeGetCWD();
382 if (chdir(Dir
.c_str()) != 0)
385 return _error
->Errno("chdir","Unable to change to ",Dir
.c_str());
388 for (struct dirent
*Dir
= readdir(D
); Dir
!= 0; Dir
= readdir(D
))
391 if (strcmp(Dir
->d_name
,"lock") == 0 ||
392 strcmp(Dir
->d_name
,"partial") == 0 ||
393 strcmp(Dir
->d_name
,".") == 0 ||
394 strcmp(Dir
->d_name
,"..") == 0)
397 // Look in the get list
398 vector
<Item
*>::iterator I
= Items
.begin();
399 for (; I
!= Items
.end(); I
++)
400 if (flNotDir((*I
)->DestFile
) == Dir
->d_name
)
403 // Nothing found, nuke it
404 if (I
== Items
.end())
408 chdir(StartDir
.c_str());
413 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
414 // ---------------------------------------------------------------------
415 /* This is the total number of bytes needed */
416 unsigned long pkgAcquire::TotalNeeded()
418 unsigned long Total
= 0;
419 for (pkgAcquire::Item
**I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
420 Total
+= (*I
)->FileSize
;
424 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
425 // ---------------------------------------------------------------------
426 /* This is the number of bytes that is not local */
427 unsigned long pkgAcquire::FetchNeeded()
429 unsigned long Total
= 0;
430 for (pkgAcquire::Item
**I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
431 if ((*I
)->Local
== false)
432 Total
+= (*I
)->FileSize
;
436 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
437 // ---------------------------------------------------------------------
438 /* This is the number of bytes that is not local */
439 unsigned long pkgAcquire::PartialPresent()
441 unsigned long Total
= 0;
442 for (pkgAcquire::Item
**I
= ItemsBegin(); I
!= ItemsEnd(); I
++)
443 if ((*I
)->Local
== false)
444 Total
+= (*I
)->PartialSize
;
448 // pkgAcquire::UriBegin - Start iterator for the uri list /*{{{*/
449 // ---------------------------------------------------------------------
451 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
453 return UriIterator(Queues
);
456 // pkgAcquire::UriEnd - End iterator for the uri list /*{{{*/
457 // ---------------------------------------------------------------------
459 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
461 return UriIterator(0);
465 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
466 // ---------------------------------------------------------------------
468 pkgAcquire::MethodConfig::MethodConfig()
470 SingleInstance
= false;
478 // Queue::Queue - Constructor /*{{{*/
479 // ---------------------------------------------------------------------
481 pkgAcquire::Queue::Queue(string Name
,pkgAcquire
*Owner
) : Name(Name
),
491 // Queue::~Queue - Destructor /*{{{*/
492 // ---------------------------------------------------------------------
494 pkgAcquire::Queue::~Queue()
506 // Queue::Enqueue - Queue an item to the queue /*{{{*/
507 // ---------------------------------------------------------------------
509 void pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
512 for (; *I
!= 0; I
= &(*I
)->Next
);
515 QItem
*Itm
= new QItem
;
520 Item
.Owner
->QueueCounter
++;
521 if (Items
->Next
== 0)
525 // Queue::Dequeue - Remove an item from the queue /*{{{*/
526 // ---------------------------------------------------------------------
527 /* We return true if we hit something */
528 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
530 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
531 return _error
->Error("Tried to dequeue a fetching object");
538 if ((*I
)->Owner
== Owner
)
542 Owner
->QueueCounter
--;
553 // Queue::Startup - Start the worker processes /*{{{*/
554 // ---------------------------------------------------------------------
556 bool pkgAcquire::Queue::Startup()
561 pkgAcquire::MethodConfig
*Cnf
= Owner
->GetConfig(U
.Access
);
565 Workers
= new Worker(this,Cnf
,Owner
->Log
);
567 if (Workers
->Start() == false)
570 /* When pipelining we commit 10 items. This needs to change when we
571 added other source retry to have cycle maintain a pipeline depth
573 if (Cnf
->Pipeline
== true)
581 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
582 // ---------------------------------------------------------------------
584 bool pkgAcquire::Queue::Shutdown()
586 // Delete all of the workers
589 pkgAcquire::Worker
*Jnk
= Workers
;
590 Workers
= Workers
->NextQueue
;
598 // Queue::FindItem - Find a URI in the item list /*{{{*/
599 // ---------------------------------------------------------------------
601 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
603 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
604 if (I
->URI
== URI
&& I
->Worker
== Owner
)
609 // Queue::ItemDone - Item has been completed /*{{{*/
610 // ---------------------------------------------------------------------
611 /* The worker signals this which causes the item to be removed from the
612 queue. If this is the last queue instance then it is removed from the
614 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
617 if (Itm
->Owner
->Status
== pkgAcquire::Item::StatFetching
)
618 Itm
->Owner
->Status
= pkgAcquire::Item::StatDone
;
620 if (Itm
->Owner
->QueueCounter
<= 1)
621 Owner
->Dequeue(Itm
->Owner
);
631 // Queue::Cycle - Queue new items into the method /*{{{*/
632 // ---------------------------------------------------------------------
633 /* This locates a new idle item and sends it to the worker. If pipelining
634 is enabled then it keeps the pipe full. */
635 bool pkgAcquire::Queue::Cycle()
637 if (Items
== 0 || Workers
== 0)
641 return _error
->Error("Pipedepth failure");
643 // Look for a queable item
645 while (PipeDepth
< (signed)MaxPipeDepth
)
647 for (; I
!= 0; I
= I
->Next
)
648 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
651 // Nothing to do, queue is idle.
656 I
->Owner
->Status
= pkgAcquire::Item::StatFetching
;
658 if (Workers
->QueueItem(I
) == false)
665 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
666 // ---------------------------------------------------------------------
667 /* This is called when an item in multiple queues is dequeued */
668 void pkgAcquire::Queue::Bump()
674 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
675 // ---------------------------------------------------------------------
677 pkgAcquireStatus::pkgAcquireStatus()
682 // AcquireStatus::Pulse - Called periodically /*{{{*/
683 // ---------------------------------------------------------------------
684 /* This computes some internal state variables for the derived classes to
685 use. It generates the current downloaded bytes and total bytes to download
686 as well as the current CPS estimate. */
687 bool pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
694 // Compute the total number of bytes to fetch
695 unsigned int Unknown
= 0;
696 unsigned int Count
= 0;
697 for (pkgAcquire::Item
**I
= Owner
->ItemsBegin(); I
!= Owner
->ItemsEnd();
701 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
704 // Totally ignore local items
705 if ((*I
)->Local
== true)
708 TotalBytes
+= (*I
)->FileSize
;
709 if ((*I
)->Complete
== true)
710 CurrentBytes
+= (*I
)->FileSize
;
711 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
715 // Compute the current completion
716 unsigned long ResumeSize
= 0;
717 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
718 I
= Owner
->WorkerStep(I
))
719 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
721 CurrentBytes
+= I
->CurrentSize
;
722 ResumeSize
+= I
->ResumePoint
;
724 // Files with unknown size always have 100% completion
725 if (I
->CurrentItem
->Owner
->FileSize
== 0 &&
726 I
->CurrentItem
->Owner
->Complete
== false)
727 TotalBytes
+= I
->CurrentSize
;
730 // Normalize the figures and account for unknown size downloads
733 if (Unknown
== Count
)
734 TotalBytes
= Unknown
;
737 struct timeval NewTime
;
738 gettimeofday(&NewTime
,0);
739 if (NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
||
740 NewTime
.tv_sec
- Time
.tv_sec
> 6)
742 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
743 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
745 // Compute the CPS value
749 CurrentCPS
= ((CurrentBytes
- ResumeSize
) - LastBytes
)/Delta
;
750 LastBytes
= CurrentBytes
- ResumeSize
;
751 ElapsedTime
= (unsigned long)Delta
;
758 // AcquireStatus::Start - Called when the download is started /*{{{*/
759 // ---------------------------------------------------------------------
760 /* We just reset the counters */
761 void pkgAcquireStatus::Start()
763 gettimeofday(&Time
,0);
764 gettimeofday(&StartTime
,0);
775 // AcquireStatus::Stop - Finished downloading /*{{{*/
776 // ---------------------------------------------------------------------
777 /* This accurately computes the elapsed time and the total overall CPS. */
778 void pkgAcquireStatus::Stop()
780 // Compute the CPS and elapsed time
781 struct timeval NewTime
;
782 gettimeofday(&NewTime
,0);
784 // Compute the delta time with full accuracy
785 long usdiff
= NewTime
.tv_usec
- StartTime
.tv_usec
;
786 long sdiff
= NewTime
.tv_sec
- StartTime
.tv_sec
;
795 // Compute the CPS value
796 if (sdiff
== 0 && usdiff
== 0)
799 CurrentCPS
= FetchedBytes
/(sdiff
+ usdiff
/1000000.0);
800 LastBytes
= CurrentBytes
;
804 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
805 // ---------------------------------------------------------------------
806 /* This is used to get accurate final transfer rate reporting. */
807 void pkgAcquireStatus::Fetched(unsigned long Size
,unsigned long Resume
)
809 FetchedBytes
+= Size
- Resume
;