Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

HEADER.


Files

file  formats.c
file  hdrinline.h
file  header.c
file  header.h
 An rpm header carries all information about a package.

file  header_internal.c
file  header_internal.h
file  package.c
file  rpmlib.h
 In Memoriam: Steve Taylor <staylor@redhat.com> was here, now he's not.


Data Structures

struct  headerToken_s

Typedefs

typedef const char * errmsg_t
typedef int_32hTAG_t
typedef headerToken_sHeader
typedef headerIterator_sHeaderIterator
typedef headerTagTableEntry_sheaderTagTableEntry
typedef char *(* headerTagFormatFunction )(int_32 type, const void *data, char *formatPrefix, int padding, int element)
typedef int(* headerTagTagFunction )(Header h, hTYP_t type, hPTR_t *data, hCNT_t count, int *freeData)
typedef headerSprintfExtension_sheaderSprintfExtension
typedef enum rpmTagType_e rpmTagType
typedef enum rpmSubTagType_e rpmSubTagType
typedef Header(* HDRnew )(void)
typedef Header(* HDRfree )(Header h)
typedef Header(* HDRlink )(Header h)
typedef Header(* HDRunlink )(Header h)
typedef void(* HDRsort )(Header h)
typedef void(* HDRunsort )(Header h)
typedef unsigned int(* HDRsizeof )(Header h, enum hMagic magicp)
typedef void *(* HDRunload )(Header h)
typedef Header(* HDRreload )(Header h, int tag)
typedef Header(* HDRcopy )(Header h)
typedef Header(* HDRload )(void *uh)
typedef Header(* HDRcopyload )(const void *uh)
typedef Header(* HDRread )(FD_t fd, enum hMagic magicp)
typedef int(* HDRwrite )(FD_t fd, Header h, enum hMagic magicp)
typedef int(* HDRisentry )(Header h, int_32 tag)
typedef void *(* HDRfreetag )(Header h, const void *data, rpmTagType type)
typedef int(* HDRget )(Header h, int_32 tag, hTYP_t type, void **p, hCNT_t c)
typedef int(* HDRgetmin )(Header h, int_32 tag, hTYP_t type, hPTR_t *p, hCNT_t c)
typedef int(* HDRadd )(Header h, int_32 tag, int_32 type, const void *p, int_32 c)
typedef int(* HDRappend )(Header h, int_32 tag, int_32 type, const void *p, int_32 c)
typedef int(* HDRaddorappend )(Header h, int_32 tag, int_32 type, const void *p, int_32 c)
typedef int(* HDRaddi18n )(Header h, int_32 tag, const char *string, const char *lang)
typedef int(* HDRmodify )(Header h, int_32 tag, int_32 type, const void *p, int_32 c)
typedef int(* HDRremove )(Header h, int_32 tag)
typedef char *(* HDRsprintf )(Header h, const char *fmt, const struct headerTagTableEntry_s *tags, const struct headerSprintfExtension_s *extensions, errmsg_t *errmsg)
typedef void(* HDRcopytags )(Header headerFrom, Header headerTo, hTAG_t tagstocopy)
typedef HeaderIterator(* HDRfreeiter )(HeaderIterator hi)
typedef HeaderIterator(* HDRinititer )(Header h)
typedef int(* HDRnextiter )(HeaderIterator hi, hTAG_t tag, hTYP_t type, hPTR_t *p, hCNT_t c)
typedef HV_sHV_t
typedef entryInfo_sentryInfo
typedef indexEntry_sindexEntry
typedef sprintfTag_ssprintfTag
typedef rpmec_srpmec
typedef sprintfToken_ssprintfToken

Enumerations

enum  headerSprintfExtensionType { HEADER_EXT_LAST = 0, HEADER_EXT_FORMAT, HEADER_EXT_MORE, HEADER_EXT_TAG }
enum  hMagic { HEADER_MAGIC_NO = 0, HEADER_MAGIC_YES = 1 }
enum  rpmTagType_e {
  RPM_NULL_TYPE = 0, RPM_CHAR_TYPE = 1, RPM_INT8_TYPE = 2, RPM_INT16_TYPE = 3,
  RPM_INT32_TYPE = 4, RPM_STRING_TYPE = 6, RPM_BIN_TYPE = 7, RPM_STRING_ARRAY_TYPE = 8,
  RPM_I18NSTRING_TYPE
}
enum  rpmSubTagType_e { RPM_REGION_TYPE = -10, RPM_BIN_ARRAY_TYPE = -11, RPM_XREF_TYPE = -12 }

Functions

