Image downloader. More...

#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <syslog.h>
#include <ipxe/iobuf.h>
#include <ipxe/xfer.h>
#include <ipxe/open.h>
#include <ipxe/job.h>
#include <ipxe/umalloc.h>
#include <ipxe/image.h>
#include <ipxe/xferbuf.h>
#include <ipxe/downloader.h>

Data Structures
struct	downloader
	A downloader. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)

	FILE_SECBOOT (PERMITTED)

static void	downloader_free (struct refcnt *refcnt)
	Free downloader object. More...

static void	downloader_finished (struct downloader *downloader, int rc)
	Terminate download. More...

static int	downloader_progress (struct downloader downloader, struct job_progress progress)
	Report progress of download job. More...

static int	downloader_deliver (struct downloader downloader, struct io_buffer iobuf, struct xfer_metadata *meta)
	Handle received data. More...

static struct xfer_buffer *	downloader_buffer (struct downloader *downloader)
	Get underlying data transfer buffer. More...

static int	downloader_vredirect (struct downloader *downloader, int type, va_list args)
	Redirect data transfer interface. More...

int	create_downloader (struct interface job, struct image image)
	Instantiate a downloader. More...

Variables
static struct interface_operation	downloader_xfer_operations []
	Downloader data transfer interface operations. More...

static struct interface_descriptor	downloader_xfer_desc
	Downloader data transfer interface descriptor. More...

static struct interface_operation	downloader_job_op []
	Downloader job control interface operations. More...

static struct interface_descriptor	downloader_job_desc
	Downloader job control interface descriptor. More...

Detailed Description

Image downloader.

Definition in file downloader.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

◆ downloader_free()

static void downloader_free ( struct refcnt * refcnt )

static

Free downloader object.

Parameters

refcnt Downloader reference counter

Definition at line 67 of file downloader.c.

                                                       {
         struct downloader *downloader =
                 container_of ( refcnt, struct downloader, refcnt );
 
         xferbuf_free ( &downloader->buffer );
         image_put ( downloader->image );
         free ( downloader );
 }

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

Referenced by create_downloader().

◆ downloader_finished()

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

static

Terminate download.

Parameters

downloader	Downloader
rc	Reason for termination

Definition at line 82 of file downloader.c.

                                                                           {
         struct xfer_buffer *buffer = &downloader->buffer;
         struct image *image = downloader->image;
 
         /* Log download status */
         if ( rc == 0 ) {
                 syslog ( LOG_NOTICE, "Downloaded \"%s\"\n", image->name );
         } else {
                 syslog ( LOG_ERR, "Download of \"%s\" failed: %s\n",
                          image->name, strerror ( rc ) );
         }
 
         /* Transfer ownership from data transfer buffer to image */
         image->data = buffer->data;
         image->len = buffer->len;
         xferbuf_detach ( buffer );
 
         /* Shut down interfaces */
         intf_shutdown ( &downloader->xfer, rc );
         intf_shutdown ( &downloader->job, rc );
 }

References buffer, downloader::buffer, image::data, downloader::image, intf_shutdown(), downloader::job, image::len, LOG_ERR, LOG_NOTICE, image::name, rc, strerror(), syslog, downloader::xfer, and xferbuf_detach().

Referenced by create_downloader(), downloader_deliver(), and downloader_vredirect().

◆ downloader_progress()

static int downloader_progress	(	struct downloader *	downloader,
		struct job_progress *	progress
	)

static

Report progress of download job.

Parameters

downloader	Downloader
progress	Progress report to fill in

Return values

ongoing_rc Ongoing job status code (if known)

Definition at line 117 of file downloader.c.

                                                                  {
         int rc;
 
         /* Allow data transfer to provide an accurate description */
         if ( ( rc = job_progress ( &downloader->xfer, progress ) ) != 0 )
                 return rc;
 
         /* 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.
          */
         if ( ! progress->total ) {
                 progress->completed = downloader->buffer.pos;
                 progress->total = downloader->buffer.len;
         }
 
         return 0;
 }

References downloader::buffer, job_progress::completed, xfer_buffer::len, xfer_buffer::pos, rc, job_progress::total, and downloader::xfer.

◆ downloader_deliver()

static int downloader_deliver	(	struct downloader *	downloader,
		struct io_buffer *	iobuf,
		struct xfer_metadata *	meta
	)

static

Handle received data.

Parameters

downloader	Downloader
iobuf	Datagram I/O buffer
meta	Data transfer metadata

Return values

rc	Return status code

Definition at line 151 of file downloader.c.

                                                              {
         int rc;
 
         /* Add data to buffer */
         if ( ( rc = xferbuf_deliver ( &downloader->buffer, iob_disown ( iobuf ),
                                       meta ) ) != 0 )
                 goto err_deliver;
 
         return 0;
 
  err_deliver:
         downloader_finished ( downloader, rc );
         return rc;
 }

References downloader::buffer, downloader_finished(), iob_disown, meta, rc, and xferbuf_deliver().

◆ downloader_buffer()

