blob.c File Reference

Openable data blobs. More...

#include <string.h>
#include <errno.h>
#include <ipxe/malloc.h>
#include <ipxe/xfer.h>
#include <ipxe/process.h>
#include <ipxe/blob.h>

Go to the source code of this file.

Data Structures
struct	blob
	An openable data blob. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static void	blob_close (struct blob *blob, int rc)
	Close data blob.
static void	blob_step (struct blob *blob)
	Process data blob.
int	blob_open (struct interface *xfer, const void *data, size_t len)
	Open data blob.

Variables
static struct interface_operation	blob_xfer_op []
	Data blob interface operations.
static struct interface_descriptor	blob_xfer_desc
	Data blob interface descriptor.
static struct process_descriptor	blob_process_desc
	Data blob process descriptor.

Detailed Description

Openable data blobs.

Within the iPXE data transfer interface model, openers are fully asynchronous and may not deliver any data until after the opener has returned. An openable data blob provides a way to open an interface that will then simply return a single fixed blob of data.

Definition in file blob.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

blob_close()

void blob_close ( struct blob * blob, int rc )

static

Close data blob.

Parameters

blob	Data blob
rc	Reason for close

Definition at line 64 of file blob.c.

                                                     {
 
        /* Stop process */
        process_del ( &blob->process );
 
        /* Shut down interface */
        intf_shutdown ( &blob->xfer, rc );
}

References intf_shutdown(), blob::process, process_del(), rc, and blob::xfer.

Referenced by blob_step().

blob_step()

void blob_step ( struct blob * blob )

static

Process data blob.

Parameters

blob

Data blob

Definition at line 78 of file blob.c.

                                            {
        int rc;
 
        /* Deliver data when window opens */
        if ( xfer_window ( &blob->xfer ) ) {
                rc = xfer_deliver_raw ( &blob->xfer, blob->data, blob->len );
                blob_close ( blob, rc );
        }
}

References blob_close(), blob::data, blob::len, rc, blob::xfer, xfer_deliver_raw(), and xfer_window().

blob_open()

int blob_open	(	struct interface *	xfer,
		const void *	data,
		size_t	len )

Open data blob.

Parameters

xfer	Data transfer interface
data	Data
len	Length of data

Return values

rc	Return status code

Definition at line 110 of file blob.c.

                                                                       {
        struct blob *blob;
        void *copy;
 
        /* Allocate and initialise structure */
        blob = zalloc ( sizeof ( *blob ) + len );
        if ( ! blob )
                return -ENOMEM;
        ref_init ( &blob->refcnt, NULL );
        intf_init ( &blob->xfer, &blob_xfer_desc, &blob->refcnt );
        process_init ( &blob->process, &blob_process_desc, &blob->refcnt );
        copy = ( ( ( void * ) blob ) + sizeof ( *blob ) );
        blob->data = copy;
        blob->len = len;
        memcpy ( copy, data, len );
 
        /* Attach parent interface, mortalise self, and return */
        intf_plug_plug ( &blob->xfer, xfer );
        ref_put ( &blob->refcnt );
        return 0;
}

References blob_process_desc, blob_xfer_desc, blob::data, data, ENOMEM, intf_init(), intf_plug_plug(), blob::len, len, memcpy(), NULL, blob::process, process_init(), ref_init, ref_put, blob::refcnt, blob::xfer, and zalloc().

Referenced by datauri_open().

Variable Documentation

blob_xfer_op

struct interface_operation blob_xfer_op[]

static

Initial value:

                                 = {
        INTF_OP ( xfer_window_changed, struct blob *, blob_step ),
        INTF_OP ( intf_close, struct blob *, blob_close ),
}

Data blob interface operations.

Definition at line 89 of file blob.c.

                                                 {
        INTF_OP ( xfer_window_changed, struct blob *, blob_step ),
        INTF_OP ( intf_close, struct blob *, blob_close ),
};

blob_xfer_desc

struct interface_descriptor blob_xfer_desc

static

Initial value:

                         =
INTF_DESC ( struct blob, xfer, blob_xfer_op )

Data blob interface descriptor.

Definition at line 95 of file blob.c.

Referenced by blob_open().

blob_process_desc

struct process_descriptor blob_process_desc

static

Initial value:

                       =
PROC_DESC_ONCE ( struct blob, process, blob_step )

Data blob process descriptor.

Definition at line 99 of file blob.c.

Referenced by blob_open().