fix: prevent segfault if malicious server sends 1 GB of data through ftpNLST.
[platform/upstream/rpm.git] / rpmdb / rpmdb.h
index cf23535..afb4609 100644 (file)
@@ -8,8 +8,14 @@
  */
 
 #include <assert.h>
-#include <rpmlib.h>
-#include <db.h>
+#include "rpmlib.h"
+#include "rpmsw.h"
+#include "db.h"
+
+/*@-exportlocal@*/
+/*@unchecked@*/
+extern int _rpmdb_debug;
+/*@=exportlocal@*/
 
 #ifdef NOTYET
 /** \ingroup rpmdb
@@ -28,9 +34,9 @@ typedef /*@abstract@*/ struct _rpmdbMatchIterator * rpmdbMatchIterator;
  */
 typedef enum rpmMireMode_e {
     RPMMIRE_DEFAULT    = 0,    /*!< regex with \., .* and ^...$ added */
-    RPMMIRE_STRCMP     = 1,    /*!< strcmp on strings */
-    RPMMIRE_REGEX      = 2,    /*!< regex patterns */
-    RPMMIRE_GLOB       = 3     /*!< glob patterns through fnmatch(3) */
+    RPMMIRE_STRCMP     = 1,    /*!< strings  using strcmp(3) */
+    RPMMIRE_REGEX      = 2,    /*!< regex(7) patterns through regcomp(3) */
+    RPMMIRE_GLOB       = 3     /*!< glob(7) patterns through fnmatch(3) */
 } rpmMireMode;
 
 /**
@@ -289,7 +295,6 @@ struct _dbiIndex {
     int        dbi_api;                /*!< Berkeley API type */
 
     int        dbi_verify_on_close;
-    int        dbi_tear_down;          /*!< tear down dbenv on close */
     int        dbi_use_dbenv;          /*!< use db environment? */
     int        dbi_permit_dups;        /*!< permit duplicate entries? */
     int        dbi_no_fsync;           /*!< no-op fsync for db */