int headerNVR (Header h, const char **np, const char **vp, const char **rp)
int headerNEVRA (Header h, const char **np, const char **ep, const char **vp, const char **rp, const char **ap)
void headerMergeLegacySigs (Header h, const Header sigh)
Header headerRegenSigHeader (const Header h, int noArchiveSize)
int rpmHeaderGetEntry (Header h, int_32 tag, int_32 *type, void **p, int_32 *c)
HV_t h2hv (Header h)
Header headerNew (void)
Header headerFree (Header h)
Header headerLink (Header h)
Header headerUnlink (Header h)
void headerSort (Header h)
void headerUnsort (Header h)
unsigned int headerSizeof (Header h, enum hMagic magicp)
void * headerUnload (Header h)
Header headerReload (Header h, int tag)
Header headerCopy (Header h)
Header headerLoad (void *uh)
Header headerCopyLoad (const void *uh)
Header headerRead (FD_t fd, enum hMagic magicp)
int headerWrite (FD_t fd, Header h, enum hMagic magicp)
int headerIsEntry (Header h, int_32 tag)
void * headerFreeTag (Header h, const void *data, rpmTagType type)
int headerGetEntry (Header h, int_32 tag, hTYP_t type, void **p, hCNT_t c)
int headerGetEntryMinMemory (Header h, int_32 tag, hTYP_t type, hPTR_t *p, hCNT_t c)
int headerAddEntry (Header h, int_32 tag, int_32 type, const void *p, int_32 c)
int headerAppendEntry (Header h, int_32 tag, int_32 type, const void *p, int_32 c)
int headerAddOrAppendEntry (Header h, int_32 tag, int_32 type, const void *p, int_32 c)
int headerAddI18NString (Header h, int_32 tag, const char *string, const char *lang)
int headerModifyEntry (Header h, int_32 tag, int_32 type, const void *p, int_32 c)
int headerRemoveEntry (Header h, int_32 tag)
char * headerSprintf (Header h, const char *fmt, const struct headerTagTableEntry_s *tbltags, const struct headerSprintfExtension_s *extensions, errmsg_t *errmsg)
void headerCopyTags (Header headerFrom, Header headerTo, hTAG_t tagstocopy)
HeaderIterator headerFreeIterator (HeaderIterator hi)
HeaderIterator headerInitIterator (Header h)
int headerNextIterator (HeaderIterator hi, hTAG_t tag, hTYP_t type, hPTR_t *p, hCNT_t c)
int regionSwab (indexEntry entry, int il, int dl, entryInfo pe, unsigned char *dataStart, const unsigned char *dataEnd, int regionid)
void * doHeaderUnload (Header h, int *lengthPtr)
int copyEntry (const indexEntry entry, hTYP_t type, hPTR_t *p, hCNT_t c, int minMem)
void * headerFreeData (const void *data, rpmTagType type)
char ** headerGetLangs (Header h)
int headerGetRawEntry (Header h, int_32 tag, hTYP_t type, hPTR_t *p, hCNT_t c)
int headerUsageCount (Header h)
void headerDump (Header h, FILE *f, int flags, const struct headerTagTableEntry_s *tags)

Variables

HV_shdrVec = &hdrVec1
unsigned char header_magic [8]
int typeAlign [16]
int typeSizes [16]
size_t headerMaxbytes = (32*1024*1024)
const struct headerSprintfExtension_s headerDefaultFormats []

Typedef Documentation

typedef struct entryInfo_s* entryInfo
 

Description of tag data.

Definition at line 25 of file header_internal.h.

typedef const char* errmsg_t
 

Definition at line 104 of file header.h.

Referenced by hdrSprintf(), and headerSprintf().

typedef int(* HDRadd)(Header h, int_32 tag, int_32 type, const void * p, int_32 c)
 

Add tag to header. Duplicate tags are okay, but only defined for iteration (with the exceptions noted below). While you are allowed to add i18n string arrays through this function, you probably don't mean to. See headerAddI18NString() instead.

Parameters:
h  header
tag  tag
type  tag value data type
p  pointer to tag value(s)
c  number of values
Returns:
1 on success, 0 on failure

Definition at line 500 of file header.h.

typedef int(* HDRaddi18n)(Header h, int_32 tag, const char * string, const char * lang)
 

Add locale specific tag to header. A NULL lang is interpreted as the C locale. Here are the rules:

 *      - If the tag isn't in the header, it's added with the passed string
 *         as new value.
 *      - If the tag occurs multiple times in entry, which tag is affected
 *         by the operation is undefined.
 *      - If the tag is in the header w/ this language, the entry is
 *         *replaced* (like headerModifyEntry()).
 * 
This function is intended to just "do the right thing". If you need more fine grained control use headerAddEntry() and headerModifyEntry().
Parameters:
h  header
tag  tag
string  tag value
lang  locale
Returns:
1 on success, 0 on failure

Definition at line 556 of file header.h.

typedef int(* HDRaddorappend)(Header h, int_32 tag, int_32 type, const void * p, int_32 c)
 

Add or append element to tag array in header.

Todo:
Arg "p" should have const.
Parameters:
h  header
tag  tag
type  tag value data type
p  pointer to tag value(s)
c  number of values
Returns:
1 on success, 0 on failure

Definition at line 532 of file header.h.

typedef int(* HDRappend)(Header h, int_32 tag, int_32 type, const void * p, int_32 c)
 

Append element to tag array in header. Appends item p to entry w/ tag and type as passed. Won't work on RPM_STRING_TYPE. Any pointers into header memory returned from headerGetEntryMinMemory() for this entry are invalid after this call has been made!

Parameters:
h  header
tag  tag
type  tag value data type
p  pointer to tag value(s)
c  number of values
Returns:
1 on success, 0 on failure

Definition at line 518 of file header.h.

typedef Header(* HDRcopy)(Header h)
 

Duplicate a header.

Parameters:
h  header
Returns:
new header instance

Definition at line 381 of file header.h.

typedef Header(* HDRcopyload)(const void * uh)
 

Make a copy and convert header to in-memory representation.

Parameters:
uh  on-disk header blob (i.e. with offsets)
Returns:
header

Definition at line 399 of file header.h.

typedef void(* HDRcopytags)(Header headerFrom, Header headerTo, hTAG_t tagstocopy)
 

Duplicate tag values from one header into another.

Parameters:
headerFrom  source header
headerTo  destination header
tagstocopy  array of tags that are copied

Definition at line 612 of file header.h.

typedef Header(* HDRfree)( Header h)
 

Dereference a header instance.

Parameters:
h  header
Returns:
NULL always

Definition at line 306 of file header.h.

typedef HeaderIterator(* HDRfreeiter)( HeaderIterator hi)
 

Destroy header tag iterator.

Parameters:
hi  header tag iterator
Returns:
NULL always

Definition at line 621 of file header.h.

typedef void*(* HDRfreetag)(Header h, const void * data, rpmTagType type)
 

Free data allocated when retrieved from header.

Parameters:
h  header
data  address of data (or NULL)
type  type of data (or -1 to force free)
Returns:
NULL always

Definition at line 442 of file header.h.

typedef int(* HDRget)(Header h, int_32 tag, hTYP_t type, void ** p, hCNT_t c)
 

Retrieve tag value. Will never return RPM_I18NSTRING_TYPE! RPM_STRING_TYPE elements with RPM_I18NSTRING_TYPE equivalent entries are translated (if HEADER_I18NTABLE entry is present).

