guestinfo.c File Reference

VMware GuestInfo settings. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <ipxe/init.h>
#include <ipxe/settings.h>
#include <ipxe/netdevice.h>
#include <ipxe/guestrpc.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER)
static int	guestinfo_fetch_type (struct settings *settings, struct setting *setting, const struct setting_type *type, void *data, size_t len, int *found)
	Fetch value of typed GuestInfo setting. More...
static int	guestinfo_fetch (struct settings *settings, struct setting *setting, void *data, size_t len)
	Fetch value of GuestInfo setting. More...
static void	guestinfo_init (void)
	Initialise GuestInfo settings. More...
struct init_fn guestinfo_init_fn	__init_fn (INIT_NORMAL)
	GuestInfo settings initialiser. More...
static int	guestinfo_net_probe (struct net_device *netdev, void *priv)
	Create per-netdevice GuestInfo settings. More...

Variables
static int	guestinfo_channel
	GuestInfo GuestRPC channel. More...
static struct settings_operations	guestinfo_settings_operations
	GuestInfo settings operations. More...
static struct settings	guestinfo_settings
	GuestInfo settings. More...
struct net_driver guestinfo_net_driver	__net_driver
	GuestInfo per-netdevice driver. More...

Detailed Description

VMware GuestInfo settings.

Definition in file guestinfo.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER

)

guestinfo_fetch_type()

static int guestinfo_fetch_type ( struct settings *  settings, struct setting *  setting, const struct setting_type *  type, void *  data, size_t  len, int *  found  )

static

Fetch value of typed GuestInfo setting.

Parameters

settings	Settings block
setting	Setting to fetch
type	Setting type to attempt (or NULL for default)
data	Buffer to fill with setting data
len	Length of buffer

Return values

found	Setting found in GuestInfo
len	Length of setting data, or negative error

Definition at line 52 of file guestinfo.c.

                                                                       {
        const char *parent_name = settings->parent->name;
        char command[ 24 /* "info-get guestinfo.ipxe." */ +
                      strlen ( parent_name ) + 1 /* "." */ +
                      strlen ( setting->name ) + 1 /* "." */ +
                      ( type ? strlen ( type->name ) : 0 ) + 1 /* NUL */ ];
        struct setting *predefined;
        char *info;
        int info_len;
        int check_len;
        int ret;

        /* Construct info-get command */
        snprintf ( command, sizeof ( command ),
                   "info-get guestinfo.ipxe.%s%s%s%s%s",
                   parent_name, ( parent_name[0] ? "." : "" ), setting->name,
                   ( type ? "." : "" ), ( type ? type->name : "" ) );

        /* Check for existence and obtain length of GuestInfo value */
        info_len = guestrpc_command ( guestinfo_channel, command, NULL, 0 );
        if ( info_len < 0 ) {
                ret = info_len;
                goto err_get_info_len;
        }

        /* Mark as found */
        *found = 1;

        /* Determine default type if necessary */
        if ( ! type ) {
                predefined = find_setting ( setting->name );
                type = ( predefined ? predefined->type : &setting_type_string );
        }
        assert ( type != NULL );

        /* Allocate temporary block to hold GuestInfo value */
        info = zalloc ( info_len + 1 /* NUL */ );
        if ( ! info ) {
                DBGC ( settings, "GuestInfo %p could not allocate %d bytes\n",
                       settings, info_len );
                ret = -ENOMEM;
                goto err_alloc;
        }
        info[info_len] = '\0';

        /* Fetch GuestInfo value */
        check_len = guestrpc_command ( guestinfo_channel, command,
                                       info, info_len );
        if ( check_len < 0 ) {
                ret = check_len;
                goto err_get_info;
        }
        if ( check_len != info_len ) {
                DBGC ( settings, "GuestInfo %p length mismatch (expected %d, "
                       "got %d)\n", settings, info_len, check_len );
                ret = -EIO;
                goto err_get_info;
        }
        DBGC2 ( settings, "GuestInfo %p found %s = \"%s\"\n",
                settings, &command[9] /* Skip "info-get " */, info );

        /* Parse GuestInfo value according to type */
        ret = setting_parse ( type, info, data, len );
        if ( ret < 0 ) {
                DBGC ( settings, "GuestInfo %p could not parse \"%s\" as %s: "
                       "%s\n", settings, info, type->name, strerror ( ret ) );
                goto err_parse;
        }

 err_parse:
 err_get_info:
        free ( info );
 err_alloc:
 err_get_info_len:
        return ret;
}

