- add repodata_dir2str function
[platform/upstream/libsolv.git] / src / repodata.h
1 /*
2  * Copyright (c) 2007, Novell Inc.
3  *
4  * This program is licensed under the BSD license, read LICENSE.BSD
5  * for further information
6  */
7
8 /*
9  * repodata.h
10  * 
11  */
12
13 #ifndef SATSOLVER_REPODATA_H
14 #define SATSOLVER_REPODATA_H
15
16 #include <stdio.h> 
17
18 #include "pooltypes.h"
19 #include "pool.h"
20 #include "dirpool.h"
21
22 struct _Repo;
23 struct _Repokey;
24 struct _KeyValue;
25
26 typedef struct _Attrblobpage
27 {
28   /* mapped_at == -1  --> not loaded, otherwise offset into
29      store->blob_store.  The size of the mapping is BLOB_PAGESIZE
30      except for the last page.  */
31   unsigned int mapped_at;
32   long file_offset;
33   /* file_size == 0 means the page is not backed by some file storage.
34      Otherwise it is L*2+(compressed ? 1 : 0), with L being the data
35      length.  */
36   long file_size;
37 } Attrblobpage;
38
39 typedef struct _Repodata {
40   struct _Repo *repo;           /* back pointer to repo */
41
42 #define REPODATA_AVAILABLE      0
43 #define REPODATA_STUB           1
44 #define REPODATA_ERROR          2
45 #define REPODATA_STORE          3
46   int state;                    /* available, stub or error */
47
48   void (*loadcallback)(struct _Repodata *);
49   char *location;               /* E.g. filename or the like */
50   char *checksum;               /* Checksum of the file */
51   unsigned nchecksum;           /* Length of the checksum */
52   unsigned checksumtype;        /* Type of checksum */
53
54   int start;                    /* start of solvables this repodata is valid for */
55   int end;                      /* last solvable + 1 of this repodata */
56
57   FILE *fp;                     /* file pointer of solv file */
58   int error;                    /* corrupt solv file */
59
60
61   struct _Repokey *keys;        /* keys, first entry is always zero */
62   unsigned int nkeys;           /* length of keys array */
63
64   Id *schemata;                 /* schema -> offset into schemadata */
65   unsigned int nschemata;       /* number of schemata */
66
67   Id *schemadata;               /* schema storage */
68   unsigned int schemadatalen;   /* schema storage size */
69
70   Stringpool spool;             /* local string pool */
71   int localpool;                /* is local string pool used */
72
73   Dirpool dirpool;              /* local dir pool */
74
75   unsigned char *incoredata;    /* in-core data (flat_attrs) */
76   unsigned int incoredatalen;   /* data len (attr_next_free) */
77   unsigned int incoredatafree;  /* free data len */
78
79   Id *incoreoffset;             /* offset for all entries (ent2attr) */
80
81   Id *verticaloffset;           /* offset for all verticals, nkeys elements */
82   Id lastverticaloffset;        /* end of verticals */
83
84   int pagefd;                   /* file descriptor of page file */
85   unsigned char *blob_store;
86   Attrblobpage *pages;
87   unsigned int num_pages;
88
89   /* mapped[i] is zero if nothing is mapped at logical page I,
90      otherwise it contains the pagenumber plus one (of the mapped page).  */
91   unsigned int *mapped;
92   unsigned int nmapped, ncanmap;
93   unsigned int rr_counter;
94
95   unsigned char *vincore;       
96   unsigned int vincorelen;
97
98   Id **attrs;                   /* un-internalized attributes */
99   unsigned char *attrdata;      /* their string data space */
100   unsigned int attrdatalen;
101   Id *attriddata;               /* their id space */
102   unsigned int attriddatalen;
103
104 } Repodata;
105
106 /* Search key <keyname> (all keys, if keyname == 0) for Id <entry>
107  * <entry> is _relative_ Id for <data>
108  * Call <callback> for each match
109  */
110 void repodata_search(Repodata *data, Id entry, Id keyname, int (*callback)(void *cbdata, Solvable *s, Repodata *data, struct _Repokey *key, struct _KeyValue *kv), void *cbdata);
111
112 /*
113  * lookup string type attribute
114  */
115 const char *repodata_lookup_str(Repodata *data, Id entry, Id keyid);
116
117 /*
118  * lookup integer type attribute
119  */
120 int repodata_lookup_num(Repodata *data, Id entry, Id keyid, unsigned *value);
121 int repodata_lookup_void(Repodata *data, Id entry, Id keyid);
122
123 void repodata_init(Repodata *data, struct _Repo *repo, int localpool);
124 void repodata_extend(Repodata *data, Id p);
125 void repodata_extend_block(Repodata *data, Id p, int num);
126 void repodata_free(Repodata *data);
127
128 void repodata_set_id(Repodata *data, Id entry, Id keyname, Id id);
129 void repodata_set_num(Repodata *data, Id entry, Id keyname, Id num);
130 void repodata_set_poolstr(Repodata *data, Id entry, Id keyname, const char *str);
131 void repodata_set_constant(Repodata *data, Id entry, Id keyname, Id constant);
132 void repodata_set_constantid(Repodata *data, Id entry, Id keyname, Id id);
133 void repodata_set_void(Repodata *data, Id entry, Id keyname);
134 void repodata_set_str(Repodata *data, Id entry, Id keyname, const char *str);
135 void repodata_add_dirnumnum(Repodata *data, Id entry, Id keyname, Id dir, Id num, Id num2);
136 void repodata_add_dirstr(Repodata *data, Id entry, Id keyname, Id dir, const char *str);
137 void repodata_merge_attrs (Repodata *data, Id dest, Id src);
138
139 void repodata_internalize(Repodata *data);
140 void repodata_disable_paging(Repodata *data);
141
142 Id repodata_str2dir(Repodata *data, const char *dir, int create);
143 const char *repodata_dir2str(Repodata *data, Id did, const char *suf);
144
145 unsigned int repodata_compress_page(unsigned char *, unsigned int, unsigned char *, unsigned int);
146 void repodata_read_or_setup_pages(Repodata *data, unsigned int pagesz, unsigned int blobsz);
147
148 #endif /* SATSOLVER_REPODATA_H */