Parameters:
h  header
tag  tag
Return values:
type  address of tag value data type (or NULL)
p  address of pointer to tag value(s) (or NULL)
c  address of number of values (or NULL)
Returns:
1 on success, 0 on failure

Definition at line 460 of file header.h.

typedef int(* HDRgetmin)(Header h, int_32 tag, hTYP_t type, hPTR_t * p, hCNT_t c)
 

Retrieve tag value using header internal array. Get an entry using as little extra RAM as possible to return the tag value. This is only an issue for RPM_STRING_ARRAY_TYPE.

Parameters:
h  header
tag  tag
Return values:
type  address of tag value data type (or NULL)
p  address of pointer to tag value(s) (or NULL)
c  address of number of values (or NULL)
Returns:
1 on success, 0 on failure

Definition at line 479 of file header.h.

typedef HeaderIterator(* HDRinititer)(Header h)
 

Create header tag iterator.

Parameters:
h  header
Returns:
header tag iterator

Definition at line 630 of file header.h.

typedef int(* HDRisentry)(Header h, int_32 tag)
 

Check if tag is in header.

Parameters:
h  header
tag  tag
Returns:
1 on success, 0 on failure

Definition at line 431 of file header.h.

typedef Header(* HDRlink)(Header h)
 

Reference a header instance.

Parameters:
h  header
Returns:
referenced header instance

Definition at line 315 of file header.h.

typedef Header(* HDRload)( void * uh)
 

Convert header to in-memory representation.

Parameters:
uh  on-disk header blob (i.e. with offsets)
Returns:
header

Definition at line 390 of file header.h.

typedef int(* HDRmodify)(Header h, int_32 tag, int_32 type, const void * p, int_32 c)
 

Modify tag in header. If there are multiple entries with this tag, the first one gets replaced.

Parameters:
h  header
tag  tag
type  tag value data type
p  pointer to tag value(s)
c  number of values
Returns:
1 on success, 0 on failure

Definition at line 571 of file header.h.

typedef Header(* HDRnew)(void)
 

Create new (empty) header instance.

Returns:
header

Definition at line 297 of file header.h.

typedef int(* HDRnextiter)(HeaderIterator hi, hTAG_t tag, hTYP_t type, hPTR_t * p, hCNT_t c)
 

Return next tag from header.

Parameters:
hi  header tag iterator
Return values:
tag  address of tag
type  address of tag value data type
p  address of pointer to tag value(s)
c  address of number of values
Returns:
1 on success, 0 on failure

Definition at line 643 of file header.h.

typedef Header(* HDRread)(FD_t fd, enum hMagic magicp)
 

Read (and load) header from file handle.

Parameters:
fd  file handle
magicp  read (and verify) 8 bytes of (magic, 0)?
Returns:
header (or NULL on error)

Definition at line 409 of file header.h.

typedef Header(* HDRreload)( Header h, int tag)
 

Convert header to on-disk representation, and then reload. This is used to insure that all header data is in one chunk.

Parameters:
h  header (with pointers)
tag  region tag
Returns:
on-disk header (with offsets)

Definition at line 372 of file header.h.

typedef int(* HDRremove)(Header h, int_32 tag)
 

Delete tag in header. Removes all entries of type tag from the header, returns 1 if none were found.

Parameters:
h  header
tag  tag
Returns:
0 on success, 1 on failure (INCONSISTENT)

Definition at line 584 of file header.h.

typedef unsigned int(* HDRsizeof)( Header h, enum hMagic magicp)
 

Return size of on-disk header representation in bytes.

Parameters:
h  header
magicp  include size of 8 bytes for (magic, 0)?
Returns:
size of on-disk header

Definition at line 352 of file header.h.

typedef void(* HDRsort)(Header h)
 

Sort tags in header.

Todo:
Eliminate from API.
Parameters:
h  header

Definition at line 333 of file header.h.

typedef char*(* HDRsprintf)(Header h, const char * fmt, const struct headerTagTableEntry_s * tags, const struct headerSprintfExtension_s * extensions, errmsg_t * errmsg)
 

Return formatted output string from header tags. The returned string must be free()d.

