An rpm header carries all information about a package. More...

#include <rpm/rpmio.h>
#include <rpm/rpmtypes.h>
#include <rpm/rpmtd.h>
#include <rpm/rpmutil.h>

Include dependency graph for header.h:

Typedefs
typedef rpmFlags	headerImportFlags

typedef rpmFlags	headerGetFlags

typedef rpmFlags	headerPutFlags

typedef enum headerConvOps_e	headerConvOps

Enumerations
enum	hMagic { HEADER_MAGIC_NO = 0, HEADER_MAGIC_YES = 1 }
	Include calculation for 8 bytes of (magic, 0)? More...

enum	headerImportFlags_e { HEADERIMPORT_COPY = (1 << 0), HEADERIMPORT_FAST = (1 << 1) }

enum	headerGetFlags_e { HEADERGET_DEFAULT = 0, HEADERGET_MINMEM = (1 << 0), HEADERGET_EXT = (1 << 1), HEADERGET_RAW = (1 << 2), HEADERGET_ALLOC = (1 << 3), HEADERGET_ARGV = (1 << 4) }
	Modifier flags for headerGet() operation. More...

enum	headerPutFlags_e { HEADERPUT_DEFAULT = 0, HEADERPUT_APPEND = (1 << 0) }

enum	headerConvOps_e { HEADERCONV_EXPANDFILELIST = 0, HEADERCONV_COMPRESSFILELIST = 1, HEADERCONV_RETROFIT_V3 = 2 }

Functions
Header	headerNew (void)
	Create new (empty) header instance. More...

Header	headerFree (Header h)
	Dereference a header instance. More...

Header	headerLink (Header h)
	Reference a header instance. More...

void	headerSort (Header h)
	Sort tags in header. More...

void	headerUnsort (Header h)
	Restore tags in header to original ordering. More...

unsigned int	headerSizeof (Header h, int magicp)
	Return size of on-disk header representation in bytes. More...

int	headerVerifyInfo (int il, int dl, const void pev, void iv, int negate)
	Perform simple sanity and range checks on header tag(s). More...

void *	headerUnload (Header h)
	Convert header to on-disk representation. More...

void *	headerExport (Header h, unsigned int *bsize)
	Export header to on-disk representation. More...

Header	headerReload (Header h, rpmTagVal tag)
	Convert header to on-disk representation, and then reload. More...

Header	headerCopy (Header h)
	Duplicate a header. More...

Header	headerLoad (void *uh)
	Convert header to in-memory representation. More...

Header	headerCopyLoad (const void *uh)
	Make a copy and convert header to in-memory representation. More...

Header	headerImport (void *blob, unsigned int bsize, headerImportFlags flags)
	Import header to in-memory representation. More...

Header	headerRead (FD_t fd, int magicp)
	Read (and load) header from file handle. More...

int	headerWrite (FD_t fd, Header h, int magicp)
	Write (with unload) header to file handle. More...

int	headerIsEntry (Header h, rpmTagVal tag)
	Check if tag is in header. More...

int	headerGet (Header h, rpmTagVal tag, rpmtd td, headerGetFlags flags)
	Retrieve tag value. More...

int	headerPut (Header h, rpmtd td, headerPutFlags flags)
	Add or append tag to header. More...

int	headerAddI18NString (Header h, rpmTagVal tag, const char string, const char lang)
	Add locale specific tag to header. More...

int	headerMod (Header h, rpmtd td)
	Modify tag in header. More...

int	headerDel (Header h, rpmTagVal tag)
	Delete tag in header. More...

char *	headerFormat (Header h, const char fmt, errmsg_t errmsg)
	Return formatted output string from header tags. More...

void	headerCopyTags (Header headerFrom, Header headerTo, const rpmTagVal *tagstocopy)
	Duplicate tag values from one header into another. More...

HeaderIterator	headerFreeIterator (HeaderIterator hi)
	Destroy header tag iterator. More...

HeaderIterator	headerInitIterator (Header h)
	Create header tag iterator. More...

