apt-pkg/pkgcache.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: pkgcache.h,v 1.18 1999/02/23 06:46:24 jgg Exp $
   4 /* ######################################################################
   5
   6    Cache - Structure definitions for the cache file
   7
   8    Please see doc/apt-pkg/cache.sgml for a more detailed description of
   9    this format. Also be sure to keep that file up-to-date!!
  10
  11    Clients should always use the CacheIterators classes for access to the
  12    cache. They provide a simple STL-like method for traversing the links
  13    of the datastructure.
  14
  15    See pkgcachegen.h for information about generating cache structures.
  16
  17    ##################################################################### */
  18                                                                         /*}}}*/
  19 // Header section: pkglib
  20 #ifndef PKGLIB_PKGCACHE_H
  21 #define PKGLIB_PKGCACHE_H
  22
  23 #ifdef __GNUG__
  24 #pragma interface "apt-pkg/pkgcache.h"
  25 #endif
  26
  27 #include <string>
  28 #include <time.h>
  29 #include <apt-pkg/mmap.h>
  30
  31 /* This should be a 32 bit type, larger tyes use too much ram and smaller
  32    types are too small. Where ever possible 'unsigned long' should be used
  33    instead of this internal type */
  34 typedef unsigned int __apt_ptrloc;
  35
  36 class pkgCache
  37 {
  38    public:
  39    // Cache element predeclarations
  40    struct Header;
  41    struct Package;
  42    struct PackageFile;
  43    struct Version;
  44    struct Provides;
  45    struct Dependency;
  46    struct StringItem;
  47    struct VerFile;
  48
  49    // Iterators
  50    class PkgIterator;
  51    class VerIterator;
  52    class DepIterator;
  53    class PrvIterator;
  54    class PkgFileIterator;
  55    class VerFileIterator;
  56    friend PkgIterator;
  57    friend VerIterator;
  58    friend DepIterator;
  59    friend PrvIterator;
  60    friend PkgFileIterator;
  61    friend VerFileIterator;
  62
  63    // These are all the constants used in the cache structures
  64    struct Dep
  65    {
  66       enum DepType {Depends=1,PreDepends=2,Suggests=3,Recommends=4,
  67          Conflicts=5,Replaces=6};
  68       enum DepCompareOp {Or=0x10,NoOp=0,LessEq=0x1,GreaterEq=0x2,Less=0x3,
  69          Greater=0x4,Equals=0x5,NotEquals=0x6};
  70    };
  71
  72    struct State
  73    {
  74       enum VerPriority {Important=1,Required=2,Standard=3,Optional=4,Extra=5};
  75       enum PkgSelectedState {Unknown=0,Install=1,Hold=2,DeInstall=3,Purge=4};
  76       enum PkgInstState {Ok=0,ReInstReq=1,HoldInst=2,HoldReInstReq=3};
  77       enum PkgCurrentState {NotInstalled=0,UnPacked=1,HalfConfigured=2,
  78          UnInstalled=3,HalfInstalled=4,ConfigFiles=5,Installed=6};
  79    };
  80
  81    struct Flag
  82    {
  83       enum PkgFlags {Auto=(1<<0),Essential=(1<<3),Important=(1<<4)};
  84       enum PkgFFlags {NotSource=(1<<0),NotAutomatic=(1<<1)};
  85    };
  86
  87    protected:
  88
  89    // Memory mapped cache file
  90    string CacheFile;
  91    MMap &Map;
  92
  93    unsigned long sHash(string S) const;
  94    unsigned long sHash(const char *S) const;
  95
  96    public:
  97
  98    // Pointers to the arrays of items
  99    Header *HeaderP;
 100    Package *PkgP;
 101    VerFile *VerFileP;
 102    PackageFile *PkgFileP;
 103    Version *VerP;
 104    Provides *ProvideP;
 105    Dependency *DepP;
 106    StringItem *StringItemP;
 107    char *StrP;
 108
 109    virtual bool ReMap();
 110    inline bool Sync() {return Map.Sync();};
 111    inline MMap &GetMap() {return Map;};
 112
 113    // String hashing function (512 range)
 114    inline unsigned long Hash(string S) const {return sHash(S);};
 115    inline unsigned long Hash(const char *S) const {return sHash(S);};
 116
 117    // Usefull transformation things
 118    const char *Priority(unsigned char Priority);
 119
 120    // Accessors
 121    PkgIterator FindPkg(string Name);
 122    Header &Head() {return *HeaderP;};
 123    inline PkgIterator PkgBegin();
 124    inline PkgIterator PkgEnd();
 125    inline PkgFileIterator FileBegin();
 126    inline PkgFileIterator FileEnd();
 127
 128    pkgCache(MMap &Map);
 129    virtual ~pkgCache() {};
 130 };
 131
 132 // Header structure
 133 struct pkgCache::Header
 134 {
 135    // Signature information
 136    unsigned long Signature;
 137    short MajorVersion;
 138    short MinorVersion;
 139    bool Dirty;
 140
 141    // Size of structure values
 142    unsigned short HeaderSz;
 143    unsigned short PackageSz;
 144    unsigned short PackageFileSz;
 145    unsigned short VersionSz;
 146    unsigned short DependencySz;
 147    unsigned short ProvidesSz;
 148    unsigned short VerFileSz;
 149
 150    // Structure counts
 151    unsigned long PackageCount;
 152    unsigned long VersionCount;
 153    unsigned long DependsCount;
 154    unsigned long PackageFileCount;
 155    unsigned long VerFileCount;
 156    unsigned long ProvidesCount;
 157
 158    // Offsets
 159    __apt_ptrloc FileList;              // struct PackageFile
 160    __apt_ptrloc StringList;            // struct StringItem
 161    unsigned long MaxVerFileSize;
 162
 163    /* Allocation pools, there should be one of these for each structure
 164       excluding the header */
 165    DynamicMMap::Pool Pools[7];
 166
 167    // Rapid package name lookup
 168    __apt_ptrloc HashTable[2*1048];
 169
 170    bool CheckSizes(Header &Against) const;
 171    Header();
 172 };
 173
 174 struct pkgCache::Package
 175 {
 176    // Pointers
 177    __apt_ptrloc Name;              // Stringtable
 178    __apt_ptrloc VersionList;       // Version
 179    __apt_ptrloc TargetVer;         // Version
 180    __apt_ptrloc CurrentVer;        // Version
 181    __apt_ptrloc TargetDist;        // StringTable (StringItem)
 182    __apt_ptrloc Section;           // StringTable (StringItem)
 183
 184    // Linked list
 185    __apt_ptrloc NextPackage;       // Package
 186    __apt_ptrloc RevDepends;        // Dependency
 187    __apt_ptrloc ProvidesList;      // Provides
 188
 189    // Install/Remove/Purge etc
 190    unsigned char SelectedState;     // What
 191    unsigned char InstState;         // Flags
 192    unsigned char CurrentState;      // State
 193
 194    unsigned short ID;
 195    unsigned long Flags;
 196 };
 197
 198 struct pkgCache::PackageFile
 199 {
 200    // Names
 201    __apt_ptrloc FileName;        // Stringtable
 202    __apt_ptrloc Archive;         // Stringtable
 203    __apt_ptrloc Component;       // Stringtable
 204    __apt_ptrloc Version;         // Stringtable
 205    __apt_ptrloc Origin;          // Stringtable
 206    __apt_ptrloc Label;           // Stringtable
 207    __apt_ptrloc Architecture;    // Stringtable
 208    unsigned long Size;
 209    unsigned long Flags;
 210
 211    // Linked list
 212    __apt_ptrloc NextFile;        // PackageFile
 213    unsigned short ID;
 214    time_t mtime;                  // Modification time for the file
 215 };
 216
 217 struct pkgCache::VerFile
 218 {
 219    __apt_ptrloc File;           // PackageFile
 220    __apt_ptrloc NextFile;       // PkgVerFile
 221    __apt_ptrloc Offset;         // File offset
 222    unsigned short Size;
 223 };
 224
 225 struct pkgCache::Version
 226 {
 227    __apt_ptrloc VerStr;            // Stringtable
 228    __apt_ptrloc Section;           // StringTable (StringItem)
 229    __apt_ptrloc Arch;              // StringTable
 230
 231    // Lists
 232    __apt_ptrloc FileList;          // VerFile
 233    __apt_ptrloc NextVer;           // Version
 234    __apt_ptrloc DependsList;       // Dependency
 235    __apt_ptrloc ParentPkg;         // Package
 236    __apt_ptrloc ProvidesList;      // Provides
 237
 238    __apt_ptrloc Size;              // These are the .deb size
 239    __apt_ptrloc InstalledSize;
 240    unsigned short ID;
 241    unsigned char Priority;
 242 };
 243
 244 struct pkgCache::Dependency
 245 {
 246    __apt_ptrloc Version;         // Stringtable
 247    __apt_ptrloc Package;         // Package
 248    __apt_ptrloc NextDepends;     // Dependency
 249    __apt_ptrloc NextRevDepends;  // Dependency
 250    __apt_ptrloc ParentVer;       // Version
 251
 252    // Specific types of depends
 253    unsigned char Type;
 254    unsigned char CompareOp;
 255    unsigned short ID;
 256 };
 257
 258 struct pkgCache::Provides
 259 {
 260    __apt_ptrloc ParentPkg;        // Pacakge
 261    __apt_ptrloc Version;          // Version
 262    __apt_ptrloc ProvideVersion;   // Stringtable
 263    __apt_ptrloc NextProvides;     // Provides
 264    __apt_ptrloc NextPkgProv;      // Provides
 265 };
 266
 267 struct pkgCache::StringItem
 268 {
 269    __apt_ptrloc String;        // Stringtable
 270    __apt_ptrloc NextItem;      // StringItem
 271 };
 272
 273 #include <apt-pkg/cacheiterators.h>
 274
 275 inline pkgCache::PkgIterator pkgCache::PkgBegin()
 276        {return PkgIterator(*this);};
 277 inline pkgCache::PkgIterator pkgCache::PkgEnd()
 278        {return PkgIterator(*this,PkgP);};
 279 inline pkgCache::PkgFileIterator pkgCache::FileBegin()
 280        {return PkgFileIterator(*this);};
 281 inline pkgCache::PkgFileIterator pkgCache::FileEnd()
 282        {return PkgFileIterator(*this,PkgFileP);};
 283
 284 #endif