Parameters:
h  header
fmt  format to use
tags  array of tag name/value pairs
extensions  chained table of formatting extensions.
Return values:
errmsg  error message (if any)
Returns:
formatted output string (malloc'ed)

Definition at line 599 of file header.h.

typedef Header(* HDRunlink)( Header h)
 

Dereference a header instance.

Parameters:
h  header
Returns:
NULL always

Definition at line 324 of file header.h.

typedef void*(* HDRunload)(Header h)
 

Convert header to on-disk representation.

Parameters:
h  header (with pointers)
Returns:
on-disk header blob (i.e. with offsets)

Definition at line 361 of file header.h.

typedef void(* HDRunsort)(Header h)
 

Restore tags in header to original ordering.

Todo:
Eliminate from API.
Parameters:
h  header

Definition at line 342 of file header.h.

typedef int(* HDRwrite)(FD_t fd, Header h, enum hMagic magicp)
 

Write (with unload) header to file handle.

Parameters:
fd  file handle
h  header
magicp  prefix write with 8 bytes of (magic, 0)?
Returns:
0 on success, 1 on error

Definition at line 420 of file header.h.

typedef struct headerToken_s* Header
 

Definition at line 115 of file header.h.

typedef struct headerIterator_s* HeaderIterator
 

Definition at line 119 of file header.h.

typedef struct headerSprintfExtension_s* headerSprintfExtension
 

Define header tag output formats.

Definition at line 179 of file header.h.

typedef char*(* headerTagFormatFunction)(int_32 type, const void * data, char * formatPrefix, int padding, int element)
 

HEADER_EXT_TAG format function prototype. This will only ever be passed RPM_INT32_TYPE or RPM_STRING_TYPE to help keep things simple.

Parameters:
type  tag type
data  tag value
formatPrefix 
padding 
element  RPM_BIN_TYPE: no. bytes of data
Returns:
formatted string

Definition at line 152 of file header.h.

typedef struct headerTagTableEntry_s* headerTagTableEntry
 

Associate tag names with numeric values.

Definition at line 124 of file header.h.

typedef int(* headerTagTagFunction)(Header h, hTYP_t type, hPTR_t * data, hCNT_t count, int * freeData)
 

HEADER_EXT_FORMAT format function prototype. This is allowed to fail, which indicates the tag doesn't exist.

Parameters:
h  header
Return values:
type  tag type
data  tag value
count  no. of data items
freedata  data-was-malloc'ed indicator
Returns:
0 on success

Definition at line 168 of file header.h.

Referenced by getExtension().

typedef int_32* hTAG_t
 

Definition at line 108 of file header.h.

Referenced by headerCopyTags(), headerNextIterator(), and intGetEntry().

typedef struct HV_s* HV_t
 

Header method vectors.

Definition at line 653 of file header.h.

typedef struct indexEntry_s* indexEntry
 

A single tag from a Header.

Definition at line 43 of file header_internal.h.

typedef struct rpmec_s* rpmec
 

Extension cache.

Definition at line 95 of file header_internal.h.

typedef enum rpmSubTagType_e rpmSubTagType
 

New rpm data types under consideration/development. These data types may (or may not) be added to rpm at some point. In order to avoid incompatibility with legacy versions of rpm, these data (sub-)types are introduced into the header by overloading RPM_BIN_TYPE, with the binary value of the tag a 16 byte image of what should/will be in the header index, followed by per-tag private data.

typedef enum rpmTagType_e rpmTagType
 

The basic types of data in tags from headers.

Referenced by addReqProv(), compressFilelist(), descriptionTag(), fileclassTag(), filenamesTag(), fileprovideTag(), filerequireTag(), fssizesTag(), groupTag(), handleOneTrigger(), handlePreambleTag(), headerFreeTag(), i18nTag(), IDTXglob(), IDTXload(), instprefixTag(), isMemberInEntry(), mireSkip(), providePackageNVR(), relocateFileList(), rpmdbAdd(), rpmdbFindByFile(), rpmdbFindFpList(), rpmdbRemove(), rpmdsNew(), rpmfiBuildFNames(), rpmInstallLoadMacros(), runImmedTriggers(), runInstScript(), runScript(), summaryTag(), timeCheck(), triggercondsTag(), and triggertypeTag().

typedef struct sprintfTag_s* sprintfTag
 

Definition at line 75 of file header_internal.h.

typedef struct sprintfToken_s* sprintfToken
 

Definition at line 107 of file header_internal.h.


Enumeration Type Documentation

enum headerSprintfExtensionType
 

Enumeration values:
HEADER_EXT_LAST  End of extension chain.
HEADER_EXT_FORMAT  headerTagFormatFunction() extension
HEADER_EXT_MORE  Chain to next table.
HEADER_EXT_TAG  headerTagTagFunction() extension

Definition at line 133 of file header.h.

enum hMagic
 

Include calculation for 8 bytes of (magic, 0)?

Enumeration values:
HEADER_MAGIC_NO 
HEADER_MAGIC_YES 

Definition at line 204 of file header.h.

Referenced by headerRead(), headerSizeof(), and headerWrite().

enum rpmSubTagType_e
 

New rpm data types under consideration/development. These data types may (or may not) be added to rpm at some point. In order to avoid incompatibility with legacy versions of rpm, these data (sub-)types are introduced into the header by overloading RPM_BIN_TYPE, with the binary value of the tag a 16 byte image of what should/will be in the header index, followed by per-tag private data.

Enumeration values:
RPM_REGION_TYPE 
RPM_BIN_ARRAY_TYPE 
Todo:
Implement, kinda like RPM_STRING_ARRAY_TYPE for known (but variable) length binary data.
RPM_XREF_TYPE 
Todo:
Implement, intent is to to carry a (???,tagNum,valNum) cross reference to retrieve data from other tags.

Definition at line 236 of file header.h.

enum rpmTagType_e
 

The basic types of data in tags from headers.

Enumeration values:
RPM_NULL_TYPE 
RPM_CHAR_TYPE 
RPM_INT8_TYPE 
RPM_INT16_TYPE 
RPM_INT32_TYPE 
RPM_STRING_TYPE 
RPM_BIN_TYPE 
RPM_STRING_ARRAY_TYPE 
RPM_I18NSTRING_TYPE 

Definition at line 212 of file header.h.


Function Documentation

int copyEntry const indexEntry    entry,
hTYP_t    type,
hPTR_t   p,
hCNT_t    c,
int    minMem
[static]
 

Retrieve data from header entry.

Todo:
Permit retrieval of regions other than HEADER_IMUTABLE.
Parameters:
entry  header entry
Return values:
type  address of type (or NULL)
p  address of data (or NULL)
c  address of count (or NULL)
Parameters:
minMem  string pointers refer to header memory?
Returns:
1 on success, otherwise error.

Definition at line 1409 of file header.c.

References entryInfo_s::count, indexEntry_s::data, ENTRY_IS_REGION, hCNT_t, HEADER_IMAGE, hPTR_t, hTYP_t, indexEntry_s::info, int_32, indexEntry_s::length, entryInfo_s::offset, indexEntry_s::rdlen, REGION_TAG_COUNT, regionSwab(), RPM_BIN_TYPE, RPM_I18NSTRING_TYPE, RPM_STRING_ARRAY_TYPE, RPM_STRING_TYPE, entryInfo_s::tag, entryInfo_s::type, and xmalloc().

Referenced by headerGetRawEntry(), headerNextIterator(), and intGetEntry().

void* doHeaderUnload Header    h,
int *    lengthPtr
[static]
 

Parameters:
h  header
Return values:
lengthPtr  no. bytes in unloaded header blob
Returns:
unloaded header blob (NULL on error)

Definition at line 617 of file header.c.

References _free(), entryInfo_s::count, indexEntry_s::data, ENTRY_IS_REGION, headerToken_s::flags, hdrchkData, hdrchkTags, HEADERFLAG_LEGACY, HEADERFLAG_SORTED, headerSort(), headerUnsort(), headerToken_s::index, headerToken_s::indexUsed, indexEntry_s::info, int_16, int_32, indexEntry_s::length, entryInfo_s::offset, indexEntry_s::rdlen, regionSwab(), RPM_INT16_TYPE, RPM_INT32_TYPE, entryInfo_s::tag, entryInfo_s::type, typeSizes, and xmalloc().

Referenced by headerReload(), headerUnload(), and headerWrite().

HV_t h2hv Header    h [inline, static]
 

Definition at line 22 of file hdrinline.h.

Referenced by headerAddEntry(), headerAddI18NString(), headerAddOrAppendEntry(), headerAppendEntry(), headerCopy(), headerFree(), headerFreeTag(), headerGetEntry(), headerGetEntryMinMemory(), headerIsEntry(), headerLink(), headerModifyEntry(), headerReload(), headerRemoveEntry(), headerSizeof(), headerSort(), headerSprintf(), headerUnlink(), headerUnload(), headerUnsort(), and headerWrite().

int headerAddEntry Header    h,
int_32    tag,
int_32    type,
const void *    p,
int_32    c
[inline, static]
 

Add tag to header. Duplicate tags are okay, but only defined for iteration (with the exceptions noted below). While you are allowed to add i18n string arrays through this function, you probably don't mean to. See headerAddI18NString() instead.

Parameters:
h  header
tag  tag
type  tag value data type
p  pointer to tag value(s)
c  number of values
Returns:
1 on success, 0 on failure

Definition at line 315 of file hdrinline.h.

References h2hv(), HV_s::hdradd, and int_32.

int headerAddI18NString Header    h,
int_32    tag,
const char *    string,
const char *    lang
[inline, static]
 

Add locale specific tag to header. A NULL lang is interpreted as the C locale. Here are the rules:

 *      - If the tag isn't in the header, it's added with the passed string
 *         as new value.
 *      - If the tag occurs multiple times in entry, which tag is affected
 *         by the operation is undefined.
 *      - If the tag is in the header w/ this language, the entry is
 *         *replaced* (like headerModifyEntry()).
 * 
This function is intended to just "do the right thing". If you need more fine grained control use headerAddEntry() and headerModifyEntry().
Parameters:
h  header
tag  tag
string  tag value
lang  locale
Returns:
1 on success, 0 on failure

Definition at line 382 of file hdrinline.h.

References h2hv(), HV_s::hdraddi18n, and int_32.

int headerAddOrAppendEntry Header    h,
int_32    tag,
int_32    type,
const void *    p,
int_32    c
[inline, static]
 

Add or append element to tag array in header.

Todo:
Arg "p" should have const.
Parameters:
h  header
tag  tag
type  tag value data type
p  pointer to tag value(s)
c  number of values
Returns:
1 on success, 0 on failure

Definition at line 354 of file hdrinline.h.

References h2hv(), HV_s::hdraddorappend, and int_32.

int headerAppendEntry Header    h,
int_32    tag,
int_32    type,
const void *    p,
int_32    c
[inline, static]
 

Append element to tag array in header. Appends item p to entry w/ tag and type as passed. Won't work on RPM_STRING_TYPE. Any pointers into header memory returned from headerGetEntryMinMemory() for this entry are invalid after this call has been made!

Parameters:
h  header
tag  tag
type  tag value data type
p  pointer to tag value(s)
c  number of values
Returns:
1 on success, 0 on failure

Definition at line 336 of file hdrinline.h.

References h2hv(), HV_s::hdrappend, and int_32.

Header headerCopy Header    h [inline, static]
 

Duplicate a header.

Parameters:
h  header
Returns:
new header instance

Definition at line 163 of file hdrinline.h.

References h2hv(), and HV_s::hdrcopy.

Header headerCopyLoad const void *    uh [inline, static]
 

Make a copy and convert header to in-memory representation.

Parameters:
uh  on-disk header blob (i.e. with offsets)
Returns:
header

Definition at line 187 of file hdrinline.h.

References HV_s::hdrcopyload.

void headerCopyTags Header    headerFrom,
Header    headerTo,
hTAG_t    tagstocopy
[inline, static]
 

Duplicate tag values from one header into another.

Parameters:
headerFrom  source header
headerTo  destination header
tagstocopy  array of tags that are copied

Definition at line 451 of file hdrinline.h.

References HV_s::hdrcopytags, and hTAG_t.

void headerDump Header    h,
FILE *    f,
int    flags,
const struct headerTagTableEntry_s   tags
 

Dump a header in human readable format (for debugging).

Parameters:
h  header
f  file handle
flags  0 or HEADER_DUMP_INLINE
tags  array of tag name/value pairs

Definition at line 35 of file header_internal.c.

References _, entryInfo_s::count, indexEntry_s::data, HEADER_DUMP_INLINE, headerToken_s::index, headerToken_s::indexUsed, indexEntry_s::info, int_16, int_32, int_8, headerTagTableEntry_s::name, entryInfo_s::offset, RPM_BIN_TYPE, RPM_CHAR_TYPE, RPM_I18NSTRING_TYPE, RPM_INT16_TYPE, RPM_INT32_TYPE, RPM_INT8_TYPE, RPM_NULL_TYPE, RPM_STRING_ARRAY_TYPE, RPM_STRING_TYPE, entryInfo_s::tag, entryInfo_s::type, and headerTagTableEntry_s::val.

Referenced by main().

Header headerFree Header    h [inline, static]
 

Dereference a header instance.

Parameters:
h  header
Returns:
NULL always

Definition at line 47 of file hdrinline.h.

References h2hv(), and HV_s::hdrfree.

void* headerFreeData const void *    data,
rpmTagType    type
[inline, static]
 

Free data allocated when retrieved from header.

Deprecated:
Use headerFreeTag() instead.
Todo:
Remove from API.
Parameters:
data  address of data (or NULL)
type  type of data (or -1 to force free)
Returns:
NULL always

Definition at line 701 of file header.h.

Referenced by formatValue(), getSignid(), headerCopy(), headerCopyTags(), initSourceHeader(), makeHDRSignature(), readFile(), rhnUnload(), rpmInstall(), rpmMergeHeaders(), rpmpsmStage(), rpmReadPackageFile(), rpmReSign(), rpmtsCleanDig(), rpmtsFindPubkey(), and rpmtsSetSig().

HeaderIterator headerFreeIterator HeaderIterator    hi [inline, static]
 

Destroy header tag iterator.

Parameters:
hi  header tag iterator
Returns:
NULL always

Definition at line 466 of file hdrinline.h.

References HV_s::hdrfreeiter.

void* headerFreeTag Header    h,
const void *    data,
rpmTagType    type
[inline, static]
 

Free data allocated when retrieved from header.

Parameters:
h  header
data  pointer to tag value(s)
type  type of data (or -1 to force free)
Returns:
NULL always

Definition at line 247 of file hdrinline.h.

References h2hv(), HV_s::hdrfreetag, and rpmTagType.

int headerGetEntry Header    h,
int_32    tag,
hTYP_t    type,
void **    p,
hCNT_t    c
[inline, static]
 

Retrieve tag value. Will never return RPM_I18NSTRING_TYPE! RPM_STRING_TYPE elements with RPM_I18NSTRING_TYPE equivalent entries are translated (if HEADER_I18NTABLE entry is present).

Parameters:
h  header
tag  tag
Return values:
type  tag value data type (or NULL)
p  pointer to tag value(s) (or NULL)
c  number of values (or NULL)
Returns:
1 on success, 0 on failure

Definition at line 268 of file hdrinline.h.

References h2hv(), hCNT_t, HV_s::hdrget, hTYP_t, and int_32.

int headerGetEntryMinMemory Header    h,
int_32    tag,
hTYP_t    type,
hPTR_t   p,
hCNT_t    c
[inline, static]
 

Retrieve tag value using header internal array. Get an entry using as little extra RAM as possible to return the tag value. This is only an issue for RPM_STRING_ARRAY_TYPE.

Parameters:
h  header
tag  tag
Return values:
type  tag value data type (or NULL)
p  pointer to tag value(s) (or NULL)
c  number of values (or NULL)
Returns:
1 on success, 0 on failure

Definition at line 290 of file hdrinline.h.

References h2hv(), hCNT_t, HV_s::hdrgetmin, hPTR_t, hTYP_t, and int_32.

char** headerGetLangs Header    h
 

Return array of locales found in header. The array is terminated with a NULL sentinel.

Parameters:
h  header
Returns:
array of locales (or NULL on error)

Definition at line 13 of file header_internal.c.

References HEADER_I18NTABLE, headerGetRawEntry(), and xcalloc().

int headerGetRawEntry Header    h,
int_32    tag,
hTYP_t    type,
hPTR_t   p,
hCNT_t    c
 

Retrieve tag value with type match. If *type is RPM_NULL_TYPE any type will match, otherwise only *type will match.

Parameters:
h  header
tag  tag
Return values:
type  address of tag value data type (or NULL)
p  address of pointer to tag value(s) (or NULL)
c  address of number of values (or NULL)
Returns:
1 on success, 0 on failure

Referenced by headerGetLangs().

HeaderIterator headerInitIterator Header    h [inline, static]
 

Create header tag iterator.

Parameters:
h  header
Returns:
header tag iterator

Definition at line 478 of file hdrinline.h.

References HV_s::hdrinititer.

int headerIsEntry Header    h,
int_32    tag
[inline, static]
 

Check if tag is in header.

Parameters:
h  header
tag  tag
Returns:
1 on success, 0 on failure

Definition at line 230 of file hdrinline.h.

References h2hv(), HV_s::hdrisentry, and int_32.

Header headerLink Header    h [inline, static]
 

Reference a header instance.

Parameters:
h  header
Returns:
new header reference

Definition at line 62 of file hdrinline.h.

References h2hv(), and HV_s::hdrlink.

Header headerLoad void *    uh [inline, static]
 

Convert header to in-memory representation.

Parameters:
uh  on-disk header blob (i.e. with offsets)
Returns:
header

Definition at line 175 of file hdrinline.h.

References HV_s::hdrload.

void headerMergeLegacySigs Header    h,
const Header    sigh
 

Translate and merge legacy signature tags into header.

Todo:
Remove headerSort() through headerInitIterator() modifies sig.
Parameters:
h  header
sigh  signature header

Definition at line 98 of file package.c.

References HAE_t, hdrchkData, hdrchkType, HEADER_SIGBASE, HEADER_TAGBASE, headerFreeIterator(), headerInitIterator(), headerIsEntry(), headerNextIterator(), HFD_t, int_32, RPM_BIN_TYPE, RPM_CHAR_TYPE, RPM_I18NSTRING_TYPE, RPM_INT16_TYPE, RPM_INT32_TYPE, RPM_INT8_TYPE, RPM_NULL_TYPE, RPM_STRING_ARRAY_TYPE, RPM_STRING_TYPE, RPMSIGTAG_DSA, RPMSIGTAG_GPG, RPMSIGTAG_LEMD5_1, RPMSIGTAG_LEMD5_2, RPMSIGTAG_MD5, RPMSIGTAG_PAYLOADSIZE, RPMSIGTAG_PGP, RPMSIGTAG_PGP5, RPMSIGTAG_RSA, RPMSIGTAG_SHA1, RPMSIGTAG_SIZE, RPMTAG_ARCHIVESIZE, RPMTAG_SIGGPG, RPMTAG_SIGLEMD5_1, RPMTAG_SIGLEMD5_2, RPMTAG_SIGMD5, RPMTAG_SIGPGP, RPMTAG_SIGPGP5, and RPMTAG_SIGSIZE.

Referenced by rpmReadPackageFile(), and writeRPM().

int headerModifyEntry Header    h,
int_32    tag,
int_32    type,
const void *    p,
int_32    c
[inline, static]
 

Modify tag in header. If there are multiple entries with this tag, the first one gets replaced.

Parameters:
h  header
tag  tag
type  tag value data type
p  pointer to tag value(s)
c  number of values
Returns:
1 on success, 0 on failure

Definition at line 400 of file hdrinline.h.

References h2hv(), HV_s::hdrmodify, and int_32.

int headerNEVRA Header    h,
const char **    np,
const char **    ep,
const char **    vp,
const char **    rp,
const char **    ap
 

Return name, epoch, version, release, arch strings from header.

Parameters:
h  header
Return values:
np  name pointer (or NULL)
ep  epoch pointer (or NULL)
vp  version pointer (or NULL)
rp  release pointer (or NULL)
ap  arch pointer (or NULL)
Returns:
0 always

Definition at line 34 of file hdrNVR.c.

References headerGetEntry(), RPM_STRING_TYPE, RPMTAG_ARCH, RPMTAG_NAME, RPMTAG_RELEASE, and RPMTAG_VERSION.

Header headerNew void    [inline, static]
 

Create new (empty) header instance.

Returns:
header

Definition at line 35 of file hdrinline.h.

References HV_s::hdrnew.

Referenced by headerCopy(), headerCopyWithConvert(), initSourceHeader(), newPackage(), newSpec(), rpmcliImportPubkey(), rpmNewSignature(), rpmpsmStage(), and rpmReSign().

int headerNextIterator HeaderIterator    hi,
hTAG_t    tag,
hTYP_t    type,
hPTR_t   p,
hCNT_t    c
[inline, static]
 

Return next tag from header.

Parameters:
hi  header tag iterator
Return values:
tag  tag
type  tag value data type
p  pointer to tag value(s)
c  number of values
Returns:
1 on success, 0 on failure

Definition at line 494 of file hdrinline.h.

References hCNT_t, HV_s::hdrnextiter, hPTR_t, hTAG_t, and hTYP_t.

int headerNVR Header    h,
const char **    np,
const char **    vp,
const char **    rp
 

Return name, version, release strings from header.

Parameters:
h  header
Return values:
np  name pointer (or NULL)
vp  version pointer (or NULL)
rp  release pointer (or NULL)
Returns:
0 always

Definition at line 9 of file hdrNVR.c.

References headerGetEntry(), RPM_STRING_TYPE, RPMTAG_NAME, RPMTAG_RELEASE, and RPMTAG_VERSION.

Referenced by doSetupMacro(), genSourceRpmName(), handleOneTrigger(), hGetNEVR(), i18nTag(), lookupPackage(), packageBinaries(), parseForSimple(), parsePreamble(), parseSpec(), printNewSpecfile(), processBinaryFiles(), providePackageNVR(), rpmdbRebuild(), rpmdbRemove(), rpmdsNVRMatchesDep(), rpmdsThis(), rpmInstall(), rpmtsCallback(), runScript(), and writeRPM().

Header headerRead FD_t    fd,
enum hMagic    magicp
[inline, static]
 

Read (and load) header from file handle.

Parameters:
fd  file handle
magicp  read (and verify) 8 bytes of (magic, 0)?
Returns:
header (or NULL on error)

Definition at line 200 of file hdrinline.h.

References HV_s::hdrread, and hMagic.

Header headerRegenSigHeader const Header    h,
int    noArchiveSize
 

Regenerate signature header.

Todo:
Remove headerSort() through headerInitIterator() modifies h.
Parameters:
h  header
noArchiveSize  don't copy archive size tag (pre rpm-4.1)
Returns:
regenerated signature header

Definition at line 178 of file package.c.

References HEADER_SIGBASE, HEADER_TAGBASE, headerAddEntry(), headerFreeIterator(), headerInitIterator(), headerIsEntry(), headerNextIterator(), HFD_t, int_32, rpmNewSignature(), RPMSIGTAG_GPG, RPMSIGTAG_LEMD5_1, RPMSIGTAG_LEMD5_2, RPMSIGTAG_MD5, RPMSIGTAG_PAYLOADSIZE, RPMSIGTAG_PGP, RPMSIGTAG_PGP5, RPMSIGTAG_SIZE, RPMTAG_ARCHIVESIZE, RPMTAG_DSAHEADER, RPMTAG_RSAHEADER, RPMTAG_SHA1HEADER, RPMTAG_SIGGPG, RPMTAG_SIGLEMD5_1, RPMTAG_SIGLEMD5_2, RPMTAG_SIGMD5, RPMTAG_SIGPGP, RPMTAG_SIGPGP5, and RPMTAG_SIGSIZE.

Referenced by rpmpsmStage().

Header headerReload Header    h,
int    tag
[inline, static]
 

Convert header to on-disk representation, and then reload. This is used to insure that all header data is in one chunk.

Parameters:
h  header (with pointers)
tag  region tag
Returns:
on-disk header (with offsets)

Definition at line 149 of file hdrinline.h.

References h2hv(), and HV_s::hdrreload.

int headerRemoveEntry Header    h,
int_32    tag
[inline, static]
 

Delete tag in header. Removes all entries of type tag from the header, returns 1 if none were found.

Parameters:
h  header
tag  tag
Returns:
0 on success, 1 on failure (INCONSISTENT)

Definition at line 417 of file hdrinline.h.

References h2hv(), HV_s::hdrremove, and int_32.

unsigned int headerSizeof Header    h,
enum hMagic    magicp
[inline, static]
 

Return size of on-disk header representation in bytes.

Parameters:
h  header
magicp  include size of 8 bytes for (magic, 0)?
Returns:
size of on-disk header

Definition at line 120 of file hdrinline.h.

References h2hv(), HV_s::hdrsizeof, and hMagic.

void headerSort Header    h [inline, static]
 

Sort tags in header.

Parameters:
h  header

Definition at line 89 of file hdrinline.h.

References h2hv(), and HV_s::hdrsort.

char* headerSprintf Header    h,
const char *    fmt,
const struct headerTagTableEntry_s   tbltags,
const struct headerSprintfExtension_s   extensions,
errmsg_t   errmsg
[inline, static]
 

Return formatted output string from header tags. The returned string must be free()d.

Parameters:
h  header
fmt  format to use
tbltags  array of tag name/value pairs
extensions  chained table of formatting extensions.
Return values:
errmsg  error message (if any)
Returns:
formatted output string (malloc'ed)

Definition at line 435 of file hdrinline.h.

References errmsg_t, h2hv(), and HV_s::hdrsprintf.

Header headerUnlink Header    h [inline, static]
 

Dereference a header instance.

Parameters:
h  header
Returns:
new header reference

Definition at line 74 of file hdrinline.h.

References h2hv(), and HV_s::hdrunlink.

void* headerUnload Header    h [inline, static]
 

Convert header to on-disk representation.

Parameters:
h  header (with pointers)
Returns:
on-disk header blob (i.e. with offsets)

Definition at line 135 of file hdrinline.h.

References h2hv(), and HV_s::hdrunload.

void headerUnsort Header    h [inline, static]
 

Restore tags in header to original ordering.

Parameters:
h  header

Definition at line 103 of file hdrinline.h.

References h2hv(), and HV_s::hdrunsort.

int headerUsageCount Header    h [inline, static]
 

Return header reference count.

Parameters:
h  header
Returns:
no. of references

Definition at line 186 of file header_internal.h.

References headerToken_s::nrefs.

int headerWrite FD_t    fd,
Header    h,
enum hMagic    magicp
[inline, static]
 

Write (with unload) header to file handle.

Parameters:
fd  file handle
h  header
magicp  prefix write with 8 bytes of (magic, 0)?
Returns:
0 on success, 1 on error

Definition at line 214 of file hdrinline.h.

References h2hv(), HV_s::hdrwrite, and hMagic.

int regionSwab indexEntry    entry,
int    il,
int    dl,
entryInfo    pe,
unsigned char *    dataStart,
const unsigned char *    dataEnd,
int    regionid
[static]
 

Swap int_32 and int_16 arrays within header region.

This code is way more twisty than I would like.

A bug with RPM_I18NSTRING_TYPE in rpm-2.5.x (fixed in August 1998) causes the offset and length of elements in a header region to disagree regarding the total length of the region data.

The "fix" is to compute the size using both offset and length and return the larger of the two numbers as the size of the region. Kinda like computing left and right Riemann sums of the data elements to determine the size of a data structure, go figger :-).

There's one other twist if a header region tag is in the set to be swabbed, as the data for a header region is located after all other tag data.

Parameters:
entry  header entry
il  no. of entries
dl  start no. bytes of data
pe  header physical entry pointer (swapped)
dataStart  header data start
dataEnd  header data end
regionid  region offset
Returns:
no. bytes of data in region, -1 on error

Definition at line 483 of file header.c.

References entryInfo_s::count, indexEntry_s::data, dataLength(), hdrchkAlign, hdrchkData, hdrchkType, HEADER_I18NTABLE, HEADER_IMAGE, indexEntry_s::info, int_16, int_32, indexEntry_s::length, entryInfo_s::offset, indexEntry_s::rdlen, REGION_TAG_COUNT, RPM_I18NSTRING_TYPE, RPM_INT16_TYPE, RPM_INT32_TYPE, entryInfo_s::tag, entryInfo_s::type, and typeSizes.

Referenced by copyEntry(), doHeaderUnload(), and headerLoad().

int rpmHeaderGetEntry Header    h,
int_32    tag,
int_32   type,
void **    p,
int_32   c
 

Retrieve tag info from header. This is a "dressed" entry to headerGetEntry to do: 1) DIRNAME/BASENAME/DIRINDICES -> FILENAMES tag conversions. 2) i18n lookaside (if enabled).

