rpm/lib/cpio.h

141 lines
3.9 KiB
C

#ifndef H_CPIO
#define H_CPIO
/** \ingroup payload
* \file lib/cpio.h
* Structures used to handle cpio payloads within rpm packages.
*
* @warning Rpm's cpio implementation may be different than standard cpio.
* The implementation is pretty close, but it has some behaviors which are
* more to RPM's liking. I tried to document the differing behavior in cpio.c,
* but I may have missed some (ewt).
*
*/
/** \ingroup payload
* @note CPIO_CHECK_ERRNO bit is set only if errno is valid.
*/
#define CPIOERR_CHECK_ERRNO 0x00008000
/** \ingroup payload
*/
enum cpioErrorReturns {
CPIOERR_BAD_MAGIC = (2 ),
CPIOERR_BAD_HEADER = (3 ),
CPIOERR_OPEN_FAILED = (4 | CPIOERR_CHECK_ERRNO),
CPIOERR_CHMOD_FAILED = (5 | CPIOERR_CHECK_ERRNO),
CPIOERR_CHOWN_FAILED = (6 | CPIOERR_CHECK_ERRNO),
CPIOERR_WRITE_FAILED = (7 | CPIOERR_CHECK_ERRNO),
CPIOERR_UTIME_FAILED = (8 | CPIOERR_CHECK_ERRNO),
CPIOERR_UNLINK_FAILED = (9 | CPIOERR_CHECK_ERRNO),
CPIOERR_RENAME_FAILED = (10 | CPIOERR_CHECK_ERRNO),
CPIOERR_SYMLINK_FAILED = (11 | CPIOERR_CHECK_ERRNO),
CPIOERR_STAT_FAILED = (12 | CPIOERR_CHECK_ERRNO),
CPIOERR_LSTAT_FAILED = (13 | CPIOERR_CHECK_ERRNO),
CPIOERR_MKDIR_FAILED = (14 | CPIOERR_CHECK_ERRNO),
CPIOERR_RMDIR_FAILED = (15 | CPIOERR_CHECK_ERRNO),
CPIOERR_MKNOD_FAILED = (16 | CPIOERR_CHECK_ERRNO),
CPIOERR_MKFIFO_FAILED = (17 | CPIOERR_CHECK_ERRNO),
CPIOERR_LINK_FAILED = (18 | CPIOERR_CHECK_ERRNO),
CPIOERR_READLINK_FAILED = (19 | CPIOERR_CHECK_ERRNO),
CPIOERR_READ_FAILED = (20 | CPIOERR_CHECK_ERRNO),
CPIOERR_COPY_FAILED = (21 | CPIOERR_CHECK_ERRNO),
CPIOERR_HDR_SIZE = (22 ),
CPIOERR_HDR_TRAILER = (23 ),
CPIOERR_UNKNOWN_FILETYPE= (24 ),
CPIOERR_MISSING_HARDLINK= (25 ),
CPIOERR_MD5SUM_MISMATCH = (26 ),
CPIOERR_INTERNAL = (27 ),
CPIOERR_UNMAPPED_FILE = (28 ),
CPIOERR_ENOENT = (29 ),
CPIOERR_ENOTEMPTY = (30 )
};
/** \ingroup payload
*/
typedef enum cpioMapFlags_e {
CPIO_MAP_PATH = (1 << 0),
CPIO_MAP_MODE = (1 << 1),
CPIO_MAP_UID = (1 << 2),
CPIO_MAP_GID = (1 << 3),
CPIO_FOLLOW_SYMLINKS= (1 << 4), /*!< only for building. */
CPIO_MAP_ABSOLUTE = (1 << 5),
CPIO_MAP_ADDDOT = (1 << 6),
CPIO_ALL_HARDLINKS = (1 << 7), /*!< fail if hardlinks are missing. */
CPIO_MAP_TYPE = (1 << 8) /*!< only for building. */
} cpioMapFlags;
#define CPIO_NEWC_MAGIC "070701"
#define CPIO_CRC_MAGIC "070702"
#define CPIO_TRAILER "TRAILER!!!"
/** \ingroup payload
* Cpio archive header information.
*/
struct cpioCrcPhysicalHeader {
char magic[6];
char inode[8];
char mode[8];
char uid[8];
char gid[8];
char nlink[8];
char mtime[8];
char filesize[8];
char devMajor[8];
char devMinor[8];
char rdevMajor[8];
char rdevMinor[8];
char namesize[8];
char checksum[8]; /* ignored !! */
};
#define PHYS_HDR_SIZE 110 /*!< Don't depend on sizeof(struct) */
#ifdef __cplusplus
extern "C" {
#endif
/**
* Write cpio trailer.
* @retval fsm file path and stat info
* @return 0 on success
*/
int cpioTrailerWrite(FSM_t fsm)
/*@globals h_errno, fileSystem, internalState @*/
/*@modifies fsm, fileSystem, internalState @*/;
/**
* Write cpio header.
* @retval fsm file path and stat info
* @param st
* @return 0 on success
*/
int cpioHeaderWrite(FSM_t fsm, struct stat * st)
/*@globals h_errno, fileSystem, internalState @*/
/*@modifies fsm, fileSystem, internalState @*/;
/**
* Read cpio header.
* @retval fsm file path and stat info
* @retval st
* @return 0 on success
*/
int cpioHeaderRead(FSM_t fsm, struct stat * st)
/*@globals h_errno, fileSystem, internalState @*/
/*@modifies fsm, *st, fileSystem, internalState @*/;
/** \ingroup payload
* Return formatted error message on payload handling failure.
* @param rc error code
* @return formatted error string
*/
/*@observer@*/ const char *const cpioStrerror(int rc)
/*@*/;
#ifdef __cplusplus
}
#endif
#endif /* H_CPIO */