apt-pkg/pkgcache.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: pkgcache.h,v 1.25 2001/07/01 22:28: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 #ifndef PKGLIB_PKGCACHE_H
  20 #define PKGLIB_PKGCACHE_H
  21
  22
  23 #include <string>
  24 #include <time.h>
  25 #include <apt-pkg/mmap.h>
  26
  27 using std::string;
  28
  29 class pkgVersioningSystem;
  30 class pkgCache                                                          /*{{{*/
  31 {
  32    public:
  33    // Cache element predeclarations
  34    struct Header;
  35    struct Group;
  36    struct Package;
  37    struct PackageFile;
  38    struct Version;
  39    struct Description;
  40    struct Provides;
  41    struct Dependency;
  42    struct StringItem;
  43    struct VerFile;
  44    struct DescFile;
  45
  46    // Iterators
  47    template<typename Str, typename Itr> class Iterator;
  48    class GrpIterator;
  49    class PkgIterator;
  50    class VerIterator;
  51    class DescIterator;
  52    class DepIterator;
  53    class PrvIterator;
  54    class PkgFileIterator;
  55    class VerFileIterator;
  56    class DescFileIterator;
  57
  58    class Namespace;
  59
  60    // These are all the constants used in the cache structures
  61
  62    // WARNING - if you change these lists you must also edit
  63    // the stringification in pkgcache.cc and also consider whether
  64    // the cache file will become incompatible.
  65    struct Dep
  66    {
  67       enum DepType {Depends=1,PreDepends=2,Suggests=3,Recommends=4,
  68          Conflicts=5,Replaces=6,Obsoletes=7,DpkgBreaks=8,Enhances=9};
  69       enum DepCompareOp {Or=0x10,NoOp=0,LessEq=0x1,GreaterEq=0x2,Less=0x3,
  70          Greater=0x4,Equals=0x5,NotEquals=0x6};
  71    };
  72
  73    struct State
  74    {
  75       enum VerPriority {Important=1,Required=2,Standard=3,Optional=4,Extra=5};
  76       enum PkgSelectedState {Unknown=0,Install=1,Hold=2,DeInstall=3,Purge=4};
  77       enum PkgInstState {Ok=0,ReInstReq=1,HoldInst=2,HoldReInstReq=3};
  78       enum PkgCurrentState {NotInstalled=0,UnPacked=1,HalfConfigured=2,
  79            HalfInstalled=4,ConfigFiles=5,Installed=6,
  80            TriggersAwaited=7,TriggersPending=8};
  81    };
  82
  83    struct Flag
  84    {
  85       enum PkgFlags {Auto=(1<<0),Essential=(1<<3),Important=(1<<4)};
  86       enum PkgFFlags {NotSource=(1<<0),NotAutomatic=(1<<1)};
  87    };
  88
  89    protected:
  90
  91    // Memory mapped cache file
  92    string CacheFile;
  93    MMap &Map;
  94
  95    unsigned long sHash(const string &S) const;
  96    unsigned long sHash(const char *S) const;
  97
  98    public:
  99
 100    // Pointers to the arrays of items
 101    Header *HeaderP;
 102    Group *GrpP;
 103    Package *PkgP;
 104    VerFile *VerFileP;
 105    DescFile *DescFileP;
 106    PackageFile *PkgFileP;
 107    Version *VerP;
 108    Description *DescP;
 109    Provides *ProvideP;
 110    Dependency *DepP;
 111    StringItem *StringItemP;
 112    char *StrP;
 113
 114    virtual bool ReMap();
 115    inline bool Sync() {return Map.Sync();};
 116    inline MMap &GetMap() {return Map;};
 117    inline void *DataEnd() {return ((unsigned char *)Map.Data()) + Map.Size();};
 118
 119    // String hashing function (512 range)
 120    inline unsigned long Hash(const string &S) const {return sHash(S);};
 121    inline unsigned long Hash(const char *S) const {return sHash(S);};
 122
 123    // Usefull transformation things
 124    const char *Priority(unsigned char Priority);
 125
 126    // Accessors
 127    GrpIterator FindGrp(const string &Name);
 128    PkgIterator FindPkg(const string &Name, string Arch = "native");
 129
 130    Header &Head() {return *HeaderP;};
 131    inline PkgIterator PkgBegin();
 132    inline PkgIterator PkgEnd();
 133    inline PkgFileIterator FileBegin();
 134    inline PkgFileIterator FileEnd();
 135
 136    // Make me a function
 137    pkgVersioningSystem *VS;
 138
 139    // Converters
 140    static const char *CompTypeDeb(unsigned char Comp);
 141    static const char *CompType(unsigned char Comp);
 142    static const char *DepType(unsigned char Dep);
 143
 144    pkgCache(MMap *Map,bool DoMap = true);
 145    virtual ~pkgCache() {};
 146 };
 147                                                                         /*}}}*/
 148 // Header structure                                                     /*{{{*/
 149 struct pkgCache::Header
 150 {
 151    // Signature information
 152    unsigned long Signature;
 153    short MajorVersion;
 154    short MinorVersion;
 155    bool Dirty;
 156
 157    // Size of structure values
 158    unsigned short HeaderSz;
 159    unsigned short PackageSz;
 160    unsigned short PackageFileSz;
 161    unsigned short VersionSz;
 162    unsigned short DescriptionSz;
 163    unsigned short DependencySz;
 164    unsigned short ProvidesSz;
 165    unsigned short VerFileSz;
 166    unsigned short DescFileSz;
 167
 168    // Structure counts
 169    unsigned long GroupCount;
 170    unsigned long PackageCount;
 171    unsigned long VersionCount;
 172    unsigned long DescriptionCount;
 173    unsigned long DependsCount;
 174    unsigned long PackageFileCount;
 175    unsigned long VerFileCount;
 176    unsigned long DescFileCount;
 177    unsigned long ProvidesCount;
 178
 179    // Offsets
 180    map_ptrloc FileList;              // struct PackageFile
 181    map_ptrloc StringList;            // struct StringItem
 182    map_ptrloc VerSysName;            // StringTable
 183    map_ptrloc Architecture;          // StringTable
 184    unsigned long MaxVerFileSize;
 185    unsigned long MaxDescFileSize;
 186
 187    /* Allocation pools, there should be one of these for each structure
 188       excluding the header */
 189    DynamicMMap::Pool Pools[9];
 190
 191    // Rapid package and group name lookup
 192    // Notice: Increase only both table sizes as the
 193    // hashmethod assume the size of the Pkg one
 194    map_ptrloc PkgHashTable[2*1048];
 195    map_ptrloc GrpHashTable[2*1048];
 196
 197    bool CheckSizes(Header &Against) const;
 198    Header();
 199 };
 200                                                                         /*}}}*/
 201 struct pkgCache::Group {                                                /*{{{*/
 202         map_ptrloc Name;        // Stringtable
 203
 204         // Linked List
 205         map_ptrloc FirstPackage;// Package
 206         map_ptrloc LastPackage; // Package
 207         map_ptrloc Next;        // Group
 208 };
 209                                                                         /*}}}*/
 210 struct pkgCache::Package                                                /*{{{*/
 211 {
 212    // Pointers
 213    map_ptrloc Name;              // Stringtable
 214    map_ptrloc Arch;              // StringTable (StringItem)
 215    map_ptrloc VersionList;       // Version
 216    map_ptrloc CurrentVer;        // Version
 217    map_ptrloc Section;           // StringTable (StringItem)
 218    map_ptrloc Group;             // Group the Package belongs to
 219
 220    // Linked list
 221    map_ptrloc NextPackage;       // Package
 222    map_ptrloc RevDepends;        // Dependency
 223    map_ptrloc ProvidesList;      // Provides
 224
 225    // Install/Remove/Purge etc
 226    unsigned char SelectedState;     // What
 227    unsigned char InstState;         // Flags
 228    unsigned char CurrentState;      // State
 229
 230    unsigned int ID;
 231    unsigned long Flags;
 232 };
 233                                                                         /*}}}*/
 234 struct pkgCache::PackageFile                                            /*{{{*/
 235 {
 236    // Names
 237    map_ptrloc FileName;        // Stringtable
 238    map_ptrloc Archive;         // Stringtable
 239    map_ptrloc Codename;        // Stringtable
 240    map_ptrloc Component;       // Stringtable
 241    map_ptrloc Version;         // Stringtable
 242    map_ptrloc Origin;          // Stringtable
 243    map_ptrloc Label;           // Stringtable
 244    map_ptrloc Architecture;    // Stringtable
 245    map_ptrloc Site;            // Stringtable
 246    map_ptrloc IndexType;       // Stringtable
 247    unsigned long Size;
 248    unsigned long Flags;
 249
 250    // Linked list
 251    map_ptrloc NextFile;        // PackageFile
 252    unsigned int ID;
 253    time_t mtime;                  // Modification time for the file
 254 };
 255                                                                         /*}}}*/
 256 struct pkgCache::VerFile                                                /*{{{*/
 257 {
 258    map_ptrloc File;           // PackageFile
 259    map_ptrloc NextFile;       // PkgVerFile
 260    map_ptrloc Offset;         // File offset
 261    unsigned long Size;
 262 };
 263                                                                         /*}}}*/
 264 struct pkgCache::DescFile                                               /*{{{*/
 265 {
 266    map_ptrloc File;           // PackageFile
 267    map_ptrloc NextFile;       // PkgVerFile
 268    map_ptrloc Offset;         // File offset
 269    unsigned long Size;
 270 };
 271                                                                         /*}}}*/
 272 struct pkgCache::Version                                                /*{{{*/
 273 {
 274    map_ptrloc VerStr;            // Stringtable
 275    map_ptrloc Section;           // StringTable (StringItem)
 276    map_ptrloc Arch;              // StringTable
 277
 278    // Lists
 279    map_ptrloc FileList;          // VerFile
 280    map_ptrloc NextVer;           // Version
 281    map_ptrloc DescriptionList;   // Description
 282    map_ptrloc DependsList;       // Dependency
 283    map_ptrloc ParentPkg;         // Package
 284    map_ptrloc ProvidesList;      // Provides
 285
 286    map_ptrloc Size;              // These are the .deb size
 287    map_ptrloc InstalledSize;
 288    unsigned short Hash;
 289    unsigned int ID;
 290    unsigned char Priority;
 291 };
 292                                                                         /*}}}*/
 293 struct pkgCache::Description                                            /*{{{*/
 294 {
 295    // Language Code store the description translation language code. If
 296    // the value has a 0 lenght then this is readed using the Package
 297    // file else the Translation-CODE are used.
 298    map_ptrloc language_code;     // StringTable
 299    map_ptrloc md5sum;            // StringTable
 300
 301    // Linked list
 302    map_ptrloc FileList;          // DescFile
 303    map_ptrloc NextDesc;          // Description
 304    map_ptrloc ParentPkg;         // Package
 305
 306    unsigned int ID;
 307 };
 308                                                                         /*}}}*/
 309 struct pkgCache::Dependency                                             /*{{{*/
 310 {
 311    map_ptrloc Version;         // Stringtable
 312    map_ptrloc Package;         // Package
 313    map_ptrloc NextDepends;     // Dependency
 314    map_ptrloc NextRevDepends;  // Dependency
 315    map_ptrloc ParentVer;       // Version
 316
 317    // Specific types of depends
 318    map_ptrloc ID;
 319    unsigned char Type;
 320    unsigned char CompareOp;
 321 };
 322                                                                         /*}}}*/
 323 struct pkgCache::Provides                                               /*{{{*/
 324 {
 325    map_ptrloc ParentPkg;        // Pacakge
 326    map_ptrloc Version;          // Version
 327    map_ptrloc ProvideVersion;   // Stringtable
 328    map_ptrloc NextProvides;     // Provides
 329    map_ptrloc NextPkgProv;      // Provides
 330 };
 331                                                                         /*}}}*/
 332 struct pkgCache::StringItem                                             /*{{{*/
 333 {
 334    map_ptrloc String;        // Stringtable
 335    map_ptrloc NextItem;      // StringItem
 336 };
 337                                                                         /*}}}*/
 338 #include <apt-pkg/cacheiterators.h>
 339
 340 inline pkgCache::PkgIterator pkgCache::PkgBegin()
 341        {return PkgIterator(*this);};
 342 inline pkgCache::PkgIterator pkgCache::PkgEnd()
 343        {return PkgIterator(*this,PkgP);};
 344 inline pkgCache::PkgFileIterator pkgCache::FileBegin()
 345        {return PkgFileIterator(*this,PkgFileP + HeaderP->FileList);};
 346 inline pkgCache::PkgFileIterator pkgCache::FileEnd()
 347        {return PkgFileIterator(*this,PkgFileP);};
 348
 349 // Oh I wish for Real Name Space Support
 350 class pkgCache::Namespace                                               /*{{{*/
 351 {
 352    public:
 353
 354    typedef pkgCache::PkgIterator PkgIterator;
 355    typedef pkgCache::VerIterator VerIterator;
 356    typedef pkgCache::DescIterator DescIterator;
 357    typedef pkgCache::DepIterator DepIterator;
 358    typedef pkgCache::PrvIterator PrvIterator;
 359    typedef pkgCache::PkgFileIterator PkgFileIterator;
 360    typedef pkgCache::VerFileIterator VerFileIterator;
 361    typedef pkgCache::Version Version;
 362    typedef pkgCache::Description Description;
 363    typedef pkgCache::Package Package;
 364    typedef pkgCache::Header Header;
 365    typedef pkgCache::Dep Dep;
 366    typedef pkgCache::Flag Flag;
 367 };
 368                                                                         /*}}}*/
 369 #endif