ifmgmt.c File Reference

Network interface management. More...

#include <string.h>
#include <stdio.h>
#include <unistd.h>
#include <errno.h>
#include <ipxe/console.h>
#include <ipxe/netdevice.h>
#include <ipxe/device.h>
#include <ipxe/job.h>
#include <ipxe/monojob.h>
#include <ipxe/timer.h>
#include <ipxe/errortab.h>
#include <usr/ifmgmt.h>

Go to the source code of this file.

Data Structures
struct	ifpoller
	Network device poller. More...

Macros
#define	LINK_WAIT_TIMEOUT   ( 15 * TICKS_PER_SEC )
	Default time to wait for link-up. More...
#define	EADDRNOTAVAIL_CONFIG   __einfo_error ( EINFO_EADDRNOTAVAIL_CONFIG )
	Default unsuccessful configuration status code. More...
#define	EINFO_EADDRNOTAVAIL_CONFIG

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	ifopen (struct net_device *netdev)
	Open network device. More...
void	ifclose (struct net_device *netdev)
	Close network device. More...
static void	ifstat_errors (struct net_device_stats *stats, const char *prefix)
	Print network device error breakdown. More...
void	ifstat (struct net_device *netdev)
	Print status of network device. More...
static int	ifpoller_progress (struct ifpoller *ifpoller, struct job_progress *progress __unused)
	Report network device poller progress. More...
static int	ifpoller_wait (struct net_device *netdev, struct net_device_configurator *configurator, unsigned long timeout, int(*progress)(struct ifpoller *ifpoller))
	Poll network device until completion. More...
static int	iflinkwait_progress (struct ifpoller *ifpoller)
	Check link-up progress. More...
int	iflinkwait (struct net_device *netdev, unsigned long timeout, int verbose)
	Wait for link-up, with status indication. More...
static int	ifconf_progress (struct ifpoller *ifpoller)
	Check configuration progress. More...
int	ifconf (struct net_device *netdev, struct net_device_configurator *configurator, unsigned long timeout)
	Perform network device configuration. More...

Variables
struct errortab ifmgmt_errors []	__errortab
	Human-readable error message. More...
static struct interface_operation	ifpoller_job_op []
	Network device poller operations. More...
static struct interface_descriptor	ifpoller_job_desc
	Network device poller descriptor. More...

Detailed Description

Network interface management.

Definition in file ifmgmt.c.

Macro Definition Documentation

LINK_WAIT_TIMEOUT

#define LINK_WAIT_TIMEOUT   ( 15 * TICKS_PER_SEC )

Default time to wait for link-up.

Definition at line 47 of file ifmgmt.c.

EADDRNOTAVAIL_CONFIG

#define EADDRNOTAVAIL_CONFIG   __einfo_error ( EINFO_EADDRNOTAVAIL_CONFIG )

Default unsuccessful configuration status code.

Definition at line 50 of file ifmgmt.c.

EINFO_EADDRNOTAVAIL_CONFIG

#define EINFO_EADDRNOTAVAIL_CONFIG

Value:

__einfo_uniqify ( EINFO_EADDRNOTAVAIL, 0x01,                    \
                          "No configuration methods succeeded" )

Definition at line 51 of file ifmgmt.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

ifopen()

int ifopen

(

struct net_device *

netdev

)

Open network device.

Parameters

netdev

Network device

Return values

rc	Return status code

Definition at line 66 of file ifmgmt.c.

                                         {
        int rc;

        if ( ( rc = netdev_open ( netdev ) ) != 0 ) {
                printf ( "Could not open %s: %s\n",
                         netdev->name, strerror ( rc ) );
                return rc;
        }

        return 0;
}

References net_device::name, netdev, netdev_open(), printf(), rc, and strerror().

Referenced by iflinkwait(), ifopen_payload(), loopback_test(), and netboot().

ifclose()

void ifclose

(

struct net_device *

netdev

)

Close network device.

Parameters

netdev

Network device

Definition at line 83 of file ifmgmt.c.

                                           {
        netdev_close ( netdev );
}

References netdev, and netdev_close().

Referenced by close_other_netdevs(), and ifclose_payload().

ifstat_errors()

static void ifstat_errors ( struct net_device_stats *  stats, const char *  prefix  )

static

Print network device error breakdown.

Parameters

stats	Network device statistics
prefix	Message prefix

Definition at line 93 of file ifmgmt.c.

                                                 {
        unsigned int i;

        for ( i = 0 ; i < ( sizeof ( stats->errors ) /
                            sizeof ( stats->errors[0] ) ) ; i++ ) {
                if ( stats->errors[i].count )
                        printf ( "  [%s: %d x \"%s\"]\n", prefix,
                                 stats->errors[i].count,
                                 strerror ( stats->errors[i].rc ) );
        }
}

