]> git.saurik.com Git - apt.git/blame - apt-pkg/pkgcache.h
deal with configured build-essential first
[apt.git] / apt-pkg / pkgcache.h
CommitLineData
578bfd0a
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
94449d7c
DK
3/**\file pkgcache.h
4 \brief pkgCache - Structure definitions for the cache file
5
6 The goal of the cache file is two fold:
7 Firstly to speed loading and processing of the package file array and
8 secondly to reduce memory consumption of the package file array.
9
10 The implementation is aimed at an environment with many primary package
11 files, for instance someone that has a Package file for their CD-ROM, a
12 Package file for the latest version of the distribution on the CD-ROM and a
13 package file for the development version. Always present is the information
14 contained in the status file which might be considered a separate package
15 file.
16
17 Please understand, this is designed as a <b>Cache file</b> it is not meant to be
18 used on any system other than the one it was created for. It is not meant to
19 be authoritative either, i.e. if a system crash or software failure occurs it
20 must be perfectly acceptable for the cache file to be in an inconsistent
21 state. Furthermore at any time the cache file may be erased without losing
22 any information.
23
24 Also the structures and storage layout is optimized for use by the APT
25 and may not be suitable for all purposes. However it should be possible
26 to extend it with associate cache files that contain other information.
27
28 To keep memory use down the cache file only contains often used fields and
29 fields that are inexpensive to store, the Package file has a full list of
30 fields. Also the client may assume that all items are perfectly valid and
31 need not perform checks against their correctness. Removal of information
32 from the cache is possible, but blanks will be left in the file, and
33 unused strings will also be present. The recommended implementation is to
34 simply rebuild the cache each time any of the data files change. It is
35 possible to add a new package file to the cache without any negative side
36 effects.
37
38 <b>Note on Pointer access</b>
578bfd0a 39 Clients should always use the CacheIterators classes for access to the
94449d7c
DK
40 cache and the data in it. They also provide a simple STL-like method for
41 traversing the links of the datastructure.
42
43 Every item in every structure is stored as the index to that structure.
44 What this means is that once the files is mmaped every data access has to
45 go through a fix up stage to get a real memory pointer. This is done
46 by taking the index, multiplying it by the type size and then adding
47 it to the start address of the memory block. This sounds complex, but
48 in C it is a single array dereference. Because all items are aligned to
49 their size and indexes are stored as multiples of the size of the structure
50 the format is immediately portable to all possible architectures - BUT the
51 generated files are -NOT-.
52
53 This scheme allows code like this to be written:
54 <example>
55 void *Map = mmap(...);
56 Package *PkgList = (Package *)Map;
57 Header *Head = (Header *)Map;
58 char *Strings = (char *)Map;
59 cout << (Strings + PkgList[Head->HashTable[0]]->Name) << endl;
60 </example>
61 Notice the lack of casting or multiplication. The net result is to return
62 the name of the first package in the first hash bucket, without error
63 checks.
64
65 The generator uses allocation pools to group similarly sized structures in
66 large blocks to eliminate any alignment overhead. The generator also
67 assures that no structures overlap and all indexes are unique. Although
68 at first glance it may seem like there is the potential for two structures
69 to exist at the same point the generator never allows this to happen.
70 (See the discussion of free space pools)
71
72 See \ref pkgcachegen.h for more information about generating cache structures. */
578bfd0a 73 /*}}}*/
578bfd0a
AL
74#ifndef PKGLIB_PKGCACHE_H
75#define PKGLIB_PKGCACHE_H
76
a02db58f
DK
77#include <apt-pkg/mmap.h>
78#include <apt-pkg/macros.h>
79
578bfd0a
AL
80#include <string>
81#include <time.h>
4ad8619b 82#include <stdint.h>
0a843901 83
a4f6bdc8
DK
84#ifndef APT_8_CLEANER_HEADERS
85using std::string;
86#endif
87
4dc77823
DK
88// size of (potentially big) files like debs or the install size of them
89typedef uint64_t map_filesize_t;
4ad8619b 90// storing file sizes of indexes, which are way below 4 GB for now
4dc77823 91typedef uint32_t map_filesize_small_t;
4ad8619b
DK
92// each package/group/dependency gets an id
93typedef uint32_t map_id_t;
94// some files get an id, too, but in far less absolute numbers
95typedef uint16_t map_fileid_t;
96// relative pointer from cache start
97typedef uint32_t map_pointer_t;
98// same as the previous, but documented to be to a string item
99typedef map_pointer_t map_stringitem_t;
dfe66c72
DK
100// we have only a small amount of flags for each item
101typedef uint8_t map_flags_t;
102typedef uint8_t map_number_t;
4ad8619b 103
b2e465d6 104class pkgVersioningSystem;
92fcbfc1 105class pkgCache /*{{{*/
578bfd0a
AL
106{
107 public:
108 // Cache element predeclarations
109 struct Header;
5bf15716 110 struct Group;
578bfd0a 111 struct Package;
b07aeb1a 112 struct ReleaseFile;
578bfd0a
AL
113 struct PackageFile;
114 struct Version;
a52f938b 115 struct Description;
578bfd0a
AL
116 struct Provides;
117 struct Dependency;
71c9e95b 118 struct DependencyData;
32ab4bd0 119 struct StringItem;
dcb79bae 120 struct VerFile;
a52f938b 121 struct DescFile;
578bfd0a
AL
122
123 // Iterators
773e2c1f 124 template<typename Str, typename Itr> class Iterator;
5bf15716 125 class GrpIterator;
578bfd0a
AL
126 class PkgIterator;
127 class VerIterator;
a52f938b 128 class DescIterator;
578bfd0a
AL
129 class DepIterator;
130 class PrvIterator;
b07aeb1a 131 class RlsFileIterator;
578bfd0a 132 class PkgFileIterator;
dcb79bae 133 class VerFileIterator;
a52f938b 134 class DescFileIterator;
b2e465d6
AL
135
136 class Namespace;
dcb79bae 137
f55a958f 138 // These are all the constants used in the cache structures
308c7d30
IJ
139
140 // WARNING - if you change these lists you must also edit
141 // the stringification in pkgcache.cc and also consider whether
142 // the cache file will become incompatible.
6c139d6e
AL
143 struct Dep
144 {
145 enum DepType {Depends=1,PreDepends=2,Suggests=3,Recommends=4,
f8ae7e8b 146 Conflicts=5,Replaces=6,Obsoletes=7,DpkgBreaks=8,Enhances=9};
94449d7c
DK
147 /** \brief available compare operators
148
149 The lower 4 bits are used to indicate what operator is being specified and
150 the upper 4 bits are flags. OR indicates that the next package is
151 or'd with the current package. */
8c7af4d4
DK
152 enum DepCompareOp {NoOp=0,LessEq=0x1,GreaterEq=0x2,Less=0x3,
153 Greater=0x4,Equals=0x5,NotEquals=0x6,
154 Or=0x10, /*!< or'ed with the next dependency */
155 MultiArchImplicit=0x20, /*!< generated internally, not spelled out in the index */
156 ArchSpecific=0x40 /*!< was decorated with an explicit architecture in index */
157 };
6c139d6e
AL
158 };
159
160 struct State
161 {
94449d7c
DK
162 /** \brief priority of a package version
163
164 Zero is used for unparsable or absent Priority fields. */
9005f08e 165 enum VerPriority {Required=1,Important=2,Standard=3,Optional=4,Extra=5};
6c139d6e
AL
166 enum PkgSelectedState {Unknown=0,Install=1,Hold=2,DeInstall=3,Purge=4};
167 enum PkgInstState {Ok=0,ReInstReq=1,HoldInst=2,HoldReInstReq=3};
168 enum PkgCurrentState {NotInstalled=0,UnPacked=1,HalfConfigured=2,
9d06bc80
MV
169 HalfInstalled=4,ConfigFiles=5,Installed=6,
170 TriggersAwaited=7,TriggersPending=8};
6c139d6e
AL
171 };
172
173 struct Flag
174 {
138d4b3d 175 enum PkgFlags {Auto=(1<<0),Essential=(1<<3),Important=(1<<4)};
448c38bd
DK
176 enum PkgFFlags {
177 NotSource=(1<<0), /*!< packages can't be fetched from here, e.g. dpkg/status file */
b07aeb1a 178 LocalSource=(1<<1), /*!< local sources can't and will not be verified by hashes */
d2cb5b15 179 NoPackages=(1<<2), /*!< the file includes no package records itself, but additions like Translations */
b07aeb1a
DK
180 };
181 enum ReleaseFileFlags {
182 NotAutomatic=(1<<0), /*!< archive has a default pin of 1 */
183 ButAutomaticUpgrades=(1<<1), /*!< (together with the previous) archive has a default pin of 100 */
448c38bd 184 };
8c7af4d4
DK
185 enum ProvidesFlags {
186 MultiArchImplicit=pkgCache::Dep::MultiArchImplicit, /*!< generated internally, not spelled out in the index */
187 ArchSpecific=pkgCache::Dep::ArchSpecific /*!< was decorated with an explicit architecture in index */
188 };
6c139d6e 189 };
578bfd0a
AL
190
191 protected:
192
193 // Memory mapped cache file
8f3ba4e8 194 std::string CacheFile;
578bfd0a
AL
195 MMap &Map;
196
4ad8619b
DK
197 map_id_t sHash(const std::string &S) const APT_PURE;
198 map_id_t sHash(const char *S) const APT_PURE;
578bfd0a
AL
199
200 public:
201
202 // Pointers to the arrays of items
203 Header *HeaderP;
5bf15716 204 Group *GrpP;
578bfd0a 205 Package *PkgP;
dcb79bae 206 VerFile *VerFileP;
a52f938b 207 DescFile *DescFileP;
b07aeb1a 208 ReleaseFile *RlsFileP;
578bfd0a
AL
209 PackageFile *PkgFileP;
210 Version *VerP;
a52f938b 211 Description *DescP;
578bfd0a
AL
212 Provides *ProvideP;
213 Dependency *DepP;
71c9e95b 214 DependencyData *DepDataP;
5dd00edb 215 APT_DEPRECATED_MSG("Not used anymore in cache generation and without a replacement") StringItem *StringItemP;
578bfd0a 216 char *StrP;
dcb79bae 217
a9fe5928 218 virtual bool ReMap(bool const &Errorchecks = true);
d3e8fbb3
DK
219 inline bool Sync() {return Map.Sync();}
220 inline MMap &GetMap() {return Map;}
221 inline void *DataEnd() {return ((unsigned char *)Map.Data()) + Map.Size();}
b2e465d6 222
578bfd0a 223 // String hashing function (512 range)
4ad8619b
DK
224 inline map_id_t Hash(const std::string &S) const {return sHash(S);}
225 inline map_id_t Hash(const char *S) const {return sHash(S);}
578bfd0a 226
94449d7c 227 // Useful transformation things
ebc5b43c 228 static const char *Priority(unsigned char Priority);
0149949b 229
578bfd0a 230 // Accessors
8f3ba4e8
DK
231 GrpIterator FindGrp(const std::string &Name);
232 PkgIterator FindPkg(const std::string &Name);
233 PkgIterator FindPkg(const std::string &Name, const std::string &Arch);
5bf15716 234
d3e8fbb3 235 Header &Head() {return *HeaderP;}
25396fb0
DK
236 inline GrpIterator GrpBegin();
237 inline GrpIterator GrpEnd();
578bfd0a
AL
238 inline PkgIterator PkgBegin();
239 inline PkgIterator PkgEnd();
ad00ae81
AL
240 inline PkgFileIterator FileBegin();
241 inline PkgFileIterator FileEnd();
b07aeb1a
DK
242 inline RlsFileIterator RlsFileBegin();
243 inline RlsFileIterator RlsFileEnd();
b2e465d6 244
d3e8fbb3 245 inline bool MultiArchCache() const { return MultiArchEnabled; }
d64e130a 246 inline char const * NativeArch();
8d4c859d 247
b2e465d6
AL
248 // Make me a function
249 pkgVersioningSystem *VS;
250
251 // Converters
a02db58f
DK
252 static const char *CompTypeDeb(unsigned char Comp) APT_CONST;
253 static const char *CompType(unsigned char Comp) APT_CONST;
b2e465d6 254 static const char *DepType(unsigned char Dep);
c8a4ce6c 255
b2e465d6 256 pkgCache(MMap *Map,bool DoMap = true);
c8a4ce6c 257 virtual ~pkgCache();
8d4c859d
DK
258
259private:
6c55f07a 260 void * const d;
8d4c859d 261 bool MultiArchEnabled;
578bfd0a 262};
92fcbfc1
DK
263 /*}}}*/
264// Header structure /*{{{*/
578bfd0a
AL
265struct pkgCache::Header
266{
94449d7c
DK
267 /** \brief Signature information
268
269 This must contain the hex value 0x98FE76DC which is designed to
270 verify that the system loading the image has the same byte order
271 and byte size as the system saving the image */
dfe66c72 272 uint32_t Signature;
94449d7c 273 /** These contain the version of the cache file */
dfe66c72
DK
274 map_number_t MajorVersion;
275 map_number_t MinorVersion;
94449d7c
DK
276 /** \brief indicates if the cache should be erased
277
278 Dirty is true if the cache file was opened for reading, the client
279 expects to have written things to it and have not fully synced it.
280 The file should be erased and rebuilt if it is true. */
578bfd0a 281 bool Dirty;
94449d7c
DK
282
283 /** \brief Size of structure values
284
285 All *Sz variables contains the sizeof() that particular structure.
286 It is used as an extra consistency check on the structure of the file.
287
288 If any of the size values do not exactly match what the client expects
289 then the client should refuse the load the file. */
dfe66c72
DK
290 uint16_t HeaderSz;
291 map_number_t GroupSz;
292 map_number_t PackageSz;
293 map_number_t ReleaseFileSz;
294 map_number_t PackageFileSz;
295 map_number_t VersionSz;
296 map_number_t DescriptionSz;
297 map_number_t DependencySz;
298 map_number_t DependencyDataSz;
299 map_number_t ProvidesSz;
300 map_number_t VerFileSz;
301 map_number_t DescFileSz;
94449d7c
DK
302
303 /** \brief Structure counts
304
305 These indicate the number of each structure contained in the cache.
306 PackageCount is especially useful for generating user state structures.
307 See Package::Id for more info. */
4ad8619b
DK
308 map_id_t GroupCount;
309 map_id_t PackageCount;
310 map_id_t VersionCount;
311 map_id_t DescriptionCount;
312 map_id_t DependsCount;
71c9e95b 313 map_id_t DependsDataCount;
b07aeb1a 314 map_fileid_t ReleaseFileCount;
4ad8619b
DK
315 map_fileid_t PackageFileCount;
316 map_fileid_t VerFileCount;
317 map_fileid_t DescFileCount;
318 map_id_t ProvidesCount;
94449d7c
DK
319
320 /** \brief index of the first PackageFile structure
321
322 The PackageFile structures are singly linked lists that represent
323 all package files that have been merged into the cache. */
4ad8619b 324 map_pointer_t FileList;
b07aeb1a
DK
325 /** \brief index of the first ReleaseFile structure */
326 map_pointer_t RlsFileList;
327
94449d7c 328 /** \brief String representing the version system used */
4ad8619b 329 map_pointer_t VerSysName;
7a223b93 330 /** \brief native architecture the cache was built against */
4ad8619b 331 map_pointer_t Architecture;
7a223b93 332 /** \brief all architectures the cache was built against */
4ad8619b 333 map_pointer_t Architectures;
94449d7c 334 /** \brief The maximum size of a raw entry from the original Package file */
4ad8619b 335 map_filesize_t MaxVerFileSize;
94449d7c 336 /** \brief The maximum size of a raw entry from the original Translation file */
4ad8619b 337 map_filesize_t MaxDescFileSize;
578bfd0a 338
94449d7c
DK
339 /** \brief The Pool structures manage the allocation pools that the generator uses
340
341 Start indicates the first byte of the pool, Count is the number of objects
342 remaining in the pool and ItemSize is the structure size (alignment factor)
343 of the pool. An ItemSize of 0 indicates the pool is empty. There should be
344 the same number of pools as there are structure types. The generator
345 stores this information so future additions can make use of any unused pool
346 blocks. */
b291aa59 347 DynamicMMap::Pool Pools[12];
e8a7b0b2 348
94449d7c
DK
349 /** \brief hash tables providing rapid group/package name lookup
350
e8a7b0b2 351 Each group/package name is inserted into a hash table using pkgCache::Hash(const &string)
94449d7c
DK
352 By iterating over each entry in the hash table it is possible to iterate over
353 the entire list of packages. Hash Collisions are handled with a singly linked
354 list of packages based at the hash item. The linked list contains only
355 packages that match the hashing function.
356 In the PkgHashTable is it possible that multiple packages have the same name -
357 these packages are stored as a sequence in the list.
e8a7b0b2 358 The size of both tables is the same. */
dfe66c72
DK
359 uint32_t HashTableSize;
360 uint32_t GetHashTableSize() const { return HashTableSize; }
32ab4bd0
DK
361 void SetHashTableSize(unsigned int const sz) { HashTableSize = sz; }
362 map_pointer_t GetArchitectures() const { return Architectures; }
363 void SetArchitectures(map_pointer_t const idx) { Architectures = idx; }
32ab4bd0
DK
364 map_pointer_t * PkgHashTableP() const { return (map_pointer_t*) (this + 1); }
365 map_pointer_t * GrpHashTableP() const { return PkgHashTableP() + GetHashTableSize(); }
578bfd0a 366
0688ccd8 367 /** \brief Size of the complete cache file */
4dc77823 368 map_filesize_small_t CacheFileSize;
0688ccd8 369
a02db58f 370 bool CheckSizes(Header &Against) const APT_PURE;
578bfd0a
AL
371 Header();
372};
92fcbfc1 373 /*}}}*/
94449d7c
DK
374// Group structure /*{{{*/
375/** \brief groups architecture depending packages together
5bf15716 376
94449d7c
DK
377 On or more packages with the same name form a group, so we have
378 a simple way to access a package built for different architectures
379 Group exists in a singly linked list of group records starting at
380 the hash index of the name in the pkgCache::Header::GrpHashTable */
381struct pkgCache::Group
382{
383 /** \brief Name of the group */
4ad8619b 384 map_stringitem_t Name;
94449d7c
DK
385
386 // Linked List
52c41485 387 /** \brief Link to the first package which belongs to the group */
4ad8619b 388 map_pointer_t FirstPackage; // Package
52c41485 389 /** \brief Link to the last package which belongs to the group */
4ad8619b 390 map_pointer_t LastPackage; // Package
52c41485 391 /** \brief Link to the next Group */
4ad8619b 392 map_pointer_t Next; // Group
52c41485 393 /** \brief unique sequel ID */
4dc77823 394 map_id_t ID;
52c41485 395
5bf15716
DK
396};
397 /*}}}*/
94449d7c
DK
398// Package structure /*{{{*/
399/** \brief contains information for a single unique package
400
401 There can be any number of versions of a given package.
402 Package exists in a singly linked list of package records starting at
403 the hash index of the name in the pkgCache::Header::PkgHashTable
404
405 A package can be created for every architecture so package names are
1e3f4083 406 not unique, but it is guaranteed that packages with the same name
94449d7c
DK
407 are sequencel ordered in the list. Packages with the same name can be
408 accessed with the Group.
409*/
410struct pkgCache::Package
578bfd0a 411{
fe86debb
DK
412 /** \brief Name of the package
413 * Note that the access method Name() will remain. It is just this data member
414 * deprecated as this information is already stored and available via the
415 * associated Group – so it is wasting precious binary cache space */
5dd00edb 416 APT_DEPRECATED_MSG("Use the .Name() method instead of accessing the member directly") map_stringitem_t Name;
94449d7c 417 /** \brief Architecture of the package */
4ad8619b 418 map_stringitem_t Arch;
94449d7c
DK
419 /** \brief Base of a singly linked list of versions
420
421 Each structure represents a unique version of the package.
422 The version structures contain links into PackageFile and the
423 original text file as well as detailed information about the size
424 and dependencies of the specific package. In this way multiple
425 versions of a package can be cleanly handled by the system.
426 Furthermore, this linked list is guaranteed to be sorted
427 from Highest version to lowest version with no duplicate entries. */
4ad8619b 428 map_pointer_t VersionList; // Version
94449d7c 429 /** \brief index to the installed version */
4ad8619b 430 map_pointer_t CurrentVer; // Version
94449d7c 431 /** \brief index of the group this package belongs to */
4ad8619b 432 map_pointer_t Group; // Group the Package belongs to
94449d7c
DK
433
434 // Linked list
435 /** \brief Link to the next package in the same bucket */
32ab4bd0 436 map_pointer_t NextPackage; // Package
94449d7c 437 /** \brief List of all dependencies on this package */
4ad8619b 438 map_pointer_t RevDepends; // Dependency
94449d7c 439 /** \brief List of all "packages" this package provide */
4ad8619b 440 map_pointer_t ProvidesList; // Provides
a52f938b 441
578bfd0a 442 // Install/Remove/Purge etc
94449d7c 443 /** \brief state that the user wishes the package to be in */
dfe66c72 444 map_number_t SelectedState; // What
94449d7c
DK
445 /** \brief installation state of the package
446
447 This should be "ok" but in case the installation failed
448 it will be different.
449 */
dfe66c72 450 map_number_t InstState; // Flags
94449d7c 451 /** \brief indicates if the package is installed */
dfe66c72 452 map_number_t CurrentState; // State
94449d7c
DK
453
454 /** \brief unique sequel ID
455
456 ID is a unique value from 0 to Header->PackageCount assigned by the generator.
457 This allows clients to create an array of size PackageCount and use it to store
458 state information for the package map. For instance the status file emitter uses
459 this to track which packages have been emitted already. */
4dc77823 460 map_id_t ID;
94449d7c 461 /** \brief some useful indicators of the package's state */
dfe66c72 462 map_flags_t Flags;
578bfd0a 463};
92fcbfc1 464 /*}}}*/
b07aeb1a
DK
465// Release File structure /*{{{*/
466/** \brief stores information about the release files used to generate the cache
94449d7c 467
b07aeb1a
DK
468 PackageFiles reference ReleaseFiles as we need to keep record of which
469 version belongs to which release e.g. for pinning. */
470struct pkgCache::ReleaseFile
578bfd0a 471{
b07aeb1a 472 /** \brief physical disk file that this ReleaseFile represents */
78a5476f 473 map_stringitem_t FileName;
94449d7c
DK
474 /** \brief the release information
475
476 Please see the files document for a description of what the
477 release information means. */
4ad8619b
DK
478 map_stringitem_t Archive;
479 map_stringitem_t Codename;
4ad8619b
DK
480 map_stringitem_t Version;
481 map_stringitem_t Origin;
482 map_stringitem_t Label;
94449d7c 483 /** \brief The site the index file was fetched from */
4ad8619b 484 map_stringitem_t Site;
b07aeb1a
DK
485
486 /** \brief Size of the file
487
488 Used together with the modification time as a
489 simple check to ensure that the Packages
490 file has not been altered since Cache generation. */
491 map_filesize_t Size;
492 /** \brief Modification time for the file */
493 time_t mtime;
494
495 /** @TODO document PackageFile::Flags */
dfe66c72 496 map_flags_t Flags;
b07aeb1a
DK
497
498 // Linked list
499 /** \brief Link to the next ReleaseFile in the Cache */
500 map_pointer_t NextFile;
501 /** \brief unique sequel ID */
4dc77823 502 map_fileid_t ID;
b07aeb1a
DK
503};
504 /*}}}*/
505// Package File structure /*{{{*/
506/** \brief stores information about the files used to generate the cache
507
508 Package files are referenced by Version structures to be able to know
509 after the generation still from which Packages file includes this Version
510 as we need this information later on e.g. for pinning. */
511struct pkgCache::PackageFile
512{
513 /** \brief physical disk file that this PackageFile represents */
514 map_stringitem_t FileName;
515 /** \brief the release information */
516 map_pointer_t Release;
517
518 map_stringitem_t Component;
519 map_stringitem_t Architecture;
520
94449d7c
DK
521 /** \brief indicates what sort of index file this is
522
523 @TODO enumerate at least the possible indexes */
4ad8619b 524 map_stringitem_t IndexType;
94449d7c
DK
525 /** \brief Size of the file
526
527 Used together with the modification time as a
528 simple check to ensure that the Packages
529 file has not been altered since Cache generation. */
4ad8619b 530 map_filesize_t Size;
94449d7c
DK
531 /** \brief Modification time for the file */
532 time_t mtime;
533
255c9e4b 534 /** @TODO document PackageFile::Flags */
dfe66c72 535 map_flags_t Flags;
94449d7c 536
578bfd0a 537 // Linked list
94449d7c 538 /** \brief Link to the next PackageFile in the Cache */
4ad8619b 539 map_pointer_t NextFile; // PackageFile
94449d7c 540 /** \brief unique sequel ID */
4dc77823 541 map_fileid_t ID;
578bfd0a 542};
92fcbfc1 543 /*}}}*/
94449d7c
DK
544// VerFile structure /*{{{*/
545/** \brief associates a version with a PackageFile
546
547 This allows a full description of all Versions in all files
548 (and hence all sources) under consideration. */
549struct pkgCache::VerFile
dcb79bae 550{
94449d7c 551 /** \brief index of the package file that this version was found in */
4ad8619b 552 map_pointer_t File; // PackageFile
94449d7c 553 /** \brief next step in the linked list */
4ad8619b 554 map_pointer_t NextFile; // PkgVerFile
94449d7c 555 /** \brief position in the package file */
4dc77823 556 map_filesize_t Offset; // File offset
255c9e4b 557 /** @TODO document pkgCache::VerFile::Size */
4ad8619b 558 map_filesize_t Size;
dcb79bae 559};
92fcbfc1 560 /*}}}*/
94449d7c
DK
561// DescFile structure /*{{{*/
562/** \brief associates a description with a Translation file */
563struct pkgCache::DescFile
a52f938b 564{
94449d7c 565 /** \brief index of the file that this description was found in */
4ad8619b 566 map_pointer_t File; // PackageFile
94449d7c 567 /** \brief next step in the linked list */
4ad8619b 568 map_pointer_t NextFile; // PkgVerFile
94449d7c 569 /** \brief position in the file */
4dc77823 570 map_filesize_t Offset; // File offset
255c9e4b 571 /** @TODO document pkgCache::DescFile::Size */
4ad8619b 572 map_filesize_t Size;
a52f938b 573};
92fcbfc1 574 /*}}}*/
94449d7c
DK
575// Version structure /*{{{*/
576/** \brief information for a single version of a package
577
578 The version list is always sorted from highest version to lowest
579 version by the generator. Equal version numbers are either merged
580 or handled as separate versions based on the Hash value. */
fcffe89d 581APT_IGNORE_DEPRECATED_PUSH
94449d7c 582struct pkgCache::Version
578bfd0a 583{
94449d7c 584 /** \brief complete version string */
4ad8619b 585 map_stringitem_t VerStr;
94449d7c 586 /** \brief section this version is filled in */
4ad8619b 587 map_stringitem_t Section;
a221efc3
DK
588 /** \brief source package name this version comes from
589 Always contains the name, even if it is the same as the binary name */
590 map_stringitem_t SourcePkgName;
591 /** \brief source version this version comes from
592 Always contains the version string, even if it is the same as the binary version */
593 map_stringitem_t SourceVerStr;
894d672e
DK
594
595 /** \brief Multi-Arch capabilities of a package version */
22df31be 596 enum VerMultiArch { No = 0, /*!< is the default and doesn't trigger special behaviour */
894d672e
DK
597 All = (1<<0), /*!< will cause that Ver.Arch() will report "all" */
598 Foreign = (1<<1), /*!< can satisfy dependencies in another architecture */
599 Same = (1<<2), /*!< can be co-installed with itself from other architectures */
00b6a181
DK
600 Allowed = (1<<3), /*!< other packages are allowed to depend on thispkg:any */
601 AllForeign = All | Foreign,
602 AllAllowed = All | Allowed };
f0109006
JAK
603
604 /** \brief deprecated variant of No */
5dd00edb 605 static const APT_DEPRECATED_MSG("The default value of the Multi-Arch field is no, not none") VerMultiArch None = No;
f0109006 606
94449d7c
DK
607 /** \brief stores the MultiArch capabilities of this version
608
894d672e
DK
609 Flags used are defined in pkgCache::Version::VerMultiArch
610 */
dfe66c72 611 map_number_t MultiArch;
25396fb0 612
94449d7c
DK
613 /** \brief references all the PackageFile's that this version came from
614
615 FileList can be used to determine what distribution(s) the Version
616 applies to. If FileList is 0 then this is a blank version.
617 The structure should also have a 0 in all other fields excluding
618 pkgCache::Version::VerStr and Possibly pkgCache::Version::NextVer. */
4ad8619b 619 map_pointer_t FileList; // VerFile
94449d7c 620 /** \brief next (lower or equal) version in the linked list */
4ad8619b 621 map_pointer_t NextVer; // Version
94449d7c 622 /** \brief next description in the linked list */
4ad8619b 623 map_pointer_t DescriptionList; // Description
94449d7c 624 /** \brief base of the dependency list */
4ad8619b 625 map_pointer_t DependsList; // Dependency
94449d7c
DK
626 /** \brief links to the owning package
627
628 This allows reverse dependencies to determine the package */
4ad8619b 629 map_pointer_t ParentPkg; // Package
94449d7c 630 /** \brief list of pkgCache::Provides */
4ad8619b 631 map_pointer_t ProvidesList; // Provides
94449d7c
DK
632
633 /** \brief archive size for this version
634
635 For Debian this is the size of the .deb file. */
4dc77823 636 map_filesize_t Size; // These are the .deb size
94449d7c 637 /** \brief uncompressed size for this version */
4dc77823 638 map_filesize_t InstalledSize;
94449d7c
DK
639 /** \brief characteristic value representing this version
640
641 No two packages in existence should have the same VerStr
642 and Hash with different contents. */
204fbdcc 643 unsigned short Hash;
94449d7c 644 /** \brief unique sequel ID */
4dc77823 645 map_id_t ID;
94449d7c 646 /** \brief parsed priority value */
dfe66c72 647 map_number_t Priority;
578bfd0a 648};
fcffe89d 649APT_IGNORE_DEPRECATED_POP
92fcbfc1 650 /*}}}*/
94449d7c
DK
651// Description structure /*{{{*/
652/** \brief datamember of a linked list of available description for a version */
653struct pkgCache::Description
a52f938b 654{
94449d7c
DK
655 /** \brief Language code of this description (translation)
656
657 If the value has a 0 length then this is read using the Package
658 file else the Translation-CODE file is used. */
4ad8619b 659 map_stringitem_t language_code;
94449d7c
DK
660 /** \brief MD5sum of the original description
661
662 Used to map Translations of a description to a version
663 and to check that the Translation is up-to-date. */
4ad8619b 664 map_stringitem_t md5sum;
a52f938b 665
255c9e4b 666 /** @TODO document pkgCache::Description::FileList */
4ad8619b 667 map_pointer_t FileList; // DescFile
94449d7c 668 /** \brief next translation for this description */
4ad8619b 669 map_pointer_t NextDesc; // Description
94449d7c 670 /** \brief the text is a description of this package */
4ad8619b 671 map_pointer_t ParentPkg; // Package
a52f938b 672
94449d7c 673 /** \brief unique sequel ID */
4dc77823 674 map_id_t ID;
a52f938b 675};
92fcbfc1 676 /*}}}*/
94449d7c
DK
677// Dependency structure /*{{{*/
678/** \brief information for a single dependency record
679
680 The records are split up like this to ease processing by the client.
681 The base of the linked list is pkgCache::Version::DependsList.
682 All forms of dependencies are recorded here including Depends,
683 Recommends, Suggests, Enhances, Conflicts, Replaces and Breaks. */
71c9e95b 684struct pkgCache::DependencyData
578bfd0a 685{
94449d7c 686 /** \brief string of the version the dependency is applied against */
78a5476f 687 map_stringitem_t Version;
94449d7c
DK
688 /** \brief index of the package this depends applies to
689
690 The generator will - if the package does not already exist -
691 create a blank (no version records) package. */
4ad8619b 692 map_pointer_t Package; // Package
94449d7c 693
94449d7c 694 /** \brief Dependency type - Depends, Recommends, Conflicts, etc */
dfe66c72 695 map_number_t Type;
94449d7c
DK
696 /** \brief comparison operator specified on the depends line
697
698 If the high bit is set then it is a logical OR with the previous record. */
dfe66c72 699 map_flags_t CompareOp;
b291aa59
DK
700
701 map_pointer_t NextData;
71c9e95b
DK
702};
703struct pkgCache::Dependency
704{
705 map_pointer_t DependencyData; // DependencyData
706 /** \brief version of the package which has the depends */
707 map_pointer_t ParentVer; // Version
708 /** \brief next reverse dependency of this package */
709 map_pointer_t NextRevDepends; // Dependency
710 /** \brief next dependency of this version */
711 map_pointer_t NextDepends; // Dependency
712
713 /** \brief unique sequel ID */
4dc77823 714 map_id_t ID;
578bfd0a 715};
92fcbfc1 716 /*}}}*/
94449d7c
DK
717// Provides structure /*{{{*/
718/** \brief handles virtual packages
719
720 When a Provides: line is encountered a new provides record is added
721 associating the package with a virtual package name.
722 The provides structures are linked off the package structures.
723 This simplifies the analysis of dependencies and other aspects A provides
724 refers to a specific version of a specific package, not all versions need to
725 provide that provides.*/
726struct pkgCache::Provides
578bfd0a 727{
94449d7c 728 /** \brief index of the package providing this */
4ad8619b 729 map_pointer_t ParentPkg; // Package
94449d7c 730 /** \brief index of the version this provide line applies to */
4ad8619b 731 map_pointer_t Version; // Version
94449d7c
DK
732 /** \brief version in the provides line (if any)
733
734 This version allows dependencies to depend on specific versions of a
8c7af4d4 735 Provides, as well as allowing Provides to override existing packages. */
4ad8619b 736 map_stringitem_t ProvideVersion;
8c7af4d4 737 map_flags_t Flags;
94449d7c 738 /** \brief next provides (based of package) */
4ad8619b 739 map_pointer_t NextProvides; // Provides
94449d7c 740 /** \brief next provides (based of version) */
4ad8619b 741 map_pointer_t NextPkgProv; // Provides
578bfd0a 742};
92fcbfc1 743 /*}}}*/
32ab4bd0 744// UNUSED StringItem structure /*{{{*/
5dd00edb 745struct APT_DEPRECATED_MSG("No longer used in cache generation without a replacement") pkgCache::StringItem
32ab4bd0
DK
746{
747 /** \brief string this refers to */
748 map_ptrloc String; // StringItem
749 /** \brief Next link in the chain */
750 map_ptrloc NextItem; // StringItem
751};
752 /*}}}*/
959470da 753
d64e130a 754inline char const * pkgCache::NativeArch()
d3e8fbb3 755 { return StrP + HeaderP->Architecture; }
959470da 756
094a497d 757#include <apt-pkg/cacheiterators.h>
578bfd0a 758
d3e8fbb3
DK
759inline pkgCache::GrpIterator pkgCache::GrpBegin()
760 {return GrpIterator(*this);}
761inline pkgCache::GrpIterator pkgCache::GrpEnd()
762 {return GrpIterator(*this,GrpP);}
763inline pkgCache::PkgIterator pkgCache::PkgBegin()
764 {return PkgIterator(*this);}
765inline pkgCache::PkgIterator pkgCache::PkgEnd()
766 {return PkgIterator(*this,PkgP);}
ad00ae81 767inline pkgCache::PkgFileIterator pkgCache::FileBegin()
d3e8fbb3 768 {return PkgFileIterator(*this,PkgFileP + HeaderP->FileList);}
ad00ae81 769inline pkgCache::PkgFileIterator pkgCache::FileEnd()
d3e8fbb3 770 {return PkgFileIterator(*this,PkgFileP);}
b07aeb1a
DK
771inline pkgCache::RlsFileIterator pkgCache::RlsFileBegin()
772 {return RlsFileIterator(*this,RlsFileP + HeaderP->RlsFileList);}
773inline pkgCache::RlsFileIterator pkgCache::RlsFileEnd()
774 {return RlsFileIterator(*this,RlsFileP);}
775
578bfd0a 776
b2e465d6 777// Oh I wish for Real Name Space Support
92fcbfc1 778class pkgCache::Namespace /*{{{*/
d3e8fbb3 779{
b2e465d6 780 public:
803ea2a8 781 typedef pkgCache::GrpIterator GrpIterator;
b2e465d6
AL
782 typedef pkgCache::PkgIterator PkgIterator;
783 typedef pkgCache::VerIterator VerIterator;
a52f938b 784 typedef pkgCache::DescIterator DescIterator;
b2e465d6
AL
785 typedef pkgCache::DepIterator DepIterator;
786 typedef pkgCache::PrvIterator PrvIterator;
b07aeb1a 787 typedef pkgCache::RlsFileIterator RlsFileIterator;
b2e465d6 788 typedef pkgCache::PkgFileIterator PkgFileIterator;
d3e8fbb3 789 typedef pkgCache::VerFileIterator VerFileIterator;
b2e465d6 790 typedef pkgCache::Version Version;
a52f938b 791 typedef pkgCache::Description Description;
b2e465d6
AL
792 typedef pkgCache::Package Package;
793 typedef pkgCache::Header Header;
794 typedef pkgCache::Dep Dep;
795 typedef pkgCache::Flag Flag;
796};
92fcbfc1 797 /*}}}*/
578bfd0a 798#endif