@@ -317,8 +322,8 @@ struct _dbiIndex {
     int        dbi_region_init;
     int        dbi_tas_spins;
        /* mpool sub-system parameters */
-    int        dbi_mp_mmapsize;        /*!< (10Mb) */
-    int        dbi_mp_size;    /*!< (128Kb) */
+    int        dbi_mmapsize;   /*!< (10Mb) */
+    int        dbi_cachesize;  /*!< (128Kb) */
        /* lock sub-system parameters */
     unsigned int dbi_lk_max;
     unsigned int dbi_lk_detect;
@@ -336,7 +341,6 @@ struct _dbiIndex {
        /*@modifies fileSystem @*/;
 #endif
        /* dbinfo parameters */
-    int        dbi_cachesize;          /*!< */
     int        dbi_pagesize;           /*!< (fs blksize) */
 /*@unused@*/ /*@null@*/
     void * (*dbi_malloc) (size_t nbytes)
@@ -369,12 +373,10 @@ struct _dbiIndex {
     unsigned int dbi_q_extentsize;
 
 /*@refcounted@*/
-    rpmdb dbi_rpmdb;
+    rpmdb dbi_rpmdb;           /*!< the parent rpm database */
     rpmTag dbi_rpmtag;         /*!< rpm tag used for index */
     int        dbi_jlen;               /*!< size of join key */
 
-    unsigned int dbi_lastoffset;       /*!< db1 with falloc.c needs this */
-
 /*@only@*//*@null@*/
     DB * dbi_db;               /*!< Berkeley DB * handle */
 /*@only@*//*@null@*/
@@ -391,32 +393,48 @@ struct _dbiIndex {
  * Describes the collection of index databases used by rpm.
  */
 struct rpmdb_s {
-/*@owned@*/ const char * db_root;/*!< path prefix */
-/*@owned@*/ const char * db_home;/*!< directory path */
+/*@owned@*/
+    const char * db_root;/*!< path prefix */
+/*@owned@*/
+    const char * db_home;/*!< directory path */
     int                db_flags;
     int                db_mode;        /*!< open mode */
     int                db_perms;       /*!< open permissions */
     int                db_api;         /*!< Berkeley API type */
-/*@owned@*/ const char * db_errpfx;
+/*@owned@*/
+    const char * db_errpfx;
     int                db_remove_env;
     int                db_filter_dups;
     int                db_chrootDone;  /*!< If chroot(2) done, ignore db_root. */
     void (*db_errcall) (const char *db_errpfx, char *buffer)
        /*@*/;
-/*@shared@*/ FILE *    db_errfile;
-/*@only@*/ void * (*db_malloc) (size_t nbytes)
+/*@shared@*/
+    FILE *     db_errfile;
+/*@only@*/
+    void * (*db_malloc) (size_t nbytes)
        /*@*/;
-/*@only@*/ void * (*db_realloc) (/*@only@*//*@null@*/ void * ptr,
+/*@only@*/
+    void * (*db_realloc) (/*@only@*//*@null@*/ void * ptr,
                                                size_t nbytes)
        /*@*/;
     void (*db_free) (/*@only@*/ void * ptr)
        /*@modifies *ptr @*/;
+/*@only@*/ /*@null@*/
+    unsigned char * db_bits;   /*!< package instance bit mask. */
+    int                db_nbits;       /*!< no. of bits in mask. */
+    rpmdb      db_next;
     int                db_opens;
-/*@only@*//*@null@*/ void * db_dbenv;  /*!< Berkeley DB_ENV handle */
+/*@only@*/ /*@null@*/
+    void *     db_dbenv;       /*!< Berkeley DB_ENV handle. */
     int                db_ndbi;        /*!< No. of tag indices. */
-    dbiIndex * _dbi;           /*!< Tag indices. */
+    dbiIndex * _dbi;           /*!< Tag indices. */
 
-/*@refs@*/ int nrefs;          /*!< Reference count. */
+    struct rpmop_s db_getops;
+    struct rpmop_s db_putops;
+    struct rpmop_s db_delops;
+
+/*@refs@*/
+    int nrefs;                 /*!< Reference count. */
 };
 
 /* for RPM's internal use only */
@@ -477,9 +495,10 @@ extern const char *const prDbiOpenFlags(int dbflags, int print_dbenv_flags)
  */
 /*@only@*/ /*@null@*/ dbiIndex dbiOpen(/*@null@*/ rpmdb db, rpmTag rpmtag,
                unsigned int flags)
-       /*@modifies db @*/;
+       /*@globals rpmGlobalMacroContext, errno @*/
+       /*@modifies db, rpmGlobalMacroContext, errno @*/;
 
-/*@-globuse -mods -mustmod @*/
+/*@-globuse -mustmod @*/ /* FIX: vector annotations */
 /** \ingroup dbi
  * Open a database cursor.
  * @param dbi          index database handle
@@ -540,11 +559,15 @@ int dbiCdup(dbiIndex dbi, DBC * dbcursor, /*@out@*/ DBC ** dbcp,
 /*@unused@*/ static inline
 int dbiDel(dbiIndex dbi, /*@null@*/ DBC * dbcursor, DBT * key, DBT * data,
                unsigned int flags)
-       /*@globals fileSystem @*/
-       /*@modifies *dbcursor, fileSystem @*/
+       /*@globals fileSystem, internalState @*/
+       /*@modifies dbi, *dbcursor, fileSystem, internalState @*/
 {
+    int rc;
     assert(key->data != NULL && key->size > 0);
-    return (dbi->dbi_vec->cdel) (dbi, dbcursor, key, data, flags);
+    (void) rpmswEnter(&dbi->dbi_rpmdb->db_delops, 0);
+    rc = (dbi->dbi_vec->cdel) (dbi, dbcursor, key, data, flags);
+    (void) rpmswExit(&dbi->dbi_rpmdb->db_delops, data->size);
+    return rc;
 }
 
 /** \ingroup dbi
@@ -559,11 +582,15 @@ int dbiDel(dbiIndex dbi, /*@null@*/ DBC * dbcursor, DBT * key, DBT * data,
 /*@unused@*/ static inline
 int dbiGet(dbiIndex dbi, /*@null@*/ DBC * dbcursor, DBT * key, DBT * data,
                unsigned int flags)
-       /*@globals fileSystem @*/
-       /*@modifies *dbcursor, *key, *data, fileSystem @*/
+       /*@globals fileSystem, internalState @*/
+       /*@modifies dbi, *dbcursor, *key, *data, fileSystem, internalState @*/
 {
+    int rc;
     assert((flags == DB_NEXT) || (key->data != NULL && key->size > 0));
-    return (dbi->dbi_vec->cget) (dbi, dbcursor, key, data, flags);
+    (void) rpmswEnter(&dbi->dbi_rpmdb->db_getops, 0);
+    rc = (dbi->dbi_vec->cget) (dbi, dbcursor, key, data, flags);
+    (void) rpmswExit(&dbi->dbi_rpmdb->db_getops, data->size);
+    return rc;
 }
 
 /** \ingroup dbi
@@ -579,11 +606,15 @@ int dbiGet(dbiIndex dbi, /*@null@*/ DBC * dbcursor, DBT * key, DBT * data,
 /*@unused@*/ static inline
 int dbiPget(dbiIndex dbi, /*@null@*/ DBC * dbcursor,
                DBT * key, DBT * pkey, DBT * data, unsigned int flags)
-       /*@globals fileSystem @*/
-       /*@modifies *dbcursor, *key, *pkey, *data, fileSystem @*/
+       /*@globals fileSystem, internalState @*/
+       /*@modifies dbi, *dbcursor, *key, *pkey, *data, fileSystem, internalState @*/
 {
+    int rc;
     assert((flags == DB_NEXT) || (key->data != NULL && key->size > 0));
-    return (dbi->dbi_vec->cpget) (dbi, dbcursor, key, pkey, data, flags);
+    (void) rpmswEnter(&dbi->dbi_rpmdb->db_getops, 0);
+    rc = (dbi->dbi_vec->cpget) (dbi, dbcursor, key, pkey, data, flags);
+    (void) rpmswExit(&dbi->dbi_rpmdb->db_getops, data->size);
+    return rc;
 }
 
 /** \ingroup dbi
@@ -598,11 +629,15 @@ int dbiPget(dbiIndex dbi, /*@null@*/ DBC * dbcursor,
 /*@unused@*/ static inline
 int dbiPut(dbiIndex dbi, /*@null@*/ DBC * dbcursor, DBT * key, DBT * data,
                unsigned int flags)
-       /*@globals fileSystem @*/
-       /*@modifies *dbcursor, *key, fileSystem @*/
+       /*@globals fileSystem, internalState @*/
+       /*@modifies dbi, *dbcursor, *key, fileSystem, internalState @*/
 {
+    int rc;
     assert(key->data != NULL && key->size > 0 && data->data != NULL && data->size > 0);
-    return (dbi->dbi_vec->cput) (dbi, dbcursor, key, data, flags);
+    (void) rpmswEnter(&dbi->dbi_rpmdb->db_putops, 0);
+    rc = (dbi->dbi_vec->cput) (dbi, dbcursor, key, data, flags);
+    (void) rpmswExit(&dbi->dbi_rpmdb->db_putops, data->size);
+    return rc;
 }
 
 /** \ingroup dbi
@@ -703,19 +738,29 @@ int dbiJoin(dbiIndex dbi, DBC ** curslist, /*@out@*/ DBC ** dbcp,
 /** \ingroup dbi
  * Is database byte swapped?
  * @param dbi          index database handle
- * @return             0 no
+ * @return             0 same order, 1 swapped order
  */
 /*@unused@*/ static inline
 int dbiByteSwapped(dbiIndex dbi)
-       /*@*/
+       /*@modifies dbi @*/
 {
-/*@-mods@*/ /* FIX: shrug */
     if (dbi->dbi_byteswapped == -1)
         dbi->dbi_byteswapped = (*dbi->dbi_vec->byteswapped) (dbi);
-/*@=mods@*/
     return dbi->dbi_byteswapped;
 }
-/*@=globuse =mods =mustmod @*/
+/** \ingroup dbi
+ * Is database byte swapped?
+ * @param dbi          index database handle
+ * @param flags                DB_FAST_STAT or 0
+ * @return             0 on success
+ */
+/*@unused@*/ static inline
+int dbiStat(dbiIndex dbi, unsigned int flags)
+       /*@modifies dbi @*/
+{
+    return (*dbi->dbi_vec->stat) (dbi, flags);
+}
+/*@=globuse =mustmod @*/
 
 /*@=exportlocal@*/
 
@@ -815,8 +860,8 @@ rpmdb XrpmdbLink (rpmdb db, const char * msg,
  */
 int rpmdbOpen (/*@null@*/ const char * prefix, /*@null@*/ /*@out@*/ rpmdb * dbp,
                int mode, int perms)
-       /*@globals fileSystem @*/
-       /*@modifies *dbp, fileSystem @*/;
+       /*@globals rpmGlobalMacroContext, fileSystem, internalState @*/
+       /*@modifies *dbp, rpmGlobalMacroContext, fileSystem, internalState @*/;
 
 /** \ingroup rpmdb
  * Initialize database.
@@ -825,8 +870,8 @@ int rpmdbOpen (/*@null@*/ const char * prefix, /*@null@*/ /*@out@*/ rpmdb * dbp,
  * @return             0 on success
  */
 int rpmdbInit(/*@null@*/ const char * prefix, int perms)
-       /*@globals fileSystem @*/
-       /*@modifies fileSystem @*/;
+       /*@globals rpmGlobalMacroContext, fileSystem, internalState @*/
+       /*@modifies rpmGlobalMacroContext, fileSystem, internalState @*/;
 
 /** \ingroup rpmdb
  * Verify database components.
@@ -834,8 +879,18 @@ int rpmdbInit(/*@null@*/ const char * prefix, int perms)
  * @return             0 on success
  */
 int rpmdbVerify(/*@null@*/ const char * prefix)
+       /*@globals rpmGlobalMacroContext, fileSystem, internalState @*/
+       /*@modifies rpmGlobalMacroContext, fileSystem, internalState @*/;
+
+/**
+ * Close a single database index.
+ * @param db           rpm database
+ * @param rpmtag       rpm tag
+ * @return              0 on success
+ */
+int rpmdbCloseDBI(/*@null@*/ rpmdb db, int rpmtag)
        /*@globals fileSystem @*/
-       /*@modifies fileSystem @*/;
+       /*@modifies db, fileSystem @*/;
 
 /** \ingroup rpmdb
  * Close all database indices and free rpmdb.
@@ -862,7 +917,8 @@ int rpmdbSync (/*@null@*/ rpmdb db)
  */
 /*@-exportlocal@*/
 int rpmdbOpenAll (/*@null@*/ rpmdb db)
-       /*@modifies db @*/;
+       /*@globals rpmGlobalMacroContext @*/
+       /*@modifies db, rpmGlobalMacroContext @*/;
 /*@=exportlocal@*/
 
 /** \ingroup rpmdb
@@ -872,8 +928,8 @@ int rpmdbOpenAll (/*@null@*/ rpmdb db)
  * @return             number of instances
  */
 int rpmdbCountPackages(/*@null@*/ rpmdb db, const char * name)
-       /*@globals fileSystem @*/
-       /*@modifies db, fileSystem @*/;
+       /*@globals rpmGlobalMacroContext, fileSystem, internalState @*/
+       /*@modifies db, rpmGlobalMacroContext, fileSystem, internalState @*/;
 
 /** \ingroup rpmdb
  * Return header join key for current position of rpm database iterator.
@@ -925,7 +981,8 @@ int rpmdbPruneIterator(/*@null@*/ rpmdbMatchIterator mi,
  */
 int rpmdbSetIteratorRE(/*@null@*/ rpmdbMatchIterator mi, rpmTag tag,
                rpmMireMode mode, /*@null@*/ const char * pattern)
-       /*@modifies mi @*/;
+       /*@globals rpmGlobalMacroContext @*/
+       /*@modifies mi, mode, rpmGlobalMacroContext @*/;
 
 /** \ingroup rpmdb
  * Prepare iterator for lazy writes.
@@ -938,7 +995,7 @@ int rpmdbSetIteratorRewrite(/*@null@*/ rpmdbMatchIterator mi, int rewrite)
        /*@modifies mi @*/;
 
 /** \ingroup rpmdb
- * Modify iterator to mark header for lazy write.
+ * Modify iterator to mark header for lazy write on release.
  * @param mi           rpm database iterator
  * @param modified     new value of modified
  * @return             previous value
@@ -947,6 +1004,17 @@ int rpmdbSetIteratorModified(/*@null@*/ rpmdbMatchIterator mi, int modified)
        /*@modifies mi @*/;
 
 /** \ingroup rpmdb
+ * Modify iterator to verify retrieved header blobs.
+ * @param mi           rpm database iterator
+ * @param ts           transaction set
+ * @param (*hdrchk)    headerCheck() vector
+ * @return             0 always
+ */
+int rpmdbSetHdrChk(/*@null@*/ rpmdbMatchIterator mi, /*@null@*/ rpmts ts,
+               /*@null@*/ rpmRC (*hdrchk) (rpmts ts, const void * uh, size_t uc, const char ** msg))
+       /*@modifies mi @*/;
+
+/** \ingroup rpmdb
  * Return database iterator.
  * @param db           rpm database
  * @param rpmtag       rpm tag
@@ -957,8 +1025,8 @@ int rpmdbSetIteratorModified(/*@null@*/ rpmdbMatchIterator mi, int modified)
 /*@only@*/ /*@null@*/
 rpmdbMatchIterator rpmdbInitIterator(/*@null@*/ rpmdb db, rpmTag rpmtag,
                        /*@null@*/ const void * keyp, size_t keylen)