Parameters:
h  header
tag  tag
Return values:
type  address of tag value data type
p  address of pointer to tag value(s)
c  address of number of values
Returns:
0 on success, 1 on bad magic, 2 on error

Definition at line 398 of file misc.c.

References headerGetEntry(), headerSprintf(), int_32, RPM_STRING_ARRAY_TYPE, RPM_STRING_TYPE, rpmfiBuildFNames(), RPMTAG_BASENAMES, RPMTAG_DESCRIPTION, RPMTAG_GROUP, RPMTAG_OLDFILENAMES, RPMTAG_SUMMARY, stpcpy(), and tagName().

Referenced by hdr_subscript().


Variable Documentation

HV_t hdrVec = &hdrVec1
 

Header methods for rpm headers.

Definition at line 3751 of file header.c.

unsigned char header_magic[8] [static]
 

Initial value:

 {
        0x8e, 0xad, 0xe8, 0x01, 0x00, 0x00, 0x00, 0x00
}

Definition at line 47 of file header.c.

Referenced by headerRead(), and headerWrite().

const struct headerSprintfExtension_s headerDefaultFormats[]
 

Supported default header tag output formats.

Definition at line 198 of file header.h.

size_t headerMaxbytes = (32*1024*1024) [static]
 

Maximum no. of bytes permitted in a header.

Definition at line 101 of file header.c.

Referenced by headerCopyLoad(), and headerRead().

int typeAlign[16] [static]
 

Initial value:

  {
    1,  
    1,  
    1,  
    2,  
    4,  
    8,  
    1,  
    1,  
    1,  
    1,  
    0,
    0,
    0,
    0,
    0,
    0
}
Alignment needed for header data types.

Definition at line 55 of file header.c.

int typeSizes[16] [static]
 

Initial value:

  { 
    0,  
    1,  
    1,  
    2,  
    4,  
    -1, 
    -1, 
    1,  
    -1, 
    -1, 
    0,
    0,
    0,
    0,
    0,
    0
}
Size of header data types.

Definition at line 78 of file header.c.

Referenced by dataLength(), doHeaderUnload(), headerSizeof(), and regionSwab().


Generated on Sun Oct 26 13:02:10 2003 for rpm by doxygen1.2.18