References net_device_error::count, net_device_stats::errors, prefix, printf(), net_device_error::rc, and strerror().

Referenced by ifstat().

ifstat()

void ifstat

(

struct net_device *

netdev

)

Print status of network device.

Parameters

netdev

Network device

Definition at line 111 of file ifmgmt.c.

                                          {
        printf ( "%s: %s using %s on %s (%s) [%s]\n"
                 "  [Link:%s%s, TX:%d TXE:%d RX:%d RXE:%d]\n",
                 netdev->name, netdev_addr ( netdev ),
                 netdev->dev->driver_name, netdev->dev->name,
                 netdev->ll_protocol->name,
                 ( netdev_is_open ( netdev ) ? "open" : "closed" ),
                 ( netdev_link_ok ( netdev ) ? "up" : "down" ),
                 ( netdev_link_blocked ( netdev ) ? " (blocked)" : "" ),
                 netdev->tx_stats.good, netdev->tx_stats.bad,
                 netdev->rx_stats.good, netdev->rx_stats.bad );
        if ( ! netdev_link_ok ( netdev ) ) {
                printf ( "  [Link status: %s]\n",
                         strerror ( netdev->link_rc ) );
        }
        ifstat_errors ( &netdev->tx_stats, "TXE" );
        ifstat_errors ( &netdev->rx_stats, "RXE" );
}

References net_device_stats::bad, net_device::dev, device::driver_name, net_device_stats::good, ifstat_errors(), net_device::link_rc, net_device::ll_protocol, device::name, ll_protocol::name, net_device::name, netdev, netdev_addr(), netdev_is_open(), netdev_link_blocked(), netdev_link_ok(), printf(), net_device::rx_stats, strerror(), and net_device::tx_stats.

Referenced by ifstat_payload(), iwstat(), loopback_test(), and netboot().

ifpoller_progress()

static int ifpoller_progress ( struct ifpoller *  ifpoller, struct job_progress *progress  __unused  )

static

Report network device poller progress.

Parameters

ifpoller	Network device poller
progress	Progress report to fill in

Return values

ongoing_rc

Ongoing job status code (if known)

Definition at line 154 of file ifmgmt.c.

                                                                        {

        /* Hand off to current progress checker */
        return ifpoller->progress ( ifpoller );
}

References ifpoller::progress.

ifpoller_wait()

static int ifpoller_wait ( struct net_device *  netdev, struct net_device_configurator *  configurator, unsigned long  timeout, int(*)(struct ifpoller *ifpoller)  progress  )

static

Poll network device until completion.

Parameters

netdev	Network device
configurator	Network device configurator (if applicable)
timeout	Timeout period, in ticks
progress	Method to check progress

Return values

rc	Return status code

Definition at line 179 of file ifmgmt.c.

                                                                              {
        static struct ifpoller ifpoller = {
                .job = INTF_INIT ( ifpoller_job_desc ),
        };

        ifpoller.netdev = netdev;
        ifpoller.configurator = configurator;
        ifpoller.progress = progress;
        intf_plug_plug ( &monojob, &ifpoller.job );
        return monojob_wait ( "", timeout );
}

References ifpoller::configurator, ifpoller_job_desc, INTF_INIT, intf_plug_plug(), ifpoller::job, monojob, monojob_wait(), netdev, ifpoller::netdev, ifpoller::progress, and timeout().

Referenced by ifconf(), and iflinkwait().

iflinkwait_progress()

static int iflinkwait_progress ( struct ifpoller *  ifpoller )

static

Check link-up progress.

Parameters

ifpoller

Network device poller

Return values

ongoing_rc

Ongoing job status code (if known)

Definition at line 200 of file ifmgmt.c.

                                                             {
        struct net_device *netdev = ifpoller->netdev;
        int ongoing_rc = netdev->link_rc;

        /* Terminate successfully if link is up */
        if ( ongoing_rc == 0 )
                intf_close ( &ifpoller->job, 0 );

        /* Otherwise, report link status as ongoing job status */
        return ongoing_rc;
}

References intf_close(), ifpoller::job, net_device::link_rc, netdev, and ifpoller::netdev.

Referenced by iflinkwait().

iflinkwait()

int iflinkwait	(	struct net_device *	netdev,
		unsigned long	timeout,
		int	verbose
	)

Wait for link-up, with status indication.

Parameters

netdev	Network device
timeout	Timeout period, in ticks
verbose	Always display progress message

Return values

rc	Return status code

