]>
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_GROUP
);
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_GROUP
);
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 static bool CheckForBadItemAndFailIt(pkgAcquire::Item
* const Item
,
273 pkgAcquire::MethodConfig
const * const Config
, pkgAcquireStatus
* const Log
)
275 auto SavedDesc
= Item
->GetItemDesc();
276 if (Item
->IsRedirectionLoop(SavedDesc
.URI
))
278 std::string
const Message
= "400 URI Failure"
279 "\nURI: " + SavedDesc
.URI
+
280 "\nFilename: " + Item
->DestFile
+
281 "\nFailReason: RedirectionLoop";
283 Item
->Status
= pkgAcquire::Item::StatError
;
284 Item
->Failed(Message
, Config
);
286 Log
->Fail(SavedDesc
);
290 HashStringList
const hsl
= Item
->GetExpectedHashes();
291 if (hsl
.usable() == false && Item
->HashesRequired() &&
292 _config
->Exists("Acquire::ForceHash") == false)
294 std::string
const Message
= "400 URI Failure"
295 "\nURI: " + SavedDesc
.URI
+
296 "\nFilename: " + Item
->DestFile
+
297 "\nFailReason: WeakHashSums";
299 auto SavedDesc
= Item
->GetItemDesc();
300 Item
->Status
= pkgAcquire::Item::StatAuthError
;
301 Item
->Failed(Message
, Config
);
303 Log
->Fail(SavedDesc
);
308 void pkgAcquire::Enqueue(ItemDesc
&Item
)
310 // Determine which queue to put the item in
311 const MethodConfig
*Config
;
312 string Name
= QueueName(Item
.URI
,Config
);
313 if (Name
.empty() == true)
316 /* the check for running avoids that we produce errors
317 in logging before we actually have started, which would
318 be easier to implement but would confuse users/implementations
319 so we check the items skipped here in #Startup */
320 if (Running
&& CheckForBadItemAndFailIt(Item
.Owner
, Config
, Log
))
323 // Find the queue structure
325 for (; I
!= 0 && I
->Name
!= Name
; I
= I
->Next
);
328 I
= new Queue(Name
,this);
336 // See if this is a local only URI
337 if (Config
->LocalOnly
== true && Item
.Owner
->Complete
== false)
338 Item
.Owner
->Local
= true;
339 Item
.Owner
->Status
= Item::StatIdle
;
341 // Queue it into the named queue
348 clog
<< "Fetching " << Item
.URI
<< endl
;
349 clog
<< " to " << Item
.Owner
->DestFile
<< endl
;
350 clog
<< " Queue is: " << Name
<< endl
;
354 // Acquire::Dequeue - Remove an item from all queues /*{{{*/
355 // ---------------------------------------------------------------------
356 /* This is called when an item is finished being fetched. It removes it
357 from all the queues */
358 void pkgAcquire::Dequeue(Item
*Itm
)
363 clog
<< "Dequeuing " << Itm
->DestFile
<< endl
;
365 for (; I
!= 0; I
= I
->Next
)
371 clog
<< "Dequeued from " << I
->Name
<< endl
;
379 // Acquire::QueueName - Return the name of the queue for this URI /*{{{*/
380 // ---------------------------------------------------------------------
381 /* The string returned depends on the configuration settings and the
382 method parameters. Given something like http://foo.org/bar it can
383 return http://foo.org or http */
384 string
pkgAcquire::QueueName(string Uri
,MethodConfig
const *&Config
)
388 Config
= GetConfig(U
.Access
);
392 /* Single-Instance methods get exactly one queue per URI. This is
393 also used for the Access queue method */
394 if (Config
->SingleInstance
== true || QueueMode
== QueueAccess
)
397 string AccessSchema
= U
.Access
+ ':';
398 string FullQueueName
;
403 // check how many queues exist already and reuse empty ones
404 for (Queue
const *I
= Queues
; I
!= 0; I
= I
->Next
)
405 if (I
->Name
.compare(0, AccessSchema
.length(), AccessSchema
) == 0)
407 if (I
->Items
== nullptr)
412 #ifdef _SC_NPROCESSORS_ONLN
413 long cpuCount
= sysconf(_SC_NPROCESSORS_ONLN
) * 2;
417 cpuCount
= _config
->FindI("Acquire::QueueHost::Limit", cpuCount
);
419 if (cpuCount
<= 0 || existing
< cpuCount
)
420 strprintf(FullQueueName
, "%s%ld", AccessSchema
.c_str(), existing
);
423 long const randomQueue
= random() % cpuCount
;
424 strprintf(FullQueueName
, "%s%ld", AccessSchema
.c_str(), randomQueue
);
428 clog
<< "Chose random queue " << FullQueueName
<< " for " << Uri
<< endl
;
431 FullQueueName
= AccessSchema
+ U
.Host
;
433 unsigned int Instances
= 0, SchemaLength
= AccessSchema
.length();
436 for (; I
!= 0; I
= I
->Next
) {
437 // if the queue already exists, re-use it
438 if (I
->Name
== FullQueueName
)
439 return FullQueueName
;
441 if (I
->Name
.compare(0, SchemaLength
, AccessSchema
) == 0)
446 clog
<< "Found " << Instances
<< " instances of " << U
.Access
<< endl
;
449 if (Instances
>= (unsigned int)_config
->FindI("Acquire::QueueHost::Limit",10))
452 return FullQueueName
;
455 // Acquire::GetConfig - Fetch the configuration information /*{{{*/
456 // ---------------------------------------------------------------------
457 /* This locates the configuration structure for an access method. If
458 a config structure cannot be found a Worker will be created to
460 pkgAcquire::MethodConfig
*pkgAcquire::GetConfig(string Access
)
462 // Search for an existing config
464 for (Conf
= Configs
; Conf
!= 0; Conf
= Conf
->Next
)
465 if (Conf
->Access
== Access
)
468 // Create the new config class
469 Conf
= new MethodConfig
;
470 Conf
->Access
= Access
;
471 Conf
->Next
= Configs
;
474 // Create the worker to fetch the configuration
476 if (Work
.Start() == false)
479 /* if a method uses DownloadLimit, we switch to SingleInstance mode */
480 if(_config
->FindI("Acquire::"+Access
+"::Dl-Limit",0) > 0)
481 Conf
->SingleInstance
= true;
486 // Acquire::SetFds - Deal with readable FDs /*{{{*/
487 // ---------------------------------------------------------------------
488 /* Collect FDs that have activity monitors into the fd sets */
489 void pkgAcquire::SetFds(int &Fd
,fd_set
*RSet
,fd_set
*WSet
)
491 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
493 if (I
->InReady
== true && I
->InFd
>= 0)
497 FD_SET(I
->InFd
,RSet
);
499 if (I
->OutReady
== true && I
->OutFd
>= 0)
503 FD_SET(I
->OutFd
,WSet
);
508 // Acquire::RunFds - compatibility remove on next abi/api break /*{{{*/
509 void pkgAcquire::RunFds(fd_set
*RSet
,fd_set
*WSet
)
511 RunFdsSane(RSet
, WSet
);
514 // Acquire::RunFdsSane - Deal with active FDs /*{{{*/
515 // ---------------------------------------------------------------------
516 /* Dispatch active FDs over to the proper workers. It is very important
517 that a worker never be erased while this is running! The queue class
518 should never erase a worker except during shutdown processing. */
519 bool pkgAcquire::RunFdsSane(fd_set
*RSet
,fd_set
*WSet
)
523 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
525 if (I
->InFd
>= 0 && FD_ISSET(I
->InFd
,RSet
) != 0)
526 Res
&= I
->InFdReady();
527 if (I
->OutFd
>= 0 && FD_ISSET(I
->OutFd
,WSet
) != 0)
528 Res
&= I
->OutFdReady();
534 // Acquire::Run - Run the fetch sequence /*{{{*/
535 // ---------------------------------------------------------------------
536 /* This runs the queues. It manages a select loop for all of the
537 Worker tasks. The workers interact with the queues and items to
538 manage the actual fetch. */
539 static bool IsAccessibleBySandboxUser(std::string
const &filename
, bool const ReadWrite
)
541 // you would think this is easily to answer with faccessat, right? Wrong!
542 // It e.g. gets groups wrong, so the only thing which works reliable is trying
543 // to open the file we want to open later on…
544 if (unlikely(filename
.empty()))
547 if (ReadWrite
== false)
550 // can we read a file? Note that non-existing files are "fine"
551 int const fd
= open(filename
.c_str(), O_RDONLY
| O_CLOEXEC
);
552 if (fd
== -1 && errno
== EACCES
)
559 // the file might not exist yet and even if it does we will fix permissions,
560 // so important is here just that the directory it is in allows that
561 std::string
const dirname
= flNotFile(filename
);
562 if (unlikely(dirname
.empty()))
565 char const * const filetag
= ".apt-acquire-privs-test.XXXXXX";
566 std::string
const tmpfile_tpl
= flCombine(dirname
, filetag
);
567 std::unique_ptr
<char, decltype(std::free
) *> tmpfile
{ strdup(tmpfile_tpl
.c_str()), std::free
};
568 int const fd
= mkstemp(tmpfile
.get());
569 if (fd
== -1 && errno
== EACCES
)
571 RemoveFile("IsAccessibleBySandboxUser", tmpfile
.get());
576 static void CheckDropPrivsMustBeDisabled(pkgAcquire
const &Fetcher
)
581 std::string
const SandboxUser
= _config
->Find("APT::Sandbox::User");
582 if (SandboxUser
.empty() || SandboxUser
== "root")
585 struct passwd
const * const pw
= getpwnam(SandboxUser
.c_str());
588 _error
->Warning(_("No sandbox user '%s' on the system, can not drop privileges"), SandboxUser
.c_str());
589 _config
->Set("APT::Sandbox::User", "");
593 gid_t
const old_euid
= geteuid();
594 gid_t
const old_egid
= getegid();
596 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
597 std::unique_ptr
<gid_t
[]> old_gidlist(new gid_t
[ngroups_max
]);
598 if (unlikely(old_gidlist
== NULL
))
600 ssize_t old_gidlist_nr
;
601 if ((old_gidlist_nr
= getgroups(ngroups_max
, old_gidlist
.get())) < 0)
603 _error
->FatalE("getgroups", "getgroups %lu failed", ngroups_max
);
607 if (setgroups(1, &pw
->pw_gid
))
608 _error
->FatalE("setgroups", "setgroups %u failed", pw
->pw_gid
);
610 if (setegid(pw
->pw_gid
) != 0)
611 _error
->FatalE("setegid", "setegid %u failed", pw
->pw_gid
);
612 if (seteuid(pw
->pw_uid
) != 0)
613 _error
->FatalE("seteuid", "seteuid %u failed", pw
->pw_uid
);
615 for (pkgAcquire::ItemCIterator I
= Fetcher
.ItemsBegin();
616 I
!= Fetcher
.ItemsEnd(); ++I
)
618 // no need to drop privileges for a complete file
619 if ((*I
)->Complete
== true || (*I
)->Status
!= pkgAcquire::Item::StatIdle
)
622 // if destination file is inaccessible all hope is lost for privilege dropping
623 if (IsAccessibleBySandboxUser((*I
)->DestFile
, true) == false)
625 _error
->WarningE("pkgAcquire::Run", _("Can't drop privileges for downloading as file '%s' couldn't be accessed by user '%s'."),
626 (*I
)->DestFile
.c_str(), SandboxUser
.c_str());
627 _config
->Set("APT::Sandbox::User", "");
631 // if its the source file (e.g. local sources) we might be lucky
632 // by dropping the dropping only for some methods.
633 URI
const source
= (*I
)->DescURI();
634 if (source
.Access
== "file" || source
.Access
== "copy")
636 std::string
const conf
= "Binary::" + source
.Access
+ "::APT::Sandbox::User";
637 if (_config
->Exists(conf
) == true)
640 if (IsAccessibleBySandboxUser(source
.Path
, false) == false)
642 _error
->NoticeE("pkgAcquire::Run", _("Can't drop privileges for downloading as file '%s' couldn't be accessed by user '%s'."),
643 source
.Path
.c_str(), SandboxUser
.c_str());
644 _config
->CndSet("Binary::file::APT::Sandbox::User", "root");
645 _config
->CndSet("Binary::copy::APT::Sandbox::User", "root");
650 if (seteuid(old_euid
) != 0)
651 _error
->FatalE("seteuid", "seteuid %u failed", old_euid
);
652 if (setegid(old_egid
) != 0)
653 _error
->FatalE("setegid", "setegid %u failed", old_egid
);
654 if (setgroups(old_gidlist_nr
, old_gidlist
.get()))
655 _error
->FatalE("setgroups", "setgroups %u failed", 0);
657 pkgAcquire::RunResult
pkgAcquire::Run(int PulseIntervall
)
659 _error
->PushToStack();
660 CheckDropPrivsMustBeDisabled(*this);
664 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
670 bool WasCancelled
= false;
672 // Run till all things have been acquired
675 tv
.tv_usec
= PulseIntervall
;
683 SetFds(Highest
,&RFds
,&WFds
);
688 Res
= select(Highest
+1,&RFds
,&WFds
,0,&tv
);
690 while (Res
< 0 && errno
== EINTR
);
694 _error
->Errno("select","Select has failed");
698 if(RunFdsSane(&RFds
,&WFds
) == false)
701 // Timeout, notify the log class
702 if (Res
== 0 || (Log
!= 0 && Log
->Update
== true))
704 tv
.tv_usec
= PulseIntervall
;
705 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
707 if (Log
!= 0 && Log
->Pulse(this) == false)
718 // Shut down the acquire bits
720 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
723 // Shut down the items
724 for (ItemIterator I
= Items
.begin(); I
!= Items
.end(); ++I
)
727 bool const newError
= _error
->PendingError();
728 _error
->MergeWithStack();
736 // Acquire::Bump - Called when an item is dequeued /*{{{*/
737 // ---------------------------------------------------------------------
738 /* This routine bumps idle queues in hopes that they will be able to fetch
740 void pkgAcquire::Bump()
742 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
746 // Acquire::WorkerStep - Step to the next worker /*{{{*/
747 // ---------------------------------------------------------------------
748 /* Not inlined to advoid including acquire-worker.h */
749 pkgAcquire::Worker
*pkgAcquire::WorkerStep(Worker
*I
)
751 return I
->NextAcquire
;
754 // Acquire::Clean - Cleans a directory /*{{{*/
755 // ---------------------------------------------------------------------
756 /* This is a bit simplistic, it looks at every file in the dir and sees
757 if it is part of the download set. */
758 bool pkgAcquire::Clean(string Dir
)
760 // non-existing directories are by definition clean…
761 if (DirectoryExists(Dir
) == false)
765 return _error
->Error(_("Clean of %s is not supported"), Dir
.c_str());
767 DIR *D
= opendir(Dir
.c_str());
769 return _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
771 string StartDir
= SafeGetCWD();
772 if (chdir(Dir
.c_str()) != 0)
775 return _error
->Errno("chdir",_("Unable to change to %s"),Dir
.c_str());
778 for (struct dirent
*Dir
= readdir(D
); Dir
!= 0; Dir
= readdir(D
))
781 if (strcmp(Dir
->d_name
,"lock") == 0 ||
782 strcmp(Dir
->d_name
,"partial") == 0 ||
783 strcmp(Dir
->d_name
,"lost+found") == 0 ||
784 strcmp(Dir
->d_name
,".") == 0 ||
785 strcmp(Dir
->d_name
,"..") == 0)
788 // Look in the get list
789 ItemCIterator I
= Items
.begin();
790 for (; I
!= Items
.end(); ++I
)
791 if (flNotDir((*I
)->DestFile
) == Dir
->d_name
)
794 // Nothing found, nuke it
795 if (I
== Items
.end())
796 RemoveFile("Clean", Dir
->d_name
);
800 if (chdir(StartDir
.c_str()) != 0)
801 return _error
->Errno("chdir",_("Unable to change to %s"),StartDir
.c_str());
805 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
806 // ---------------------------------------------------------------------
807 /* This is the total number of bytes needed */
808 APT_PURE
unsigned long long pkgAcquire::TotalNeeded()
810 return std::accumulate(ItemsBegin(), ItemsEnd(), 0llu,
811 [](unsigned long long const T
, Item
const * const I
) {
812 return T
+ I
->FileSize
;
816 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
817 // ---------------------------------------------------------------------
818 /* This is the number of bytes that is not local */
819 APT_PURE
unsigned long long pkgAcquire::FetchNeeded()
821 return std::accumulate(ItemsBegin(), ItemsEnd(), 0llu,
822 [](unsigned long long const T
, Item
const * const I
) {
823 if (I
->Local
== false)
824 return T
+ I
->FileSize
;
830 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
831 // ---------------------------------------------------------------------
832 /* This is the number of bytes that is not local */
833 APT_PURE
unsigned long long pkgAcquire::PartialPresent()
835 return std::accumulate(ItemsBegin(), ItemsEnd(), 0llu,
836 [](unsigned long long const T
, Item
const * const I
) {
837 if (I
->Local
== false)
838 return T
+ I
->PartialSize
;
844 // Acquire::UriBegin - Start iterator for the uri list /*{{{*/
845 // ---------------------------------------------------------------------
847 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
849 return UriIterator(Queues
);
852 // Acquire::UriEnd - End iterator for the uri list /*{{{*/
853 // ---------------------------------------------------------------------
855 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
857 return UriIterator(0);
860 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
861 // ---------------------------------------------------------------------
863 pkgAcquire::MethodConfig::MethodConfig() : d(NULL
), Next(0), SingleInstance(false),
864 Pipeline(false), SendConfig(false), LocalOnly(false), NeedsCleanup(false),
869 // Queue::Queue - Constructor /*{{{*/
870 // ---------------------------------------------------------------------
872 pkgAcquire::Queue::Queue(string
const &name
,pkgAcquire
* const owner
) : d(NULL
), Next(0),
873 Name(name
), Items(0), Workers(0), Owner(owner
), PipeDepth(0), MaxPipeDepth(1)
877 // Queue::~Queue - Destructor /*{{{*/
878 // ---------------------------------------------------------------------
880 pkgAcquire::Queue::~Queue()
892 // Queue::Enqueue - Queue an item to the queue /*{{{*/
893 // ---------------------------------------------------------------------
895 bool pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
898 // move to the end of the queue and check for duplicates here
899 for (; *I
!= 0; I
= &(*I
)->Next
)
900 if (Item
.URI
== (*I
)->URI
)
902 if (_config
->FindB("Debug::pkgAcquire::Worker",false) == true)
903 std::cerr
<< " @ Queue: Action combined for " << Item
.URI
<< " and " << (*I
)->URI
<< std::endl
;
904 (*I
)->Owners
.push_back(Item
.Owner
);
905 Item
.Owner
->Status
= (*I
)->Owner
->Status
;
910 QItem
*Itm
= new QItem
;
915 Item
.Owner
->QueueCounter
++;
916 if (Items
->Next
== 0)
921 // Queue::Dequeue - Remove an item from the queue /*{{{*/
922 // ---------------------------------------------------------------------
923 /* We return true if we hit something */
924 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
926 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
927 return _error
->Error("Tried to dequeue a fetching object");
934 if (Owner
== (*I
)->Owner
)
938 Owner
->QueueCounter
--;
949 // Queue::Startup - Start the worker processes /*{{{*/
950 // ---------------------------------------------------------------------
951 /* It is possible for this to be called with a pre-existing set of
953 bool pkgAcquire::Queue::Startup()
958 pkgAcquire::MethodConfig
* const Cnf
= Owner
->GetConfig(U
.Access
);
959 if (unlikely(Cnf
== nullptr))
962 // now-running twin of the pkgAcquire::Enqueue call
963 for (QItem
*I
= Items
; I
!= 0; )
965 auto const INext
= I
->Next
;
966 for (auto &&O
: I
->Owners
)
967 CheckForBadItemAndFailIt(O
, Cnf
, Owner
->Log
);
968 // if an item failed, it will be auto-dequeued invalidation our I here
972 Workers
= new Worker(this,Cnf
,Owner
->Log
);
974 if (Workers
->Start() == false)
977 /* When pipelining we commit 10 items. This needs to change when we
978 added other source retry to have cycle maintain a pipeline depth
980 if (Cnf
->Pipeline
== true)
981 MaxPipeDepth
= _config
->FindI("Acquire::Max-Pipeline-Depth",10);
989 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
990 // ---------------------------------------------------------------------
991 /* If final is true then all workers are eliminated, otherwise only workers
992 that do not need cleanup are removed */
993 bool pkgAcquire::Queue::Shutdown(bool Final
)
995 // Delete all of the workers
996 pkgAcquire::Worker
**Cur
= &Workers
;
999 pkgAcquire::Worker
*Jnk
= *Cur
;
1000 if (Final
== true || Jnk
->GetConf()->NeedsCleanup
== false)
1002 *Cur
= Jnk
->NextQueue
;
1007 Cur
= &(*Cur
)->NextQueue
;
1013 // Queue::FindItem - Find a URI in the item list /*{{{*/
1014 // ---------------------------------------------------------------------
1016 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
1018 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
1019 if (I
->URI
== URI
&& I
->Worker
== Owner
)
1024 // Queue::ItemDone - Item has been completed /*{{{*/
1025 // ---------------------------------------------------------------------
1026 /* The worker signals this which causes the item to be removed from the
1027 queue. If this is the last queue instance then it is removed from the
1029 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
1032 for (QItem::owner_iterator O
= Itm
->Owners
.begin(); O
!= Itm
->Owners
.end(); ++O
)
1034 if ((*O
)->Status
== pkgAcquire::Item::StatFetching
)
1035 (*O
)->Status
= pkgAcquire::Item::StatDone
;
1038 if (Itm
->Owner
->QueueCounter
<= 1)
1039 Owner
->Dequeue(Itm
->Owner
);
1042 Dequeue(Itm
->Owner
);
1049 // Queue::Cycle - Queue new items into the method /*{{{*/
1050 // ---------------------------------------------------------------------
1051 /* This locates a new idle item and sends it to the worker. If pipelining
1052 is enabled then it keeps the pipe full. */
1053 bool pkgAcquire::Queue::Cycle()
1055 if (Items
== 0 || Workers
== 0)
1059 return _error
->Error("Pipedepth failure");
1061 // Look for a queable item
1063 while (PipeDepth
< (signed)MaxPipeDepth
)
1065 for (; I
!= 0; I
= I
->Next
)
1066 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
1069 // Nothing to do, queue is idle.
1073 I
->Worker
= Workers
;
1074 for (auto const &O
: I
->Owners
)
1075 O
->Status
= pkgAcquire::Item::StatFetching
;
1077 if (Workers
->QueueItem(I
) == false)
1084 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
1085 // ---------------------------------------------------------------------
1086 /* This is called when an item in multiple queues is dequeued */
1087 void pkgAcquire::Queue::Bump()
1092 HashStringList
pkgAcquire::Queue::QItem::GetExpectedHashes() const /*{{{*/
1094 /* each Item can have multiple owners and each owner might have different
1095 hashes, even if that is unlikely in practice and if so at least some
1096 owners will later fail. There is one situation through which is not a
1097 failure and still needs this handling: Two owners who expect the same
1098 file, but one owner only knows the SHA1 while the other only knows SHA256. */
1099 HashStringList superhsl
;
1100 for (pkgAcquire::Queue::QItem::owner_iterator O
= Owners
.begin(); O
!= Owners
.end(); ++O
)
1102 HashStringList
const hsl
= (*O
)->GetExpectedHashes();
1103 if (hsl
.usable() == false)
1105 if (superhsl
.usable() == false)
1109 // we merge both lists - if we find disagreement send no hashes
1110 HashStringList::const_iterator hs
= hsl
.begin();
1111 for (; hs
!= hsl
.end(); ++hs
)
1112 if (superhsl
.push_back(*hs
) == false)
1114 if (hs
!= hsl
.end())
1124 APT_PURE
unsigned long long pkgAcquire::Queue::QItem::GetMaximumSize() const /*{{{*/
1126 unsigned long long Maximum
= std::numeric_limits
<unsigned long long>::max();
1127 for (auto const &O
: Owners
)
1129 if (O
->FileSize
== 0)
1131 Maximum
= std::min(Maximum
, O
->FileSize
);
1133 if (Maximum
== std::numeric_limits
<unsigned long long>::max())
1138 void pkgAcquire::Queue::QItem::SyncDestinationFiles() const /*{{{*/
1140 /* ensure that the first owner has the best partial file of all and
1141 the rest have (potentially dangling) symlinks to it so that
1142 everything (like progress reporting) finds it easily */
1143 std::string superfile
= Owner
->DestFile
;
1144 off_t supersize
= 0;
1145 for (pkgAcquire::Queue::QItem::owner_iterator O
= Owners
.begin(); O
!= Owners
.end(); ++O
)
1147 if ((*O
)->DestFile
== superfile
)
1150 if (lstat((*O
)->DestFile
.c_str(),&file
) == 0)
1152 if ((file
.st_mode
& S_IFREG
) == 0)
1153 RemoveFile("SyncDestinationFiles", (*O
)->DestFile
);
1154 else if (supersize
< file
.st_size
)
1156 supersize
= file
.st_size
;
1157 RemoveFile("SyncDestinationFiles", superfile
);
1158 rename((*O
)->DestFile
.c_str(), superfile
.c_str());
1161 RemoveFile("SyncDestinationFiles", (*O
)->DestFile
);
1162 if (symlink(superfile
.c_str(), (*O
)->DestFile
.c_str()) != 0)
1164 ; // not a problem per-se and no real alternative
1170 std::string
pkgAcquire::Queue::QItem::Custom600Headers() const /*{{{*/
1172 /* The others are relatively easy to merge, but this one?
1173 Lets not merge and see how far we can run with it…
1174 Likely, nobody will ever notice as all the items will
1175 be of the same class and hence generate the same headers. */
1176 return Owner
->Custom600Headers();
1180 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
1181 // ---------------------------------------------------------------------
1183 pkgAcquireStatus::pkgAcquireStatus() : d(NULL
), Percent(-1), Update(true), MorePulses(false)
1188 // AcquireStatus::Pulse - Called periodically /*{{{*/
1189 // ---------------------------------------------------------------------
1190 /* This computes some internal state variables for the derived classes to
1191 use. It generates the current downloaded bytes and total bytes to download
1192 as well as the current CPS estimate. */
1193 bool pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
1200 // Compute the total number of bytes to fetch
1201 unsigned int Unknown
= 0;
1202 unsigned int Count
= 0;
1203 bool ExpectAdditionalItems
= false;
1204 for (pkgAcquire::ItemCIterator I
= Owner
->ItemsBegin();
1205 I
!= Owner
->ItemsEnd();
1209 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
1212 // do we expect to acquire more files than we know of yet?
1213 if ((*I
)->ExpectedAdditionalItems
> 0)
1214 ExpectAdditionalItems
= true;
1216 TotalBytes
+= (*I
)->FileSize
;
1217 if ((*I
)->Complete
== true)
1218 CurrentBytes
+= (*I
)->FileSize
;
1219 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
1223 // Compute the current completion
1224 unsigned long long ResumeSize
= 0;
1225 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
1226 I
= Owner
->WorkerStep(I
))
1228 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
1230 CurrentBytes
+= I
->CurrentSize
;
1231 ResumeSize
+= I
->ResumePoint
;
1233 // Files with unknown size always have 100% completion
1234 if (I
->CurrentItem
->Owner
->FileSize
== 0 &&
1235 I
->CurrentItem
->Owner
->Complete
== false)
1236 TotalBytes
+= I
->CurrentSize
;
1240 // Normalize the figures and account for unknown size downloads
1241 if (TotalBytes
<= 0)
1243 if (Unknown
== Count
)
1244 TotalBytes
= Unknown
;
1246 // Wha?! Is not supposed to happen.
1247 if (CurrentBytes
> TotalBytes
)
1248 CurrentBytes
= TotalBytes
;
1251 struct timeval NewTime
;
1252 gettimeofday(&NewTime
,0);
1253 if ((NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
) ||
1254 NewTime
.tv_sec
- Time
.tv_sec
> 6)
1256 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
1257 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
1259 // Compute the CPS value
1263 CurrentCPS
= ((CurrentBytes
- ResumeSize
) - LastBytes
)/Delta
;
1264 LastBytes
= CurrentBytes
- ResumeSize
;
1265 ElapsedTime
= (unsigned long long)Delta
;
1269 double const OldPercent
= Percent
;
1270 // calculate the percentage, if we have too little data assume 1%
1271 if (ExpectAdditionalItems
)
1274 // use both files and bytes because bytes can be unreliable
1275 Percent
= (0.8 * (CurrentBytes
/float(TotalBytes
)*100.0) +
1276 0.2 * (CurrentItems
/float(TotalItems
)*100.0));
1279 if (_config
->FindB("Debug::acquire::progress", false) == true)
1283 << std::setw(5) << std::setprecision(4) << std::showpoint
<< Percent
1286 << SizeToStr(CurrentBytes
) << " / " << SizeToStr(TotalBytes
)
1288 << CurrentItems
<< " / " << TotalItems
1292 double const DiffPercent
= Percent
- OldPercent
;
1293 if (DiffPercent
< 0.001 && _config
->FindB("Acquire::Progress::Diffpercent", false) == true)
1296 int fd
= _config
->FindI("APT::Status-Fd",-1);
1299 ostringstream status
;
1302 long i
= CurrentItems
< TotalItems
? CurrentItems
+ 1 : CurrentItems
;
1303 unsigned long long ETA
= 0;
1305 ETA
= (TotalBytes
- CurrentBytes
) / CurrentCPS
;
1307 // only show the ETA if it makes sense
1308 if (ETA
> 0 && ETA
< 172800 /* two days */ )
1309 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li (%s remaining)"), i
, TotalItems
, TimeToStr(ETA
).c_str());
1311 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li"), i
, TotalItems
);
1313 // build the status str
1314 std::ostringstream str
;
1315 str
.imbue(std::locale::classic());
1317 str
<< "dlstatus" << ':' << std::fixed
<< i
<< ':' << Percent
<< ':' << msg
<< '\n';
1318 auto const dlstatus
= str
.str();
1319 FileFd::Write(fd
, dlstatus
.data(), dlstatus
.size());
1325 // AcquireStatus::Start - Called when the download is started /*{{{*/
1326 // ---------------------------------------------------------------------
1327 /* We just reset the counters */
1328 void pkgAcquireStatus::Start()
1330 gettimeofday(&Time
,0);
1331 gettimeofday(&StartTime
,0);
1342 // AcquireStatus::Stop - Finished downloading /*{{{*/
1343 // ---------------------------------------------------------------------
1344 /* This accurately computes the elapsed time and the total overall CPS. */
1345 void pkgAcquireStatus::Stop()
1347 // Compute the CPS and elapsed time
1348 struct timeval NewTime
;
1349 gettimeofday(&NewTime
,0);
1351 double Delta
= NewTime
.tv_sec
- StartTime
.tv_sec
+
1352 (NewTime
.tv_usec
- StartTime
.tv_usec
)/1000000.0;
1354 // Compute the CPS value
1358 CurrentCPS
= FetchedBytes
/Delta
;
1359 LastBytes
= CurrentBytes
;
1360 ElapsedTime
= (unsigned long long)Delta
;
1363 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
1364 // ---------------------------------------------------------------------
1365 /* This is used to get accurate final transfer rate reporting. */
1366 void pkgAcquireStatus::Fetched(unsigned long long Size
,unsigned long long Resume
)
1368 FetchedBytes
+= Size
- Resume
;
1372 pkgAcquire::UriIterator::UriIterator(pkgAcquire::Queue
*Q
) : d(NULL
), CurQ(Q
), CurItem(0)
1374 while (CurItem
== 0 && CurQ
!= 0)
1376 CurItem
= CurQ
->Items
;
1381 APT_CONST
pkgAcquire::UriIterator::~UriIterator() {}
1382 APT_CONST
pkgAcquire::MethodConfig::~MethodConfig() {}
1383 APT_CONST
pkgAcquireStatus::~pkgAcquireStatus() {}