4 /** \ingroup rpmdep rpmtrans
6 * Structure(s) used for dependency tag sets.
15 extern int _rpmds_debug;
22 extern int _rpmds_nopromote;
25 #if defined(_RPMDS_INTERNAL)
27 * A package dependency set.
31 const char * Type; /*!< Tag name. */
33 const char * DNEVR; /*!< Formatted dependency string. */
34 /*@refcounted@*/ /*@null@*/
35 Header h; /*!< Header for dependency set (or NULL) */
37 const char ** N; /*!< Name. */
39 const char ** EVR; /*!< Epoch-Version-Release. */
41 int_32 * Flags; /*!< Bit(s) identifying context/comparison. */
43 uint_32 * Color; /*!< Bit(s) calculated from file color(s). */
45 int_32 * Refs; /*!< No. of file refs. */
46 int_32 BT; /*!< Package build time tie breaker. */
47 rpmTag tagN; /*!< Header tag. */
48 rpmTagType Nt, EVRt, Ft; /*!< Tag data types. */
49 int_32 Count; /*!< No. of elements */
50 int i; /*!< Element index. */
51 unsigned l; /*!< Low element (bsearch). */
52 unsigned u; /*!< High element (bsearch). */
53 int nopromote; /*!< Don't promote Epoch: in rpmdsCompare()? */
55 int nrefs; /*!< Reference count. */
57 #endif /* _RPMDS_INTERNAL */
64 * Unreference a dependency set instance.
65 * @param ds dependency set
69 /*@unused@*/ /*@null@*/
70 rpmds rpmdsUnlink (/*@killref@*/ /*@only@*/ /*@null@*/ rpmds ds,
71 /*@null@*/ const char * msg)
74 /** @todo Remove debugging entry from the ABI. */
77 rpmds XrpmdsUnlink (/*@killref@*/ /*@only@*/ /*@null@*/ rpmds ds,
78 /*@null@*/ const char * msg, const char * fn, unsigned ln)
81 #define rpmdsUnlink(_ds, _msg) XrpmdsUnlink(_ds, _msg, __FILE__, __LINE__)
84 * Reference a dependency set instance.
85 * @param ds dependency set
87 * @return new dependency set reference
89 /*@unused@*/ /*@newref@*/ /*@null@*/
90 rpmds rpmdsLink (/*@null@*/ rpmds ds, /*@null@*/ const char * msg)
93 /** @todo Remove debugging entry from the ABI. */
94 /*@newref@*/ /*@null@*/
95 rpmds XrpmdsLink (/*@null@*/ rpmds ds, /*@null@*/ const char * msg,
96 const char * fn, unsigned ln)
98 #define rpmdsLink(_ds, _msg) XrpmdsLink(_ds, _msg, __FILE__, __LINE__)
101 * Destroy a dependency set.
102 * @param ds dependency set
103 * @return NULL always
106 rpmds rpmdsFree(/*@killref@*/ /*@only@*/ /*@null@*/ rpmds ds)
109 * Create and load a dependency set.
110 * @deprecated Only scareMem = 0 will be permitted.
112 * @param tagN type of dependency
113 * @param scareMem Use pointers to refcounted header memory?
114 * @return new dependency set
117 rpmds rpmdsNew(Header h, rpmTag tagN, int scareMem)
121 * Return new formatted dependency string.
122 * @param dspfx formatted dependency string prefix
123 * @param ds dependency set
124 * @return new formatted dependency (malloc'ed)
127 char * rpmdsNewDNEVR(const char * dspfx, const rpmds ds)
131 * Create, load and initialize a dependency for this header.
133 * @param tagN type of dependency
134 * @param Flags comparison flags
135 * @return new dependency set
138 rpmds rpmdsThis(Header h, rpmTag tagN, int_32 Flags)
142 * Create, load and initialize a dependency set of size 1.
143 * @param tagN type of dependency
145 * @param EVR epoch:version-release
146 * @param Flags comparison flags
147 * @return new dependency set
150 rpmds rpmdsSingle(rpmTag tagN, const char * N, const char * EVR, int_32 Flags)
154 * Return dependency set count.
155 * @param ds dependency set
156 * @return current count
158 int rpmdsCount(/*@null@*/ const rpmds ds)
162 * Return dependency set index.
163 * @param ds dependency set
164 * @return current index
166 int rpmdsIx(/*@null@*/ const rpmds ds)
170 * Set dependency set index.
171 * @param ds dependency set
172 * @param ix new index
173 * @return current index
175 int rpmdsSetIx(/*@null@*/ rpmds ds, int ix)
179 * Return current formatted dependency string.
180 * @param ds dependency set
181 * @return current dependency DNEVR, NULL on invalid
183 /*@observer@*/ /*@null@*/
184 extern const char * rpmdsDNEVR(/*@null@*/ const rpmds ds)
188 * Return current dependency name.
189 * @param ds dependency set
190 * @return current dependency name, NULL on invalid
192 /*@observer@*/ /*@null@*/
193 extern const char * rpmdsN(/*@null@*/ const rpmds ds)
197 * Return current dependency epoch-version-release.
198 * @param ds dependency set
199 * @return current dependency EVR, NULL on invalid
201 /*@observer@*/ /*@null@*/
202 extern const char * rpmdsEVR(/*@null@*/ const rpmds ds)
206 * Return current dependency flags.
207 * @param ds dependency set
208 * @return current dependency flags, 0 on invalid
210 int_32 rpmdsFlags(/*@null@*/ const rpmds ds)
214 * Return current dependency type.
215 * @param ds dependency set
216 * @return current dependency type, 0 on invalid
218 rpmTag rpmdsTagN(/*@null@*/ const rpmds ds)
222 * Return dependency build time.
223 * @param ds dependency set
224 * @return dependency build time, 0 on invalid
226 time_t rpmdsBT(/*@null@*/ const rpmds ds)
230 * Set dependency build time.
231 * @param ds dependency set
232 * @return dependency build time, 0 on invalid
234 time_t rpmdsSetBuildtime(/*@null@*/ const rpmds ds, time_t BT)
238 * Return current "Don't promote Epoch:" flag.
240 * This flag controls for Epoch: promotion when a dependency set is
241 * compared. If the flag is set (for already installed packages), then
242 * an unspecified value will be treated as Epoch: 0. Otherwise (for added
243 * packages), the Epoch: portion of the comparison is skipped if the value
244 * is not specified, i.e. an unspecified Epoch: is assumed to be equal
245 * in dependency comparisons.
247 * @param ds dependency set
248 * @return current "Don't promote Epoch:" flag
250 int rpmdsNoPromote(/*@null@*/ const rpmds ds)
254 * Set "Don't promote Epoch:" flag.
255 * @param ds dependency set
256 * @param nopromote Should an unspecified Epoch: be treated as Epoch: 0?
257 * @return previous "Don't promote Epoch:" flag
259 int rpmdsSetNoPromote(/*@null@*/ rpmds ds, int nopromote)
263 * Return current dependency color.
264 * @param ds dependency set
265 * @return current dependency color
267 uint_32 rpmdsColor(/*@null@*/ const rpmds ds)
271 * Return current dependency color.
272 * @param ds dependency set
273 * @param color new dependency color
274 * @return previous dependency color
276 uint_32 rpmdsSetColor(/*@null@*/ const rpmds ds, uint_32 color)
280 * Return current dependency file refs.
281 * @param ds dependency set
282 * @return current dependency file refs, -1 on global
284 int_32 rpmdsRefs(/*@null@*/ const rpmds ds)
288 * Return current dependency color.
289 * @param ds dependency set
290 * @param refs new dependency refs
291 * @return previous dependency refs
293 int_32 rpmdsSetRefs(/*@null@*/ const rpmds ds, int_32 refs)
297 * Notify of results of dependency match.
298 * @param ds dependency set
299 * @param where where dependency was resolved (or NULL)
300 * @param rc 0 == YES, otherwise NO
302 /*@-globuse@*/ /* FIX: rpmMessage annotation is a lie */
303 void rpmdsNotify(/*@null@*/ rpmds ds, /*@null@*/ const char * where, int rc)
304 /*@globals fileSystem @*/
305 /*@modifies fileSystem @*/;
309 * Return next dependency set iterator index.
310 * @param ds dependency set
311 * @return dependency set iterator index, -1 on termination
313 int rpmdsNext(/*@null@*/ rpmds ds)
317 * Initialize dependency set iterator.
318 * @param ds dependency set
319 * @return dependency set
322 rpmds rpmdsInit(/*@null@*/ rpmds ds)
326 * Find a dependency set element using binary search.
327 * @param ds dependency set to search
328 * @param ods dependency set element to find.
329 * @return dependency index (or -1 if not found)
332 int rpmdsFind(rpmds ds, /*@null@*/ rpmds ods)
333 /*@modifies ds, ods @*/;
336 * Merge a dependency set maintaining (N,EVR,Flags) sorted order.
337 * @retval *dsp (merged) dependency set
338 * @param ods dependency set to merge
339 * @return (merged) dependency index
342 int rpmdsMerge(/*@out@*/ rpmds * dsp, /*@null@*/ rpmds ods)
343 /*@modifies *dsp, ods @*/;
346 * Compare two versioned dependency ranges, looking for overlap.
347 * @param A 1st dependency
348 * @param B 2nd dependency
349 * @return 1 if dependencies overlap, 0 otherwise
351 int rpmdsCompare(const rpmds A, const rpmds B)
355 * Report a Requires: or Conflicts: dependency problem.
356 * @param ps transaction set problems
357 * @param pkgNEVR package name/epoch/version/release
358 * @param ds dependency set
359 * @param suggestedKeys filename or python object address
360 * @param adding dependency problem is from added package set?
362 void rpmdsProblem(/*@null@*/ rpmps ps, const char * pkgNEVR, const rpmds ds,
363 /*@only@*/ /*@null@*/ const fnpyKey * suggestedKeys,
368 * Compare package provides dependencies from header with a single dependency.
370 * @param req dependency set
371 * @param nopromote Don't promote Epoch: in comparison?
372 * @return 1 if any dependency overlaps, 0 otherwise
374 int rpmdsAnyMatchesDep (const Header h, const rpmds req, int nopromote)
378 * Compare package name-version-release from header with a single dependency.
380 * @param req dependency set
381 * @param nopromote Don't promote Epoch: in comparison?
382 * @return 1 if dependency overlaps, 0 otherwise
384 int rpmdsNVRMatchesDep(const Header h, const rpmds req, int nopromote)