-       /*@globals fileSystem @*/
-       /*@modifies db, fileSystem @*/;
+       /*@globals rpmGlobalMacroContext, fileSystem, internalState @*/
+       /*@modifies db, rpmGlobalMacroContext, fileSystem, internalState @*/;
 
 /** \ingroup rpmdb
  * Return next package header from iteration.
@@ -967,8 +1035,16 @@ rpmdbMatchIterator rpmdbInitIterator(/*@null@*/ rpmdb db, rpmTag rpmtag,
  */
 /*@null@*/
 Header rpmdbNextIterator(/*@null@*/ rpmdbMatchIterator mi)
-       /*@globals fileSystem @*/
-       /*@modifies mi, fileSystem @*/;
+       /*@globals rpmGlobalMacroContext, fileSystem, internalState @*/
+       /*@modifies mi, rpmGlobalMacroContext, fileSystem, internalState @*/;
+
+/** \ingroup rpmdb
+ * Check rpmdb signal handler for trapped signal exit.
+ */
+/*@mayexit@*/
+int rpmdbCheckSignals(void)
+       /*@globals fileSystem, internalState @*/
+       /*@modifies fileSystem, internalState @*/;
 
 /** \ingroup rpmdb
  * Destroy rpm database iterator.
@@ -977,37 +1053,47 @@ Header rpmdbNextIterator(/*@null@*/ rpmdbMatchIterator mi)
  */
 /*@null@*/
 rpmdbMatchIterator rpmdbFreeIterator(/*@only@*/ /*@null@*/rpmdbMatchIterator mi)
