apt-pkg/pkgcache.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: pkgcache.h,v 1.10 1998/11/12 03:28:29 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),New=(1<<1),Obsolete=(1<<2),Essential=(1<<3),
  84          ImmediateConf=(1<<4)};
  85       enum PkgFFlags {NotSource=(1<<0)};
  86    };
  87
  88    protected:
  89
  90    // Memory mapped cache file
  91    string CacheFile;
  92    MMap &Map;
  93
  94    static unsigned long sHash(string S);
  95    static unsigned long sHash(const char *S);
  96
  97    public:
  98
  99    // Pointers to the arrays of items
 100    Header *HeaderP;
 101    Package *PkgP;
 102    VerFile *VerFileP;
 103    PackageFile *PkgFileP;
 104    Version *VerP;
 105    Provides *ProvideP;
 106    Dependency *DepP;
 107    StringItem *StringItemP;
 108    char *StrP;
 109
 110    virtual bool ReMap();
 111    inline bool Sync() {return Map.Sync();};
 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
 156    // Offsets
 157    __apt_ptrloc FileList;              // struct PackageFile
 158    __apt_ptrloc StringList;            // struct StringItem
 159    unsigned long MaxVerFileSize;
 160
 161    /* Allocation pools, there should be one of these for each structure
 162       excluding the header */
 163    DynamicMMap::Pool Pools[7];
 164
 165    // Rapid package name lookup
 166    __apt_ptrloc HashTable[512];
 167
 168    bool CheckSizes(Header &Against) const;
 169    Header();
 170 };
 171
 172 struct pkgCache::Package
 173 {
 174    // Pointers
 175    __apt_ptrloc Name;              // Stringtable
 176    __apt_ptrloc VersionList;       // Version
 177    __apt_ptrloc TargetVer;         // Version
 178    __apt_ptrloc CurrentVer;        // Version
 179    __apt_ptrloc TargetDist;        // StringTable (StringItem)
 180    __apt_ptrloc Section;           // StringTable (StringItem)
 181
 182    // Linked list
 183    __apt_ptrloc NextPackage;       // Package
 184    __apt_ptrloc RevDepends;        // Dependency
 185    __apt_ptrloc ProvidesList;      // Provides
 186
 187    // Install/Remove/Purge etc
 188    unsigned char SelectedState;     // What
 189    unsigned char InstState;         // Flags
 190    unsigned char CurrentState;      // State
 191
 192    unsigned short ID;
 193    unsigned long Flags;
 194 };
 195
 196 struct pkgCache::PackageFile
 197 {
 198    // Names
 199    __apt_ptrloc FileName;        // Stringtable
 200    __apt_ptrloc Version;         // Stringtable
 201    __apt_ptrloc Distribution;    // Stringtable
 202    __apt_ptrloc Size;
 203
 204    // Linked list
 205    __apt_ptrloc NextFile;        // PackageFile
 206    unsigned short ID;
 207    unsigned long Flags;
 208    time_t mtime;                  // Modification time for the file
 209 };
 210
 211 struct pkgCache::VerFile
 212 {
 213    __apt_ptrloc File;           // PackageFile
 214    __apt_ptrloc NextFile;       // PkgVerFile
 215    __apt_ptrloc Offset;         // File offset
 216    unsigned short Size;
 217 };
 218
 219 struct pkgCache::Version
 220 {
 221    __apt_ptrloc VerStr;            // Stringtable
 222    __apt_ptrloc Section;           // StringTable (StringItem)
 223
 224    // Lists
 225    __apt_ptrloc FileList;          // VerFile
 226    __apt_ptrloc NextVer;           // Version
 227    __apt_ptrloc DependsList;       // Dependency
 228    __apt_ptrloc ParentPkg;         // Package
 229    __apt_ptrloc ProvidesList;      // Provides
 230
 231    __apt_ptrloc Size;              // These are the .deb size
 232    __apt_ptrloc InstalledSize;
 233    unsigned short ID;
 234    unsigned char Priority;
 235 };
 236
 237 struct pkgCache::Dependency
 238 {
 239    __apt_ptrloc Version;         // Stringtable
 240    __apt_ptrloc Package;         // Package
 241    __apt_ptrloc NextDepends;     // Dependency
 242    __apt_ptrloc NextRevDepends;  // Dependency
 243    __apt_ptrloc ParentVer;       // Version
 244
 245    // Specific types of depends
 246    unsigned char Type;
 247    unsigned char CompareOp;
 248    unsigned short ID;
 249 };
 250
 251 struct pkgCache::Provides
 252 {
 253    __apt_ptrloc ParentPkg;        // Pacakge
 254    __apt_ptrloc Version;          // Version
 255    __apt_ptrloc ProvideVersion;   // Stringtable
 256    __apt_ptrloc NextProvides;     // Provides
 257    __apt_ptrloc NextPkgProv;      // Provides
 258 };
 259
 260 struct pkgCache::StringItem
 261 {
 262    __apt_ptrloc String;        // Stringtable
 263    __apt_ptrloc NextItem;      // StringItem
 264 };
 265
 266 #include <apt-pkg/cacheiterators.h>
 267
 268 inline pkgCache::PkgIterator pkgCache::PkgBegin()
 269        {return PkgIterator(*this);};
 270 inline pkgCache::PkgIterator pkgCache::PkgEnd()
 271        {return PkgIterator(*this,PkgP);};
 272 inline pkgCache::PkgFileIterator pkgCache::FileBegin()
 273        {return PkgFileIterator(*this);};
 274 inline pkgCache::PkgFileIterator pkgCache::FileEnd()
 275        {return PkgFileIterator(*this,PkgFileP);};
 276
 277 #endif