0e785d3a927aa92e925dfccd879f06627069c4ef
[apt.git] / apt-pkg / contrib / mmap.h
1 // -*- mode: c++; mode: fold -*-
2 // Description                                                          /*{{{*/
3 // $Id: mmap.h,v 1.1 2002/07/23 17:54:51 niemeyer Exp $
4 /* ######################################################################
5    
6    MMap Class - Provides 'real' mmap or a faked mmap using read().
7
8    The purpose of this code is to provide a generic way for clients to
9    access the mmap function. In enviroments that do not support mmap
10    from file fd's this function will use read and normal allocated 
11    memory.
12    
13    Writing to a public mmap will always fully comit all changes when the 
14    class is deleted. Ie it will rewrite the file, unless it is readonly
15
16    The DynamicMMap class is used to help the on-disk data structure 
17    generators. It provides a large allocated workspace and members
18    to allocate space from the workspace in an effecient fashion.
19    
20    This source is placed in the Public Domain, do with it what you will
21    It was originally written by Jason Gunthorpe.
22    
23    ##################################################################### */
24                                                                         /*}}}*/
25 #ifndef PKGLIB_MMAP_H
26 #define PKGLIB_MMAP_H
27
28 #ifdef __GNUG__
29 #pragma interface "apt-pkg/mmap.h"
30 #endif
31
32 #include <string>
33 #include <apt-pkg/fileutl.h>
34
35 using std::string;
36
37 /* This should be a 32 bit type, larger tyes use too much ram and smaller
38    types are too small. Where ever possible 'unsigned long' should be used
39    instead of this internal type */
40 typedef unsigned int map_ptrloc;
41
42 class MMap
43 {
44    protected:
45    
46    unsigned long Flags;
47    unsigned long iSize;
48    void *Base;
49
50    bool Map(FileFd &Fd);
51    bool Close(bool DoSync = true);
52    
53    public:
54
55    enum OpenFlags {NoImmMap = (1<<0),Public = (1<<1),ReadOnly = (1<<2),
56                    UnMapped = (1<<3)};
57       
58    // Simple accessors
59    inline operator void *() {return Base;};
60    inline void *Data() {return Base;}; 
61    inline unsigned long Size() {return iSize;};
62    
63    // File manipulators
64    bool Sync();
65    bool Sync(size_t Start,size_t Stop);
66    
67    MMap(FileFd &F,unsigned long Flags);
68    MMap(unsigned long Flags);
69    virtual ~MMap();
70 };
71
72 class DynamicMMap : public MMap
73 {
74    public:
75    
76    // This is the allocation pool structure
77    struct Pool
78    {
79       unsigned long ItemSize;
80       unsigned long Start;
81       unsigned long Count;
82    };
83    
84    protected:
85    
86    FileFd *Fd;
87    unsigned long WorkSpace;
88    Pool *Pools;
89    unsigned int PoolCount;
90    
91    public:
92
93    // Allocation
94    unsigned long RawAllocate(unsigned long Size,unsigned long Aln = 0);
95    unsigned long Allocate(unsigned long ItemSize);
96    unsigned long WriteString(const char *String,unsigned long Len = (unsigned long)-1);
97    inline unsigned long WriteString(string S) {return WriteString(S.c_str(),S.length());};
98    void UsePools(Pool &P,unsigned int Count) {Pools = &P; PoolCount = Count;};
99    
100    DynamicMMap(FileFd &F,unsigned long Flags,unsigned long WorkSpace = 2*1024*1024);
101    DynamicMMap(unsigned long Flags,unsigned long WorkSpace = 2*1024*1024);
102    virtual ~DynamicMMap();
103 };
104
105 #endif