lib/rpmds.h

   1 #ifndef H_RPMDS
   2 #define H_RPMDS
   3
   4 /** \ingroup rpmdep rpmtrans
   5  * \file lib/rpmds.h
   6  * Structure(s) used for dependency tag sets.
   7  */
   8
   9 #include <time.h>
  10
  11 #include <rpm/rpmtypes.h>
  12 #include <rpm/rpmps.h>
  13
  14 #ifdef __cplusplus
  15 extern "C" {
  16 #endif
  17
  18 /**
  19  */
  20 extern int _rpmds_debug;
  21
  22 /**
  23  */
  24 extern int _rpmds_nopromote;
  25
  26 /** \ingroup rpmds
  27  * Dependency Attributes.
  28  */
  29 typedef enum rpmsenseFlags_e {
  30     RPMSENSE_ANY        = 0,
  31     RPMSENSE_LESS       = (1 << 1),
  32     RPMSENSE_GREATER    = (1 << 2),
  33     RPMSENSE_EQUAL      = (1 << 3),
  34     RPMSENSE_PROVIDES   = (1 << 4), /* only used internally by builds */
  35     RPMSENSE_CONFLICTS  = (1 << 5), /* only used internally by builds */
  36     RPMSENSE_PREREQ     = (1 << 6), /* legacy prereq dependency */
  37     RPMSENSE_OBSOLETES  = (1 << 7), /* only used internally by builds */
  38     RPMSENSE_INTERP     = (1 << 8),     /*!< Interpreter used by scriptlet. */
  39     RPMSENSE_SCRIPT_PRE = (1 << 9),     /*!< %pre dependency. */
  40     RPMSENSE_SCRIPT_POST = (1 << 10),   /*!< %post dependency. */
  41     RPMSENSE_SCRIPT_PREUN = (1 << 11),  /*!< %preun dependency. */
  42     RPMSENSE_SCRIPT_POSTUN = (1 << 12), /*!< %postun dependency. */
  43     RPMSENSE_SCRIPT_VERIFY = (1 << 13), /*!< %verify dependency. */
  44     RPMSENSE_FIND_REQUIRES = (1 << 14), /*!< find-requires generated dependency. */
  45     RPMSENSE_FIND_PROVIDES = (1 << 15), /*!< find-provides generated dependency. */
  46
  47     RPMSENSE_TRIGGERIN  = (1 << 16),    /*!< %triggerin dependency. */
  48     RPMSENSE_TRIGGERUN  = (1 << 17),    /*!< %triggerun dependency. */
  49     RPMSENSE_TRIGGERPOSTUN = (1 << 18), /*!< %triggerpostun dependency. */
  50     RPMSENSE_MISSINGOK  = (1 << 19),    /*!< suggests/enhances hint. */
  51     RPMSENSE_SCRIPT_PREP = (1 << 20),   /*!< %prep build dependency. */
  52     RPMSENSE_SCRIPT_BUILD = (1 << 21),  /*!< %build build dependency. */
  53     RPMSENSE_SCRIPT_INSTALL = (1 << 22),/*!< %install build dependency. */
  54     RPMSENSE_SCRIPT_CLEAN = (1 << 23),  /*!< %clean build dependency. */
  55     RPMSENSE_RPMLIB = (1 << 24),        /*!< rpmlib(feature) dependency. */
  56     RPMSENSE_TRIGGERPREIN = (1 << 25),  /*!< %triggerprein dependency. */
  57     RPMSENSE_KEYRING    = (1 << 26),
  58     RPMSENSE_PATCHES    = (1 << 27),
  59     RPMSENSE_CONFIG     = (1 << 28)
  60 } rpmsenseFlags;
  61
  62 #define RPMSENSE_SENSEMASK      15       /* Mask to get senses, ie serial, */
  63                                          /* less, greater, equal.          */
  64
  65 #define RPMSENSE_TRIGGER        \
  66         (RPMSENSE_TRIGGERPREIN | RPMSENSE_TRIGGERIN | RPMSENSE_TRIGGERUN | RPMSENSE_TRIGGERPOSTUN)
  67
  68 #define _ALL_REQUIRES_MASK      (\
  69     RPMSENSE_INTERP | \
  70     RPMSENSE_SCRIPT_PRE | \
  71     RPMSENSE_SCRIPT_POST | \
  72     RPMSENSE_SCRIPT_PREUN | \
  73     RPMSENSE_SCRIPT_POSTUN | \
  74     RPMSENSE_SCRIPT_VERIFY | \
  75     RPMSENSE_FIND_REQUIRES | \
  76     RPMSENSE_SCRIPT_PREP | \
  77     RPMSENSE_SCRIPT_BUILD | \
  78     RPMSENSE_SCRIPT_INSTALL | \
  79     RPMSENSE_SCRIPT_CLEAN | \
  80     RPMSENSE_RPMLIB | \
  81     RPMSENSE_KEYRING | \
  82     RPMSENSE_PREREQ)
  83
  84 #define _notpre(_x)             ((_x) & ~RPMSENSE_PREREQ)
  85 #define _INSTALL_ONLY_MASK \
  86     _notpre(RPMSENSE_SCRIPT_PRE|RPMSENSE_SCRIPT_POST|RPMSENSE_RPMLIB|RPMSENSE_KEYRING)
  87 #define _ERASE_ONLY_MASK  \
  88     _notpre(RPMSENSE_SCRIPT_PREUN|RPMSENSE_SCRIPT_POSTUN)
  89
  90 #define isLegacyPreReq(_x)  (((_x) & _ALL_REQUIRES_MASK) == RPMSENSE_PREREQ)
  91 #define isInstallPreReq(_x)     ((_x) & _INSTALL_ONLY_MASK)
  92 #define isErasePreReq(_x)       ((_x) & _ERASE_ONLY_MASK)
  93
  94 /** \ingroup rpmds
  95  * Unreference a dependency set instance.
  96  * @param ds            dependency set
  97  * @param msg
  98  * @return              NULL always
  99  */
 100 rpmds rpmdsUnlink (rpmds ds, const char * msg);
 101 /** \ingroup rpmds
 102  * Reference a dependency set instance.
 103  * @param ds            dependency set
 104  * @param msg
 105  * @return              new dependency set reference
 106  */
 107 rpmds rpmdsLink (rpmds ds, const char * msg);
 108
 109 /** \ingroup rpmds
 110  * Destroy a dependency set.
 111  * @param ds            dependency set
 112  * @return              NULL always
 113  */
 114 rpmds rpmdsFree(rpmds ds);
 115 /** \ingroup rpmds
 116  * Create and load a dependency set.
 117  * @param h             header
 118  * @param tagN          type of dependency
 119  * @param flags         unused
 120  * @return              new dependency set
 121  */
 122 rpmds rpmdsNew(Header h, rpmTag tagN, int flags);
 123
 124 /** \ingroup rpmds
 125  * Return new formatted dependency string.
 126  * @param dspfx         formatted dependency string prefix
 127  * @param ds            dependency set
 128  * @return              new formatted dependency (malloc'ed)
 129  */
 130 char * rpmdsNewDNEVR(const char * dspfx, const rpmds ds);
 131
 132 /** \ingroup rpmds
 133  * Create, load and initialize a dependency for this header.
 134  * @param h             header
 135  * @param tagN          type of dependency
 136  * @param Flags         comparison flags
 137  * @return              new dependency set
 138  */
 139 rpmds rpmdsThis(Header h, rpmTag tagN, rpmsenseFlags Flags);
 140
 141 /** \ingroup rpmds
 142  * Create, load and initialize a dependency set of size 1.
 143  * @param tagN          type of dependency
 144  * @param N             name
 145  * @param EVR           epoch:version-release
 146  * @param Flags         comparison flags
 147  * @return              new dependency set
 148  */
 149 rpmds rpmdsSingle(rpmTag tagN, const char * N, const char * EVR, rpmsenseFlags Flags);
 150
 151 /** \ingroup rpmds
 152  * Return dependency set count.
 153  * @param ds            dependency set
 154  * @return              current count
 155  */
 156 int rpmdsCount(const rpmds ds);
 157
 158 /** \ingroup rpmds
 159  * Return dependency set index.
 160  * @param ds            dependency set
 161  * @return              current index
 162  */
 163 int rpmdsIx(const rpmds ds);
 164
 165 /** \ingroup rpmds
 166  * Set dependency set index.
 167  * @param ds            dependency set
 168  * @param ix            new index
 169  * @return              current index
 170  */
 171 int rpmdsSetIx(rpmds ds, int ix);
 172
 173 /** \ingroup rpmds
 174  * Return current formatted dependency string.
 175  * @param ds            dependency set
 176  * @return              current dependency DNEVR, NULL on invalid
 177  */
 178 const char * rpmdsDNEVR(const rpmds ds);
 179
 180 /** \ingroup rpmds
 181  * Return current dependency name.
 182  * @param ds            dependency set
 183  * @return              current dependency name, NULL on invalid
 184  */
 185 const char * rpmdsN(const rpmds ds);
 186
 187 /** \ingroup rpmds
 188  * Return current dependency epoch-version-release.
 189  * @param ds            dependency set
 190  * @return              current dependency EVR, NULL on invalid
 191  */
 192 const char * rpmdsEVR(const rpmds ds);
 193
 194 /** \ingroup rpmds
 195  * Return current dependency flags.
 196  * @param ds            dependency set
 197  * @return              current dependency flags, 0 on invalid
 198  */
 199 rpmsenseFlags rpmdsFlags(const rpmds ds);
 200
 201 /** \ingroup rpmds
 202  * Return current dependency type.
 203  * @param ds            dependency set
 204  * @return              current dependency type, 0 on invalid
 205  */
 206 rpmTag rpmdsTagN(const rpmds ds);
 207
 208 /** \ingroup rpmds
 209  * Return dependency build time.
 210  * @param ds            dependency set
 211  * @return              dependency build time, 0 on invalid
 212  */
 213 time_t rpmdsBT(const rpmds ds);
 214
 215 /** \ingroup rpmds
 216  * Set dependency build time.
 217  * @param ds            dependency set
 218  * @param BT            build time
 219  * @return              dependency build time, 0 on invalid
 220  */
 221 time_t rpmdsSetBT(const rpmds ds, time_t BT);
 222
 223 /** \ingroup rpmds
 224  * Return current "Don't promote Epoch:" flag.
 225  *
 226  * This flag controls for Epoch: promotion when a dependency set is
 227  * compared. If the flag is set (for already installed packages), then
 228  * an unspecified value will be treated as Epoch: 0. Otherwise (for added
 229  * packages), the Epoch: portion of the comparison is skipped if the value
 230  * is not specified, i.e. an unspecified Epoch: is assumed to be equal
 231  * in dependency comparisons.
 232  *
 233  * @param ds            dependency set
 234  * @return              current "Don't promote Epoch:" flag
 235  */
 236 int rpmdsNoPromote(const rpmds ds);
 237
 238 /** \ingroup rpmds
 239  * Set "Don't promote Epoch:" flag.
 240  * @param ds            dependency set
 241  * @param nopromote     Should an unspecified Epoch: be treated as Epoch: 0?
 242  * @return              previous "Don't promote Epoch:" flag
 243  */
 244 int rpmdsSetNoPromote(rpmds ds, int nopromote);
 245
 246 /** \ingroup rpmds
 247  * Return current dependency color.
 248  * @param ds            dependency set
 249  * @return              current dependency color
 250  */
 251 rpm_color_t rpmdsColor(const rpmds ds);
 252
 253 /** \ingroup rpmds
 254  * Return current dependency color.
 255  * @param ds            dependency set
 256  * @param color         new dependency color
 257  * @return              previous dependency color
 258  */
 259 rpm_color_t rpmdsSetColor(const rpmds ds, rpm_color_t color);
 260
 261 /** \ingroup rpmds
 262  * Return current dependency file refs.
 263  * @param ds            dependency set
 264  * @return              current dependency file refs, -1 on global
 265  */
 266 int32_t rpmdsRefs(const rpmds ds);
 267
 268 /** \ingroup rpmds
 269  * Return current dependency color.
 270  * @param ds            dependency set
 271  * @param refs          new dependency refs
 272  * @return              previous dependency refs
 273  */
 274 int32_t rpmdsSetRefs(const rpmds ds, int32_t refs);
 275
 276 /** \ingroup rpmds
 277  * Notify of results of dependency match.
 278  * @param ds            dependency set
 279  * @param where         where dependency was resolved (or NULL)
 280  * @param rc            0 == YES, otherwise NO
 281  */
 282 /* FIX: rpmMessage annotation is a lie */
 283 void rpmdsNotify(rpmds ds, const char * where, int rc);
 284
 285 /** \ingroup rpmds
 286  * Return next dependency set iterator index.
 287  * @param ds            dependency set
 288  * @return              dependency set iterator index, -1 on termination
 289  */
 290 int rpmdsNext(rpmds ds);
 291
 292 /** \ingroup rpmds
 293  * Initialize dependency set iterator.
 294  * @param ds            dependency set
 295  * @return              dependency set
 296  */
 297 rpmds rpmdsInit(rpmds ds);
 298
 299 /** \ingroup rpmds
 300  * Find a dependency set element using binary search.
 301  * @param ds            dependency set to search
 302  * @param ods           dependency set element to find.
 303  * @return              dependency index (or -1 if not found)
 304  */
 305 int rpmdsFind(rpmds ds, const rpmds ods);
 306
 307 /** \ingroup rpmds
 308  * Merge a dependency set maintaining (N,EVR,Flags) sorted order.
 309  * @retval *dsp         (merged) dependency set
 310  * @param ods           dependency set to merge
 311  * @return              (merged) dependency index
 312  */
 313 int rpmdsMerge(rpmds * dsp, rpmds ods);
 314
 315 /** \ingroup rpmds
 316  * Search a sorted dependency set for an element that overlaps.
 317  * A boolean result is saved (if allocated) and accessible through
 318  * rpmdsResult(ods) afterwards.
 319  * @param ds            dependency set to search
 320  * @param ods           dependency set element to find.
 321  * @return              dependency index (or -1 if not found)
 322  **/
 323 int rpmdsSearch(rpmds ds, rpmds ods);
 324
 325
 326 /** \ingroup rpmds
 327  * Compare two versioned dependency ranges, looking for overlap.
 328  * @param A             1st dependency
 329  * @param B             2nd dependency
 330  * @return              1 if dependencies overlap, 0 otherwise
 331  */
 332 int rpmdsCompare(const rpmds A, const rpmds B);
 333
 334 /** \ingroup rpmds
 335  * Report a Requires: or Conflicts: dependency problem.
 336  * @param ps            transaction set problems
 337  * @param pkgNEVR       package name/epoch/version/release
 338  * @param ds            dependency set
 339  * @param suggestedKeys filename or python object address
 340  * @param adding        dependency problem is from added package set?
 341  */
 342 void rpmdsProblem(rpmps ps, const char * pkgNEVR, const rpmds ds,
 343                 const fnpyKey * suggestedKeys,
 344                 int adding);
 345
 346 /** \ingroup rpmds
 347  * Compare package provides dependencies from header with a single dependency.
 348  * @param h             header
 349  * @param req           dependency set
 350  * @param nopromote     Don't promote Epoch: in comparison?
 351  * @return              1 if any dependency overlaps, 0 otherwise
 352  */
 353 int rpmdsAnyMatchesDep (const Header h, const rpmds req, int nopromote);
 354
 355 /** \ingroup rpmds
 356  * Compare package name-version-release from header with a single dependency.
 357  * @param h             header
 358  * @param req           dependency set
 359  * @param nopromote     Don't promote Epoch: in comparison?
 360  * @return              1 if dependency overlaps, 0 otherwise
 361  */
 362 int rpmdsNVRMatchesDep(const Header h, const rpmds req, int nopromote);
 363
 364 /**
 365  * Load rpmlib provides into a dependency set.
 366  * @retval *dsp         (loaded) depedency set
 367  * @param tblp          rpmlib provides table (NULL uses internal table)
 368  * @return              0 on success
 369  */
 370 int rpmdsRpmlib(rpmds * dsp, void * tblp);
 371
 372 #ifdef __cplusplus
 373 }
 374 #endif
 375
 376 #endif  /* H_RPMDS */