a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/*
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This program is free software; you can redistribute it and/or
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * modify it under the terms of the GNU General Public License as
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * published by the Free Software Foundation; either version 2 of the
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * License, or any later version.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This program is distributed in the hope that it will be useful, but
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * WITHOUT ANY WARRANTY; without even the implied warranty of
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * General Public License for more details.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * You should have received a copy of the GNU General Public License
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * along with this program; if not, write to the Free Software
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncFILE_LICENCE ( GPL2_OR_LATER );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <stdint.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <stdlib.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <stdio.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <errno.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <ipxe/image.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <ipxe/downloader.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <ipxe/monojob.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <ipxe/open.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <ipxe/uri.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#include <usr/imgmgmt.h>
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** @file
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Image management
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Download a new image
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v uri URI
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v image Image to fill in
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncint imgdownload ( struct uri *uri, struct image **image ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync size_t len = ( unparse_uri ( NULL, 0, uri, URI_ALL ) + 1 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync char uri_string_redacted[len];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync const char *password;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync int rc;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Allocate image */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *image = alloc_image ( uri );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ! *image ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync rc = -ENOMEM;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync goto err_alloc_image;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Redact password portion of URI, if necessary */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync password = uri->password;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( password )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync uri->password = "***";
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync unparse_uri ( uri_string_redacted, sizeof ( uri_string_redacted ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync uri, URI_ALL );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync uri->password = password;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Create downloader */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = create_downloader ( &monojob, *image, LOCATION_URI,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync uri ) ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync printf ( "Could not start download: %s\n", strerror ( rc ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync goto err_create_downloader;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Wait for download to complete */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = monojob_wait ( uri_string_redacted ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync goto err_monojob_wait;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Register image */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = register_image ( *image ) ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync printf ( "Could not register image: %s\n", strerror ( rc ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync goto err_register_image;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync }
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Drop local reference to image. Image is guaranteed to
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * remain in scope since it is registered.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync image_put ( *image );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return 0;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync err_register_image:
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync err_monojob_wait:
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync err_create_downloader:
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync image_put ( *image );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync err_alloc_image:
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return rc;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Download a new image
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v uri_string URI string
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v image Image to fill in
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncint imgdownload_string ( const char *uri_string, struct image **image ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct uri *uri;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync int rc;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ! ( uri = parse_uri ( uri_string ) ) )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return -ENOMEM;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync rc = imgdownload ( uri, image );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync uri_put ( uri );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return rc;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Acquire an image
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v name_uri Name or URI string
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v image Image to fill in
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncint imgacquire ( const char *name_uri, struct image **image ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* If we already have an image with the specified name, use it */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *image = find_image ( name_uri );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( *image )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return 0;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Otherwise, download a new image */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return imgdownload_string ( name_uri, image );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Display status of an image
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v image Executable/loadable image
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncvoid imgstat ( struct image *image ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync printf ( "%s : %zd bytes", image->name, image->len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( image->type )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync printf ( " [%s]", image->type->name );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( image->flags & IMAGE_TRUSTED )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync printf ( " [TRUSTED]" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( image->flags & IMAGE_SELECTED )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync printf ( " [SELECTED]" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( image->cmdline )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync printf ( " \"%s\"", image->cmdline );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync printf ( "\n" );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}