Definition at line 220 of file ifmgmt.c.

                               {
        int rc;

        /* Ensure device is open */
        if ( ( rc = ifopen ( netdev ) ) != 0 )
                return rc;

        /* Return immediately if link is already up, unless being verbose */
        netdev_poll ( netdev );
        if ( netdev_link_ok ( netdev ) && ( ! verbose ) )
                return 0;

        /* Wait for link-up */
        printf ( "Waiting for link-up on %s", netdev->name );
        return ifpoller_wait ( netdev, NULL, timeout, iflinkwait_progress );
}

References iflinkwait_progress(), ifopen(), ifpoller_wait(), net_device::name, netdev, netdev_link_ok(), netdev_poll(), NULL, printf(), rc, and timeout().

Referenced by ifconf(), iflinkwait_payload(), and loopback_test().

ifconf_progress()

static int ifconf_progress ( struct ifpoller *  ifpoller )

static

Check configuration progress.

Parameters

ifpoller

Network device poller

Return values

ongoing_rc

Ongoing job status code (if known)

Definition at line 244 of file ifmgmt.c.

                                                         {
        struct net_device *netdev = ifpoller->netdev;
        struct net_device_configurator *configurator = ifpoller->configurator;
        struct net_device_configuration *config;
        int rc;

        /* Do nothing unless configuration has completed */
        if ( netdev_configuration_in_progress ( netdev ) )
                return 0;

        /* Terminate with appropriate overall return status code */
        if ( configurator ) {
                config = netdev_configuration ( netdev, configurator );
                rc = config->rc;
        } else {
                rc = ( netdev_configuration_ok ( netdev ) ?
                       0 : -EADDRNOTAVAIL_CONFIG );
        }
        intf_close ( &ifpoller->job, rc );

        return rc;
}

References ifpoller::configurator, net_device_configuration::configurator, EADDRNOTAVAIL_CONFIG, intf_close(), ifpoller::job, netdev, ifpoller::netdev, netdev_configuration(), netdev_configuration_in_progress(), netdev_configuration_ok(), net_device_configuration::rc, and rc.

Referenced by ifconf().

ifconf()

int ifconf	(	struct net_device *	netdev,
		struct net_device_configurator *	configurator,
		unsigned long	timeout
	)

Perform network device configuration.

Parameters

netdev	Network device
configurator	Network device configurator, or NULL to use all
timeout	Timeout period, in ticks

Return values

rc	Return status code

Definition at line 275 of file ifmgmt.c.

                                     {
        int rc;

        /* Ensure device is open and link is up */
        if ( ( rc = iflinkwait ( netdev, LINK_WAIT_TIMEOUT, 0 ) ) != 0 )
                return rc;

        /* Start configuration */
        if ( configurator ) {
                if ( ( rc = netdev_configure ( netdev, configurator ) ) != 0 ) {
                        printf ( "Could not configure %s via %s: %s\n",
                                 netdev->name, configurator->name,
                                 strerror ( rc ) );
                        return rc;
                }
        } else {
                if ( ( rc = netdev_configure_all ( netdev ) ) != 0 ) {
                        printf ( "Could not configure %s: %s\n",
                                 netdev->name, strerror ( rc ) );
                        return rc;
                }
        }

        /* Wait for configuration to complete */
        printf ( "Configuring %s%s%s(%s %s)",
                 ( configurator ? "[" : "" ),
                 ( configurator ? configurator->name : "" ),
                 ( configurator ? "] " : "" ),
                 netdev->name, netdev->ll_protocol->ntoa ( netdev->ll_addr ) );
        return ifpoller_wait ( netdev, configurator, timeout, ifconf_progress );
}

References net_device_configuration::configurator, ifconf_progress(), iflinkwait(), ifpoller_wait(), LINK_WAIT_TIMEOUT, net_device::ll_addr, net_device::ll_protocol, net_device_configurator::name, net_device::name, netdev, netdev_configure(), netdev_configure_all(), ll_protocol::ntoa, printf(), rc, strerror(), and timeout().

Referenced by ifconf_payload(), and netboot().

Variable Documentation

__errortab

struct errortab ifmgmt_errors [] __errortab

Initial value:

= {
        __einfo_errortab ( EINFO_EADDRNOTAVAIL_CONFIG ),
}

Human-readable error message.

Definition at line 56 of file ifmgmt.c.

ifpoller_job_op

struct interface_operation ifpoller_job_op[]

static

Initial value:

= {
        INTF_OP ( job_progress, struct ifpoller *, ifpoller_progress ),
}

Network device poller operations.

Definition at line 162 of file ifmgmt.c.

ifpoller_job_desc

struct interface_descriptor ifpoller_job_desc

static

Initial value:

=
        INTF_DESC ( struct ifpoller, job, ifpoller_job_op )

Network device poller descriptor.

Definition at line 167 of file ifmgmt.c.

Referenced by ifpoller_wait().