- incompatible ABI change: switch num over to unsigned long long and store sizes...
[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 LIBSOLV_REPODATA_H
14 #define LIBSOLV_REPODATA_H
15
16 #include <stdio.h> 
17
18 #include "pooltypes.h"
19 #include "pool.h"
20 #include "dirpool.h"
21
22 #ifdef LIBSOLV_INTERNAL
23 #include "repopage.h"
24 #endif
25
26 #define SIZEOF_MD5      16
27 #define SIZEOF_SHA1     20
28 #define SIZEOF_SHA256   32
29
30 struct _Repo;
31 struct _KeyValue;
32
33 typedef struct _Repokey {
34   Id name;
35   Id type;                      /* REPOKEY_TYPE_xxx */
36   unsigned int size;
37   unsigned int storage;         /* KEY_STORAGE_xxx */
38 } Repokey;
39
40 #define KEY_STORAGE_DROPPED             0
41 #define KEY_STORAGE_SOLVABLE            1
42 #define KEY_STORAGE_INCORE              2
43 #define KEY_STORAGE_VERTICAL_OFFSET     3
44
45 #ifdef LIBSOLV_INTERNAL
46 struct dircache;
47 #endif
48
49 typedef struct _Repodata {
50   Id repodataid;                /* our id */
51   struct _Repo *repo;           /* back pointer to repo */
52
53 #define REPODATA_AVAILABLE      0
54 #define REPODATA_STUB           1
55 #define REPODATA_ERROR          2
56 #define REPODATA_STORE          3
57 #define REPODATA_LOADING        4
58
59   int state;                    /* available, stub or error */
60
61   void (*loadcallback)(struct _Repodata *);
62
63   int start;                    /* start of solvables this repodata is valid for */
64   int end;                      /* last solvable + 1 of this repodata */
65
66   Repokey *keys;                /* keys, first entry is always zero */
67   int nkeys;                    /* length of keys array */
68   unsigned char keybits[32];    /* keyname hash */
69
70   Id *schemata;                 /* schema -> offset into schemadata */
71   int nschemata;                /* number of schemata */
72   Id *schemadata;               /* schema storage */
73
74   Stringpool spool;             /* local string pool */
75   int localpool;                /* is local string pool used */
76
77   Dirpool dirpool;              /* local dir pool */
78
79 #ifdef LIBSOLV_INTERNAL
80   FILE *fp;                     /* file pointer of solv file */
81   int error;                    /* corrupt solv file */
82
83   unsigned int schemadatalen;   /* schema storage size */
84   Id *schematahash;             /* unification helper */
85
86   unsigned char *incoredata;    /* in-core data */
87   unsigned int incoredatalen;   /* in-core data used */
88   unsigned int incoredatafree;  /* free data len */
89
90   Id mainschema;                /* SOLVID_META schema */
91   Id *mainschemaoffsets;        /* SOLVID_META offsets into incoredata */
92
93   Id *incoreoffset;             /* offset for all entries */
94
95   Id *verticaloffset;           /* offset for all verticals, nkeys elements */
96   Id lastverticaloffset;        /* end of verticals */
97
98   Repopagestore store;          /* our page store */
99
100   unsigned char *vincore;       /* internal vertical data */
101   unsigned int vincorelen;      /* data size */
102
103   Id **attrs;                   /* un-internalized attributes */
104   Id **xattrs;                  /* anonymous handles */
105   int nxattrs;                  /* number of handles */
106
107   unsigned char *attrdata;      /* their string data space */
108   unsigned int attrdatalen;     /* its len */
109   Id *attriddata;               /* their id space */
110   unsigned int attriddatalen;   /* its len */
111   unsigned long long *attrnum64data;    /* their 64bit num data space */
112   unsigned int attrnum64datalen;        /* its len */
113
114   /* array cache to speed up repodata_add functions*/
115   Id lasthandle;
116   Id lastkey;
117   Id lastdatalen;
118
119   /* directory cache to speed up repodata_str2dir */
120   struct dircache *dircache;
121 #endif
122
123 } Repodata;
124
125 #define SOLVID_META             -1
126 #define SOLVID_POS              -2
127 #define SOLVID_SUBSCHEMA        -3              /* internal! */
128
129
130 /*-----
131  * management functions
132  */
133 void repodata_initdata(Repodata *data, struct _Repo *repo, int localpool);
134 void repodata_freedata(Repodata *data);
135
136 void repodata_free(Repodata *data);
137 void repodata_empty(Repodata *data, int localpool);
138
139
140 /*
141  * key management functions
142  */
143 Id repodata_key2id(Repodata *data, Repokey *key, int create);
144
145 static inline Repokey *
146 repodata_id2key(Repodata *data, Id keyid)
147 {
148   return data->keys + keyid;
149 }
150
151 /*
152  * schema management functions
153  */
154 Id repodata_schema2id(Repodata *data, Id *schema, int create);
155 void repodata_free_schemahash(Repodata *data);
156
157 static inline Id *
158 repodata_id2schema(Repodata *data, Id schemaid)
159 {
160   return data->schemadata + data->schemata[schemaid];
161 }
162
163 /*
164  * data search and access
165  */
166
167 /* check if there is a chance that the repodata contains data for
168  * the specified keyname */
169 static inline int
170 repodata_precheck_keyname(Repodata *data, Id keyname)
171 {
172   unsigned char x = data->keybits[(keyname >> 3) & (sizeof(data->keybits) - 1)];
173   return x && (x & (1 << (keyname & 7))) ? 1 : 0;
174 }
175
176 /* check if the repodata contains data for the specified keyname */
177 static inline int
178 repodata_has_keyname(Repodata *data, Id keyname)
179 {
180   int i;
181   if (!repodata_precheck_keyname(data, keyname))
182     return 0;
183   for (i = 1; i < data->nkeys; i++)
184     if (data->keys[i].name == keyname)
185       return 1;
186   return 0;
187 }
188
189 /* search key <keyname> (all keys, if keyname == 0) for Id <solvid>
190  * Call <callback> for each match */
191 void repodata_search(Repodata *data, Id solvid, Id keyname, int flags, int (*callback)(void *cbdata, Solvable *s, Repodata *data, Repokey *key, struct _KeyValue *kv), void *cbdata);
192
193 /* Make sure the found KeyValue has the "str" field set. Return false
194  * if not possible */
195 int repodata_stringify(Pool *pool, Repodata *data, Repokey *key, struct _KeyValue *kv, int flags);
196
197 int repodata_filelistfilter_matches(Repodata *data, const char *str);
198
199
200 /* lookup functions */
201 Id repodata_lookup_type(Repodata *data, Id solvid, Id keyname);
202 Id repodata_lookup_id(Repodata *data, Id solvid, Id keyname);
203 const char *repodata_lookup_str(Repodata *data, Id solvid, Id keyname);
204 int repodata_lookup_num(Repodata *data, Id solvid, Id keyname, unsigned long long *value);
205 int repodata_lookup_void(Repodata *data, Id solvid, Id keyname);
206 const unsigned char *repodata_lookup_bin_checksum(Repodata *data, Id solvid, Id keyname, Id *typep);
207 int repodata_lookup_idarray(Repodata *data, Id solvid, Id keyname, Queue *q);
208
209
210 /*-----
211  * data assignment functions
212  */
213
214 /*
215  * extend the data so that it contains the specified solvables
216  * (no longer needed, as the repodata_set functions autoextend)
217  */
218 void repodata_extend(Repodata *data, Id p);
219 void repodata_extend_block(Repodata *data, Id p, int num);
220 void repodata_shrink(Repodata *data, int end);
221
222 /* internalize freshly set data, so that it is found by the search
223  * functions and written out */
224 void repodata_internalize(Repodata *data);
225
226 /* create an anonymous handle. useful for substructures like
227  * fixarray/flexarray  */
228 Id repodata_new_handle(Repodata *data);
229
230 /* basic types: void, num, string, Id */
231 void repodata_set_void(Repodata *data, Id solvid, Id keyname);
232 void repodata_set_num(Repodata *data, Id solvid, Id keyname, unsigned long long num);
233 void repodata_set_id(Repodata *data, Id solvid, Id keyname, Id id);
234 void repodata_set_str(Repodata *data, Id solvid, Id keyname, const char *str);
235 void repodata_set_binary(Repodata *data, Id solvid, Id keyname, void *buf, int len);
236 /* create id from string, then set_id */
237 void repodata_set_poolstr(Repodata *data, Id solvid, Id keyname, const char *str);
238
239 /* set numeric constant */
240 void repodata_set_constant(Repodata *data, Id solvid, Id keyname, unsigned int constant);
241
242 /* set Id constant */
243 void repodata_set_constantid(Repodata *data, Id solvid, Id keyname, Id id);
244
245 /* checksum */
246 void repodata_set_bin_checksum(Repodata *data, Id solvid, Id keyname, Id type,
247                                const unsigned char *buf);
248 void repodata_set_checksum(Repodata *data, Id solvid, Id keyname, Id type,
249                            const char *str);
250 void repodata_set_idarray(Repodata *data, Id solvid, Id keyname, Queue *q);
251
252
253 /* directory (for package file list) */
254 void repodata_add_dirnumnum(Repodata *data, Id solvid, Id keyname, Id dir, Id num, Id num2);
255 void repodata_add_dirstr(Repodata *data, Id solvid, Id keyname, Id dir, const char *str);
256 void repodata_free_dircache(Repodata *data);
257
258
259 /* Arrays */
260 void repodata_add_idarray(Repodata *data, Id solvid, Id keyname, Id id);
261 void repodata_add_poolstr_array(Repodata *data, Id solvid, Id keyname, const char *str);
262 void repodata_add_fixarray(Repodata *data, Id solvid, Id keyname, Id ghandle);
263 void repodata_add_flexarray(Repodata *data, Id solvid, Id keyname, Id ghandle);
264
265 void repodata_delete(Repodata *data, Id solvid, Id keyname);
266 void repodata_delete_uninternalized(Repodata *data, Id solvid, Id keyname);
267
268 /* 
269  merge/swap attributes from one solvable to another
270  works only if the data is not yet internalized
271 */
272 void repodata_merge_attrs(Repodata *data, Id dest, Id src);
273 void repodata_merge_some_attrs(Repodata *data, Id dest, Id src, Map *keyidmap, int overwrite);
274 void repodata_swap_attrs(Repodata *data, Id dest, Id src);
275
276 void repodata_create_stubs(Repodata *data);
277 void repodata_join(Repodata *data, Id joinkey);
278
279 /*
280  * load all paged data, used to speed up copying in repo_rpmdb
281  */
282 void repodata_disable_paging(Repodata *data);
283
284 /* helper functions */
285 Id repodata_globalize_id(Repodata *data, Id id, int create);
286 Id repodata_localize_id(Repodata *data, Id id, int create);
287 Id repodata_str2dir(Repodata *data, const char *dir, int create);
288 const char *repodata_dir2str(Repodata *data, Id did, const char *suf);
289 const char *repodata_chk2str(Repodata *data, Id type, const unsigned char *buf);
290 void repodata_set_location(Repodata *data, Id solvid, int medianr, const char *dir, const char *file);
291 Id repodata_lookup_id_uninternalized(Repodata *data, Id solvid, Id keyname, Id voidid);
292
293 /* stats */
294 unsigned int repodata_memused(Repodata *data);
295
296 #endif /* LIBSOLV_REPODATA_H */