downloader.c File Reference

Image downloader. More...

#include <stdlib.h>
#include <stdarg.h>
#include <errno.h>
#include <gpxe/xfer.h>
#include <gpxe/open.h>
#include <gpxe/job.h>
#include <gpxe/uaccess.h>
#include <gpxe/umalloc.h>
#include <gpxe/image.h>
#include <gpxe/downloader.h>

Go to the source code of this file.

Data Structures
struct	downloader
	A downloader. More...
Functions
	FILE_LICENCE (GPL2_OR_LATER)
static void	downloader_free (struct refcnt *refcnt)
	Free downloader object.
static void	downloader_finished (struct downloader *downloader, int rc)
	Terminate download.
static int	downloader_ensure_size (struct downloader *downloader, size_t len)
	Ensure that download buffer is large enough for the specified size.
static void	downloader_job_kill (struct job_interface *job)
	Handle kill() event received via job control interface.
static void	downloader_job_progress (struct job_interface *job, struct job_progress *progress)
	Report progress of download job.
static int	downloader_xfer_deliver_iob (struct xfer_interface *xfer, struct io_buffer *iobuf, struct xfer_metadata *meta)
	Handle deliver_raw() event received via data transfer interface.
static void	downloader_xfer_close (struct xfer_interface *xfer, int rc)
	Handle close() event received via data transfer interface.
int	create_downloader (struct job_interface *job, struct image *image, int(*register_image)(struct image *image), int type,...)
	Instantiate a downloader.
Variables
static struct job_interface_operations	downloader_job_operations
	Downloader job control interface operations.
static struct xfer_interface_operations	downloader_xfer_operations
	Downloader data transfer interface operations.

---

Detailed Description

Image downloader.

Definition in file downloader.c.

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

static void downloader_free

(

struct refcnt *

refcnt

)

[static]

Free downloader object.

Parameters:

refcnt

Downloader reference counter

Definition at line 61 of file downloader.c.

References container_of, free(), downloader::image, and image_put().

Referenced by create_downloader().

                                                      {
        struct downloader *downloader =
                container_of ( refcnt, struct downloader, refcnt );

        image_put ( downloader->image );
        free ( downloader );
}

static void downloader_finished	(	struct downloader *	downloader,
		int	rc
	)			[static]

Terminate download.

Parameters:

	downloader	Downloader
	rc	Reason for termination

Definition at line 75 of file downloader.c.

References downloader::job, job_done(), job_nullify(), downloader::xfer, and xfer_close().

Referenced by create_downloader(), downloader_job_kill(), and downloader_xfer_close().

                                                                          {

        /* Block further incoming messages */
        job_nullify ( &downloader->job );
        xfer_nullify ( &downloader->xfer );

        /* Free resources and close interfaces */
        xfer_close ( &downloader->xfer, rc );
        job_done ( &downloader->job, rc );
}

static int downloader_ensure_size	(	struct downloader *	downloader,
		size_t	len
	)			[static]

Ensure that download buffer is large enough for the specified size.

Parameters:

	downloader	Downloader
	len	Required minimum size

Return values:

rc

Return status code

Definition at line 93 of file downloader.c.

References image::data, DBGC, ENOBUFS, downloader::image, image::len, and urealloc().

Referenced by downloader_xfer_deliver_iob().

                                                 {
        userptr_t new_buffer;

        /* If buffer is already large enough, do nothing */
        if ( len <= downloader->image->len )
                return 0;

        DBGC ( downloader, "Downloader %p extending to %zd bytes\n",
               downloader, len );

        /* Extend buffer */
        new_buffer = urealloc ( downloader->image->data, len );
        if ( ! new_buffer ) {
                DBGC ( downloader, "Downloader %p could not extend buffer to "
                       "%zd bytes\n", downloader, len );
                return -ENOBUFS;
        }
        downloader->image->data = new_buffer;
        downloader->image->len = len;

        return 0;
}

static void downloader_job_kill

(

struct job_interface *

job

)

[static]

Handle kill() event received via job control interface.

Parameters:

job

Downloader job control interface

Definition at line 128 of file downloader.c.

References container_of, downloader_finished(), and ECANCELED.

                                                              {
        struct downloader *downloader =
                container_of ( job, struct downloader, job );

        /* Terminate download */
        downloader_finished ( downloader, -ECANCELED );
}

static void downloader_job_progress	(	struct job_interface *	job,
		struct job_progress *	progress
	)			[static]

Report progress of download job.

Parameters:

	job	Downloader job control interface
	progress	Progress report to fill in

Definition at line 142 of file downloader.c.

References job_progress::completed, container_of, downloader::image, image::len, downloader::pos, and job_progress::total.

                                                                      {
        struct downloader *downloader =
                container_of ( job, struct downloader, job );

        /* This is not entirely accurate, since downloaded data may
         * arrive out of order (e.g. with multicast protocols), but
         * it's a reasonable first approximation.
         */
        progress->completed = downloader->pos;
        progress->total = downloader->image->len;
}

