rpm  4.14.3-rc1
rpmts.h
Go to the documentation of this file.
1 #ifndef H_RPMTS
2 #define H_RPMTS
3 
9 #include <sys/types.h>
10 
11 #include <rpm/rpmtypes.h>
12 #include <rpm/rpmte.h>
13 #include <rpm/rpmps.h>
14 #include <rpm/rpmsw.h>
15 #include <rpm/rpmpgp.h>
16 #include <rpm/rpmfi.h>
17 #include <rpm/rpmcallback.h>
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 extern int _rpmts_stats;
24 
30  RPMTRANS_FLAG_TEST = (1 << 0),
33  RPMTRANS_FLAG_JUSTDB = (1 << 3),
35  RPMTRANS_FLAG_NODOCS = (1 << 5),
39  RPMTRANS_FLAG_NOCAPS = (1 << 9),
40  /* bits 10-15 unused */
42  RPMTRANS_FLAG_NOPRE = (1 << 17),
43  RPMTRANS_FLAG_NOPOST = (1 << 18),
46  RPMTRANS_FLAG_NOPREUN = (1 << 21),
47  RPMTRANS_FLAG_NOPOSTUN = (1 << 22),
51  /* bit 26 unused */
52  RPMTRANS_FLAG_NOMD5 = (1 << 27),
54  /* bits 28-29 unused */
57 };
58 
60 
61 #define _noTransScripts \
62  ( RPMTRANS_FLAG_NOPRE | \
63  RPMTRANS_FLAG_NOPOST | \
64  RPMTRANS_FLAG_NOPREUN | \
65  RPMTRANS_FLAG_NOPOSTUN | \
66  RPMTRANS_FLAG_NOPRETRANS | \
67  RPMTRANS_FLAG_NOPOSTTRANS \
68  )
69 
70 #define _noTransTriggers \
71  ( RPMTRANS_FLAG_NOTRIGGERPREIN | \
72  RPMTRANS_FLAG_NOTRIGGERIN | \
73  RPMTRANS_FLAG_NOTRIGGERUN | \
74  RPMTRANS_FLAG_NOTRIGGERPOSTUN \
75  )
76 
77 /* Avoid unnecessary breakage for stuff referring to these unused flags */
78 #define RPMTRANS_FLAG_NOPAYLOAD 0
79 #define RPMTRANS_FLAG_APPLYONLY 0
80 #define RPMTRANS_FLAG_KEEPOBSOLETE 0
81 #define RPMTRANS_FLAG_DIRSTASH 0
82 #define RPMTRANS_FLAG_REPACKAGE 0
83 #define RPMTRANS_FLAG_PKGCOMMIT 0
84 #define RPMTRANS_FLAG_PKGUNDO 0
85 #define RPMTRANS_FLAG_COMMIT 0
86 #define RPMTRANS_FLAG_UNDO 0
87 #define RPMTRANS_FLAG_REVERSE 0
88 #define RPMTRANS_FLAG_NOSUGGEST 0
89 #define RPMTRANS_FLAG_ADDINDEPS 0
90 
96  RPMVSF_NOHDRCHK = (1 << 0),
97  RPMVSF_NEEDPAYLOAD = (1 << 1),
98  /* bit(s) 2-7 unused */
99  RPMVSF_NOSHA1HEADER = (1 << 8),
101  RPMVSF_NODSAHEADER = (1 << 10),
102  RPMVSF_NORSAHEADER = (1 << 11),
103  /* bit(s) 12-15 unused */
104  RPMVSF_NOPAYLOAD = (1 << 16),
105  RPMVSF_NOMD5 = (1 << 17),
106  RPMVSF_NODSA = (1 << 18),
107  RPMVSF_NORSA = (1 << 19)
108  /* bit(s) 16-31 unused */
109 };
110 
112 
113 #define RPMVSF_MASK_NODIGESTS \
114  ( RPMVSF_NOSHA1HEADER | \
115  RPMVSF_NOSHA256HEADER | \
116  RPMVSF_NOPAYLOAD | \
117  RPMVSF_NOMD5 )
118 #define _RPMVSF_NODIGESTS RPMVSF_MASK_NODIGESTS
119 
120 #define RPMVSF_MASK_NOSIGNATURES \
121  ( RPMVSF_NODSAHEADER | \
122  RPMVSF_NORSAHEADER | \
123  RPMVSF_NODSA | \
124  RPMVSF_NORSA )
125 #define _RPMVSF_NOSIGNATURES RPMVSF_MASK_NOSIGNATURES
126 
127 #define RPMVSF_MASK_NOHEADER \
128  ( RPMVSF_NOSHA1HEADER | \
129  RPMVSF_NOSHA256HEADER | \
130  RPMVSF_NODSAHEADER | \
131  RPMVSF_NORSAHEADER )
132 #define _RPMVSF_NOHEADER RPMVSF_MASK_NOHEADER
133 
134 #define RPMVSF_MASK_NOPAYLOAD \
135  ( RPMVSF_NOMD5 | \
136  RPMVSF_NOPAYLOAD | \
137  RPMVSF_NODSA | \
138  RPMVSF_NORSA )
139 #define _RPMVSF_NOPAYLOAD RPMVSF_MASK_NOPAYLOAD
140 
141 enum {
143  RPMSIG_DIGEST_TYPE = (1 << 0),
145  RPMSIG_OTHER_TYPE = (1 << 2),
146 };
147 
148 #define RPMSIG_VERIFIABLE_TYPE (RPMSIG_DIGEST_TYPE|RPMSIG_SIGNATURE_TYPE)
149 
153 typedef enum rpmtsOpX_e {
172 } rpmtsOpX;
173 
175  RPMTXN_READ = (1 << 0),
176  RPMTXN_WRITE = (1 << 1),
177 };
179 
190 int rpmtsCheck(rpmts ts);
191 
208 int rpmtsOrder(rpmts ts);
209 
227 int rpmtsRun(rpmts ts, rpmps okProbs, rpmprobFilterFlags ignoreSet);
228 
234 rpmts rpmtsLink (rpmts ts);
235 
241 int rpmtsCloseDB(rpmts ts);
242 
249 int rpmtsOpenDB(rpmts ts, int dbmode);
250 
258 int rpmtsInitDB(rpmts ts, int dbmode);
259 
265 int rpmtsGetDBMode(rpmts ts);
266 
274 int rpmtsSetDBMode(rpmts ts, int dbmode);
275 
281 int rpmtsRebuildDB(rpmts ts);
282 
288 int rpmtsVerifyDB(rpmts ts);
289 
299  const void * keyp, size_t keylen);
300 
309 
318 rpmRC rpmtsImportPubkey(rpmts ts, const unsigned char * pkt, size_t pktlen);
319 
326 rpmKeyring rpmtsGetKeyring(rpmts ts, int autoload);
327 
336 int rpmtsSetKeyring(rpmts ts, rpmKeyring keyring);
337 
346  int (*solve) (rpmts ts, rpmds ds, const void * data),
347  const void * solveData);
348 
355 
360 void rpmtsCleanProblems(rpmts ts);
361 
366 void rpmtsClean(rpmts ts);
367 
372 void rpmtsEmpty(rpmts ts);
373 
379 rpmts rpmtsFree(rpmts ts);
380 
387 
395 
402 
410 
416 int rpmtsVfyLevel(rpmts ts);
417 
424 int rpmtsSetVfyLevel(rpmts ts, int vfylevel);
425 
431 const char * rpmtsRootDir(rpmts ts);
432 
439 int rpmtsSetRootDir(rpmts ts, const char * rootDir);
440 
447 
453 void rpmtsSetScriptFd(rpmts ts, FD_t scriptFd);
454 
461 
469 
476 
486 void * rpmtsNotify(rpmts ts, rpmte te,
487  rpmCallbackType what, rpm_loff_t amount, rpm_loff_t total);
488 
494 int rpmtsNElements(rpmts ts);
495 
502 rpmte rpmtsElement(rpmts ts, int ix);
503 
510 
517 
525 
532 
539 
547 
555 
562 rpmop rpmtsOp(rpmts ts, rpmtsOpX opx);
563 
570 
583  rpmCallbackFunction notify,
584  rpmCallbackData notifyData);
585 
590 rpmts rpmtsCreate(void);
591 
606  const fnpyKey key, int upgrade,
607  rpmRelocation * relocs);
608 
617 int rpmtsAddReinstallElement(rpmts ts, Header h, const fnpyKey key);
618 
626 int rpmtsAddEraseElement(rpmts ts, Header h, int dboffset);
627 
635 
641 rpmtxn rpmtxnEnd(rpmtxn txn);
642 
649 
656 
664 
665 #ifdef __cplusplus
666 }
667 #endif
668 
669 
670 #endif /* H_RPMTS */
int rpmtsSetNotifyCallback(rpmts ts, rpmCallbackFunction notify, rpmCallbackData notifyData)
Set transaction notify callback function and argument.
enum rpmCallbackType_e rpmCallbackType
Bit(s) to identify progress callbacks.
rpmRC rpmtsImportPubkey(rpmts ts, const unsigned char *pkt, size_t pktlen)
Import public key packet(s).
struct rpmdbMatchIterator_s * rpmdbMatchIterator
Definition: rpmtypes.h:69
rpmop rpmtsOp(rpmts ts, rpmtsOpX opx)
Retrieve operation timestamp from a transaction set.
rpmprobFilterFlags rpmtsFilterFlags(rpmts ts)
Get problem ignore bit mask, i.e.
rpmtxn rpmtxnEnd(rpmtxn txn)
Destroy transaction (lock) handle.
struct rpmps_s * rpmps
Definition: rpmtypes.h:71
struct rpmtxn_s * rpmtxn
Definition: rpmtypes.h:72
rpm_color_t rpmtsSetColor(rpmts ts, rpm_color_t color)
Set color bits of transaction set.
struct rpmtsi_s * rpmtsi
Definition: rpmtypes.h:70
rpmtransFlags rpmtsSetFlags(rpmts ts, rpmtransFlags transFlags)
Set transaction flags, i.e.
rpmdb rpmtsGetRdb(rpmts ts)
Get transaction set database handle.
rpmts rpmtsFree(rpmts ts)
Destroy transaction set, closing the database as well.
rpmPlugins rpmtsPlugins(rpmts ts)
Get the plugins associated with a transaction set.
rpmts rpmtsLink(rpmts ts)
Reference a transaction set instance.
rpmFlags rpmtxnFlags
Definition: rpmts.h:178
int rpmtsRebuildDB(rpmts ts)
Rebuild the database used by the transaction.
rpm_tid_t rpmtsGetTid(rpmts ts)
Get transaction id, i.e.
void rpmtsEmpty(rpmts ts)
Re-create an empty transaction set.
int rpmtsSetKeyring(rpmts ts, rpmKeyring keyring)
Set keyring to use for this transaction set.
void * rpmtsNotify(rpmts ts, rpmte te, rpmCallbackType what, rpm_loff_t amount, rpm_loff_t total)
Perform transaction progress notify callback.
struct rpmts_s * rpmts
The main types involved in transaction manipulation.
Definition: rpmtypes.h:63
void * rpmCallbackData
Definition: rpmtypes.h:76
rpm_color_t rpmtsColor(rpmts ts)
Retrieve color bits of transaction set.
rpm_color_t rpmtsPrefColor(rpmts ts)
Retrieve preferred file color.
rpmFlags rpmprobFilterFlags
Definition: rpmprob.h:35
int rpmtsAddInstallElement(rpmts ts, Header h, const fnpyKey key, int upgrade, rpmRelocation *relocs)
Add package to be installed to transaction set.
We pass these around as an array with a sentinel.
Definition: rpmfiles.h:96
int rpmtsSetSolveCallback(rpmts ts, int(*solve)(rpmts ts, rpmds ds, const void *data), const void *solveData)
Set dependency solver callback.
FD_t rpmtsScriptFd(rpmts ts)
Get transaction script file handle, i.e.
rpmdbMatchIterator rpmtsInitIterator(const rpmts ts, rpmDbiTagVal rpmtag, const void *keyp, size_t keylen)
Return transaction database iterator.
struct rpmKeyring_s * rpmKeyring
Definition: rpmtypes.h:80
void *(* rpmCallbackFunction)(const void *h, const rpmCallbackType what, const rpm_loff_t amount, const rpm_loff_t total, fnpyKey key, rpmCallbackData data)
Function pointer type for rpmtsSetNotifyCallback() triggered by rpmtsNotify()
Definition: rpmcallback.h:61
rpmts rpmtsCreate(void)
Create an empty transaction set.
struct rpmPlugins_s * rpmPlugins
Definition: rpmtypes.h:86
int _rpmts_stats
uint32_t rpmFlags
Definition: rpmtypes.h:42
int rpmtsAddReinstallElement(rpmts ts, Header h, const fnpyKey key)
Add package to be reinstalled to transaction set.
int rpmtsInitDB(rpmts ts, int dbmode)
Initialize the database used by the transaction.
struct rpmdb_s * rpmdb
Definition: rpmtypes.h:68
rpmtransFlags_e
Bit(s) to control rpmtsRun() operation.
Definition: rpmts.h:28
enum rpmtsOpX_e rpmtsOpX
Indices for timestamps.
struct _FD_s * FD_t
RPM IO file descriptor type.
Definition: rpmtypes.h:98
int rpmtsVerifyDB(rpmts ts)
Verify the database used by the transaction.
uint32_t rpm_color_t
Definition: rpmtypes.h:38
int rpmtsCloseDB(rpmts ts)
Close the database used by the transaction.
rpmVSFlags rpmtsSetVfyFlags(rpmts ts, rpmVSFlags vfyflags)
Set package verify flag(s).
struct headerToken_s * Header
RPM header and data retrieval types.
Definition: rpmtypes.h:24
rpmVSFlags_e
Bit(s) to control digest and signature verification.
Definition: rpmts.h:94
int rpmtsSetVfyLevel(rpmts ts, int vfylevel)
Set enforced package verify level.
const char * rpmtsRootDir(rpmts ts)
Get transaction rootDir, i.e.
const void * fnpyKey
Definition: rpmtypes.h:75
rpmFlags rpmVSFlags
Definition: rpmts.h:111
struct rpmds_s * rpmds
Definition: rpmtypes.h:65
int rpmtsOpenDB(rpmts ts, int dbmode)
Open the database used by the transaction.
rpmtsi rpmtsiFree(rpmtsi tsi)
Destroy transaction element iterator.
rpmte rpmtsElement(rpmts ts, int ix)
Return (ordered) transaction set element.
rpmte rpmtsiNext(rpmtsi tsi, rpmElementTypes types)
Return next transaction element of type.
int rpmtsSetDBMode(rpmts ts, int dbmode)
Set the transaction database mode.
rpmtxnFlags_e
Definition: rpmts.h:174
struct rpmte_s * rpmte
Definition: rpmtypes.h:64
Cumulative statistics for an operation.
Definition: rpmsw.h:42
rpmRC rpmtsImportHeader(rpmtxn txn, Header h, rpmFlags flags)
Import a header into the rpmdb.
rpmVSFlags rpmtsSetVSFlags(rpmts ts, rpmVSFlags vsflags)
Set verify signatures flag(s).
rpmKeyring rpmtsGetKeyring(rpmts ts, int autoload)
Retrieve handle for keyring used for this transaction set.
uint32_t rpm_tid_t
Definition: rpmtypes.h:40
int rpmtsOrder(rpmts ts)
Determine package order in a transaction set according to dependencies.
void rpmtsClean(rpmts ts)
Free memory needed only for dependency checks and ordering.
rpm_tag_t rpmDbiTagVal
Definition: rpmtypes.h:31
int rpmtsAddEraseElement(rpmts ts, Header h, int dboffset)
Add package to be erased to transaction set.
int rpmtsRun(rpmts ts, rpmps okProbs, rpmprobFilterFlags ignoreSet)
Process all package elements in a transaction set.
int rpmtsGetDBMode(rpmts ts)
Return the transaction database mode.
int rpmtsNElements(rpmts ts)
Return number of (ordered) transaction set elements.
rpmtransFlags rpmtsFlags(rpmts ts)
Get transaction flags, i.e.
rpmVSFlags rpmtsVfyFlags(rpmts ts)
Get package verify flag(s).
rpmFlags rpmElementTypes
Definition: rpmte.h:24
rpmVSFlags rpmtsVSFlags(rpmts ts)
Get verify signatures flag(s).
rpm_color_t rpmtsSetPrefColor(rpmts ts, rpm_color_t color)
Set preferred file color.
rpmFlags rpmtransFlags
Definition: rpmts.h:59
int rpmtsSetRootDir(rpmts ts, const char *rootDir)
Set transaction rootDir, i.e.
int rpmtsVfyLevel(rpmts ts)
Get enforced package verify level.
void rpmtsSetScriptFd(rpmts ts, FD_t scriptFd)
Set transaction script file handle, i.e.
rpmtsOpX_e
Indices for timestamps.
Definition: rpmts.h:153
int rpmtsCheck(rpmts ts)
Perform dependency resolution on the transaction set.
uint64_t rpm_loff_t
Definition: rpmtypes.h:51
void rpmtsCleanProblems(rpmts ts)
Clean current transaction problem set.
rpmtsi rpmtsiInit(rpmts ts)
Create transaction element iterator.
enum rpmRC_e rpmRC
Package read return codes.
rpmtxn rpmtxnBegin(rpmts ts, rpmtxnFlags flags)
Create a transaction (lock) handle.
rpmps rpmtsProblems(rpmts ts)
Return current transaction set problems.
rpm_tid_t rpmtsSetTid(rpmts ts, rpm_tid_t tid)
Set transaction id, i.e.