2
* libdpkg - Debian packaging suite library routines
3
* dpkg-db.h - declarations for in-core package database management
5
* Copyright © 1994,1995 Ian Jackson <ian@chiark.greenend.org.uk>
6
* Copyright © 2000,2001 Wichert Akkerman
8
* This is free software; you can redistribute it and/or modify
9
* it under the terms of the GNU General Public License as
10
* published by the Free Software Foundation; either version 2,
11
* or (at your option) any later version.
13
* This is distributed in the hope that it will be useful, but
14
* WITHOUT ANY WARRANTY; without even the implied warranty of
15
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
* GNU General Public License for more details.
18
* You should have received a copy of the GNU General Public
19
* License along with dpkg; if not, write to the Free Software
20
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
30
#include <sys/types.h>
33
struct versionrevision {
58
dvr_earlierequal= dvrf_builtup | dvrf_earlier | dvrf_orequal,
59
dvr_earlierstrict= dvrf_builtup | dvrf_earlier | dvrf_strict,
60
dvr_laterequal= dvrf_builtup | dvrf_later | dvrf_orequal,
61
dvr_laterstrict= dvrf_builtup | dvrf_later | dvrf_strict,
67
struct dependency *next;
68
struct deppossi *list;
73
struct dependency *up;
75
struct deppossi *next, *nextrev, *backrev;
76
struct versionrevision version;
77
enum depverrel verrel;
81
struct arbitraryfield {
82
struct arbitraryfield *next;
88
struct conffile *next;
95
struct filedetails *next;
97
const char *msdosname;
102
struct pkginfoperfile { /* pif */
104
struct dependency *depends;
105
struct deppossi *depended;
106
int essential; /* The `essential' flag, 1=yes, 0=no (absent) */
107
const char *description;
108
const char *maintainer;
110
const char *architecture;
111
const char *installedsize;
114
struct versionrevision version;
115
struct conffile *conffiles;
116
struct arbitraryfield *arbs;
120
/* Node indicates that parent's Triggers-Pending mentions name. */
121
/* NB that these nodes do double duty: after they're removed from
122
* a package's trigpend list, references may be preserved by the
123
* trigger cycle checker (see trigproc.c).
125
struct trigpend *next;
130
/* Node indicates that aw's Triggers-Awaited mentions pend. */
131
struct pkginfo *aw, *pend;
132
struct trigaw *nextsamepend;
134
struct trigaw *next, *back;
138
struct perpackagestate; /* dselect and dpkg have different versions of this */
140
struct pkginfo { /* pig */
141
struct pkginfo *next;
144
want_unknown, want_install, want_hold, want_deinstall, want_purge,
145
want_sentinel /* Not allowed except as special sentinel value
149
eflagf_reinstreq = 01,
150
eflagf_obsoletehold = 02,
152
eflagv_reinstreq = eflagf_reinstreq,
153
eflagv_obsoletehold = eflagf_obsoletehold,
154
eflagv_obsoleteboth = eflagf_reinstreq | eflagf_obsoletehold
155
} eflag; /* bitmask, but obsoletehold no longer used except when reading */
162
stat_triggersawaited,
163
stat_triggerspending,
172
pri_other, pri_unknown, pri_unset=-1
174
const char *otherpriority;
176
struct versionrevision configversion;
177
struct filedetails *files;
178
struct pkginfoperfile installed;
179
struct pkginfoperfile available;
180
struct perpackagestate *clientdata;
181
enum { white, gray, black } color; /* used during cycle detection */
185
struct trigaw *head, *tail;
188
/* ->pend == this, non-NULL for us when Triggers-Pending. */
189
struct trigaw *othertrigaw_head;
190
struct trigpend *trigpend_head;
193
/*** from lock.c ***/
195
void lockdatabase(const char *admindir);
196
void unlockdatabase(void);
198
/*** from dbmodify.c ***/
201
/* Those marked with \*s*\ are possible returns from modstatdb_init. */
202
msdbrw_readonly/*s*/, msdbrw_needsuperuserlockonly/*s*/,
204
msdbrw_write/*s*/, msdbrw_needsuperuser,
205
/* Now some optional flags: */
206
msdbrw_flagsmask= ~077,
207
/* flags start at 0100 */
208
msdbrw_noavail= 0100,
211
enum modstatdb_rw modstatdb_init(const char *admindir, enum modstatdb_rw reqrwflags);
212
void modstatdb_note(struct pkginfo *pkg);
213
void modstatdb_note_ifwrite(struct pkginfo *pkg);
214
void modstatdb_checkpoint(void);
215
void modstatdb_shutdown(void);
217
/* Initialised by modstatdb_init. */
218
extern char *statusfile, *availablefile;
219
extern char *triggersdir, *triggersfilefile, *triggersnewfilefile;
221
const char *pkgadminfile(struct pkginfo *pkg, const char *whichfile);
223
/*** from trigdeferred.l ***/
225
enum trigdef_updateflags {
229
/* Should not be set unless _write is. */
230
tduf_writeifempty = 010,
231
tduf_writeifenoent = 020,
234
struct trigdefmeths {
235
void (*trig_begin)(const char *trig);
236
void (*package)(const char *awname);
237
void (*trig_end)(void);
240
extern const struct trigdefmeths *trigdef;
241
extern FILE *trig_new_deferred;
244
* -1 Lock ENOENT with O_CREAT (directory does not exist)
245
* -2 Unincorp empty, tduf_writeifempty unset
246
* -3 Unincorp ENOENT, tduf_writeifenoent unset
247
* 1 Unincorp ENOENT, tduf_writeifenoent set } caller must call
248
* 2 ok } trigdef_update_done!
250
int trigdef_update_start(enum trigdef_updateflags uf, const char *admindir);
252
int trigdef_yylex(void);
253
void trigdef_process_done(void);
255
/*** hooks for more sophisticated processing in dpkg proper ***/
257
/* We do things like this so we can get most of the trigger tracking
258
* in dpkg-query, dselect, and so on, but avoid the transitional
259
* processing and deferred trigproc queue management other than when
260
* we're actually doing real package management work. */
264
struct filenamenode *fnn;
265
struct trigfileint *samefile_next;
267
struct trigfileint *next, *back;
272
/* The first two are normally NULL.
273
* If non-NULL, we're dpkg proper and we might need to invent trigger
274
* activations as the first run of a triggers-supporting dpkg.
276
void (*enqueue_deferred)(struct pkginfo *pend);
277
void (*transitional_activate)(enum modstatdb_rw cstatus);
279
struct filenamenode *(*namenode_find)(const char *filename, int nonew);
280
struct trigfileint **(*namenode_interested)(struct filenamenode *fnn);
282
/* Returns a pointer from nfmalloc. */
283
const char *(*namenode_name)(struct filenamenode *fnn);
286
extern struct trig_hooks trigh;
288
#define TRIGHOOKS_DEFINE_NAMENODE_ACCESSORS \
289
static struct trigfileint **th_nn_interested(struct filenamenode *fnn) \
290
{ return &fnn->trig_interested; } \
291
static const char *th_nn_name(struct filenamenode *fnn) \
292
{ return fnn->name; }
294
/*** from triglib.c ***/
296
void trig_file_activate_byname(const char *trig, struct pkginfo *aw);
297
void trig_file_activate(struct filenamenode *trig, struct pkginfo *aw);
299
int trig_note_pend_core(struct pkginfo *pend, const char *trig /*not copied!*/);
300
int trig_note_pend(struct pkginfo *pend, const char *trig /*not copied!*/);
301
int trig_note_aw(struct pkginfo *pend, struct pkginfo *aw);
302
void trig_clear_awaiters(struct pkginfo *notpend);
304
void trig_enqueue_awaited_pend(struct pkginfo *pend);
305
void trig_fixup_awaiters(enum modstatdb_rw cstatus);
307
void trig_file_interests_ensure(void);
308
void trig_file_interests_save(void);
310
void trig_cicb_interest_delete(const char *trig, void *user);
311
void trig_cicb_interest_add(const char *trig, void *user);
312
typedef void trig_parse_cicb(const char *trig, void *user);
313
void trig_parse_ci(const char *file, trig_parse_cicb *interest,
314
trig_parse_cicb *activate, void *user);
316
/* Called by process_archive. */
317
void trig_cicb_statuschange_activate(const char *trig, void *user);
319
void trig_incorporate(enum modstatdb_rw cstatus, const char *admindir);
321
const char *illegal_triggername(const char *p);
323
/*** from database.c ***/
325
struct pkginfo *findpackage(const char *name);
326
void blankpackage(struct pkginfo *pp);
327
void blankpackageperfile(struct pkginfoperfile *pifp);
328
void blankversion(struct versionrevision*);
329
int informative(struct pkginfo *pkg, struct pkginfoperfile *info);
330
int countpackages(void);
331
void resetpackages(void);
333
struct pkgiterator *iterpkgstart(void);
334
struct pkginfo *iterpkgnext(struct pkgiterator*);
335
void iterpkgend(struct pkgiterator*);
337
void hashreport(FILE*);
339
/*** from parse.c ***/
342
pdb_recordavailable =001, /* Store in `available' in-core structures, not `status' */
343
pdb_rejectstatus =002, /* Throw up an error if `Status' encountered */
344
pdb_weakclassification=004, /* Ignore priority/section info if we already have any */
345
pdb_ignorefiles =010 /* Ignore files info if we already have them */
348
const char *illegal_packagename(const char *p, const char **ep);
349
int parsedb(const char *filename, enum parsedbflags, struct pkginfo **donep,
350
FILE *warnto, int *warncount);
351
void copy_dependency_links(struct pkginfo *pkg,
352
struct dependency **updateme,
353
struct dependency *newdepends,
356
/*** from parsehelp.c ***/
363
extern const struct namevalue booleaninfos[];
364
extern const struct namevalue priorityinfos[];
365
extern const struct namevalue statusinfos[];
366
extern const struct namevalue eflaginfos[];
367
extern const struct namevalue wantinfos[];
369
int informativeversion(const struct versionrevision *version);
371
enum versiondisplayepochwhen { vdew_never, vdew_nonambig, vdew_always };
372
void varbufversion(struct varbuf*, const struct versionrevision*,
373
enum versiondisplayepochwhen);
374
const char *parseversion(struct versionrevision *rversion, const char*);
375
const char *versiondescribe(const struct versionrevision*,
376
enum versiondisplayepochwhen);
378
/*** from varbuf.c ***/
382
#define VARBUF_INIT { 0, 0, NULL }
384
extern void varbufaddc(struct varbuf *v, int c);
385
extern void varbufdupc(struct varbuf *v, int c, size_t s);
386
extern void varbufsubstc(struct varbuf *v, int c_src, int c_dst);
387
int varbufprintf(struct varbuf *v, const char *fmt, ...) PRINTFFORMAT(2,3);
388
int varbufvprintf(struct varbuf *v, const char *fmt, va_list va);
389
void varbufinit(struct varbuf *v, size_t size);
390
void varbufreset(struct varbuf *v);
391
void varbufextend(struct varbuf *v);
392
void varbuffree(struct varbuf *v);
393
#define varbufaddstr(v, s) varbufaddbuf(v, s, strlen(s))
394
extern void varbufaddbuf(struct varbuf *v, const void *s, size_t size);
396
/* varbufinit must be called exactly once before the use of each varbuf
397
* (including before any call to varbuffree), or the variable must be
398
* initialized with VARBUF_INIT.
400
* However, varbufs allocated `static' are properly initialised anyway and
401
* do not need varbufinit; multiple consecutive calls to varbufinit before
402
* any use are allowed.
404
* varbuffree must be called after a varbuf is finished with, if anything
405
* other than varbufinit has been done. After this you are allowed but
406
* not required to call varbufinit again if you want to start using the
409
* Callers using C++ need not worry about any of this.
416
void init(size_t _size = 0) { varbufinit(this, _size); }
417
void free() { varbuffree(this); }
418
varbuf(size_t _size = 0) { varbufinit(this, _size); }
419
~varbuf() { varbuffree(this); }
420
void operator()(int c) { varbufaddc(this,c); }
421
void operator()(const char *s) { varbufaddstr(this,s); }
422
void terminate(void/*to shut 2.6.3 up*/) { varbufaddc(this,0); used--; }
423
void reset() { used=0; }
424
const char *string() { terminate(); return buf; }
428
/*** from dump.c ***/
430
void writerecord(FILE*, const char*,
431
const struct pkginfo*, const struct pkginfoperfile*);
433
void writedb(const char *filename, int available, int mustsync);
435
void varbufrecord(struct varbuf*, const struct pkginfo*, const struct pkginfoperfile*);
436
void varbufdependency(struct varbuf *vb, struct dependency *dep);
437
/* NB THE VARBUF MUST HAVE BEEN INITIALISED AND WILL NOT BE NULL-TERMINATED */
439
/*** from vercmp.c ***/
441
int versionsatisfied(struct pkginfoperfile *it, struct deppossi *against);
442
int versionsatisfied3(const struct versionrevision *it,
443
const struct versionrevision *ref,
444
enum depverrel verrel);
445
int versioncompare(const struct versionrevision *version,
446
const struct versionrevision *refversion);
447
int epochsdiffer(const struct versionrevision *a,
448
const struct versionrevision *b);
450
/*** from nfmalloc.c ***/
451
extern void *nfmalloc(size_t);
452
char *nfstrsave(const char*);
453
char *nfstrnsave(const char*, size_t);
454
void nffreeall(void);
456
/*** from showpkg.c ***/
460
struct lstitem* parseformat(const char* fmt);
461
void freeformat(struct lstitem* head);
462
void show1package(const struct lstitem* head, struct pkginfo *pkg);
466
#endif /* DPKG_DB_H */