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