int	headerNext (HeaderIterator hi, rpmtd td)
	Return next tag contents from header. More...

rpmTagVal	headerNextTag (HeaderIterator hi)
	Return next tag number from header. More...

RPM_GNUC_DEPRECATED int	headerNVR (Header h, const char np, const char vp, const char **rp)
	Return name, version, release strings from header. More...

RPM_GNUC_DEPRECATED int	headerNEVRA (Header h, const char np, uint32_t ep, const char vp, const char rp, const char **ap)
	Return name, epoch, version, release, arch strings from header. More...

RPM_GNUC_DEPRECATED char *	headerGetNEVR (Header h, const char **np)
	Return (malloc'd) header name-version-release string. More...

RPM_GNUC_DEPRECATED char *	headerGetNEVRA (Header h, const char **np)
	Return (malloc'd) header name-version-release.arch string. More...

RPM_GNUC_DEPRECATED char *	headerGetEVR (Header h, const char **np)

char *	headerGetAsString (Header h, rpmTagVal tag)
	Return any non-array tag from header, converted to string. More...

const char *	headerGetString (Header h, rpmTagVal tag)
	Return a simple string tag from header. More...

uint64_t	headerGetNumber (Header h, rpmTagVal tag)

RPM_GNUC_DEPRECATED rpm_color_t	headerGetColor (Header h)
	Return header color. More...

int	headerIsSource (Header h)
	Check if header is a source or binary package header. More...

unsigned int	headerGetInstance (Header h)
	Return header instance, ie is the header from rpmdb. More...

int	headerConvert (Header h, int op)
	Convert header to/from (legacy) data presentation. More...


int	headerPutBin (Header h, rpmTagVal tag, const uint8_t *val, rpm_count_t size)
	Type-safe methods for inserting tag data to header. More...

int	headerPutString (Header h, rpmTagVal tag, const char *val)

int	headerPutStringArray (Header h, rpmTagVal tag, const char **val, rpm_count_t size)

int	headerPutChar (Header h, rpmTagVal tag, const char *val, rpm_count_t size)

int	headerPutUint8 (Header h, rpmTagVal tag, const uint8_t *val, rpm_count_t size)

int	headerPutUint16 (Header h, rpmTagVal tag, const uint16_t *val, rpm_count_t size)

int	headerPutUint32 (Header h, rpmTagVal tag, const uint32_t *val, rpm_count_t size)

int	headerPutUint64 (Header h, rpmTagVal tag, const uint64_t *val, rpm_count_t size)

Variables
const unsigned char	rpm_header_magic [8]
	Header magic value. More...

Detailed Description

An rpm header carries all information about a package.

A header is a collection of data elements called tags. Each tag has a data type, and includes 1 or more values.

Definition in file header.h.

Typedef Documentation

§ headerConvOps

typedef enum headerConvOps_e headerConvOps

§ headerGetFlags

typedef rpmFlags headerGetFlags

Definition at line 195 of file header.h.

§ headerImportFlags

typedef rpmFlags headerImportFlags

Definition at line 141 of file header.h.

§ headerPutFlags

typedef rpmFlags headerPutFlags

Definition at line 213 of file header.h.

Enumeration Type Documentation

§ headerConvOps_e

enum headerConvOps_e

Enumerator
HEADERCONV_EXPANDFILELIST
HEADERCONV_COMPRESSFILELIST
HEADERCONV_RETROFIT_V3

Definition at line 455 of file header.h.

§ headerGetFlags_e

enum headerGetFlags_e

Modifier flags for headerGet() operation.

For consistent behavior you'll probably want to use ALLOC to ensure the caller owns the data, but MINMEM is useful for avoiding extra copy of data when you are sure the header wont go away. Most of the time you'll probably want EXT too, but note that extensions tags don't generally honor the other flags, MINMEM, RAW, ALLOC and ARGV are only relevant for non-extension data.

Enumerator
HEADERGET_DEFAULT
HEADERGET_MINMEM
HEADERGET_EXT
HEADERGET_RAW
HEADERGET_ALLOC
HEADERGET_ARGV

Definition at line 186 of file header.h.

§ headerImportFlags_e

enum headerImportFlags_e

Enumerator
HEADERIMPORT_COPY
HEADERIMPORT_FAST

Definition at line 136 of file header.h.

§ headerPutFlags_e

enum headerPutFlags_e

Enumerator
HEADERPUT_DEFAULT
HEADERPUT_APPEND

Definition at line 208 of file header.h.

§ hMagic

enum hMagic

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

Enumerator
HEADER_MAGIC_NO
HEADER_MAGIC_YES

Definition at line 32 of file header.h.

Function Documentation

§ headerAddI18NString()

int headerAddI18NString	(	Header	h,
		rpmTagVal	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 headerMod()).
*

This function is intended to just "do the right thing". If you need more fine grained control use headerPut() and headerMod().

Parameters

h	header
tag	tag
string	tag value
lang	locale

Returns: 1 on success, 0 on failure

§ headerConvert()

int headerConvert	(	Header	h,
		int	op
	)

Convert header to/from (legacy) data presentation.

Parameters

h	header
op	one of headerConvOps operations

Returns: 1 on success, 0 on failure

§ headerCopy()

Header headerCopy ( Header h )

Duplicate a header.

Parameters

h header

Returns: new header instance

§ headerCopyLoad()

Header headerCopyLoad ( const void * uh )

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

Deprecated:: Use headerImport() instead

Parameters

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

Returns: header

§ headerCopyTags()

void headerCopyTags	(	Header	headerFrom,
		Header	headerTo,
		const rpmTagVal *	tagstocopy
	)

Duplicate tag values from one header into another.

Parameters

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

§ headerDel()

int headerDel	(	Header	h,
		rpmTagVal	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)

§ headerExport()

void* headerExport	(	Header	h,
		unsigned int *	bsize
	)

Export header to on-disk representation.

Parameters

h	header (with pointers)

Return values

bsize on-disk header blob size in bytes

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

§ headerFormat()

char* headerFormat	(	Header	h,
		const char *	fmt,
		errmsg_t *	errmsg
	)

Return formatted output string from header tags.

The returned string must be free()d.

Parameters

h	header
fmt	format to use

Return values

errmsg error message (if any)

Returns: formatted output string (malloc'ed)

§ headerFree()

Header headerFree ( Header h )

Dereference a header instance.

Parameters

h header

Returns: NULL always

Referenced by process_package().

§ headerFreeIterator()

HeaderIterator headerFreeIterator ( HeaderIterator hi )

Destroy header tag iterator.

Parameters

hi	header tag iterator

Returns: NULL always

§ headerGet()

int headerGet	(	Header	h,
		rpmTagVal	tag,
		rpmtd	td,
		headerGetFlags	flags
	)

Retrieve tag value.

Parameters

h	header
tag	tag

Return values

td	tag data container

Parameters

flags retrieval modifier flags

Returns: 1 on success, 0 on failure

§ headerGetAsString()

char* headerGetAsString	(	Header	h,
		rpmTagVal	tag
	)

Return any non-array tag from header, converted to string.

Parameters

h	header
tag	tag to retrieve

Returns: string pointer (malloced) or NULL on failure

§ headerGetColor()

RPM_GNUC_DEPRECATED rpm_color_t headerGetColor ( Header h )

Return header color.

Parameters

h header

Returns: header color

§ headerGetEVR()

RPM_GNUC_DEPRECATED char* headerGetEVR	(	Header	h,
		const char **	np
	)

§ headerGetInstance()

unsigned int headerGetInstance ( Header h )

Return header instance, ie is the header from rpmdb.

Parameters

h header

Returns: rpmdb record number or 0

§ headerGetNEVR()

RPM_GNUC_DEPRECATED char* headerGetNEVR	(	Header	h,
		const char **	np
	)

Return (malloc'd) header name-version-release string.

Parameters

h header

Return values

np	name tag value

Returns: name-version-release string

§ headerGetNEVRA()

RPM_GNUC_DEPRECATED char* headerGetNEVRA	(	Header	h,
		const char **	np
	)

Return (malloc'd) header name-version-release.arch string.

Parameters

h header

Return values

np	name tag value

Returns: name-version-release string

§ headerGetNumber()

uint64_t headerGetNumber	(	Header	h,
		rpmTagVal	tag
	)

Referenced by main().

§ headerGetString()

const char* headerGetString	(	Header	h,
		rpmTagVal	tag
	)

Return a simple string tag from header.

Parameters

h	header
tag	tag to retrieve

Returns: string pointer (to header memory) or NULL on failure

Referenced by main(), and process_package().

§ headerImport()

Header headerImport	(	void *	blob,
		unsigned int	bsize,
		headerImportFlags	flags
	)

Import header to in-memory representation.

Parameters

blob	on-disk header blob (i.e. with offsets)
bsize	on-disk header blob size in bytes (0 if unknown)
flags	flags to control operation

Returns: header

§ headerInitIterator()

HeaderIterator headerInitIterator ( Header h )

Create header tag iterator.

Parameters

h header

Returns: header tag iterator

§ headerIsEntry()

int headerIsEntry	(	Header	h,
		rpmTagVal	tag
	)

Check if tag is in header.

Parameters

h	header
tag	tag

Returns: 1 on success, 0 on failure

§ headerIsSource()

int headerIsSource ( Header h )

Check if header is a source or binary package header.

Parameters

h header

Returns: 0 == binary, 1 == source

§ headerLink()

Header headerLink ( Header h )

Reference a header instance.

Parameters

h header

Returns: new header reference

§ headerLoad()

Header headerLoad ( void * uh )

Convert header to in-memory representation.

Deprecated:: Use headerImport() instead

Parameters

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

Returns: header

§ headerMod()

int headerMod	(	Header	h,
		rpmtd	td
	)

Modify tag in header.

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

Parameters

h	header
td	tag data container

Returns: 1 on success, 0 on failure

§ headerNEVRA()

RPM_GNUC_DEPRECATED int headerNEVRA	(	Header	h,
		const char **	np,
		uint32_t **	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

§ headerNew()

Header headerNew ( void )

Create new (empty) header instance.

Returns: header

§ headerNext()

int headerNext	(	HeaderIterator	hi,
		rpmtd	td
	)

Return next tag contents from header.

Parameters

hi	header tag iterator

Return values

td	tag data container

Returns: 1 on success, 0 on failure

§ headerNextTag()

rpmTagVal headerNextTag ( HeaderIterator hi )

Return next tag number from header.

Parameters

hi	header tag iterator

Returns: next tag, RPMTAG_NOT_FOUND to stop iteration

§ headerNVR()

RPM_GNUC_DEPRECATED 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

§ headerPut()

int headerPut	(	Header	h,
		rpmtd	td,
		headerPutFlags	flags
	)

Add or append tag to header.

Parameters

h	header
td	tag data container
flags	flags to control operation

Returns: 1 on success, 0 on failure

§ headerPutBin()

int headerPutBin	(	Header	h,
		rpmTagVal	tag,
		const uint8_t *	val,
		rpm_count_t	size
	)

Type-safe methods for inserting tag data to header.

Tag data type is validated to match the function type, ie things like headerPutUint32(h, RPMTAG_NAME, ...) will return failure. For non-array types size must equal 1, and data is checked to be non-NULL. For array types, add-or-append mode is always used.

headerPutString() can be used on both RPM_STRING_TYPE and RPM_STRING_ARRAY_TYPE (to add a single string into the array) tags, for others the type must match exactly.

These are intended to "do the right thing" in the common case, if you need more fine grained control use headerPut() & friends instead.

Todo:: Make doxygen group these meaningfully.

Parameters

h	header
tag	tag to insert
val	pointer to value(s)
size	number of items in array (1 or larger)

Returns: 1 on success, 0 on failure

§ headerPutChar()

int headerPutChar	(	Header	h,
		rpmTagVal	tag,
		const char *	val,
		rpm_count_t	size
	)

§ headerPutString()

int headerPutString	(	Header	h,
		rpmTagVal	tag,
		const char *	val
	)

§ headerPutStringArray()

int headerPutStringArray	(	Header	h,
		rpmTagVal	tag,
		const char **	val,
		rpm_count_t	size
	)

§ headerPutUint16()

int headerPutUint16	(	Header	h,
		rpmTagVal	tag,
		const uint16_t *	val,
		rpm_count_t	size
	)

§ headerPutUint32()

int headerPutUint32	(	Header	h,
		rpmTagVal	tag,
		const uint32_t *	val,
		rpm_count_t	size
	)

§ headerPutUint64()

int headerPutUint64	(	Header	h,
		rpmTagVal	tag,
		const uint64_t *	val,
		rpm_count_t	size
	)

§ headerPutUint8()

int headerPutUint8	(	Header	h,
		rpmTagVal	tag,
		const uint8_t *	val,
		rpm_count_t	size
	)

§ headerRead()

Header headerRead	(	FD_t	fd,
		int	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)

Referenced by importDB().

§ headerReload()

Header headerReload	(	Header	h,
		rpmTagVal	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)

§ headerSizeof()

unsigned int headerSizeof	(	Header	h,
		int	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

§ headerSort()

void headerSort ( Header h )

Sort tags in header.

Parameters

h header

§ headerUnload()

void* headerUnload ( Header h )

Convert header to on-disk representation.

Deprecated:: Use headerExport() instead

Parameters

h	header (with pointers)

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

§ headerUnsort()

void headerUnsort ( Header h )

Restore tags in header to original ordering.

Parameters

h header

§ headerVerifyInfo()

int headerVerifyInfo	(	int	il,
		int	dl,
		const void *	pev,
		void *	iv,
		int	negate
	)

Perform simple sanity and range checks on header tag(s).

Parameters

il	no. of tags in header
dl	no. of bytes in header data.
pev	1st element in tag array, big-endian
iv	failing (or last) tag element, host-endian
negate	negative offset expected?

Returns: -1 on success, otherwise failing tag element index

§ headerWrite()

int headerWrite	(	FD_t	fd,
		Header	h,
		int	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

Referenced by exportDB().

Variable Documentation

§ rpm_header_magic

const unsigned char rpm_header_magic[8]

Header magic value.

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

§ headerConvOps

§ headerGetFlags

§ headerImportFlags

§ headerPutFlags

Enumeration Type Documentation

§ headerConvOps_e

§ headerGetFlags_e

§ headerImportFlags_e

§ headerPutFlags_e

§ hMagic

Function Documentation

§ headerAddI18NString()

§ headerConvert()

§ headerCopy()

§ headerCopyLoad()

§ headerCopyTags()

§ headerDel()

§ headerExport()

§ headerFormat()

§ headerFree()

§ headerFreeIterator()

§ headerGet()

§ headerGetAsString()

§ headerGetColor()

§ headerGetEVR()

§ headerGetInstance()

§ headerGetNEVR()

§ headerGetNEVRA()

§ headerGetNumber()

§ headerGetString()

§ headerImport()

§ headerInitIterator()

§ headerIsEntry()

§ headerIsSource()

§ headerLink()

§ headerLoad()

§ headerMod()

§ headerNEVRA()

§ headerNew()

§ headerNext()

§ headerNextTag()

§ headerNVR()

§ headerPut()

§ headerPutBin()

§ headerPutChar()

§ headerPutString()

§ headerPutStringArray()

§ headerPutUint16()

§ headerPutUint32()

§ headerPutUint64()

§ headerPutUint8()

§ headerRead()

§ headerReload()

§ headerSizeof()

§ headerSort()

§ headerUnload()

§ headerUnsort()

§ headerVerifyInfo()

§ headerWrite()

Variable Documentation

§ rpm_header_magic