static int downloader_xfer_deliver_iob	(	struct xfer_interface *	xfer,
		struct io_buffer *	iobuf,
		struct xfer_metadata *	meta
	)			[static]

Handle deliver_raw() event received via data transfer interface.

Parameters:

	xfer	Downloader data transfer interface
	iobuf	Datagram I/O buffer
	meta	Data transfer metadata

Return values:

rc

Return status code

Definition at line 176 of file downloader.c.

References container_of, copy_to_user(), io_buffer::data, image::data, downloader_ensure_size(), free_iob(), downloader::image, iob_len(), max, xfer_metadata::offset, downloader::pos, SEEK_CUR, and xfer_metadata::whence.

                                                                      {
        struct downloader *downloader =
                container_of ( xfer, struct downloader, xfer );
        size_t len;
        size_t max;
        int rc;

        /* Calculate new buffer position */
        if ( meta->whence != SEEK_CUR )
                downloader->pos = 0;
        downloader->pos += meta->offset;

        /* Ensure that we have enough buffer space for this data */
        len = iob_len ( iobuf );
        max = ( downloader->pos + len );
        if ( ( rc = downloader_ensure_size ( downloader, max ) ) != 0 )
                goto done;

        /* Copy data to buffer */
        copy_to_user ( downloader->image->data, downloader->pos,
                       iobuf->data, len );

        /* Update current buffer position */
        downloader->pos += len;

 done:
        free_iob ( iobuf );
        return rc;
}

static void downloader_xfer_close	(	struct xfer_interface *	xfer,
		int	rc
	)			[static]

Handle close() event received via data transfer interface.

Parameters:

	xfer	Downloader data transfer interface
	rc	Reason for close

Definition at line 214 of file downloader.c.

References container_of, downloader_finished(), downloader::image, and downloader::register_image.

                                                                          {
        struct downloader *downloader =
                container_of ( xfer, struct downloader, xfer );

        /* Register image if download was successful */
        if ( rc == 0 )
                rc = downloader->register_image ( downloader->image );

        /* Terminate download */
        downloader_finished ( downloader, rc );
}

int create_downloader	(	struct job_interface *	job,
		struct image *	image,
		int(*)(struct image *image)	register_image,
		int	type,
			...
	)

Instantiate a downloader.

Parameters:

	job	Job control interface
	image	Image to fill with downloaded file
	register_image	Image registration routine
	type	Location type to pass to xfer_open()
	...	Remaining arguments to pass to xfer_open()

Return values:

rc

Return status code

Instantiates a downloader object to download the specified URI into the specified image object. If the download is successful, the image registration routine register_image() will be called.

Definition at line 256 of file downloader.c.

References downloader_finished(), downloader_free(), ENOMEM, refcnt::free, downloader::image, image_get(), downloader::job, job_init(), job_plug_plug(), ref_put(), downloader::refcnt, register_image(), downloader::register_image, va_end, va_start, downloader::xfer, xfer_init(), xfer_vopen(), and zalloc().

Referenced by imgfetch().

                                        {
        struct downloader *downloader;
        va_list args;
        int rc;

        /* Allocate and initialise structure */
        downloader = zalloc ( sizeof ( *downloader ) );
        if ( ! downloader )
                return -ENOMEM;
        downloader->refcnt.free = downloader_free;
        job_init ( &downloader->job, &downloader_job_operations,
                   &downloader->refcnt );
        xfer_init ( &downloader->xfer, &downloader_xfer_operations,
                    &downloader->refcnt );
        downloader->image = image_get ( image );
        downloader->register_image = register_image;
        va_start ( args, type );

        /* Instantiate child objects and attach to our interfaces */
        if ( ( rc = xfer_vopen ( &downloader->xfer, type, args ) ) != 0 )
                goto err;

        /* Attach parent interface, mortalise self, and return */
        job_plug_plug ( &downloader->job, job );
        ref_put ( &downloader->refcnt );
        va_end ( args );
        return 0;

 err:
        downloader_finished ( downloader, rc );
        ref_put ( &downloader->refcnt );
        va_end ( args );
        return rc;
}

---

Variable Documentation

struct job_interface_operations downloader_job_operations [static]

Initial value:

 {
        .done           = ignore_job_done,
        .kill           = downloader_job_kill,
        .progress       = downloader_job_progress,
}

Downloader job control interface operations.

Definition at line 156 of file downloader.c.

struct xfer_interface_operations downloader_xfer_operations [static]

Initial value:

 {
        .close          = downloader_xfer_close,
        .vredirect      = xfer_vreopen,
        .window         = unlimited_xfer_window,
        .alloc_iob      = default_xfer_alloc_iob,
        .deliver_iob    = downloader_xfer_deliver_iob,
        .deliver_raw    = xfer_deliver_as_iob,
}

Downloader data transfer interface operations.

Definition at line 227 of file downloader.c.