-       /*@globals fileSystem @*/
-       /*@modifies mi, fileSystem @*/;
+       /*@globals rpmGlobalMacroContext, fileSystem, internalState @*/
+       /*@modifies mi, rpmGlobalMacroContext, fileSystem, internalState @*/;
 
 /** \ingroup rpmdb
  * Add package header to rpm database and indices.
  * @param db           rpm database
  * @param iid          install transaction id (iid = 0 or -1 to skip)
  * @param h            header
+ * @param ts           (unused) transaction set (or NULL)
+ * @param (*hdrchk)    (unused) headerCheck() vector (or NULL)
  * @return             0 on success
  */
-int rpmdbAdd(/*@null@*/ rpmdb db, int iid, Header h)
-       /*@globals fileSystem @*/
-       /*@modifies db, h, fileSystem @*/;
+int rpmdbAdd(/*@null@*/ rpmdb db, int iid, Header h, /*@null@*/ rpmts ts,
+               /*@null@*/ rpmRC (*hdrchk) (rpmts ts, const void *uh, size_t uc, const char ** msg))
+       /*@globals rpmGlobalMacroContext, fileSystem, internalState @*/
+       /*@modifies db, h, rpmGlobalMacroContext, fileSystem, internalState @*/;
 
 /** \ingroup rpmdb
  * Remove package header from rpm database and indices.
  * @param db           rpm database
- * @param rid          remove transaction id (rid = 0 or -1 to skip)
+ * @param rid          (unused) remove transaction id (rid = 0 or -1 to skip)
  * @param hdrNum       package instance number in database
+ * @param ts           (unused) transaction set (or NULL)
+ * @param (*hdrchk)    (unused) headerCheck() vector (or NULL)
  * @return             0 on success
  */
