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