rpm-build/rpmdb/fprint.h

147 lines
4.0 KiB
C
Raw Normal View History

2002-03-25 23:16:26 +03:00
#ifndef H_FINGERPRINT
#define H_FINGERPRINT
/** \ingroup rpmtrans
* \file rpmdb/fprint.h
* Identify a file name path by a unique "finger print".
*/
/**
* Finger print cache.
2002-03-25 23:16:26 +03:00
*/
typedef /*@abstract@*/ struct fprintCache_s * fingerPrintCache;
/**
* @todo Convert to pointer and make abstract.
*/
typedef struct fingerPrint_s fingerPrint;
/**
* Finger print cache entry.
* This is really a directory and symlink cache. We don't differentiate between
* the two. We can prepopulate it, which allows us to easily conduct "fake"
* installs of a system w/o actually mounting filesystems.
*/
struct fprintCacheEntry_s {
dev_t dev; /*!< stat(2) device number */
ino_t ino; /*!< stat(2) inode number */
char dirName[1]; /*!< path to existing directory */
2002-03-25 23:16:26 +03:00
};
/**
* Associates a trailing sub-directory and final base name with an existing
* directory finger print.
*/
struct fingerPrint_s {
/*! directory finger print entry (the directory path is stat(2)-able */
const struct fprintCacheEntry_s * entry;
/*! trailing sub-directory path (directories that are not stat(2)-able */
/*@owned@*/ /*@null@*/ const char * subDir;
/*@dependent@*/ const char * baseName; /*!< file base name */
};
/* only if !scarceMemory */
/** */
#define fpFree(a) free((void *)(a).baseName)
/** */
#define FP_ENTRY_EQUAL(a, b) (((a)->dev == (b)->dev) && ((a)->ino == (b)->ino))
/** */
#define FP_EQUAL(a, b) ( \
FP_ENTRY_EQUAL((a).entry, (b).entry) && \
!strcmp((a).baseName, (b).baseName) && ( \
((a).subDir == (b).subDir) || \
((a).subDir && (b).subDir && !strcmp((a).subDir, (b).subDir)) \
) \
)
#ifdef __cplusplus
extern "C" {
#endif
/** \ingroup rpmdb
* Find fingerprint matches in database.
* @param db rpm database
* @param fpList fingerprint array
* @retval matchList returned fingerprint matches
* @param numItems number of fingerprint items
* @return 0 always
*/
int rpmdbFindFpList(/*@null@*/ rpmdb db, fingerPrint * fpList,
/*@out@*/ dbiIndexSet * matchList, int numItems,
fingerPrintCache fpc);
2002-03-25 23:16:26 +03:00
/*@globals fileSystem@*/
/*@modifies db, *matchList, fileSystem @*/;
/* Be carefull with the memory... assert(*fullName == '/' || !scareMemory) */
/**
* Create finger print cache.
* @param size number of directories expected
2002-03-25 23:16:26 +03:00
* @return pointer to initialized fingerprint cache
*/
/*@only@*/ fingerPrintCache fpCacheCreate(unsigned int size)
2002-03-25 23:16:26 +03:00
/*@*/;
/**
* Destroy finger print cache.
* @param cache pointer to fingerprint cache
2009-03-26 09:12:58 +03:00
* @return NULL always
2002-03-25 23:16:26 +03:00
*/
2009-03-26 09:12:58 +03:00
/*@null@*/
fingerPrintCache fpCacheFree(/*@only@*/ fingerPrintCache cache)
2002-03-25 23:16:26 +03:00
/*@modifies cache @*/;
/**
* Return finger print of a file path.
* @param cache pointer to fingerprint cache
* @param dirName leading directory name of file path
* @param baseName base name of file path
* @param scareMemory
* @return pointer to the finger print associated with a file path.
*/
fingerPrint fpLookup(fingerPrintCache cache, const char * dirName,
const char * baseName, int scareMemory)
/*@modifies cache @*/;
/**
* Return hash value for a finger print.
* Hash based on dev and inode only!
* @param key pointer to finger print entry
* @return hash value
*/
unsigned int fpHashFunction(const void * key)
/*@*/;
/**
* Compare two finger print entries.
* exactly equivalent to FP_EQUAL macro.
* @param key1 finger print 1
* @param key2 finger print 2
* @return result of comparing key1 and key2
*/
int fpEqual(const void * key1, const void * key2)
/*@*/;
/**
* Return finger prints of an array of file paths.
* @warning: scareMemory is assumed!
* @param cache pointer to fingerprint cache
* @param dirNames directory names
* @param baseNames file base names
* @param dirIndexes index into dirNames for each baseNames
* @param fileCount number of file entries
* @retval fpList pointer to array of finger prints
*/
void fpLookupList(fingerPrintCache cache, const char ** dirNames,
const char ** baseNames, const int * dirIndexes,
int fileCount, fingerPrint * fpList)
/*@modifies cache, *fpList @*/;
#ifdef __cplusplus
}
#endif
#endif