rpm  4.12.0.1
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  /* bits 9-15 unused */
41  RPMTRANS_FLAG_NOPRE = (1 << 17),
42  RPMTRANS_FLAG_NOPOST = (1 << 18),
45  RPMTRANS_FLAG_NOPREUN = (1 << 21),
46  RPMTRANS_FLAG_NOPOSTUN = (1 << 22),
50  /* bit 26 unused */
51  RPMTRANS_FLAG_NOMD5 = (1 << 27),
53  /* bits 28-29 unused */
56 };
57 
59 
60 #define _noTransScripts \
61  ( RPMTRANS_FLAG_NOPRE | \
62  RPMTRANS_FLAG_NOPOST | \
63  RPMTRANS_FLAG_NOPREUN | \
64  RPMTRANS_FLAG_NOPOSTUN | \
65  RPMTRANS_FLAG_NOPRETRANS | \
66  RPMTRANS_FLAG_NOPOSTTRANS \
67  )
68 
69 #define _noTransTriggers \
70  ( RPMTRANS_FLAG_NOTRIGGERPREIN | \
71  RPMTRANS_FLAG_NOTRIGGERIN | \
72  RPMTRANS_FLAG_NOTRIGGERUN | \
73  RPMTRANS_FLAG_NOTRIGGERPOSTUN \
74  )
75 
76 /* Avoid unnecessary breakage for stuff referring to these unused flags */
77 #define RPMTRANS_FLAG_NOPAYLOAD 0
78 #define RPMTRANS_FLAG_APPLYONLY 0
79 #define RPMTRANS_FLAG_KEEPOBSOLETE 0
80 #define RPMTRANS_FLAG_DIRSTASH 0
81 #define RPMTRANS_FLAG_REPACKAGE 0
82 #define RPMTRANS_FLAG_PKGCOMMIT 0
83 #define RPMTRANS_FLAG_PKGUNDO 0
84 #define RPMTRANS_FLAG_COMMIT 0
85 #define RPMTRANS_FLAG_UNDO 0
86 #define RPMTRANS_FLAG_REVERSE 0
87 #define RPMTRANS_FLAG_NOSUGGEST 0
88 #define RPMTRANS_FLAG_ADDINDEPS 0
89 
95  RPMVSF_NOHDRCHK = (1 << 0),
96  RPMVSF_NEEDPAYLOAD = (1 << 1),
97  /* bit(s) 2-7 unused */
98  RPMVSF_NOSHA1HEADER = (1 << 8),
99  RPMVSF_NOMD5HEADER = (1 << 9), /* unimplemented */
100  RPMVSF_NODSAHEADER = (1 << 10),
101  RPMVSF_NORSAHEADER = (1 << 11), /* unimplemented */
102  /* bit(s) 12-15 unused */
103  RPMVSF_NOSHA1 = (1 << 16), /* unimplemented */
104  RPMVSF_NOMD5 = (1 << 17),
105  RPMVSF_NODSA = (1 << 18),
106  RPMVSF_NORSA = (1 << 19)
107  /* bit(s) 16-31 unused */
108 };
109 
111 
112 #define _RPMVSF_NODIGESTS \
113  ( RPMVSF_NOSHA1HEADER | \
114  RPMVSF_NOMD5HEADER | \
115  RPMVSF_NOSHA1 | \
116  RPMVSF_NOMD5 )
117 
118 #define _RPMVSF_NOSIGNATURES \
119  ( RPMVSF_NODSAHEADER | \
120  RPMVSF_NORSAHEADER | \
121  RPMVSF_NODSA | \
122  RPMVSF_NORSA )
123 
124 #define _RPMVSF_NOHEADER \
125  ( RPMVSF_NOSHA1HEADER | \
126  RPMVSF_NOMD5HEADER | \
127  RPMVSF_NODSAHEADER | \
128  RPMVSF_NORSAHEADER )
129 
130 #define _RPMVSF_NOPAYLOAD \
131  ( RPMVSF_NOSHA1 | \
132  RPMVSF_NOMD5 | \
133  RPMVSF_NODSA | \
134  RPMVSF_NORSA )
135 
139 typedef enum rpmtsOpX_e {
157 } rpmtsOpX;
158 
160  RPMTXN_READ = (1 << 0),
161  RPMTXN_WRITE = (1 << 1),
162 };
164 
175 int rpmtsCheck(rpmts ts);
176 
193 int rpmtsOrder(rpmts ts);
194 
212 int rpmtsRun(rpmts ts, rpmps okProbs, rpmprobFilterFlags ignoreSet);
213 
219 rpmts rpmtsLink (rpmts ts);
220 
226 int rpmtsCloseDB(rpmts ts);
227 
234 int rpmtsOpenDB(rpmts ts, int dbmode);
235 
243 int rpmtsInitDB(rpmts ts, int dbmode);
244 
250 int rpmtsGetDBMode(rpmts ts);
251 
259 int rpmtsSetDBMode(rpmts ts, int dbmode);
260 
266 int rpmtsRebuildDB(rpmts ts);
267 
273 int rpmtsVerifyDB(rpmts ts);
274 
284  const void * keyp, size_t keylen);
285 
294 
303 rpmRC rpmtsImportPubkey(rpmts ts, const unsigned char * pkt, size_t pktlen);
304 
311 rpmKeyring rpmtsGetKeyring(rpmts ts, int autoload);
312 
321 int rpmtsSetKeyring(rpmts ts, rpmKeyring keyring);
322 
331  int (*solve) (rpmts ts, rpmds ds, const void * data),
332  const void * solveData);
333 
340 
345 void rpmtsCleanProblems(rpmts ts);
346 
351 void rpmtsClean(rpmts ts);
352 
357 void rpmtsEmpty(rpmts ts);
358 
364 rpmts rpmtsFree(rpmts ts);
365 
371 rpmVSFlags rpmtsVSFlags(rpmts ts);
372 
379 rpmVSFlags rpmtsSetVSFlags(rpmts ts, rpmVSFlags vsflags);
380 
386 const char * rpmtsRootDir(rpmts ts);
387 
394 int rpmtsSetRootDir(rpmts ts, const char * rootDir);
395 
402 
408 void rpmtsSetScriptFd(rpmts ts, FD_t scriptFd);
409 
416 
424 
431 
441 void * rpmtsNotify(rpmts ts, rpmte te,
442  rpmCallbackType what, rpm_loff_t amount, rpm_loff_t total);
443 
449 int rpmtsNElements(rpmts ts);
450 
457 rpmte rpmtsElement(rpmts ts, int ix);
458 
465 
471 rpmtransFlags rpmtsFlags(rpmts ts);
472 
479 rpmtransFlags rpmtsSetFlags(rpmts ts, rpmtransFlags transFlags);
480 
487 
494 
502 
510 
517 rpmop rpmtsOp(rpmts ts, rpmtsOpX opx);
518 
525 
538  rpmCallbackFunction notify,
539  rpmCallbackData notifyData);
540 
545 rpmts rpmtsCreate(void);
546 
561  const fnpyKey key, int upgrade,
562  rpmRelocation * relocs);
563 
572 int rpmtsAddReinstallElement(rpmts ts, Header h, const fnpyKey key);
573 
581 int rpmtsAddEraseElement(rpmts ts, Header h, int dboffset);
582 
589 rpmtxn rpmtxnBegin(rpmts ts, rpmtxnFlags flags);
590 
596 rpmtxn rpmtxnEnd(rpmtxn txn);
597 
604 
611 
619 
620 #ifdef __cplusplus
621 }
622 #endif
623 
624 
625 #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:163
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:34
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:94
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
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.
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:93
const char * rpmtsRootDir(rpmts ts)
Get transaction rootDir, i.e.
const void * fnpyKey
Definition: rpmtypes.h:75
void *(* rpmCallbackFunction)(const void *h, const rpmCallbackType what, const rpm_loff_t amount, const rpm_loff_t total, fnpyKey key, rpmCallbackData data)
Definition: rpmcallback.h:39
rpmFlags rpmVSFlags
Definition: rpmts.h:110
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:159
struct rpmte_s * rpmte
Definition: rpmtypes.h:64
Cumulative statistics for an operation.
Definition: rpmsw.h:40
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.
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:58
int rpmtsSetRootDir(rpmts ts, const char *rootDir)
Set transaction rootDir, i.e.
void rpmtsSetScriptFd(rpmts ts, FD_t scriptFd)
Set transaction script file handle, i.e.
rpmtsOpX_e
Indices for timestamps.
Definition: rpmts.h:139
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.