ifmgmt_cmd.c File Reference

Network interface management commands. More...

#include <stdio.h>
#include <errno.h>
#include <getopt.h>
#include <ipxe/netdevice.h>
#include <ipxe/command.h>
#include <ipxe/parseopt.h>
#include <usr/ifmgmt.h>
#include <hci/ifmgmt_cmd.h>

Go to the source code of this file.

Data Structures
struct	ifopen_options
	"ifopen" options More...
struct	ifclose_options
	"ifclose" options More...
struct	ifstat_options
	"ifstat" options More...
struct	ifconf_options
	"ifconf" options More...
struct	iflinkwait_options
	"iflinkwait" option list More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	ifcommon_exec (int argc, char **argv, struct ifcommon_command_descriptor *ifcmd)
	Execute if<xxx> command.
static int	ifopen_payload (struct net_device *netdev, struct ifopen_options *opts __unused)
	"ifopen" payload
static int	ifopen_exec (int argc, char **argv)
	The "ifopen" command.
static int	ifclose_payload (struct net_device *netdev, struct ifclose_options *opts __unused)
	"ifclose" payload
static int	ifclose_exec (int argc, char **argv)
	The "ifclose" command.
static int	ifstat_payload (struct net_device *netdev, struct ifstat_options *opts __unused)
	"ifstat" payload
static int	ifstat_exec (int argc, char **argv)
	The "ifstat" command.
static int	ifconf_payload (struct net_device *netdev, struct ifconf_options *opts)
	"ifconf" payload
int	ifconf_exec (int argc, char **argv)
	The "ifconf" command.
static int	iflinkwait_payload (struct net_device *netdev, struct iflinkwait_options *opts)
	"iflinkwait" payload
static int	iflinkwait_exec (int argc, char **argv)
	The "iflinkwait" command.
	COMMAND (ifopen, ifopen_exec)
	Interface management commands.
	COMMAND (ifclose, ifclose_exec)
	COMMAND (ifstat, ifstat_exec)
	COMMAND (ifconf, ifconf_exec)
	COMMAND (iflinkwait, iflinkwait_exec)

Variables
static struct option_descriptor	ifopen_opts [] = {}
	"ifopen" option list
static struct ifcommon_command_descriptor	ifopen_cmd
	"ifopen" command descriptor
static struct option_descriptor	ifclose_opts [] = {}
	"ifclose" option list
static struct ifcommon_command_descriptor	ifclose_cmd
	"ifclose" command descriptor
static struct option_descriptor	ifstat_opts [] = {}
	"ifstat" option list
static struct ifcommon_command_descriptor	ifstat_cmd
	"ifstat" command descriptor
static struct option_descriptor	ifconf_opts []
	"ifconf" option list
static struct ifcommon_command_descriptor	ifconf_cmd
	"ifconf" command descriptor
static struct option_descriptor	iflinkwait_opts []
	"iflinkwait" option list
static struct ifcommon_command_descriptor	iflinkwait_cmd
	"iflinkwait" command descriptor

Detailed Description

Network interface management commands.

Definition in file ifmgmt_cmd.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

ifcommon_exec()

int ifcommon_exec	(	int	argc,
		char **	argv,
		struct ifcommon_command_descriptor *	ifcmd )

Execute if<xxx> command.

Parameters

argc	Argument count
argv	Argument list
cmd	Command descriptor
payload	Command to execute
verb	Verb describing the action of the command

Return values

rc	Return status code

Definition at line 52 of file ifmgmt_cmd.c.

                                                                {
        struct command_descriptor *cmd = &ifcmd->cmd;
        uint8_t opts[cmd->len];
        struct net_device *netdev;
        int i;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, cmd, opts ) ) != 0 )
                return rc;
 
        if ( optind != argc ) {
                /* Treat arguments as a list of interfaces to try */
                for ( i = optind ; i < argc ; i++ ) {
                        if ( ( rc = parse_netdev ( argv[i], &netdev ) ) != 0 )
                                continue;
                        if ( ( ( rc = ifcmd->payload ( netdev, opts ) ) == 0 )
                             && ifcmd->stop_on_first_success ) {
                                return 0;
                        }
                }
        } else {
                /* Try all interfaces */
                rc = -ENODEV;
                for_each_netdev ( netdev ) {
                        if ( ( ( rc = ifcmd->payload ( netdev, opts ) ) == 0 )
                             && ifcmd->stop_on_first_success ) {
                                return 0;
                        }
                }
        }
 
        return rc;
}

References cmd, ifcommon_command_descriptor::cmd, ENODEV, for_each_netdev, netdev, optind, opts, parse_netdev(), parse_options(), ifcommon_command_descriptor::payload, rc, and ifcommon_command_descriptor::stop_on_first_success.

