]>
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 FullQueueName
= AccessSchema
+ U
.Host
;
356 unsigned int Instances
= 0, SchemaLength
= AccessSchema
.length();
359 for (; I
!= 0; I
= I
->Next
) {
360 // if the queue already exists, re-use it
361 if (I
->Name
== FullQueueName
)
362 return FullQueueName
;
364 if (I
->Name
.compare(0, SchemaLength
, AccessSchema
) == 0)
369 clog
<< "Found " << Instances
<< " instances of " << U
.Access
<< endl
;
372 if (Instances
>= (unsigned int)_config
->FindI("Acquire::QueueHost::Limit",10))
375 return FullQueueName
;
378 // Acquire::GetConfig - Fetch the configuration information /*{{{*/
379 // ---------------------------------------------------------------------
380 /* This locates the configuration structure for an access method. If
381 a config structure cannot be found a Worker will be created to
383 pkgAcquire::MethodConfig
*pkgAcquire::GetConfig(string Access
)
385 // Search for an existing config
387 for (Conf
= Configs
; Conf
!= 0; Conf
= Conf
->Next
)
388 if (Conf
->Access
== Access
)
391 // Create the new config class
392 Conf
= new MethodConfig
;
393 Conf
->Access
= Access
;
394 Conf
->Next
= Configs
;
397 // Create the worker to fetch the configuration
399 if (Work
.Start() == false)
402 /* if a method uses DownloadLimit, we switch to SingleInstance mode */
403 if(_config
->FindI("Acquire::"+Access
+"::Dl-Limit",0) > 0)
404 Conf
->SingleInstance
= true;
409 // Acquire::SetFds - Deal with readable FDs /*{{{*/
410 // ---------------------------------------------------------------------
411 /* Collect FDs that have activity monitors into the fd sets */
412 void pkgAcquire::SetFds(int &Fd
,fd_set
*RSet
,fd_set
*WSet
)
414 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
416 if (I
->InReady
== true && I
->InFd
>= 0)
420 FD_SET(I
->InFd
,RSet
);
422 if (I
->OutReady
== true && I
->OutFd
>= 0)
426 FD_SET(I
->OutFd
,WSet
);
431 // Acquire::RunFds - Deal with active FDs /*{{{*/
432 // ---------------------------------------------------------------------
433 /* Dispatch active FDs over to the proper workers. It is very important
434 that a worker never be erased while this is running! The queue class
435 should never erase a worker except during shutdown processing. */
436 void pkgAcquire::RunFds(fd_set
*RSet
,fd_set
*WSet
)
438 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
440 if (I
->InFd
>= 0 && FD_ISSET(I
->InFd
,RSet
) != 0)
442 if (I
->OutFd
>= 0 && FD_ISSET(I
->OutFd
,WSet
) != 0)
447 // Acquire::Run - Run the fetch sequence /*{{{*/
448 // ---------------------------------------------------------------------
449 /* This runs the queues. It manages a select loop for all of the
450 Worker tasks. The workers interact with the queues and items to
451 manage the actual fetch. */
452 static bool IsAccessibleBySandboxUser(std::string
const &filename
, bool const ReadWrite
)
454 // you would think this is easily to answer with faccessat, right? Wrong!
455 // It e.g. gets groups wrong, so the only thing which works reliable is trying
456 // to open the file we want to open later on…
457 if (unlikely(filename
.empty()))
460 if (ReadWrite
== false)
463 // can we read a file? Note that non-existing files are "fine"
464 int const fd
= open(filename
.c_str(), O_RDONLY
| O_CLOEXEC
);
465 if (fd
== -1 && errno
== EACCES
)
472 // the file might not exist yet and even if it does we will fix permissions,
473 // so important is here just that the directory it is in allows that
474 std::string
const dirname
= flNotFile(filename
);
475 if (unlikely(dirname
.empty()))
478 char const * const filetag
= ".apt-acquire-privs-test.XXXXXX";
479 std::string
const tmpfile_tpl
= flCombine(dirname
, filetag
);
480 std::unique_ptr
<char, decltype(std::free
) *> tmpfile
{ strdup(tmpfile_tpl
.c_str()), std::free
};
481 int const fd
= mkstemp(tmpfile
.get());
482 if (fd
== -1 && errno
== EACCES
)
484 RemoveFile("IsAccessibleBySandboxUser", tmpfile
.get());
489 static void CheckDropPrivsMustBeDisabled(pkgAcquire
const &Fetcher
)
494 std::string
const SandboxUser
= _config
->Find("APT::Sandbox::User");
495 if (SandboxUser
.empty() || SandboxUser
== "root")
498 struct passwd
const * const pw
= getpwnam(SandboxUser
.c_str());
502 gid_t
const old_euid
= geteuid();
503 gid_t
const old_egid
= getegid();
505 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
506 std::unique_ptr
<gid_t
[]> old_gidlist(new gid_t
[ngroups_max
]);
507 if (unlikely(old_gidlist
== NULL
))
509 ssize_t old_gidlist_nr
;
510 if ((old_gidlist_nr
= getgroups(ngroups_max
, old_gidlist
.get())) < 0)
512 _error
->FatalE("getgroups", "getgroups %lu failed", ngroups_max
);
516 if (setgroups(1, &pw
->pw_gid
))
517 _error
->FatalE("setgroups", "setgroups %u failed", pw
->pw_gid
);
519 if (setegid(pw
->pw_gid
) != 0)
520 _error
->FatalE("setegid", "setegid %u failed", pw
->pw_gid
);
521 if (seteuid(pw
->pw_uid
) != 0)
522 _error
->FatalE("seteuid", "seteuid %u failed", pw
->pw_uid
);
524 for (pkgAcquire::ItemCIterator I
= Fetcher
.ItemsBegin();
525 I
!= Fetcher
.ItemsEnd(); ++I
)
527 // no need to drop privileges for a complete file
528 if ((*I
)->Complete
== true)
531 // if destination file is inaccessible all hope is lost for privilege dropping
532 if (IsAccessibleBySandboxUser((*I
)->DestFile
, true) == false)
534 _error
->WarningE("pkgAcquire::Run", _("Can't drop privileges for downloading as file '%s' couldn't be accessed by user '%s'."),
535 (*I
)->DestFile
.c_str(), SandboxUser
.c_str());
536 _config
->Set("APT::Sandbox::User", "");
540 // if its the source file (e.g. local sources) we might be lucky
541 // by dropping the dropping only for some methods.
542 URI
const source
= (*I
)->DescURI();
543 if (source
.Access
== "file" || source
.Access
== "copy")
545 std::string
const conf
= "Binary::" + source
.Access
+ "::APT::Sandbox::User";
546 if (_config
->Exists(conf
) == true)
549 if (IsAccessibleBySandboxUser(source
.Path
, false) == false)
551 _error
->NoticeE("pkgAcquire::Run", _("Can't drop privileges for downloading as file '%s' couldn't be accessed by user '%s'."),
552 source
.Path
.c_str(), SandboxUser
.c_str());
553 _config
->CndSet("Binary::file::APT::Sandbox::User", "root");
554 _config
->CndSet("Binary::copy::APT::Sandbox::User", "root");
559 if (seteuid(old_euid
) != 0)
560 _error
->FatalE("seteuid", "seteuid %u failed", old_euid
);
561 if (setegid(old_egid
) != 0)
562 _error
->FatalE("setegid", "setegid %u failed", old_egid
);
563 if (setgroups(old_gidlist_nr
, old_gidlist
.get()))
564 _error
->FatalE("setgroups", "setgroups %u failed", 0);
566 pkgAcquire::RunResult
pkgAcquire::Run(int PulseIntervall
)
568 _error
->PushToStack();
569 CheckDropPrivsMustBeDisabled(*this);
573 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
579 bool WasCancelled
= false;
581 // Run till all things have been acquired
584 tv
.tv_usec
= PulseIntervall
;
592 SetFds(Highest
,&RFds
,&WFds
);
597 Res
= select(Highest
+1,&RFds
,&WFds
,0,&tv
);
599 while (Res
< 0 && errno
== EINTR
);
603 _error
->Errno("select","Select has failed");
609 // Timeout, notify the log class
610 if (Res
== 0 || (Log
!= 0 && Log
->Update
== true))
612 tv
.tv_usec
= PulseIntervall
;
613 for (Worker
*I
= Workers
; I
!= 0; I
= I
->NextAcquire
)
615 if (Log
!= 0 && Log
->Pulse(this) == false)
626 // Shut down the acquire bits
628 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
631 // Shut down the items
632 for (ItemIterator I
= Items
.begin(); I
!= Items
.end(); ++I
)
635 bool const newError
= _error
->PendingError();
636 _error
->MergeWithStack();
644 // Acquire::Bump - Called when an item is dequeued /*{{{*/
645 // ---------------------------------------------------------------------
646 /* This routine bumps idle queues in hopes that they will be able to fetch
648 void pkgAcquire::Bump()
650 for (Queue
*I
= Queues
; I
!= 0; I
= I
->Next
)
654 // Acquire::WorkerStep - Step to the next worker /*{{{*/
655 // ---------------------------------------------------------------------
656 /* Not inlined to advoid including acquire-worker.h */
657 pkgAcquire::Worker
*pkgAcquire::WorkerStep(Worker
*I
)
659 return I
->NextAcquire
;
662 // Acquire::Clean - Cleans a directory /*{{{*/
663 // ---------------------------------------------------------------------
664 /* This is a bit simplistic, it looks at every file in the dir and sees
665 if it is part of the download set. */
666 bool pkgAcquire::Clean(string Dir
)
668 // non-existing directories are by definition clean…
669 if (DirectoryExists(Dir
) == false)
673 return _error
->Error(_("Clean of %s is not supported"), Dir
.c_str());
675 DIR *D
= opendir(Dir
.c_str());
677 return _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
679 string StartDir
= SafeGetCWD();
680 if (chdir(Dir
.c_str()) != 0)
683 return _error
->Errno("chdir",_("Unable to change to %s"),Dir
.c_str());
686 for (struct dirent
*Dir
= readdir(D
); Dir
!= 0; Dir
= readdir(D
))
689 if (strcmp(Dir
->d_name
,"lock") == 0 ||
690 strcmp(Dir
->d_name
,"partial") == 0 ||
691 strcmp(Dir
->d_name
,".") == 0 ||
692 strcmp(Dir
->d_name
,"..") == 0)
695 // Look in the get list
696 ItemCIterator I
= Items
.begin();
697 for (; I
!= Items
.end(); ++I
)
698 if (flNotDir((*I
)->DestFile
) == Dir
->d_name
)
701 // Nothing found, nuke it
702 if (I
== Items
.end())
703 RemoveFile("Clean", Dir
->d_name
);
707 if (chdir(StartDir
.c_str()) != 0)
708 return _error
->Errno("chdir",_("Unable to change to %s"),StartDir
.c_str());
712 // Acquire::TotalNeeded - Number of bytes to fetch /*{{{*/
713 // ---------------------------------------------------------------------
714 /* This is the total number of bytes needed */
715 APT_PURE
unsigned long long pkgAcquire::TotalNeeded()
717 return std::accumulate(ItemsBegin(), ItemsEnd(), 0,
718 [](unsigned long long const T
, Item
const * const I
) {
719 return T
+ I
->FileSize
;
723 // Acquire::FetchNeeded - Number of bytes needed to get /*{{{*/
724 // ---------------------------------------------------------------------
725 /* This is the number of bytes that is not local */
726 APT_PURE
unsigned long long pkgAcquire::FetchNeeded()
728 return std::accumulate(ItemsBegin(), ItemsEnd(), 0,
729 [](unsigned long long const T
, Item
const * const I
) {
730 if (I
->Local
== false)
731 return T
+ I
->FileSize
;
737 // Acquire::PartialPresent - Number of partial bytes we already have /*{{{*/
738 // ---------------------------------------------------------------------
739 /* This is the number of bytes that is not local */
740 APT_PURE
unsigned long long pkgAcquire::PartialPresent()
742 return std::accumulate(ItemsBegin(), ItemsEnd(), 0,
743 [](unsigned long long const T
, Item
const * const I
) {
744 if (I
->Local
== false)
745 return T
+ I
->PartialSize
;
751 // Acquire::UriBegin - Start iterator for the uri list /*{{{*/
752 // ---------------------------------------------------------------------
754 pkgAcquire::UriIterator
pkgAcquire::UriBegin()
756 return UriIterator(Queues
);
759 // Acquire::UriEnd - End iterator for the uri list /*{{{*/
760 // ---------------------------------------------------------------------
762 pkgAcquire::UriIterator
pkgAcquire::UriEnd()
764 return UriIterator(0);
767 // Acquire::MethodConfig::MethodConfig - Constructor /*{{{*/
768 // ---------------------------------------------------------------------
770 pkgAcquire::MethodConfig::MethodConfig() : d(NULL
), Next(0), SingleInstance(false),
771 Pipeline(false), SendConfig(false), LocalOnly(false), NeedsCleanup(false),
776 // Queue::Queue - Constructor /*{{{*/
777 // ---------------------------------------------------------------------
779 pkgAcquire::Queue::Queue(string
const &name
,pkgAcquire
* const owner
) : d(NULL
), Next(0),
780 Name(name
), Items(0), Workers(0), Owner(owner
), PipeDepth(0), MaxPipeDepth(1)
784 // Queue::~Queue - Destructor /*{{{*/
785 // ---------------------------------------------------------------------
787 pkgAcquire::Queue::~Queue()
799 // Queue::Enqueue - Queue an item to the queue /*{{{*/
800 // ---------------------------------------------------------------------
802 bool pkgAcquire::Queue::Enqueue(ItemDesc
&Item
)
805 // move to the end of the queue and check for duplicates here
806 HashStringList
const hsl
= Item
.Owner
->GetExpectedHashes();
807 for (; *I
!= 0; I
= &(*I
)->Next
)
808 if (Item
.URI
== (*I
)->URI
|| hsl
== (*I
)->Owner
->GetExpectedHashes())
810 if (_config
->FindB("Debug::pkgAcquire::Worker",false) == true)
811 std::cerr
<< " @ Queue: Action combined for " << Item
.URI
<< " and " << (*I
)->URI
<< std::endl
;
812 (*I
)->Owners
.push_back(Item
.Owner
);
813 Item
.Owner
->Status
= (*I
)->Owner
->Status
;
818 QItem
*Itm
= new QItem
;
823 Item
.Owner
->QueueCounter
++;
824 if (Items
->Next
== 0)
829 // Queue::Dequeue - Remove an item from the queue /*{{{*/
830 // ---------------------------------------------------------------------
831 /* We return true if we hit something */
832 bool pkgAcquire::Queue::Dequeue(Item
*Owner
)
834 if (Owner
->Status
== pkgAcquire::Item::StatFetching
)
835 return _error
->Error("Tried to dequeue a fetching object");
842 if (Owner
== (*I
)->Owner
)
846 Owner
->QueueCounter
--;
857 // Queue::Startup - Start the worker processes /*{{{*/
858 // ---------------------------------------------------------------------
859 /* It is possible for this to be called with a pre-existing set of
861 bool pkgAcquire::Queue::Startup()
866 pkgAcquire::MethodConfig
*Cnf
= Owner
->GetConfig(U
.Access
);
870 Workers
= new Worker(this,Cnf
,Owner
->Log
);
872 if (Workers
->Start() == false)
875 /* When pipelining we commit 10 items. This needs to change when we
876 added other source retry to have cycle maintain a pipeline depth
878 if (Cnf
->Pipeline
== true)
879 MaxPipeDepth
= _config
->FindI("Acquire::Max-Pipeline-Depth",10);
887 // Queue::Shutdown - Shutdown the worker processes /*{{{*/
888 // ---------------------------------------------------------------------
889 /* If final is true then all workers are eliminated, otherwise only workers
890 that do not need cleanup are removed */
891 bool pkgAcquire::Queue::Shutdown(bool Final
)
893 // Delete all of the workers
894 pkgAcquire::Worker
**Cur
= &Workers
;
897 pkgAcquire::Worker
*Jnk
= *Cur
;
898 if (Final
== true || Jnk
->GetConf()->NeedsCleanup
== false)
900 *Cur
= Jnk
->NextQueue
;
905 Cur
= &(*Cur
)->NextQueue
;
911 // Queue::FindItem - Find a URI in the item list /*{{{*/
912 // ---------------------------------------------------------------------
914 pkgAcquire::Queue::QItem
*pkgAcquire::Queue::FindItem(string URI
,pkgAcquire::Worker
*Owner
)
916 for (QItem
*I
= Items
; I
!= 0; I
= I
->Next
)
917 if (I
->URI
== URI
&& I
->Worker
== Owner
)
922 // Queue::ItemDone - Item has been completed /*{{{*/
923 // ---------------------------------------------------------------------
924 /* The worker signals this which causes the item to be removed from the
925 queue. If this is the last queue instance then it is removed from the
927 bool pkgAcquire::Queue::ItemDone(QItem
*Itm
)
930 for (QItem::owner_iterator O
= Itm
->Owners
.begin(); O
!= Itm
->Owners
.end(); ++O
)
932 if ((*O
)->Status
== pkgAcquire::Item::StatFetching
)
933 (*O
)->Status
= pkgAcquire::Item::StatDone
;
936 if (Itm
->Owner
->QueueCounter
<= 1)
937 Owner
->Dequeue(Itm
->Owner
);
947 // Queue::Cycle - Queue new items into the method /*{{{*/
948 // ---------------------------------------------------------------------
949 /* This locates a new idle item and sends it to the worker. If pipelining
950 is enabled then it keeps the pipe full. */
951 bool pkgAcquire::Queue::Cycle()
953 if (Items
== 0 || Workers
== 0)
957 return _error
->Error("Pipedepth failure");
959 // Look for a queable item
961 while (PipeDepth
< (signed)MaxPipeDepth
)
963 for (; I
!= 0; I
= I
->Next
)
964 if (I
->Owner
->Status
== pkgAcquire::Item::StatIdle
)
967 // Nothing to do, queue is idle.
972 for (auto const &O
: I
->Owners
)
973 O
->Status
= pkgAcquire::Item::StatFetching
;
975 if (Workers
->QueueItem(I
) == false)
982 // Queue::Bump - Fetch any pending objects if we are idle /*{{{*/
983 // ---------------------------------------------------------------------
984 /* This is called when an item in multiple queues is dequeued */
985 void pkgAcquire::Queue::Bump()
990 HashStringList
pkgAcquire::Queue::QItem::GetExpectedHashes() const /*{{{*/
992 /* each Item can have multiple owners and each owner might have different
993 hashes, even if that is unlikely in practice and if so at least some
994 owners will later fail. There is one situation through which is not a
995 failure and still needs this handling: Two owners who expect the same
996 file, but one owner only knows the SHA1 while the other only knows SHA256. */
997 HashStringList superhsl
;
998 for (pkgAcquire::Queue::QItem::owner_iterator O
= Owners
.begin(); O
!= Owners
.end(); ++O
)
1000 HashStringList
const hsl
= (*O
)->GetExpectedHashes();
1001 if (hsl
.usable() == false)
1003 if (superhsl
.usable() == false)
1007 // we merge both lists - if we find disagreement send no hashes
1008 HashStringList::const_iterator hs
= hsl
.begin();
1009 for (; hs
!= hsl
.end(); ++hs
)
1010 if (superhsl
.push_back(*hs
) == false)
1012 if (hs
!= hsl
.end())
1022 APT_PURE
unsigned long long pkgAcquire::Queue::QItem::GetMaximumSize() const /*{{{*/
1024 unsigned long long Maximum
= std::numeric_limits
<unsigned long long>::max();
1025 for (auto const &O
: Owners
)
1027 if (O
->FileSize
== 0)
1029 Maximum
= std::min(Maximum
, O
->FileSize
);
1031 if (Maximum
== std::numeric_limits
<unsigned long long>::max())
1036 void pkgAcquire::Queue::QItem::SyncDestinationFiles() const /*{{{*/
1038 /* ensure that the first owner has the best partial file of all and
1039 the rest have (potentially dangling) symlinks to it so that
1040 everything (like progress reporting) finds it easily */
1041 std::string superfile
= Owner
->DestFile
;
1042 off_t supersize
= 0;
1043 for (pkgAcquire::Queue::QItem::owner_iterator O
= Owners
.begin(); O
!= Owners
.end(); ++O
)
1045 if ((*O
)->DestFile
== superfile
)
1048 if (lstat((*O
)->DestFile
.c_str(),&file
) == 0)
1050 if ((file
.st_mode
& S_IFREG
) == 0)
1051 RemoveFile("SyncDestinationFiles", (*O
)->DestFile
);
1052 else if (supersize
< file
.st_size
)
1054 supersize
= file
.st_size
;
1055 RemoveFile("SyncDestinationFiles", superfile
);
1056 rename((*O
)->DestFile
.c_str(), superfile
.c_str());
1059 RemoveFile("SyncDestinationFiles", (*O
)->DestFile
);
1060 if (symlink(superfile
.c_str(), (*O
)->DestFile
.c_str()) != 0)
1062 ; // not a problem per-se and no real alternative
1068 std::string
pkgAcquire::Queue::QItem::Custom600Headers() const /*{{{*/
1070 /* The others are relatively easy to merge, but this one?
1071 Lets not merge and see how far we can run with it…
1072 Likely, nobody will ever notice as all the items will
1073 be of the same class and hence generate the same headers. */
1074 return Owner
->Custom600Headers();
1078 // AcquireStatus::pkgAcquireStatus - Constructor /*{{{*/
1079 // ---------------------------------------------------------------------
1081 pkgAcquireStatus::pkgAcquireStatus() : d(NULL
), Percent(-1), Update(true), MorePulses(false)
1086 // AcquireStatus::Pulse - Called periodically /*{{{*/
1087 // ---------------------------------------------------------------------
1088 /* This computes some internal state variables for the derived classes to
1089 use. It generates the current downloaded bytes and total bytes to download
1090 as well as the current CPS estimate. */
1091 bool pkgAcquireStatus::Pulse(pkgAcquire
*Owner
)
1098 // Compute the total number of bytes to fetch
1099 unsigned int Unknown
= 0;
1100 unsigned int Count
= 0;
1101 bool UnfetchedReleaseFiles
= false;
1102 for (pkgAcquire::ItemCIterator I
= Owner
->ItemsBegin();
1103 I
!= Owner
->ItemsEnd();
1107 if ((*I
)->Status
== pkgAcquire::Item::StatDone
)
1110 // Totally ignore local items
1111 if ((*I
)->Local
== true)
1114 // see if the method tells us to expect more
1115 TotalItems
+= (*I
)->ExpectedAdditionalItems
;
1117 // check if there are unfetched Release files
1118 if ((*I
)->Complete
== false && (*I
)->ExpectedAdditionalItems
> 0)
1119 UnfetchedReleaseFiles
= true;
1121 TotalBytes
+= (*I
)->FileSize
;
1122 if ((*I
)->Complete
== true)
1123 CurrentBytes
+= (*I
)->FileSize
;
1124 if ((*I
)->FileSize
== 0 && (*I
)->Complete
== false)
1128 // Compute the current completion
1129 unsigned long long ResumeSize
= 0;
1130 for (pkgAcquire::Worker
*I
= Owner
->WorkersBegin(); I
!= 0;
1131 I
= Owner
->WorkerStep(I
))
1133 if (I
->CurrentItem
!= 0 && I
->CurrentItem
->Owner
->Complete
== false)
1135 CurrentBytes
+= I
->CurrentSize
;
1136 ResumeSize
+= I
->ResumePoint
;
1138 // Files with unknown size always have 100% completion
1139 if (I
->CurrentItem
->Owner
->FileSize
== 0 &&
1140 I
->CurrentItem
->Owner
->Complete
== false)
1141 TotalBytes
+= I
->CurrentSize
;
1145 // Normalize the figures and account for unknown size downloads
1146 if (TotalBytes
<= 0)
1148 if (Unknown
== Count
)
1149 TotalBytes
= Unknown
;
1151 // Wha?! Is not supposed to happen.
1152 if (CurrentBytes
> TotalBytes
)
1153 CurrentBytes
= TotalBytes
;
1156 if (_config
->FindB("Debug::acquire::progress", false) == true)
1157 std::clog
<< " Bytes: "
1158 << SizeToStr(CurrentBytes
) << " / " << SizeToStr(TotalBytes
)
1162 struct timeval NewTime
;
1163 gettimeofday(&NewTime
,0);
1164 if ((NewTime
.tv_sec
- Time
.tv_sec
== 6 && NewTime
.tv_usec
> Time
.tv_usec
) ||
1165 NewTime
.tv_sec
- Time
.tv_sec
> 6)
1167 double Delta
= NewTime
.tv_sec
- Time
.tv_sec
+
1168 (NewTime
.tv_usec
- Time
.tv_usec
)/1000000.0;
1170 // Compute the CPS value
1174 CurrentCPS
= ((CurrentBytes
- ResumeSize
) - LastBytes
)/Delta
;
1175 LastBytes
= CurrentBytes
- ResumeSize
;
1176 ElapsedTime
= (unsigned long long)Delta
;
1180 double const OldPercent
= Percent
;
1181 // calculate the percentage, if we have too little data assume 1%
1182 if (TotalBytes
> 0 && UnfetchedReleaseFiles
)
1185 // use both files and bytes because bytes can be unreliable
1186 Percent
= (0.8 * (CurrentBytes
/float(TotalBytes
)*100.0) +
1187 0.2 * (CurrentItems
/float(TotalItems
)*100.0));
1188 double const DiffPercent
= Percent
- OldPercent
;
1189 if (DiffPercent
< 0.001 && _config
->FindB("Acquire::Progress::Diffpercent", false) == true)
1192 int fd
= _config
->FindI("APT::Status-Fd",-1);
1195 ostringstream status
;
1198 long i
= CurrentItems
< TotalItems
? CurrentItems
+ 1 : CurrentItems
;
1199 unsigned long long ETA
= 0;
1201 ETA
= (TotalBytes
- CurrentBytes
) / CurrentCPS
;
1203 // only show the ETA if it makes sense
1204 if (ETA
> 0 && ETA
< 172800 /* two days */ )
1205 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li (%s remaining)"), i
, TotalItems
, TimeToStr(ETA
).c_str());
1207 snprintf(msg
,sizeof(msg
), _("Retrieving file %li of %li"), i
, TotalItems
);
1209 // build the status str
1210 status
<< "dlstatus:" << i
1211 << ":" << std::setprecision(3) << Percent
1215 std::string
const dlstatus
= status
.str();
1216 FileFd::Write(fd
, dlstatus
.c_str(), dlstatus
.size());
1222 // AcquireStatus::Start - Called when the download is started /*{{{*/
1223 // ---------------------------------------------------------------------
1224 /* We just reset the counters */
1225 void pkgAcquireStatus::Start()
1227 gettimeofday(&Time
,0);
1228 gettimeofday(&StartTime
,0);
1239 // AcquireStatus::Stop - Finished downloading /*{{{*/
1240 // ---------------------------------------------------------------------
1241 /* This accurately computes the elapsed time and the total overall CPS. */
1242 void pkgAcquireStatus::Stop()
1244 // Compute the CPS and elapsed time
1245 struct timeval NewTime
;
1246 gettimeofday(&NewTime
,0);
1248 double Delta
= NewTime
.tv_sec
- StartTime
.tv_sec
+
1249 (NewTime
.tv_usec
- StartTime
.tv_usec
)/1000000.0;
1251 // Compute the CPS value
1255 CurrentCPS
= FetchedBytes
/Delta
;
1256 LastBytes
= CurrentBytes
;
1257 ElapsedTime
= (unsigned long long)Delta
;
1260 // AcquireStatus::Fetched - Called when a byte set has been fetched /*{{{*/
1261 // ---------------------------------------------------------------------
1262 /* This is used to get accurate final transfer rate reporting. */
1263 void pkgAcquireStatus::Fetched(unsigned long long Size
,unsigned long long Resume
)
1265 FetchedBytes
+= Size
- Resume
;
1269 pkgAcquire::UriIterator::UriIterator(pkgAcquire::Queue
*Q
) : d(NULL
), CurQ(Q
), CurItem(0)
1271 while (CurItem
== 0 && CurQ
!= 0)
1273 CurItem
= CurQ
->Items
;
1278 APT_CONST
pkgAcquire::UriIterator::~UriIterator() {}
1279 APT_CONST
pkgAcquire::MethodConfig::~MethodConfig() {}
1280 APT_CONST
pkgAcquireStatus::~pkgAcquireStatus() {}