]>
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 schedule 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 controlled by how the queue
11 name is derived from the URI.
13 ##################################################################### */
15 // Include Files /*{{{*/
18 #include <apt-pkg/acquire.h>
19 #include <apt-pkg/acquire-item.h>
20 #include <apt-pkg/acquire-worker.h>
21 #include <apt-pkg/configuration.h>
22 #include <apt-pkg/error.h>
23 #include <apt-pkg/strutl.h>
24 #include <apt-pkg/fileutl.h>
44 #include <sys/select.h>
53 // Acquire::pkgAcquire - Constructor /*{{{*/
54 // ---------------------------------------------------------------------
55 /* We grab some runtime state from the configuration space */
56 pkgAcquire::pkgAcquire() : LockFD(-1), d(NULL
), Queues(0), Workers(0), Configs(0), Log(NULL
), ToFetch(0),
57 Debug(_config
->FindB("Debug::pkgAcquire",false)),
62 pkgAcquire::pkgAcquire(pkgAcquireStatus
*Progress
) : LockFD(-1), d(NULL
), Queues(0), Workers(0),
63 Configs(0), Log(NULL
), ToFetch(0),
64 Debug(_config
->FindB("Debug::pkgAcquire",false)),
70 void pkgAcquire::Initialize()
72 string
const Mode
= _config
->Find("Acquire::Queue-Mode","host");
73 if (strcasecmp(Mode
.c_str(),"host") == 0)
74 QueueMode
= QueueHost
;
75 if (strcasecmp(Mode
.c_str(),"access") == 0)
76 QueueMode
= QueueAccess
;
78 // chown the auth.conf file as it will be accessed by our methods
79 std::string
const SandboxUser
= _config
->Find("APT::Sandbox::User");
80 if (getuid() == 0 && SandboxUser
.empty() == false && SandboxUser
!= "root") // if we aren't root, we can't chown, so don't try it
82 struct passwd
const * const pw
= getpwnam(SandboxUser
.c_str());
83 struct group
const * const gr
= getgrnam("root");
84 if (pw
!= NULL
&& gr
!= NULL
)
86 std::string
const AuthConf
= _config
->FindFile("Dir::Etc::netrc");
87 if(AuthConf
.empty() == false && RealFileExists(AuthConf
) &&
88 chown(AuthConf
.c_str(), pw
->pw_uid
, gr
->gr_gid
) != 0)
89 _error
->WarningE("SetupAPTPartialDirectory", "chown to %s:root of file %s failed", SandboxUser
.c_str(), AuthConf
.c_str());
94 // Acquire::GetLock - lock directory and prepare for action /*{{{*/
95 static bool SetupAPTPartialDirectory(std::string
const &grand
, std::string
const &parent
)
97 std::string
const partial
= parent
+ "partial";
98 mode_t
const mode
= umask(S_IWGRP
| S_IWOTH
);
99 bool const creation_fail
= (CreateAPTDirectoryIfNeeded(grand
, partial
) == false &&
100 CreateAPTDirectoryIfNeeded(parent
, partial
) == false);
102 if (creation_fail
== true)
105 std::string
const SandboxUser
= _config
->Find("APT::Sandbox::User");
106 if (getuid() == 0 && SandboxUser
.empty() == false && SandboxUser
!= "root") // if we aren't root, we can't chown, so don't try it
108 struct passwd
const * const pw
= getpwnam(SandboxUser
.c_str());
109 struct group
const * const gr
= getgrnam("root");
110 if (pw
!= NULL
&& gr
!= NULL
)
112 // chown the partial dir
113 if(chown(partial
.c_str(), pw
->pw_uid
, gr
->gr_gid
) != 0)
114 _error
->WarningE("SetupAPTPartialDirectory", "chown to %s:root of directory %s failed", SandboxUser
.c_str(), partial
.c_str());
117 if (chmod(partial
.c_str(), 0700) != 0)
118 _error
->WarningE("SetupAPTPartialDirectory", "chmod 0700 of directory %s failed", partial
.c_str());
122 bool pkgAcquire::Setup(pkgAcquireStatus
*Progress
, string
const &Lock
)
127 string
const listDir
= _config
->FindDir("Dir::State::lists");
128 if (SetupAPTPartialDirectory(_config
->FindDir("Dir::State"), listDir
) == false)
129 return _error
->Errno("Acquire", _("List directory %spartial is missing."), listDir
.c_str());
130 string
const archivesDir
= _config
->FindDir("Dir::Cache::Archives");
131 if (SetupAPTPartialDirectory(_config
->FindDir("Dir::Cache"), archivesDir
) == false)
132 return _error
->Errno("Acquire", _("Archives directory %spartial is missing."), archivesDir
.c_str());
135 return GetLock(Lock
);
137 bool pkgAcquire::GetLock(std::string
const &Lock
)
139 if (Lock
.empty() == true)
142 // check for existence and possibly create auxiliary directories
143 string
const listDir
= _config
->FindDir("Dir::State::lists");
144 string
const archivesDir
= _config
->FindDir("Dir::Cache::Archives");
148 if (SetupAPTPartialDirectory(_config
->FindDir("Dir::State"), listDir
) == false)
149 return _error
->Errno("Acquire", _("List directory %spartial is missing."), listDir
.c_str());
151 if (Lock
== archivesDir
)
153 if (SetupAPTPartialDirectory(_config
->FindDir("Dir::Cache"), archivesDir
) == false)
154 return _error
->Errno("Acquire", _("Archives directory %spartial is missing."), archivesDir
.c_str());
157 if (_config
->FindB("Debug::NoLocking", false) == true)
160 // Lock the directory this acquire object will work in
163 LockFD
= ::GetLock(flCombine(Lock
, "lock"));
165 return _error
->Error(_("Unable to lock directory %s"), Lock
.c_str());
170 // Acquire::~pkgAcquire - Destructor /*{{{*/
171 // ---------------------------------------------------------------------
172 /* Free our memory, clean up the queues (destroy the workers) */
173 pkgAcquire::~pkgAcquire()
182 MethodConfig
*Jnk
= Configs
;
183 Configs
= Configs
->Next
;
188 // Acquire::Shutdown - Clean out the acquire object /*{{{*/
189 // ---------------------------------------------------------------------
191 void pkgAcquire::Shutdown()
193 while (Items
.empty() == false)
195 if (Items
[0]->Status
== Item::StatFetching
)
196 Items
[0]->Status
= Item::StatError
;
203 Queues
= Queues
->Next
;
208 // Acquire::Add - Add a new item /*{{{*/
209 // ---------------------------------------------------------------------
210 /* This puts an item on the acquire list. This list is mainly for tracking
212 void pkgAcquire::Add(Item
*Itm
)
214 Items
.push_back(Itm
);
217 // Acquire::Remove - Remove a item /*{{{*/
218 // ---------------------------------------------------------------------
219 /* Remove an item from the acquire list. This is usually not used.. */
220 void pkgAcquire::Remove(Item
*Itm
)
224 for (ItemIterator I
= Items
.begin(); I
!= Items
.end();)
236 // Acquire::Add - Add a worker /*{{{*/
237 // ---------------------------------------------------------------------
238 /* A list of workers is kept so that the select loop can direct their FD
240 void pkgAcquire::Add(Worker
*Work
)
242 Work
->NextAcquire
= Workers
;
246 // Acquire::Remove - Remove a worker /*{{{*/
247 // ---------------------------------------------------------------------
248 /* A worker has died. This can not be done while the select loop is running
249 as it would require that RunFds could handling a changing list state and
251 void pkgAcquire::Remove(Worker
*Work
)
256 Worker
**I
= &Workers
;
260 *I
= (*I
)->NextAcquire
;
262 I
= &(*I
)->NextAcquire
;
266 // Acquire::Enqueue - Queue an URI for fetching /*{{{*/
267 // ---------------------------------------------------------------------
268 /* This is the entry point for an item. An item calls this function when
269 it is constructed which creates a queue (based on the current queue
270 mode) and puts the item in that queue. If the system is running then
271 the queue might be started. */
272 void pkgAcquire::Enqueue(ItemDesc
&Item
)
274 // Determine which queue to put the item in
275 const MethodConfig
*Config
;
276 string Name
= QueueName(Item
.URI
,Config
);
277 if (Name
.empty() == true)
280 // Find the queue structure
282 for (; I
!= 0 && I
->Name
!= Name
; I
= I
->Next
);
285 I
= new Queue(Name
,this);
293 // See if this is a local only URI
294 if (Config
->LocalOnly
== true && Item
.Owner
->Complete
== false)
295 Item
.Owner
->Local
= true;
296 Item
.Owner
->Status
= Item::StatIdle
;
298 // Queue it into the named queue
305 clog
<< "Fetching " << Item
.URI
<< endl
;
306 clog
<< " to " << Item
.Owner
->DestFile
<< endl
;
307 clog
<< " Queue is: " << Name
<< endl
;
311 // Acquire::Dequeue - Remove an item from all queues /*{{{*/
312 // ---------------------------------------------------------------------
313 /* This is called when an item is finished being fetched. It removes it
314 from all the queues */
315 void pkgAcquire::Dequeue(Item
*Itm
)
320 clog
<< "Dequeuing " << Itm
->DestFile
<< endl
;
322 for (; I
!= 0; I
= I
->Next
)
328 clog
<< "Dequeued from " << I
->Name
<< endl
;
336 // Acquire::QueueName - Return the name of the queue for this URI /*{{{*/
337 // ---------------------------------------------------------------------
338 /* The string returned depends on the configuration settings and the
339 method parameters. Given something like http://foo.org/bar it can
340 return http://foo.org or http */
341 string
pkgAcquire::QueueName(string Uri
,MethodConfig
const *&Config
)
345 Config
= GetConfig(U
.Access
);
349 /* Single-Instance methods get exactly one queue per URI. This is
350 also used for the Access queue method */
351 if (Config
->SingleInstance
== true || QueueMode
== QueueAccess
)
354 string AccessSchema
= U
.Access
+ ':';
355 string FullQueueName
;
359 long randomQueue
= random();
360 #ifdef _SC_NPROCESSORS_ONLN
361 long cpuCount
= sysconf(_SC_NPROCESSORS_ONLN
) * 2;
363 long cpuCount
= _config
->FindI("Acquire::QueueHost::Limit",10);
366 randomQueue
%= cpuCount
;
368 strprintf(FullQueueName
, "%s%ld", AccessSchema
.c_str(), randomQueue
);
370 clog
<< "Chose random queue " << FullQueueName
<< " for " << Uri
<< endl
;
374 FullQueueName
= AccessSchema
+ U
.Host
;
376 unsigned int Instances
= 0, SchemaLength
= AccessSchema
.length();
379 for (; I
!= 0; I
= I
->Next
) {
380 // if the queue already exists, re-use it
381 if (I
->Name
== FullQueueName
)
382 return FullQueueName
;
384 if (I
->Name
.compare(0, SchemaLength
, AccessSchema
) == 0)
389 clog
<< "Found " << Instances
<< " instances of " << U
.Access
<< endl
;
392 if (Instances
>= (unsigned int)_config
->FindI("Acquire::QueueHost::Limit",10))
395 return FullQueueName
;
398 // Acquire::GetConfig - Fetch the configuration information /*{{{*/
399 // ---------------------------------------------------------------------
400 /* This locates the configuration structure for an access method. If
401 a config structure cannot be found a Worker will be created to
403 pkgAcquire::MethodConfig
*pkgAcquire::GetConfig(string Access
)
405 // Search for an existing config
407 for (Conf
= Configs
; Conf
!= 0; Conf
= Conf
->Next
)
408 if (Conf
->Access
== Access
)
411 // Create the new config class
412 Conf
= new MethodConfig
;
413 Conf
->Access
= Access
;
414 Conf
->Next
= Configs
;
417 // Create the worker to fetch the configuration
419 if (Work
.Start() == false)
422 /* if a method uses DownloadLimit, we switch to SingleInstance mode */
423 if(_config
->FindI("Acquire::"+Access
+"::Dl-Limit",0) > 0)
424 Conf
->SingleInstance
= true;
429 // Acquire::SetFds - Deal with readable FDs /*{{{*/
430 // ---------------------------------------------------------------------
431 /* Collect FDs that have activity monitors into the fd sets */
432 void pkgAcquire::SetFds(int &Fd
,fd_set
*RSet
,fd_set
*WSet
)
434 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
436 if (I
->InReady
== true && I
->InFd
>= 0)
440 FD_SET(I
->InFd
,RSet
);
442 if (I
->OutReady
== true && I
->OutFd
>= 0)
446 FD_SET(I
->OutFd
,WSet
);
451 // Acquire::RunFds - compatibility remove on next abi/api break /*{{{*/
452 void pkgAcquire::RunFds(fd_set
*RSet
,fd_set
*WSet
)
454 RunFdsSane(RSet
, WSet
);
457 // Acquire::RunFdsSane - Deal with active FDs /*{{{*/
458 // ---------------------------------------------------------------------
459 /* Dispatch active FDs over to the proper workers. It is very important
460 that a worker never be erased while this is running! The queue class
461 should never erase a worker except during shutdown processing. */
462 bool pkgAcquire::RunFdsSane(fd_set
*RSet
,fd_set
*WSet
)
466 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
468 if (I
->InFd
>= 0 && FD_ISSET(I
->InFd
,RSet
) != 0)
469 Res
&= I
->InFdReady();
470 if (I
->OutFd
>= 0 && FD_ISSET(I
->OutFd
,WSet
) != 0)
471 Res
&= I
->OutFdReady();
477 // Acquire::Run - Run the fetch sequence /*{{{*/
478 // ---------------------------------------------------------------------
479 /* This runs the queues. It manages a select loop for all of the
480 Worker tasks. The workers interact with the queues and items to
481 manage the actual fetch. */
482 static bool IsAccessibleBySandboxUser(std::string
const &filename
, bool const ReadWrite
)
484 // you would think this is easily to answer with faccessat, right? Wrong!
485 // It e.g. gets groups wrong, so the only thing which works reliable is trying
486 // to open the file we want to open later on…
487 if (unlikely(filename
.empty()))
490 if (ReadWrite
== false)
493 // can we read a file? Note that non-existing files are "fine"
494 int const fd
= open(filename
.c_str(), O_RDONLY
| O_CLOEXEC
);
495 if (fd
== -1 && errno
== EACCES
)
502 // the file might not exist yet and even if it does we will fix permissions,
503 // so important is here just that the directory it is in allows that
504 std::string
const dirname
= flNotFile(filename
);
505 if (unlikely(dirname
.empty()))
508 char const * const filetag
= ".apt-acquire-privs-test.XXXXXX";
509 std::string
const tmpfile_tpl
= flCombine(dirname
, filetag
);
510 std::unique_ptr
<char, decltype(std::free
) *> tmpfile
{ strdup(tmpfile_tpl
.c_str()), std::free
};
511 int const fd
= mkstemp(tmpfile
.get());
512 if (fd
== -1 && errno
== EACCES
)
514 RemoveFile("IsAccessibleBySandboxUser", tmpfile
.get());
519 static void CheckDropPrivsMustBeDisabled(pkgAcquire
const &Fetcher
)
524 std::string
const SandboxUser
= _config
->Find("APT::Sandbox::User");
525 if (SandboxUser
.empty() || SandboxUser
== "root")
528 struct passwd
const * const pw
= getpwnam(SandboxUser
.c_str());
531 _error
->Warning(_("No sandbox user '%s' on the system, can not drop privileges"), SandboxUser
.c_str());
532 _config
->Set("APT::Sandbox::User", "");
536 gid_t
const old_euid
= geteuid();
537 gid_t
const old_egid
= getegid();
539 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
540 std::unique_ptr
<gid_t
[]> old_gidlist(new gid_t
[ngroups_max
]);
541 if (unlikely(old_gidlist
== NULL
))
543 ssize_t old_gidlist_nr
;
544 if ((old_gidlist_nr
= getgroups(ngroups_max
, old_gidlist
.get())) < 0)
546 _error
->FatalE("getgroups", "getgroups %lu failed", ngroups_max
);
550 if (setgroups(1, &pw
->pw_gid
))
551 _error
->FatalE("setgroups", "setgroups %u failed", pw
->pw_gid
);
553 if (setegid(pw
->pw_gid
) != 0)
554 _error
->FatalE("setegid", "setegid %u failed", pw
->pw_gid
);
555 if (seteuid(pw
->pw_uid
) != 0)
556 _error
->FatalE("seteuid", "seteuid %u failed", pw
->pw_uid
);
558 for (pkgAcquire::ItemCIterator I
= Fetcher
.ItemsBegin();
559 I
!= Fetcher
.ItemsEnd(); ++I
)
561 // no need to drop privileges for a complete file
562 if ((*I
)->Complete
== true)
565 // if destination file is inaccessible all hope is lost for privilege dropping
566 if (IsAccessibleBySandboxUser((*I
)->DestFile
, true) == false)
568 _error
->WarningE("pkgAcquire::Run", _("Can't drop privileges for downloading as file '%s' couldn't be accessed by user '%s'."),
569 (*I
)->DestFile
.c_str(), SandboxUser
.c_str());
570 _config
->Set("APT::Sandbox::User", "");
574 // if its the source file (e.g. local sources) we might be lucky
575 // by dropping the dropping only for some methods.
576 URI
const source
= (*I
)->DescURI();
577 if (source
.Access
== "file" || source
.Access
== "copy")
579 std::string
const conf
= "Binary::" + source
.Access
+ "::APT::Sandbox::User";
580 if (_config
->Exists(conf
) == true)
583 if (IsAccessibleBySandboxUser(source
.Path
, false) == false)
585 _error
->NoticeE("pkgAcquire::Run", _("Can't drop privileges for downloading as file '%s' couldn't be accessed by user '%s'."),
586 source
.Path
.c_str(), SandboxUser
.c_str());
587 _config
->CndSet("Binary::file::APT::Sandbox::User", "root");
588 _config
->CndSet("Binary::copy::APT::Sandbox::User", "root");
593 if (seteuid(old_euid
) != 0)
594 _error
->FatalE("seteuid", "seteuid %u failed", old_euid
);
595 if (setegid(old_egid
) != 0)
596 _error
->FatalE("setegid", "setegid %u failed", old_egid
);
597 if (setgroups(old_gidlist_nr
, old_gidlist
.get()))
598 _error
->FatalE("setgroups", "setgroups %u failed", 0);
600 pkgAcquire::RunResult
pkgAcquire::Run(int PulseIntervall
)
602 _error
->PushToStack();
603 CheckDropPrivsMustBeDisabled(*this);
607 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
613 bool WasCancelled
= false;
615 // Run till all things have been acquired
618 tv
.tv_usec
= PulseIntervall
;
626 SetFds(Highest
,&RFds
,&WFds
);
631 Res
= select(Highest
+1,&RFds
,&WFds
,0,&tv
);
633 while (Res
< 0 && errno
== EINTR
);
637 _error
->Errno("select","Select has failed");
641 if(RunFdsSane(&RFds
,&WFds
) == false)
644 // Timeout, notify the log class
645 if (Res
== 0 || (Log
!= 0 && Log
->Update
== true))
647 tv
.tv_usec
= PulseIntervall
;
648 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
650 if (Log
!= 0 && Log
->Pulse(this) == false)
661 // Shut down the acquire bits
663 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
666 // Shut down the items
667 for (ItemIterator I
= Items
.begin(); I
!= Items
.end(); ++I
)
670 bool const newError
= _error
->PendingError();
671 _error
->MergeWithStack();
679 // Acquire::Bump - Called when an item is dequeued /*{{{*/
680 // ---------------------------------------------------------------------
681 /* This routine bumps idle queues in hopes that they will be able to fetch
683 void pkgAcquire::Bump()
685 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
689 // Acquire::WorkerStep - Step to the next worker /*{{{*/
690 // ---------------------------------------------------------------------
691 /* Not inlined to advoid including acquire-worker.h */
692 pkgAcquire::Worker
*pkgAcquire::WorkerStep(Worker
*I
)
694 return I
->NextAcquire
;
697 // Acquire::Clean - Cleans a directory /*{{{*/
698 // ---------------------------------------------------------------------
699 /* This is a bit simplistic, it looks at every file in the dir and sees
700 if it is part of the download set. */
701 bool pkgAcquire::Clean(string Dir
)
703 // non-existing directories are by definition clean…
704 if (DirectoryExists(Dir
) == false)
708 return _error
->Error(_("Clean of %s is not supported"), Dir
.c_str());
710 DIR *D
= opendir(Dir
.c_str());
712 return _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
714 string StartDir
= SafeGetCWD();
715 if (chdir(Dir
.c_str()) != 0)
718 return _error
->Errno("chdir",_("Unable to change to %s"),Dir
.c_str());
721 for (struct dirent
*Dir
= readdir(D
); Dir
!= 0; Dir
= readdir(D
))
724 if (strcmp(Dir
->d_name
,"lock") == 0 ||
725 strcmp(Dir
->d_name
,"partial") == 0 ||
726 strcmp(Dir
->d_name
,"lost+found") == 0 ||
727 strcmp(Dir
->d_name
,".") == 0 ||
728 strcmp(Dir
->d_name
,"..") == 0)
731 // Look in the get list
732 ItemCIterator I
= Items
.begin();
733 for (; I
!= Items
.end(); ++I
)
734 if (flNotDir((*I
)->DestFile
) == Dir
->d_name
)
737 // Nothing found, nuke it
738 if (I
== Items
.end())
739 RemoveFile("Clean", Dir
->d_name
);
743 if (chdir(StartDir
.c_str()) != 0)
744 return _error
->Errno("chdir",_("Unable to change to %s"),StartDir
.c_str());
748 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
749 // ---------------------------------------------------------------------
750 /* This is the total number of bytes needed */
751 APT_PURE
unsigned long long pkgAcquire::TotalNeeded()
753 return std::accumulate(ItemsBegin(), ItemsEnd(), 0llu,
754 [](unsigned long long const T
, Item
const * const I
) {
755 return T
+ I
->FileSize
;
759 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
760 // ---------------------------------------------------------------------
761 /* This is the number of bytes that is not local */
762 APT_PURE
unsigned long long pkgAcquire::FetchNeeded()
764 return std::accumulate(ItemsBegin(), ItemsEnd(), 0llu,
765 [](unsigned long long const T
, Item
const * const I
) {
766 if (I
->Local
== false)
767 return T
+ I
->FileSize
;
773 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
774 // ---------------------------------------------------------------------
775 /* This is the number of bytes that is not local */
776 APT_PURE
unsigned long long pkgAcquire::PartialPresent()
778 return std::accumulate(ItemsBegin(), ItemsEnd(), 0llu,
779 [](unsigned long long const T
, Item
const * const I
) {
780 if (I
->Local
== false)
781 return T
+ I
->PartialSize
;
787 // Acquire::UriBegin - Start iterator for the uri list /*{{{*/
788 // ---------------------------------------------------------------------
790 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
792 return UriIterator(Queues
);
795 // Acquire::UriEnd - End iterator for the uri list /*{{{*/
796 // ---------------------------------------------------------------------
798 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
800 return UriIterator(0);
803 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
804 // ---------------------------------------------------------------------
806 pkgAcquire::MethodConfig::MethodConfig() : d(NULL
), Next(0), SingleInstance(false),
807 Pipeline(false), SendConfig(false), LocalOnly(false), NeedsCleanup(false),
812 // Queue::Queue - Constructor /*{{{*/
813 // ---------------------------------------------------------------------
815 pkgAcquire::Queue::Queue(string
const &name
,pkgAcquire
* const owner
) : d(NULL
), Next(0),
816 Name(name
), Items(0), Workers(0), Owner(owner
), PipeDepth(0), MaxPipeDepth(1)
820 // Queue::~Queue - Destructor /*{{{*/
821 // ---------------------------------------------------------------------
823 pkgAcquire::Queue::~Queue()
835 // Queue::Enqueue - Queue an item to the queue /*{{{*/
836 // ---------------------------------------------------------------------
838 bool pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
841 // move to the end of the queue and check for duplicates here
842 for (; *I
!= 0; I
= &(*I
)->Next
)
843 if (Item
.URI
== (*I
)->URI
)
845 if (_config
->FindB("Debug::pkgAcquire::Worker",false) == true)
846 std::cerr
<< " @ Queue: Action combined for " << Item
.URI
<< " and " << (*I
)->URI
<< std::endl
;
847 (*I
)->Owners
.push_back(Item
.Owner
);
848 Item
.Owner
->Status
= (*I
)->Owner
->Status
;
853 QItem
*Itm
= new QItem
;
858 Item
.Owner
->QueueCounter
++;
859 if (Items
->Next
== 0)
864 // Queue::Dequeue - Remove an item from the queue /*{{{*/
865 // ---------------------------------------------------------------------
866 /* We return true if we hit something */
867 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
869 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
870 return _error
->Error("Tried to dequeue a fetching object");
877 if (Owner
== (*I
)->Owner
)
881 Owner
->QueueCounter
--;
892 // Queue::Startup - Start the worker processes /*{{{*/
893 // ---------------------------------------------------------------------
894 /* It is possible for this to be called with a pre-existing set of
896 bool pkgAcquire::Queue::Startup()
901 pkgAcquire::MethodConfig
*Cnf
= Owner
->GetConfig(U
.Access
);
905 Workers
= new Worker(this,Cnf
,Owner
->Log
);
907 if (Workers
->Start() == false)
910 /* When pipelining we commit 10 items. This needs to change when we
911 added other source retry to have cycle maintain a pipeline depth
913 if (Cnf
->Pipeline
== true)
914 MaxPipeDepth
= _config
->FindI("Acquire::Max-Pipeline-Depth",10);
922 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
923 // ---------------------------------------------------------------------
924 /* If final is true then all workers are eliminated, otherwise only workers
925 that do not need cleanup are removed */
926 bool pkgAcquire::Queue::Shutdown(bool Final
)
928 // Delete all of the workers
929 pkgAcquire::Worker
**Cur
= &Workers
;
932 pkgAcquire::Worker
*Jnk
= *Cur
;
933 if (Final
== true || Jnk
->GetConf()->NeedsCleanup
== false)
935 *Cur
= Jnk
->NextQueue
;
940 Cur
= &(*Cur
)->NextQueue
;
946 // Queue::FindItem - Find a URI in the item list /*{{{*/
947 // ---------------------------------------------------------------------
949 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
951 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
952 if (I
->URI
== URI
&& I
->Worker
== Owner
)
957 // Queue::ItemDone - Item has been completed /*{{{*/
958 // ---------------------------------------------------------------------
959 /* The worker signals this which causes the item to be removed from the
960 queue. If this is the last queue instance then it is removed from the
962 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
965 for (QItem::owner_iterator O
= Itm
->Owners
.begin(); O
!= Itm
->Owners
.end(); ++O
)
967 if ((*O
)->Status
== pkgAcquire::Item::StatFetching
)
968 (*O
)->Status
= pkgAcquire::Item::StatDone
;
971 if (Itm
->Owner
->QueueCounter
<= 1)
972 Owner
->Dequeue(Itm
->Owner
);
982 // Queue::Cycle - Queue new items into the method /*{{{*/
983 // ---------------------------------------------------------------------
984 /* This locates a new idle item and sends it to the worker. If pipelining
985 is enabled then it keeps the pipe full. */
986 bool pkgAcquire::Queue::Cycle()
988 if (Items
== 0 || Workers
== 0)
992 return _error
->Error("Pipedepth failure");
994 // Look for a queable item
996 while (PipeDepth
< (signed)MaxPipeDepth
)
998 for (; I
!= 0; I
= I
->Next
)
999 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
1002 // Nothing to do, queue is idle.
1006 I
->Worker
= Workers
;
1007 for (auto const &O
: I
->Owners
)
1008 O
->Status
= pkgAcquire::Item::StatFetching
;
1010 if (Workers
->QueueItem(I
) == false)
1017 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
1018 // ---------------------------------------------------------------------
1019 /* This is called when an item in multiple queues is dequeued */
1020 void pkgAcquire::Queue::Bump()
1025 HashStringList
pkgAcquire::Queue::QItem::GetExpectedHashes() const /*{{{*/
1027 /* each Item can have multiple owners and each owner might have different
1028 hashes, even if that is unlikely in practice and if so at least some
1029 owners will later fail. There is one situation through which is not a
1030 failure and still needs this handling: Two owners who expect the same
1031 file, but one owner only knows the SHA1 while the other only knows SHA256. */
1032 HashStringList superhsl
;
1033 for (pkgAcquire::Queue::QItem::owner_iterator O
= Owners
.begin(); O
!= Owners
.end(); ++O
)
1035 HashStringList
const hsl
= (*O
)->GetExpectedHashes();
1036 if (hsl
.usable() == false)
1038 if (superhsl
.usable() == false)
1042 // we merge both lists - if we find disagreement send no hashes
1043 HashStringList::const_iterator hs
= hsl
.begin();
1044 for (; hs
!= hsl
.end(); ++hs
)
1045 if (superhsl
.push_back(*hs
) == false)
1047 if (hs
!= hsl
.end())
1057 APT_PURE
unsigned long long pkgAcquire::Queue::QItem::GetMaximumSize() const /*{{{*/
1059 unsigned long long Maximum
= std::numeric_limits
<unsigned long long>::max();
1060 for (auto const &O
: Owners
)
1062 if (O
->FileSize
== 0)
1064 Maximum
= std::min(Maximum
, O
->FileSize
);
1066 if (Maximum
== std::numeric_limits
<unsigned long long>::max())
1071 void pkgAcquire::Queue::QItem::SyncDestinationFiles() const /*{{{*/
1073 /* ensure that the first owner has the best partial file of all and
1074 the rest have (potentially dangling) symlinks to it so that
1075 everything (like progress reporting) finds it easily */
1076 std::string superfile
= Owner
->DestFile
;
1077 off_t supersize
= 0;
1078 for (pkgAcquire::Queue::QItem::owner_iterator O
= Owners
.begin(); O
!= Owners
.end(); ++O
)
1080 if ((*O
)->DestFile
== superfile
)
1083 if (lstat((*O
)->DestFile
.c_str(),&file
) == 0)
1085 if ((file
.st_mode
& S_IFREG
) == 0)
1086 RemoveFile("SyncDestinationFiles", (*O
)->DestFile
);
1087 else if (supersize
< file
.st_size
)
1089 supersize
= file
.st_size
;
1090 RemoveFile("SyncDestinationFiles", superfile
);
1091 rename((*O
)->DestFile
.c_str(), superfile
.c_str());
1094 RemoveFile("SyncDestinationFiles", (*O
)->DestFile
);
1095 if (symlink(superfile
.c_str(), (*O
)->DestFile
.c_str()) != 0)
1097 ; // not a problem per-se and no real alternative
1103 std::string
pkgAcquire::Queue::QItem::Custom600Headers() const /*{{{*/
1105 /* The others are relatively easy to merge, but this one?
1106 Lets not merge and see how far we can run with it…
1107 Likely, nobody will ever notice as all the items will
1108 be of the same class and hence generate the same headers. */
1109 return Owner
->Custom600Headers();
1113 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
1114 // ---------------------------------------------------------------------
1116 pkgAcquireStatus::pkgAcquireStatus() : d(NULL
), Percent(-1), Update(true), MorePulses(false)
1121 // AcquireStatus::Pulse - Called periodically /*{{{*/
1122 // ---------------------------------------------------------------------
1123 /* This computes some internal state variables for the derived classes to
1124 use. It generates the current downloaded bytes and total bytes to download
1125 as well as the current CPS estimate. */
1126 bool pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
1133 // Compute the total number of bytes to fetch
1134 unsigned int Unknown
= 0;
1135 unsigned int Count
= 0;
1136 bool UnfetchedReleaseFiles
= false;
1137 for (pkgAcquire::ItemCIterator I
= Owner
->ItemsBegin();
1138 I
!= Owner
->ItemsEnd();
1142 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
1145 // Totally ignore local items
1146 if ((*I
)->Local
== true)
1149 // see if the method tells us to expect more
1150 TotalItems
+= (*I
)->ExpectedAdditionalItems
;
1152 // check if there are unfetched Release files
1153 if ((*I
)->Complete
== false && (*I
)->ExpectedAdditionalItems
> 0)
1154 UnfetchedReleaseFiles
= true;
1156 TotalBytes
+= (*I
)->FileSize
;
1157 if ((*I
)->Complete
== true)
1158 CurrentBytes
+= (*I
)->FileSize
;
1159 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
1163 // Compute the current completion
1164 unsigned long long ResumeSize
= 0;
1165 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
1166 I
= Owner
->WorkerStep(I
))
1168 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
1170 CurrentBytes
+= I
->CurrentSize
;
1171 ResumeSize
+= I
->ResumePoint
;
1173 // Files with unknown size always have 100% completion
1174 if (I
->CurrentItem
->Owner
->FileSize
== 0 &&
1175 I
->CurrentItem
->Owner
->Complete
== false)
1176 TotalBytes
+= I
->CurrentSize
;
1180 // Normalize the figures and account for unknown size downloads
1181 if (TotalBytes
<= 0)
1183 if (Unknown
== Count
)
1184 TotalBytes
= Unknown
;
1186 // Wha?! Is not supposed to happen.
1187 if (CurrentBytes
> TotalBytes
)
1188 CurrentBytes
= TotalBytes
;
1191 if (_config
->FindB("Debug::acquire::progress", false) == true)
1192 std::clog
<< " Bytes: "
1193 << SizeToStr(CurrentBytes
) << " / " << SizeToStr(TotalBytes
)
1197 struct timeval NewTime
;
1198 gettimeofday(&NewTime
,0);
1199 if ((NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
) ||
1200 NewTime
.tv_sec
- Time
.tv_sec
> 6)
1202 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
1203 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
1205 // Compute the CPS value
1209 CurrentCPS
= ((CurrentBytes
- ResumeSize
) - LastBytes
)/Delta
;
1210 LastBytes
= CurrentBytes
- ResumeSize
;
1211 ElapsedTime
= (unsigned long long)Delta
;
1215 double const OldPercent
= Percent
;
1216 // calculate the percentage, if we have too little data assume 1%
1217 if (TotalBytes
> 0 && UnfetchedReleaseFiles
)
1220 // use both files and bytes because bytes can be unreliable
1221 Percent
= (0.8 * (CurrentBytes
/float(TotalBytes
)*100.0) +
1222 0.2 * (CurrentItems
/float(TotalItems
)*100.0));
1223 double const DiffPercent
= Percent
- OldPercent
;
1224 if (DiffPercent
< 0.001 && _config
->FindB("Acquire::Progress::Diffpercent", false) == true)
1227 int fd
= _config
->FindI("APT::Status-Fd",-1);
1230 ostringstream status
;
1233 long i
= CurrentItems
< TotalItems
? CurrentItems
+ 1 : CurrentItems
;
1234 unsigned long long ETA
= 0;
1236 ETA
= (TotalBytes
- CurrentBytes
) / CurrentCPS
;
1238 // only show the ETA if it makes sense
1239 if (ETA
> 0 && ETA
< 172800 /* two days */ )
1240 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li (%s remaining)"), i
, TotalItems
, TimeToStr(ETA
).c_str());
1242 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li"), i
, TotalItems
);
1244 // build the status str
1245 status
<< "dlstatus:" << i
1246 << ":" << std::setprecision(3) << Percent
1250 std::string
const dlstatus
= status
.str();
1251 FileFd::Write(fd
, dlstatus
.c_str(), dlstatus
.size());
1257 // AcquireStatus::Start - Called when the download is started /*{{{*/
1258 // ---------------------------------------------------------------------
1259 /* We just reset the counters */
1260 void pkgAcquireStatus::Start()
1262 gettimeofday(&Time
,0);
1263 gettimeofday(&StartTime
,0);
1274 // AcquireStatus::Stop - Finished downloading /*{{{*/
1275 // ---------------------------------------------------------------------
1276 /* This accurately computes the elapsed time and the total overall CPS. */
1277 void pkgAcquireStatus::Stop()
1279 // Compute the CPS and elapsed time
1280 struct timeval NewTime
;
1281 gettimeofday(&NewTime
,0);
1283 double Delta
= NewTime
.tv_sec
- StartTime
.tv_sec
+
1284 (NewTime
.tv_usec
- StartTime
.tv_usec
)/1000000.0;
1286 // Compute the CPS value
1290 CurrentCPS
= FetchedBytes
/Delta
;
1291 LastBytes
= CurrentBytes
;
1292 ElapsedTime
= (unsigned long long)Delta
;
1295 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
1296 // ---------------------------------------------------------------------
1297 /* This is used to get accurate final transfer rate reporting. */
1298 void pkgAcquireStatus::Fetched(unsigned long long Size
,unsigned long long Resume
)
1300 FetchedBytes
+= Size
- Resume
;
1304 pkgAcquire::UriIterator::UriIterator(pkgAcquire::Queue
*Q
) : d(NULL
), CurQ(Q
), CurItem(0)
1306 while (CurItem
== 0 && CurQ
!= 0)
1308 CurItem
= CurQ
->Items
;
1313 APT_CONST
pkgAcquire::UriIterator::~UriIterator() {}
1314 APT_CONST
pkgAcquire::MethodConfig::~MethodConfig() {}
1315 APT_CONST
pkgAcquireStatus::~pkgAcquireStatus() {}