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
  83 #define _notpre(_x)             ((_x) & ~RPMSENSE_PREREQ)
  84 #define _INSTALL_ONLY_MASK \
  85     _notpre(RPMSENSE_SCRIPT_PRE|RPMSENSE_SCRIPT_POST|RPMSENSE_RPMLIB|RPMSENSE_KEYRING)
  86 #define _ERASE_ONLY_MASK  \
  87     _notpre(RPMSENSE_SCRIPT_PREUN|RPMSENSE_SCRIPT_POSTUN)
  88
  89 #define isLegacyPreReq(_x)  (((_x) & _ALL_REQUIRES_MASK) == RPMSENSE_PREREQ)
  90 #define isInstallPreReq(_x)     ((_x) & _INSTALL_ONLY_MASK)
  91 #define isErasePreReq(_x)       ((_x) & _ERASE_ONLY_MASK)
  92
  93 /** \ingroup rpmds
  94  * Unreference a dependency set instance.
  95  * @param ds            dependency set
  96  * @param msg
  97  * @return              NULL always
  98  */
  99 rpmds rpmdsUnlink (rpmds ds, const char * msg);
 100 /** \ingroup rpmds
 101  * Reference a dependency set instance.
 102  * @param ds            dependency set
 103  * @param msg
 104  * @return              new dependency set reference
 105  */
 106 rpmds rpmdsLink (rpmds ds, const char * msg);
 107
 108 /** \ingroup rpmds
 109  * Destroy a dependency set.
 110  * @param ds            dependency set
 111  * @return              NULL always
 112  */
 113 rpmds rpmdsFree(rpmds ds);
 114 /** \ingroup rpmds
 115  * Create and load a dependency set.
 116  * @param h             header
 117  * @param tagN          type of dependency
 118  * @param flags         unused
 119  * @return              new dependency set
 120  */
 121 rpmds rpmdsNew(Header h, rpmTag tagN, int flags);
 122
 123 /** \ingroup rpmds
 124  * Return new formatted dependency string.
 125  * @param dspfx         formatted dependency string prefix
 126  * @param ds            dependency set
 127  * @return              new formatted dependency (malloc'ed)
 128  */
 129 char * rpmdsNewDNEVR(const char * dspfx, const rpmds ds);
 130
 131 /** \ingroup rpmds
 132  * Create, load and initialize a dependency for this header.
 133  * @param h             header
 134  * @param tagN          type of dependency
 135  * @param Flags         comparison flags
 136  * @return              new dependency set
 137  */
 138 rpmds rpmdsThis(Header h, rpmTag tagN, rpmsenseFlags Flags);
 139
 140 /** \ingroup rpmds
 141  * Create, load and initialize a dependency set of size 1.
 142  * @param tagN          type of dependency
 143  * @param N             name
 144  * @param EVR           epoch:version-release
 145  * @param Flags         comparison flags
 146  * @return              new dependency set
 147  */
 148 rpmds rpmdsSingle(rpmTag tagN, const char * N, const char * EVR, rpmsenseFlags Flags);
 149
 150 /** \ingroup rpmds
 151  * Return dependency set count.
 152  * @param ds            dependency set
 153  * @return              current count
 154  */
 155 int rpmdsCount(const rpmds ds);
 156
 157 /** \ingroup rpmds
 158  * Return dependency set index.
 159  * @param ds            dependency set
 160  * @return              current index
 161  */
 162 int rpmdsIx(const rpmds ds);
 163
 164 /** \ingroup rpmds
 165  * Set dependency set index.
 166  * @param ds            dependency set
 167  * @param ix            new index
 168  * @return              current index
 169  */
 170 int rpmdsSetIx(rpmds ds, int ix);
 171
 172 /** \ingroup rpmds
 173  * Return current formatted dependency string.
 174  * @param ds            dependency set
 175  * @return              current dependency DNEVR, NULL on invalid
 176  */
 177 const char * rpmdsDNEVR(const rpmds ds);
 178
 179 /** \ingroup rpmds
 180  * Return current dependency name.
 181  * @param ds            dependency set
 182  * @return              current dependency name, NULL on invalid
 183  */
 184 const char * rpmdsN(const rpmds ds);
 185
 186 /** \ingroup rpmds
 187  * Return current dependency epoch-version-release.
 188  * @param ds            dependency set
 189  * @return              current dependency EVR, NULL on invalid
 190  */
 191 const char * rpmdsEVR(const rpmds ds);
 192
 193 /** \ingroup rpmds
 194  * Return current dependency flags.
 195  * @param ds            dependency set
 196  * @return              current dependency flags, 0 on invalid
 197  */
 198 rpmsenseFlags rpmdsFlags(const rpmds ds);
 199
 200 /** \ingroup rpmds
 201  * Return current dependency type.
 202  * @param ds            dependency set
 203  * @return              current dependency type, 0 on invalid
 204  */
 205 rpmTag rpmdsTagN(const rpmds ds);
 206
 207 /** \ingroup rpmds
 208  * Return dependency build time.
 209  * @param ds            dependency set
 210  * @return              dependency build time, 0 on invalid
 211  */
 212 time_t rpmdsBT(const rpmds ds);
 213
 214 /** \ingroup rpmds
 215  * Set dependency build time.
 216  * @param ds            dependency set
 217  * @param BT            build time
 218  * @return              dependency build time, 0 on invalid
 219  */
 220 time_t rpmdsSetBT(const rpmds ds, time_t BT);
 221
 222 /** \ingroup rpmds
 223  * Return current "Don't promote Epoch:" flag.
 224  *
 225  * This flag controls for Epoch: promotion when a dependency set is
 226  * compared. If the flag is set (for already installed packages), then
 227  * an unspecified value will be treated as Epoch: 0. Otherwise (for added
 228  * packages), the Epoch: portion of the comparison is skipped if the value
 229  * is not specified, i.e. an unspecified Epoch: is assumed to be equal
 230  * in dependency comparisons.
 231  *
 232  * @param ds            dependency set
 233  * @return              current "Don't promote Epoch:" flag
 234  */
 235 int rpmdsNoPromote(const rpmds ds);
 236
 237 /** \ingroup rpmds
 238  * Set "Don't promote Epoch:" flag.
 239  * @param ds            dependency set
 240  * @param nopromote     Should an unspecified Epoch: be treated as Epoch: 0?
 241  * @return              previous "Don't promote Epoch:" flag
 242  */
 243 int rpmdsSetNoPromote(rpmds ds, int nopromote);
 244
 245 /** \ingroup rpmds
 246  * Return current dependency color.
 247  * @param ds            dependency set
 248  * @return              current dependency color
 249  */
 250 rpm_color_t rpmdsColor(const rpmds ds);
 251
 252 /** \ingroup rpmds
 253  * Return current dependency color.
 254  * @param ds            dependency set
 255  * @param color         new dependency color
 256  * @return              previous dependency color
 257  */
 258 rpm_color_t rpmdsSetColor(const rpmds ds, rpm_color_t color);
 259
 260 /** \ingroup rpmds
 261  * Return current dependency file refs.
 262  * @param ds            dependency set
 263  * @return              current dependency file refs, -1 on global
 264  */
 265 int32_t rpmdsRefs(const rpmds ds);
 266
 267 /** \ingroup rpmds
 268  * Return current dependency color.
 269  * @param ds            dependency set
 270  * @param refs          new dependency refs
 271  * @return              previous dependency refs
 272  */
 273 int32_t rpmdsSetRefs(const rpmds ds, int32_t refs);
 274
 275 /** \ingroup rpmds
 276  * Notify of results of dependency match.
 277  * @param ds            dependency set
 278  * @param where         where dependency was resolved (or NULL)
 279  * @param rc            0 == YES, otherwise NO
 280  */
 281 /* FIX: rpmMessage annotation is a lie */
 282 void rpmdsNotify(rpmds ds, const char * where, int rc);
 283
 284 /** \ingroup rpmds
 285  * Return next dependency set iterator index.
 286  * @param ds            dependency set
 287  * @return              dependency set iterator index, -1 on termination
 288  */
 289 int rpmdsNext(rpmds ds);
 290
 291 /** \ingroup rpmds
 292  * Initialize dependency set iterator.
 293  * @param ds            dependency set
 294  * @return              dependency set
 295  */
 296 rpmds rpmdsInit(rpmds ds);
 297
 298 /** \ingroup rpmds
 299  * Find a dependency set element using binary search.
 300  * @param ds            dependency set to search
 301  * @param ods           dependency set element to find.
 302  * @return              dependency index (or -1 if not found)
 303  */
 304 int rpmdsFind(rpmds ds, const rpmds ods);
 305
 306 /** \ingroup rpmds
 307  * Merge a dependency set maintaining (N,EVR,Flags) sorted order.
 308  * @retval *dsp         (merged) dependency set
 309  * @param ods           dependency set to merge
 310  * @return              (merged) dependency index
 311  */
 312 int rpmdsMerge(rpmds * dsp, rpmds ods);
 313
 314 /** \ingroup rpmds
 315  * Search a sorted dependency set for an element that overlaps.
 316  * A boolean result is saved (if allocated) and accessible through
 317  * rpmdsResult(ods) afterwards.
 318  * @param ds            dependency set to search
 319  * @param ods           dependency set element to find.
 320  * @return              dependency index (or -1 if not found)
 321  **/
 322 int rpmdsSearch(rpmds ds, rpmds ods);
 323
 324
 325 /** \ingroup rpmds
 326  * Compare two versioned dependency ranges, looking for overlap.
 327  * @param A             1st dependency
 328  * @param B             2nd dependency
 329  * @return              1 if dependencies overlap, 0 otherwise
 330  */
 331 int rpmdsCompare(const rpmds A, const rpmds B);
 332
 333 /** \ingroup rpmds
 334  * Report a Requires: or Conflicts: dependency problem.
 335  * @param ps            transaction set problems
 336  * @param pkgNEVR       package name/epoch/version/release
 337  * @param ds            dependency set
 338  * @param suggestedKeys filename or python object address
 339  * @param adding        dependency problem is from added package set?
 340  */
 341 void rpmdsProblem(rpmps ps, const char * pkgNEVR, const rpmds ds,
 342                 const fnpyKey * suggestedKeys,
 343                 int adding);
 344
 345 /** \ingroup rpmds
 346  * Compare package provides dependencies from header with a single dependency.
 347  * @param h             header
 348  * @param req           dependency set
 349  * @param nopromote     Don't promote Epoch: in comparison?
 350  * @return              1 if any dependency overlaps, 0 otherwise
 351  */
 352 int rpmdsAnyMatchesDep (const Header h, const rpmds req, int nopromote);
 353
 354 /** \ingroup rpmds
 355  * Compare package name-version-release from header with a single dependency.
 356  * @param h             header
 357  * @param req           dependency set
 358  * @param nopromote     Don't promote Epoch: in comparison?
 359  * @return              1 if dependency overlaps, 0 otherwise
 360  */
 361 int rpmdsNVRMatchesDep(const Header h, const rpmds req, int nopromote);
 362
 363 /**
 364  * Load rpmlib provides into a dependency set.
 365  * @retval *dsp         (loaded) depedency set
 366  * @param tblp          rpmlib provides table (NULL uses internal table)
 367  * @return              0 on success
 368  */
 369 int rpmdsRpmlib(rpmds * dsp, void * tblp);
 370
 371 #ifdef __cplusplus
 372 }
 373 #endif
 374
 375 #endif  /* H_RPMDS */