netdev_test.h File Reference

Network device tests. More...

#include <ipxe/device.h>
#include <ipxe/netdevice.h>

Go to the source code of this file.

Data Structures
struct	testnet_setting
	A test network device setting. More...
struct	testnet
	A test network device. More...

Macros
#define	TESTNET(NAME, ...)
	Declare a test network device. More...
#define	testnet_ok(testnet)   testnet_okx ( testnet, __FILE__, __LINE__ )
	Report a network device creation test result. More...
#define	testnet_open_ok(testnet)   testnet_open_okx ( testnet, __FILE__, __LINE__ )
	Report a network device opening test result. More...
#define	testnet_set_ok(testnet, name, value)   testnet_set_okx ( testnet, name, value, __FILE__, __LINE__ )
	Report a network device setting test result. More...
#define	testnet_close_ok(testnet)   testnet_close_okx ( testnet, __FILE__, __LINE__ )
	Report a network device closing test result. More...
#define	testnet_remove_ok(testnet)   testnet_remove_okx ( testnet, __FILE__, __LINE__ )
	Report a network device removal test result. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
void	testnet_okx (struct testnet *testnet, const char *file, unsigned int line)
	Report a network device creation test result. More...
void	testnet_open_okx (struct testnet *testnet, const char *file, unsigned int line)
	Report a network device opening test result. More...
void	testnet_set_okx (struct testnet *testnet, const char *name, const char *value, const char *file, unsigned int line)
	Report a network device setting test result. More...
void	testnet_close_okx (struct testnet *testnet, const char *file, unsigned int line)
	Report a network device closing test result. More...
void	testnet_remove_okx (struct testnet *testnet, const char *file, unsigned int line)
	Report a network device removal test result. More...

Detailed Description

Network device tests.

Definition in file netdev_test.h.

Macro Definition Documentation

TESTNET

#define TESTNET	(		NAME,
			...
	)

Value:

