cpio.h File Reference

CPIO archives. More...

#include <stdint.h>
#include <ipxe/image.h>

Go to the source code of this file.

Data Structures
struct	cpio_header
	A CPIO archive header. More...

Macros
#define	CPIO_MAGIC   "070701"
	CPIO magic.
#define	CPIO_MODE_FILE   0100000
	CPIO type for regular files.
#define	CPIO_MODE_DIR   0040000
	CPIO type for directories.
#define	CPIO_ALIGN   4
	CPIO header length alignment.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static const char *	cpio_name (struct image *image)
	Get CPIO image name.
static size_t	cpio_pad_len (size_t len)
	Get CPIO header zero-padding length.
size_t	cpio_header (struct image *image, unsigned int index, struct cpio_header *cpio)
	Construct CPIO header for image, if applicable.

Detailed Description

CPIO archives.

Definition in file cpio.h.

Macro Definition Documentation

CPIO_MAGIC

#define CPIO_MAGIC   "070701"

CPIO magic.

Definition at line 53 of file cpio.h.

Referenced by cpio_header().

CPIO_MODE_FILE

#define CPIO_MODE_FILE   0100000

CPIO type for regular files.

Definition at line 56 of file cpio.h.

Referenced by cpio_header().

CPIO_MODE_DIR

#define CPIO_MODE_DIR   0040000

CPIO type for directories.

Definition at line 59 of file cpio.h.

Referenced by cpio_header().

CPIO_ALIGN

#define CPIO_ALIGN   4

CPIO header length alignment.

Definition at line 62 of file cpio.h.

Referenced by cpio_okx(), and cpio_pad_len().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

cpio_name()

const char * cpio_name ( struct image * image )

inlinestatic

Get CPIO image name.

Parameters

image

Image

Return values

name	Image name (not NUL terminated)

Definition at line 71 of file cpio.h.

                                  {
        return image->cmdline;
}

References image::cmdline.

Referenced by cpio_header(), cpio_max(), cpio_name_len(), cpio_okx(), efi_file_read_initrd(), and initrd_load().

cpio_pad_len()

size_t cpio_pad_len ( size_t len )

inlinestatic

Get CPIO header zero-padding length.

Parameters

len	Length of CPIO header (including name, excluding NUL)

Return values

pad_len

Padding length

Definition at line 82 of file cpio.h.

                            {
 
        /* Pad by at least one byte (for name's terminating NUL) */
        return ( CPIO_ALIGN - ( len % CPIO_ALIGN ) );
}

References CPIO_ALIGN, and len.

Referenced by cpio_okx(), efi_file_read_initrd(), and initrd_load().

cpio_header()

size_t cpio_header ( struct image * image, unsigned int index, struct cpio_header * cpio )

extern

Construct CPIO header for image, if applicable.

Parameters

image	Image
index	CPIO header index
cpio	CPIO header to fill in

Return values

len	Length of CPIO header (including name, excluding NUL)

Definition at line 156 of file cpio.c.

                                                {
        const char *name = cpio_name ( image );
        unsigned int mode;
        unsigned int count;
        unsigned int max;
        unsigned int depth;
        unsigned int i;
        size_t name_len;
        size_t len;
 
        /* Parse command line arguments */
        cpio_parse_cmdline ( image, &mode, &count );
 
        /* Determine number of CPIO headers to be constructed */
        max = cpio_max ( image );
        if ( count > max )
                count = max;
 
        /* Determine path depth of this CPIO header */
        if ( index >= count )
                return 0;
        depth = ( max - count + index + 1 );
 
        /* Get filename length */
        name_len = cpio_name_len ( image, depth );
 
        /* Set directory mode or file mode as appropriate */
        if ( name[name_len] == '/' ) {
                mode = ( CPIO_MODE_DIR | CPIO_DEFAULT_DIR_MODE );
        } else {
                mode |= CPIO_MODE_FILE;
        }
 
        /* Set length on final header */
        len = ( ( depth < max ) ? 0 : image->len );
 
        /* Construct CPIO header */
        memset ( cpio, '0', sizeof ( *cpio ) );
        memcpy ( cpio->c_magic, CPIO_MAGIC, sizeof ( cpio->c_magic ) );
        cpio_set_field ( cpio->c_mode, mode );
        cpio_set_field ( cpio->c_nlink, 1 );
        cpio_set_field ( cpio->c_filesize, len );
        cpio_set_field ( cpio->c_namesize, ( name_len + 1 /* NUL */ ) );
        DBGC ( image, "CPIO %s %d/%d \"", image->name, depth, max );
        for ( i = 0 ; i < name_len ; i++ )
                DBGC ( image, "%c", name[i] );
        DBGC ( image, "\"\n" );
        DBGC2_HDA ( image, 0, cpio, sizeof ( *cpio ) );
 
        /* Calculate total length */
        return ( sizeof ( *cpio ) + name_len );
}

References cpio_header::c_filesize, cpio_header::c_magic, cpio_header::c_mode, cpio_header::c_namesize, cpio_header::c_nlink, count, CPIO_DEFAULT_DIR_MODE, CPIO_MAGIC, cpio_max(), CPIO_MODE_DIR, CPIO_MODE_FILE, cpio_name(), cpio_name_len(), cpio_parse_cmdline(), cpio_set_field(), DBGC, DBGC2_HDA, index, image::len, len, max, memcpy(), memset(), mode, image::name, and name.

Referenced by cpio_okx(), efi_file_read_initrd(), and initrd_load().