-int rpmdbRemove(/*@null@*/ rpmdb db, /*@unused@*/ int rid, unsigned int hdrNum)
-       /*@globals fileSystem @*/
-       /*@modifies db, fileSystem @*/;
+int rpmdbRemove(/*@null@*/ rpmdb db, /*@unused@*/ int rid, unsigned int hdrNum,
+               /*@null@*/ rpmts ts,
+               /*@null@*/ rpmRC (*hdrchk) (rpmts ts, const void *uh, size_t uc, const char ** msg))
+       /*@globals rpmGlobalMacroContext, fileSystem, internalState @*/
+       /*@modifies db, rpmGlobalMacroContext, fileSystem, internalState @*/;
 
 /** \ingroup rpmdb
  * Rebuild database indices from package headers.
  * @param prefix       path to top of install tree
+ * @param ts           transaction set (or NULL)
+ * @param (*hdrchk)    headerCheck() vector (or NULL)
  * @return             0 on success
  */
-int rpmdbRebuild(/*@null@*/ const char * prefix)
+int rpmdbRebuild(/*@null@*/ const char * prefix, /*@null@*/ rpmts ts,
+               /*@null@*/ rpmRC (*hdrchk) (rpmts ts, const void *uh, size_t uc, const char ** msg))
        /*@globals rpmGlobalMacroContext, fileSystem, internalState @*/
        /*@modifies rpmGlobalMacroContext, fileSystem, internalState @*/;