Referenced by autoboot_exec(), ifclose_exec(), ifconf_exec(), iflinkwait_exec(), ifopen_exec(), ifstat_exec(), iwlist_exec(), iwstat_exec(), and startpxe_exec().

ifopen_payload()

int ifopen_payload ( struct net_device * netdev, struct ifopen_options *opts __unused )

static

"ifopen" payload

Parameters

netdev	Network device
opts	Command options

Return values

rc	Return status code

Definition at line 101 of file ifmgmt_cmd.c.

                                                                   {
        return ifopen ( netdev );
}

References __unused, ifopen(), netdev, and opts.

ifopen_exec()

int ifopen_exec ( int argc, char ** argv )

static

The "ifopen" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 119 of file ifmgmt_cmd.c.

                                                 {
        return ifcommon_exec ( argc, argv, &ifopen_cmd );
}

References ifcommon_exec(), and ifopen_cmd.

Referenced by COMMAND().

ifclose_payload()

int ifclose_payload ( struct net_device * netdev, struct ifclose_options *opts __unused )

static

"ifclose" payload

Parameters

netdev	Network device
opts	Command options

Return values

rc	Return status code

Definition at line 136 of file ifmgmt_cmd.c.

                                                                     {
        ifclose ( netdev );
        return 0;
}

References __unused, ifclose(), netdev, and opts.

ifclose_exec()

int ifclose_exec ( int argc, char ** argv )

static

The "ifclose" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 155 of file ifmgmt_cmd.c.

                                                  {
        return ifcommon_exec ( argc, argv, &ifclose_cmd );
}

References ifclose_cmd, and ifcommon_exec().

Referenced by COMMAND().

ifstat_payload()

int ifstat_payload ( struct net_device * netdev, struct ifstat_options *opts __unused )

static

"ifstat" payload

Parameters

netdev	Network device
opts	Command options

Return values

rc	Return status code

Definition at line 172 of file ifmgmt_cmd.c.

                                                                   {
        ifstat ( netdev );
        return 0;
}

References __unused, ifstat(), netdev, and opts.

ifstat_exec()

int ifstat_exec ( int argc, char ** argv )

static

The "ifstat" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 191 of file ifmgmt_cmd.c.

                                                 {
        return ifcommon_exec ( argc, argv, &ifstat_cmd );
}

References ifcommon_exec(), and ifstat_cmd.

Referenced by COMMAND().

ifconf_payload()

int ifconf_payload ( struct net_device * netdev, struct ifconf_options * opts )

static

"ifconf" payload

Parameters

netdev	Network device
opts	Command options

Return values

rc	Return status code

Definition at line 220 of file ifmgmt_cmd.c.

                                                          {
        int rc;
 
        /* Attempt configuration */
        if ( ( rc = ifconf ( netdev, opts->configurator,
                             opts->timeout ) ) != 0 ) {
 
                /* Close device on failure, to avoid memory exhaustion */
                netdev_close ( netdev );
 
                return rc;
        }
 
        return 0;
}

References ifconf(), netdev, netdev_close(), opts, and rc.

ifconf_exec()

int ifconf_exec	(	int	argc,
		char **	argv )

The "ifconf" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 250 of file ifmgmt_cmd.c.

                                          {
        return ifcommon_exec ( argc, argv, &ifconf_cmd );
}

References ifcommon_exec(), and ifconf_cmd.

Referenced by COMMAND(), and COMMAND().

iflinkwait_payload()

int iflinkwait_payload ( struct net_device * netdev, struct iflinkwait_options * opts )

static

"iflinkwait" payload

Parameters

netdev	Network device
opts	Command options

Return values

rc	Return status code

Definition at line 273 of file ifmgmt_cmd.c.

                                                                  {
        int rc;
 
        /* Wait for link-up */
        if ( ( rc = iflinkwait ( netdev, opts->timeout, 1 ) ) != 0 ) {
 
                /* Close device on failure, to avoid memory exhaustion */
                netdev_close ( netdev );
 
                return rc;
        }
 
        return 0;
}

References iflinkwait(), netdev, netdev_close(), opts, and rc.

iflinkwait_exec()

int iflinkwait_exec ( int argc, char ** argv )

static

The "iflinkwait" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 302 of file ifmgmt_cmd.c.

                                                     {
        return ifcommon_exec ( argc, argv, &iflinkwait_cmd );
}

References ifcommon_exec(), and iflinkwait_cmd.

Referenced by COMMAND().

COMMAND() [1/5]