static struct testnet_setting NAME ## _setting[] = {            \
                __VA_ARGS__                                             \
        };                                                              \
        static struct testnet NAME = {                                  \
                .dev = {                                                \
                        .name = #NAME,                                  \
                        .driver_name = "testnet",                       \
                        .siblings =                                     \
                                LIST_HEAD_INIT ( NAME.dev.siblings ),   \
                        .children =                                     \
                                LIST_HEAD_INIT ( NAME.dev.children ),   \
                },                                                      \
                .testset = NAME ## _setting,                            \
                .count = ( sizeof ( NAME ## _setting ) /                \
                           sizeof ( NAME ## _setting[0] ) ),            \
        };

Declare a test network device.

Parameters

NAME	Network device name
...	Initial network device settings

Definition at line 41 of file netdev_test.h.

testnet_ok

#define testnet_ok

(

testnet

)

testnet_okx ( testnet, __FILE__, __LINE__ )

Report a network device creation test result.

Parameters

testnet

Test network device

Definition at line 64 of file netdev_test.h.

testnet_open_ok

#define testnet_open_ok

(

testnet

)

testnet_open_okx ( testnet, __FILE__, __LINE__ )

Report a network device opening test result.

Parameters

testnet

Test network device

Definition at line 73 of file netdev_test.h.

testnet_set_ok

#define testnet_set_ok	(		testnet,
			name,
			value
	)		testnet_set_okx ( testnet, name, value, __FILE__, __LINE__ )

Report a network device setting test result.

Parameters

testnet	Test network device
name	Setting name (relative to network device's settings)
value	Setting value

Definition at line 85 of file netdev_test.h.

testnet_close_ok

#define testnet_close_ok

(

testnet

)

testnet_close_okx ( testnet, __FILE__, __LINE__ )

Report a network device closing test result.

Parameters

testnet

Test network device

Definition at line 96 of file netdev_test.h.

testnet_remove_ok

#define testnet_remove_ok

(

testnet

)

testnet_remove_okx ( testnet, __FILE__, __LINE__ )

Report a network device removal test result.

Parameters

testnet

Test network device

Definition at line 106 of file netdev_test.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

testnet_okx()

void testnet_okx	(	struct testnet *	testnet,
		const char *	file,
		unsigned int	line
	)

Report a network device creation test result.

Parameters

testnet	Test network device
file	Test code file
line	Test code line

Definition at line 104 of file netdev_test.c.

                                       {
        struct testnet_setting *testset;
        unsigned int i;

        /* Allocate device */
        testnet->netdev = alloc_etherdev ( 0 );
        okx ( testnet->netdev != NULL, file, line );
        netdev_init ( testnet->netdev, &testnet_operations );
        testnet->netdev->dev = &testnet->dev;
        snprintf ( testnet->netdev->name, sizeof ( testnet->netdev->name ),
                   "%s", testnet->dev.name );

        /* Register device */
        okx ( register_netdev ( testnet->netdev ) == 0, file, line );

        /* Open device */
        testnet_open_okx ( testnet, file, line );

        /* Apply initial settings */
        for ( i = 0 ; i < testnet->count ; i++ ) {
                testset = &testnet->testset[i];
                testnet_set_okx ( testnet, testset->name, testset->value,
                                  file, line );
        }
}

References alloc_etherdev(), testnet::count, testnet::dev, net_device::dev, testnet_setting::name, device::name, net_device::name, testnet::netdev, netdev_init(), NULL, okx, register_netdev(), snprintf(), testnet_open_okx(), testnet_operations, testnet_set_okx(), testnet::testset, and testnet_setting::value.

testnet_open_okx()

void testnet_open_okx	(	struct testnet *	testnet,
		const char *	file,
		unsigned int	line
	)

Report a network device opening test result.

Parameters

testnet	Test network device
file	Test code file
line	Test code line

Definition at line 138 of file netdev_test.c.

                                            {

        /* Sanity check */
        okx ( testnet->netdev != NULL, file, line );

        /* Open device */
        okx ( netdev_open ( testnet->netdev ) == 0, file, line );
}

References testnet::netdev, netdev_open(), NULL, and okx.

Referenced by testnet_okx().

testnet_set_okx()

void testnet_set_okx	(	struct testnet *	testnet,
		const char *	name,
		const char *	value,
		const char *	file,
		unsigned int	line
	)

Report a network device setting test result.

Parameters

testnet	Test network device
name	Setting name (relative to network device's settings)
value	Setting value
file	Test code file
line	Test code line

Definition at line 157 of file netdev_test.c.

                                           {
        char fullname[ strlen ( testnet->dev.name ) + 1 /* "." or "/" */ +
                       strlen ( name ) + 1 /* NUL */ ];
        struct settings *settings;
        struct setting setting;

        /* Sanity check */
        okx ( testnet->netdev != NULL, file, line );
        settings = netdev_settings ( testnet->netdev );
        okx ( settings != NULL, file, line );
        okx ( strcmp ( settings->name, testnet->dev.name ) == 0, file, line );

        /* Construct setting name */
        snprintf ( fullname, sizeof ( fullname ), "%s%c%s", testnet->dev.name,
                   ( strchr ( name, '/' ) ? '.' : '/' ), name );

        /* Parse setting name */
        okx ( parse_setting_name ( fullname, autovivify_child_settings,
                                   &settings, &setting ) == 0, file, line );

        /* Apply setting */
        okx ( storef_setting ( settings, &setting, value ) == 0, file, line );
}

References autovivify_child_settings(), testnet::dev, device::name, settings::name, name, testnet::netdev, netdev_settings(), NULL, okx, parse_setting_name(), snprintf(), storef_setting(), strchr(), strcmp(), strlen(), and value.

Referenced by testnet_okx().

testnet_close_okx()

void testnet_close_okx	(	struct testnet *	testnet,
		const char *	file,
		unsigned int	line
	)

Report a network device closing test result.

Parameters

testnet	Test network device
file	Test code file
line	Test code line

Definition at line 190 of file netdev_test.c.

                                            {

        /* Sanity check */
        okx ( testnet->netdev != NULL, file, line );

        /* Close device */
        netdev_close ( testnet->netdev );
}

References testnet::netdev, netdev_close(), NULL, and okx.

testnet_remove_okx()

void testnet_remove_okx	(	struct testnet *	testnet,
		const char *	file,
		unsigned int	line
	)

Report a network device removal test result.

Parameters

testnet	Test network device
file	Test code file
line	Test code line

Definition at line 207 of file netdev_test.c.

                                              {

        /* Sanity check */
        okx ( testnet->netdev != NULL, file, line );

        /* Remove device */
        unregister_netdev ( testnet->netdev );
        netdev_nullify ( testnet->netdev );
        netdev_put ( testnet->netdev );
        testnet->netdev = NULL;
}

References testnet::netdev, netdev_nullify(), netdev_put(), NULL, okx, and unregister_netdev().