static struct xfer_buffer* downloader_buffer ( struct downloader * downloader )

static

Get underlying data transfer buffer.

Parameters

downloader Downloader

Return values

xferbuf Data transfer buffer, or NULL on error

Definition at line 175 of file downloader.c.

                                                     {
 
         /* Provide direct access to underlying data transfer buffer */
         return &downloader->buffer;
 }

References downloader::buffer.

◆ downloader_vredirect()

static int downloader_vredirect	(	struct downloader *	downloader,
		int	type,
		va_list	args
	)

static

Redirect data transfer interface.

Parameters

downloader	Downloader
type	New location type
args	Remaining arguments depend upon location type

Return values

rc	Return status code

Definition at line 189 of file downloader.c.

                                                  {
         va_list tmp;
         struct uri *uri;
         int rc;
 
         /* Intercept redirects to a LOCATION_URI and update the image URI */
         if ( type == LOCATION_URI ) {
 
                 /* Extract URI argument */
                 va_copy ( tmp, args );
                 uri = va_arg ( tmp, struct uri * );
                 va_end ( tmp );
 
                 /* Set image URI */
                 if ( ( rc = image_set_uri ( downloader->image, uri ) ) != 0 )
                         goto err;
         }
 
         /* Redirect to new location */
         if ( ( rc = xfer_vreopen ( &downloader->xfer, type, args ) ) != 0 )
                 goto err;
 
         return 0;
 
  err:
         downloader_finished ( downloader, rc );
         return rc;
 }

References downloader_finished(), downloader::image, image_set_uri(), LOCATION_URI, rc, tmp, type, va_arg, va_copy, va_end, downloader::xfer, and xfer_vreopen().

◆ create_downloader()

int create_downloader	(	struct interface *	job,
		struct image *	image
	)

Instantiate a downloader.

Parameters

job	Job control interface
image	Image to fill with downloaded file

Return values

rc	Return status code

Instantiates a downloader object to download the content of the specified image from its URI.

Definition at line 263 of file downloader.c.

                                                                      {
         struct downloader *downloader;
         int rc;
 
         /* Allocate and initialise structure */
         downloader = zalloc ( sizeof ( *downloader ) );
         if ( ! downloader )
                 return -ENOMEM;
         ref_init ( &downloader->refcnt, downloader_free );
         intf_init ( &downloader->job, &downloader_job_desc,
                     &downloader->refcnt );
         intf_init ( &downloader->xfer, &downloader_xfer_desc,
                     &downloader->refcnt );
         downloader->image = image_get ( image );
         xferbuf_umalloc_init ( &downloader->buffer );
 
         /* Instantiate child objects and attach to our interfaces */
         if ( ( rc = xfer_open_uri ( &downloader->xfer, image->uri ) ) != 0 )
                 goto err;
 
         /* Attach parent interface, mortalise self, and return */
         intf_plug_plug ( &downloader->job, job );
         ref_put ( &downloader->refcnt );
         return 0;
 
  err:
         downloader_finished ( downloader, rc );
         ref_put ( &downloader->refcnt );
         return rc;
 }

References downloader::buffer, downloader_finished(), downloader_free(), downloader_job_desc, downloader_xfer_desc, ENOMEM, downloader::image, image_get(), intf_init(), intf_plug_plug(), downloader::job, rc, ref_init, ref_put, downloader::refcnt, image::uri, downloader::xfer, xfer_open_uri(), xferbuf_umalloc_init(), and zalloc().

Referenced by imgdownload().

Variable Documentation

◆ downloader_xfer_operations

struct interface_operation downloader_xfer_operations[]

static

Initial value:

= {
        INTF_OP ( xfer_deliver, struct downloader *, downloader_deliver ),
        INTF_OP ( xfer_buffer, struct downloader *, downloader_buffer ),
        INTF_OP ( xfer_vredirect, struct downloader *, downloader_vredirect ),
        INTF_OP ( intf_close, struct downloader *, downloader_finished ),
}

Downloader data transfer interface operations.

Definition at line 220 of file downloader.c.

◆ downloader_xfer_desc

struct interface_descriptor downloader_xfer_desc

static

Initial value:

=

INTF_DESC ( struct downloader, xfer, downloader_xfer_operations )

downloader

A downloader.

Definition: downloader.c:47

downloader::xfer

struct interface xfer

Data transfer interface.

Definition: downloader.c:54

INTF_DESC

#define INTF_DESC(object_type, intf, operations)

Define an object interface descriptor.

Definition: interface.h:81

downloader_xfer_operations

static struct interface_operation downloader_xfer_operations[]

Downloader data transfer interface operations.

Definition: downloader.c:220

Downloader data transfer interface descriptor.

Definition at line 228 of file downloader.c.

Referenced by create_downloader().

◆ downloader_job_op

struct interface_operation downloader_job_op[]

static

Initial value:

= {
        INTF_OP ( job_progress, struct downloader *, downloader_progress ),
        INTF_OP ( intf_close, struct downloader *, downloader_finished ),
}