COMMAND	(	ifopen	,
		ifopen_exec	)

Interface management commands.

References ifopen(), and ifopen_exec().

COMMAND() [2/5]

COMMAND	(	ifclose	,
		ifclose_exec	)

References ifclose(), and ifclose_exec().

COMMAND() [3/5]

COMMAND	(	ifstat	,
		ifstat_exec	)

References ifstat(), and ifstat_exec().

COMMAND() [4/5]

COMMAND	(	ifconf	,
		ifconf_exec	)

References ifconf(), and ifconf_exec().

COMMAND() [5/5]

COMMAND	(	iflinkwait	,
		iflinkwait_exec	)

References iflinkwait(), and iflinkwait_exec().

Variable Documentation

ifopen_opts

struct option_descriptor ifopen_opts[] = {}

static

"ifopen" option list

Definition at line 92 of file ifmgmt_cmd.c.

{};

ifopen_cmd

struct ifcommon_command_descriptor ifopen_cmd

static

Initial value:

=
        IFCOMMON_COMMAND_DESC ( struct ifopen_options, ifopen_opts,
                                0, MAX_ARGUMENTS, "[<interface>...]",
                                ifopen_payload, 0 )

"ifopen" command descriptor

Definition at line 107 of file ifmgmt_cmd.c.

Referenced by ifopen_exec().

ifclose_opts

struct option_descriptor ifclose_opts[] = {}

static

"ifclose" option list

Definition at line 127 of file ifmgmt_cmd.c.

{};

ifclose_cmd

struct ifcommon_command_descriptor ifclose_cmd

static

Initial value:

=
        IFCOMMON_COMMAND_DESC ( struct ifclose_options, ifclose_opts,
                                0, MAX_ARGUMENTS, "[<interface>...]",
                                ifclose_payload, 0 )

"ifclose" command descriptor

Definition at line 143 of file ifmgmt_cmd.c.

Referenced by ifclose_exec().

ifstat_opts

struct option_descriptor ifstat_opts[] = {}

static

"ifstat" option list

Definition at line 163 of file ifmgmt_cmd.c.

{};

ifstat_cmd

struct ifcommon_command_descriptor ifstat_cmd

static

Initial value:

=
        IFCOMMON_COMMAND_DESC ( struct ifstat_options, ifstat_opts,
                                0, MAX_ARGUMENTS, "[<interface>...]",
                                ifstat_payload, 0 )

"ifstat" command descriptor

Definition at line 179 of file ifmgmt_cmd.c.

Referenced by ifstat_exec().

ifconf_opts

struct option_descriptor ifconf_opts[]

static

Initial value:

= {
        OPTION_DESC ( "configurator", 'c', required_argument,
                      struct ifconf_options, configurator,
                      parse_netdev_configurator ),
        OPTION_DESC ( "timeout", 't', required_argument,
                      struct ifconf_options, timeout,
                      parse_timeout ),
}

"ifconf" option list

Definition at line 204 of file ifmgmt_cmd.c.

                                                {
        OPTION_DESC ( "configurator", 'c', required_argument,
                      struct ifconf_options, configurator,
                      parse_netdev_configurator ),
        OPTION_DESC ( "timeout", 't', required_argument,
                      struct ifconf_options, timeout,
                      parse_timeout ),
};

ifconf_cmd

struct ifcommon_command_descriptor ifconf_cmd

static

Initial value:

=
        IFCOMMON_COMMAND_DESC ( struct ifconf_options, ifconf_opts,
                                0, MAX_ARGUMENTS, "[<interface>...]",
                                ifconf_payload, 1 )

"ifconf" command descriptor

Definition at line 238 of file ifmgmt_cmd.c.

Referenced by ifconf_exec().

iflinkwait_opts

struct option_descriptor iflinkwait_opts[]

static

Initial value:

= {
        OPTION_DESC ( "timeout", 't', required_argument,
                      struct iflinkwait_options, timeout, parse_timeout ),
}

"iflinkwait" option list

Definition at line 261 of file ifmgmt_cmd.c.

                                                    {
        OPTION_DESC ( "timeout", 't', required_argument,
                      struct iflinkwait_options, timeout, parse_timeout ),
};

iflinkwait_cmd

struct ifcommon_command_descriptor iflinkwait_cmd

static

Initial value:

=
        IFCOMMON_COMMAND_DESC ( struct iflinkwait_options, iflinkwait_opts,
                                0, MAX_ARGUMENTS, "[<interface>...]",
                                iflinkwait_payload, 1 )

"iflinkwait" command descriptor

Definition at line 290 of file ifmgmt_cmd.c.

Referenced by iflinkwait_exec().