References assert(), data, DBGC, DBGC2, EIO, ENOMEM, find_setting(), free, guestinfo_channel, guestrpc_command(), info, info_len, len, setting::name, settings::name, NULL, settings::parent, setting_parse(), snprintf(), strerror(), strlen(), type, setting::type, and zalloc().

Referenced by guestinfo_fetch().

guestinfo_fetch()

static int guestinfo_fetch ( struct settings *  settings, struct setting *  setting, void *  data, size_t  len  )

static

Fetch value of GuestInfo setting.

Parameters

settings	Settings block
setting	Setting to fetch
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 141 of file guestinfo.c.

                                                      {
        struct setting_type *type;
        int found = 0;
        int ret;

        /* Try default type first */
        ret = guestinfo_fetch_type ( settings, setting, NULL,
                                     data, len, &found );
        if ( found )
                return ret;

        /* Otherwise, try all possible types */
        for_each_table_entry ( type, SETTING_TYPES ) {
                ret = guestinfo_fetch_type ( settings, setting, type,
                                             data, len, &found );
                if ( found )
                        return ret;
        }

        /* Not found */
        return -ENOENT;
}

References data, ENOENT, for_each_table_entry, guestinfo_fetch_type(), len, NULL, SETTING_TYPES, and type.

guestinfo_init()

static void guestinfo_init ( void  )

static

Initialise GuestInfo settings.

Definition at line 180 of file guestinfo.c.

                                    {
        int rc;

        /* Open GuestRPC channel */
        guestinfo_channel = guestrpc_open();
        if ( guestinfo_channel < 0 ) {
                rc = guestinfo_channel;
                DBG ( "GuestInfo could not open channel: %s\n",
                      strerror ( rc ) );
                return;
        }

        /* Register root GuestInfo settings */
        if ( ( rc = register_settings ( &guestinfo_settings, NULL,
                                        "vmware" ) ) != 0 ) {
                DBG ( "GuestInfo could not register settings: %s\n",
                      strerror ( rc ) );
                return;
        }
}

References DBG, guestinfo_channel, guestinfo_settings, guestrpc_open(), NULL, rc, register_settings(), and strerror().

__init_fn()

struct init_fn guestinfo_init_fn __init_fn

(

INIT_NORMAL

)

GuestInfo settings initialiser.

guestinfo_net_probe()

static int guestinfo_net_probe ( struct net_device *  netdev, void *  priv  )

static

Create per-netdevice GuestInfo settings.

Parameters

netdev	Network device
priv	Private data

Return values

rc	Return status code

Definition at line 213 of file guestinfo.c.

                                                                         {
        struct settings *settings = priv;
        int rc;

        /* Do nothing unless we have a GuestInfo channel available */
        if ( guestinfo_channel < 0 )
                return 0;

        /* Initialise and register settings */
        settings_init ( settings, &guestinfo_settings_operations,
                        &netdev->refcnt, NULL );
        if ( ( rc = register_settings ( settings, netdev_settings ( netdev ),
                                        "vmware" ) ) != 0 ) {
                DBGC ( settings, "GuestInfo %p could not register for %s: %s\n",
                       settings, netdev->name, strerror ( rc ) );
                return rc;
        }
        DBGC ( settings, "GuestInfo %p registered for %s\n",
               settings, netdev->name );

        return 0;
}

References DBGC, guestinfo_channel, guestinfo_settings_operations, net_device::name, netdev, netdev_settings(), NULL, priv, rc, net_device::refcnt, register_settings(), settings_init(), and strerror().

Variable Documentation

guestinfo_channel

int guestinfo_channel

static

GuestInfo GuestRPC channel.

Definition at line 39 of file guestinfo.c.

Referenced by guestinfo_fetch_type(), guestinfo_init(), and guestinfo_net_probe().

guestinfo_settings_operations

struct settings_operations guestinfo_settings_operations

static

Initial value:

= {
        .fetch = guestinfo_fetch,
}

GuestInfo settings operations.

Definition at line 167 of file guestinfo.c.

Referenced by guestinfo_net_probe().

guestinfo_settings

struct settings guestinfo_settings

static

Initial value:

= {
        .refcnt = NULL,
        .siblings = LIST_HEAD_INIT ( guestinfo_settings.siblings ),
        .children = LIST_HEAD_INIT ( guestinfo_settings.children ),
        .op = &guestinfo_settings_operations,
}

GuestInfo settings.

Definition at line 172 of file guestinfo.c.

Referenced by guestinfo_init().

__net_driver

struct net_driver guestinfo_net_driver __net_driver

Initial value:

= {
        .name = "GuestInfo",
        .priv_len = sizeof ( struct settings ),
        .probe = guestinfo_net_probe,
}

GuestInfo per-netdevice driver.

Definition at line 237 of file guestinfo.c.