Object interfaces. More...

#include <stddef.h>
#include <stdarg.h>
#include <ipxe/refcnt.h>

Data Structures
struct	interface_operation
	An object interface operation. More...
struct	interface_descriptor
	An object interface descriptor. More...
struct	interface
	An object interface. More...

Macros
#define	INTF_OP(op_type, object_type, op_func)
	Define an object interface operation.
#define	UNUSED_INTF_OP(op_type, object_type, op_func)
	Define an unused object interface operation.
#define	intf_offset(object_type, intf)
#define	INTF_DESC(object_type, intf, operations)
	Define an object interface descriptor.
#define	INTF_DESC_PASSTHRU(object_type, intf, operations, passthru)
	Define an object interface descriptor with pass-through interface.
#define	INTF_DESC_PURE(operations)
	Define an object interface descriptor for a pure-interface object.
#define	intf_close_TYPE(object_type)
#define	intf_poke_TYPE(object_type)
#define	INTF_INIT(descriptor)
	Initialise a static object interface.
#define	intf_get_dest_op_no_passthru(intf, type, dest)
	Get object interface destination and operation method (without pass-through)
#define	intf_get_dest_op(intf, type, dest)
	Get object interface destination and operation method.
#define	INTF_COL(intf)
	Find debugging colourisation for an object interface.
#define	INTF_FMT "%p+%zx"
	printf() format string for INTF_DBG()
#define	INTF_DBG(intf)
	printf() arguments for representing an object interface
#define	INTF_INTF_FMT INTF_FMT "->" INTF_FMT
	printf() format string for INTF_INTF_DBG()
#define	INTF_INTF_DBG(intf, dest)
	printf() arguments for representing an object interface pair

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
void	intf_plug (struct interface intf, struct interface dest)
	Plug an object interface into a new destination object interface.
void	intf_plug_plug (struct interface a, struct interface b)
	Plug two object interfaces together.
void	intf_unplug (struct interface *intf)
	Unplug an object interface.
void	intf_nullify (struct interface *intf)
	Ignore all further operations on an object interface.
struct interface *	intf_get (struct interface *intf)
	Increment reference count on an object interface.
void	intf_put (struct interface *intf)
	Decrement reference count on an object interface.
void *	__attribute__ ((pure)) intf_object(struct interface *intf)
void *	intf_get_dest_op_no_passthru_untyped (struct interface intf, void type, struct interface **dest)
	Get object interface destination and operation method (without pass-through)
void *	intf_get_dest_op_untyped (struct interface intf, void type, struct interface **dest)
	Get object interface destination and operation method.
void	intf_close (struct interface *intf, int rc)
	Close an object interface.
void	intf_shutdown (struct interface *intf, int rc)
	Shut down an object interface.
void	intfs_vshutdown (va_list intfs, int rc)
	Shut down multiple object interfaces.
void	intfs_shutdown (int rc,...) __attribute__((sentinel))
	Shut down multiple object interfaces.
void	intf_restart (struct interface *intf, int rc)
	Shut down and restart an object interface.
void	intfs_vrestart (va_list intfs, int rc)
	Shut down and restart multiple object interfaces.
void	intfs_restart (int rc,...) __attribute__((sentinel))
	Shut down and restart multiple object interfaces.
void	intf_insert (struct interface intf, struct interface upper, struct interface *lower)
	Insert a filter interface.
void	intf_poke (struct interface intf, void(type)(struct interface intf))
	Poke an object interface.
static void	intf_init (struct interface intf, struct interface_descriptor desc, struct refcnt *refcnt)
	Initialise an object interface.
static void	intf_temp_init (struct interface intf, struct interface original)
	Initialise a temporary outbound-only object interface.
static struct interface *	intf_origin (struct interface *intf)
	Get original interface.
static void	intf_reinit (struct interface *intf)
	Reinitialise an object interface.

Variables
struct interface_descriptor	null_intf_desc
	Null interface descriptor.
struct interface	null_intf
	The null interface.

Detailed Description

Object interfaces.

Definition in file interface.h.

Macro Definition Documentation

◆ INTF_OP

#define INTF_OP	(	op_type,
		object_type,
		op_func )

Value:

                {                             \
                .type = op_type,                                              \
                .func = ( ( ( ( typeof ( op_func ) * ) NULL ) ==            \
                            ( ( op_type ## _TYPE ( object_type ) * ) NULL ) ) \
                          ? op_func : op_func ),                              \
        }

Define an object interface operation.

Parameters

op_type	Operation type
object_type	Implementing method's expected object type
op_func	Implementing method

Return values

op	Object interface operation

Definition at line 33 of file interface.h.

#define INTF_OP( op_type, object_type, op_func ) {                            \
                .type = op_type,                                              \
                .func = ( ( ( ( typeof ( op_func ) * ) NULL ) ==              \
                            ( ( op_type ## _TYPE ( object_type ) * ) NULL ) ) \
                          ? op_func : op_func ),                              \
        }

◆ UNUSED_INTF_OP

#define UNUSED_INTF_OP	(	op_type,
		object_type,
		op_func )

Value:

                {                     \
                .type = NULL,                                                     \
                .func = ( ( ( ( typeof ( op_func ) * ) NULL ) ==            \
                            ( ( op_type ## _TYPE ( object_type ) * ) NULL ) ) \
                          ? NULL : NULL ),                                    \
        }

Define an unused object interface operation.

Parameters

op_type	Operation type
object_type	Implementing method's expected object type
op_func	Implementing method

Return values

op	Object interface operation

Definition at line 48 of file interface.h.

#define UNUSED_INTF_OP( op_type, object_type, op_func ) {                     \
                .type = NULL,                                                 \
                .func = ( ( ( ( typeof ( op_func ) * ) NULL ) ==              \
                            ( ( op_type ## _TYPE ( object_type ) * ) NULL ) ) \
                          ? NULL : NULL ),                                    \
        }

◆ intf_offset

#define intf_offset	(		object_type,
			intf )

Value:

        ( ( ( ( typeof ( ( ( object_type * ) NULL )->intf ) * ) NULL )          \
            == ( ( struct interface * ) NULL ) )                         \
          ? offsetof ( object_type, intf )                                    \
          : offsetof ( object_type, intf ) )

Definition at line 67 of file interface.h.

#define intf_offset( object_type, intf )                                      \
        ( ( ( ( typeof ( ( ( object_type * ) NULL )->intf ) * ) NULL )        \
            == ( ( struct interface * ) NULL ) )                              \
          ? offsetof ( object_type, intf )                                    \
          : offsetof ( object_type, intf ) )

◆ INTF_DESC

#define INTF_DESC	(	object_type,
		intf,
		operations )

Value:

                {                             \
                .offset = intf_offset ( object_type, intf ),               \
                .op = operations,                                             \
                .num_op = ( sizeof ( operations ) /                           \
                            sizeof ( operations[0] ) ),                       \
                .passthru_offset = 0,                                         \
        }

Define an object interface descriptor.

Parameters

object_type	Containing object data type
intf	Interface name (i.e. field within object data type)
operations	Object interface operations array

Return values

desc	Object interface descriptor

Definition at line 81 of file interface.h.

#define INTF_DESC( object_type, intf, operations ) {                          \
                .offset = intf_offset ( object_type, intf ),                  \
                .op = operations,                                             \
                .num_op = ( sizeof ( operations ) /                           \
                            sizeof ( operations[0] ) ),                       \
                .passthru_offset = 0,                                         \
        }

◆ INTF_DESC_PASSTHRU

#define INTF_DESC_PASSTHRU	(	object_type,
		intf,
		operations,
		passthru )

Value:

                {             \
                .offset = offsetof ( object_type, intf ),                     \
                .op = operations,                                             \
                .num_op = ( sizeof ( operations ) /                           \
                            sizeof ( operations[0] ) ),                       \
                .passthru_offset = ( intf_offset ( object_type, passthru ) -  \
                                     intf_offset ( object_type, intf ) ),     \
        }

Define an object interface descriptor with pass-through interface.

Parameters

object_type	Containing object data type
intf	Interface name (i.e. field within object data type)
operations	Object interface operations array
passthru	Pass-through interface name

Return values

desc	Object interface descriptor

Definition at line 98 of file interface.h.

#define INTF_DESC_PASSTHRU( object_type, intf, operations, passthru ) {       \
                .offset = offsetof ( object_type, intf ),                     \
                .op = operations,                                             \
                .num_op = ( sizeof ( operations ) /                           \
                            sizeof ( operations[0] ) ),                       \
                .passthru_offset = ( intf_offset ( object_type, passthru ) -  \
                                     intf_offset ( object_type, intf ) ),     \
        }

◆ INTF_DESC_PURE

#define INTF_DESC_PURE ( operations )

Value:

                {                                             \
                .offset = 0,                                                  \
                .op = operations,                                             \
                .num_op = ( sizeof ( operations ) /                           \
                            sizeof ( operations[0] ) ),                       \
                .passthru_offset = 0,                                         \
        }

Define an object interface descriptor for a pure-interface object.

Parameters

operations Object interface operations array

Return values

desc	Object interface descriptor

A pure-interface object is an object that consists solely of a single interface.

Definition at line 116 of file interface.h.

#define INTF_DESC_PURE( operations ) {                                        \
                .offset = 0,                                                  \
                .op = operations,                                             \
                .num_op = ( sizeof ( operations ) /                           \
                            sizeof ( operations[0] ) ),                       \
                .passthru_offset = 0,                                         \
        }

◆ intf_close_TYPE

#define intf_close_TYPE ( object_type )

Value:

typeof ( void ( object_type, int rc ) )

rc

struct arbelprm_rc_send_wqe rc

Definition arbel.h:3

Definition at line 177 of file interface.h.

177#define intf_close_TYPE( object_type ) \

178 typeof ( void ( object_type, int rc ) )

Referenced by intf_close().

◆ intf_poke_TYPE

#define intf_poke_TYPE ( object_type )

Value:

typeof ( void ( object_type ) )

Definition at line 191 of file interface.h.

191#define intf_poke_TYPE( object_type ) \

192 typeof ( void ( object_type ) )

Referenced by intf_poke().

◆ INTF_INIT

#define INTF_INIT ( descriptor )

Value:

                {                                       \
                .dest = &null_intf,                                    \
                .refcnt = NULL,                                             \
                .desc = &(descriptor),                                  \
                .original = {                                           \
                        .desc = &(descriptor),                          \
                },                                                      \
        }

Initialise a static object interface.

Parameters

descriptor Object interface descriptor

Definition at line 218 of file interface.h.

#define INTF_INIT( descriptor ) {                                       \
                .dest = &null_intf,                                     \
                .refcnt = NULL,                                         \
                .desc = &(descriptor),                                  \
                .original = {                                           \
                        .desc = &(descriptor),                          \
                },                                                      \
        }

Referenced by ifpoller_wait().

◆ intf_get_dest_op_no_passthru

#define intf_get_dest_op_no_passthru	(	intf,
		type,
		dest )

Value:

( ( type ## _TYPE ( void * ) * ) \

intf_get_dest_op_no_passthru_untyped ( intf, type, dest ) )

dest

if(len >=6 *4) __asm__ __volatile__("movsl" if(len >=5 *4) __asm__ __volatile__("movsl" if(len >=4 *4) __asm__ __volatile__("movsl" if(len >=3 *4) __asm__ __volatile__("movsl" if(len >=2 *4) __asm__ __volatile__("movsl" if(len >=1 *4) __asm__ __volatile__("movsl" if((len % 4) >=2) __asm__ __volatile__("movsw" if((len % 2) >=1) __asm__ __volatile__("movsb" retur dest)

Definition string.h:151

type

uint32_t type

Operating system type.

Definition ena.h:1

intf_get_dest_op_no_passthru_untyped

void * intf_get_dest_op_no_passthru_untyped(struct interface *intf, void *type, struct interface **dest)

Get object interface destination and operation method (without pass-through)

Definition interface.c:188

Get object interface destination and operation method (without pass-through)

Parameters

intf	Object interface
type	Operation type

Return values

dest	Destination interface
func	Implementing method, or NULL

Definition at line 258 of file interface.h.

#define intf_get_dest_op_no_passthru( intf, type, dest )                \
        ( ( type ## _TYPE ( void * ) * )                                \
          intf_get_dest_op_no_passthru_untyped ( intf, type, dest ) )

Referenced by xfer_vredirect().

◆ intf_get_dest_op

#define intf_get_dest_op	(	intf,
		type,
		dest )

Value:

( ( type ## _TYPE ( void * ) * ) \

intf_get_dest_op_untyped ( intf, type, dest ) )

intf_get_dest_op_untyped

void * intf_get_dest_op_untyped(struct interface *intf, void *type, struct interface **dest)

Get object interface destination and operation method.

Definition interface.c:213

Get object interface destination and operation method.

Parameters

intf	Object interface
type	Operation type

Return values

dest	Destination interface
func	Implementing method, or NULL

Definition at line 270 of file interface.h.

#define intf_get_dest_op( intf, type, dest )                            \
        ( ( type ## _TYPE ( void * ) * )                                \
          intf_get_dest_op_untyped ( intf, type, dest ) )

Referenced by acpi_describe(), ata_command(), block_capacity(), block_read(), block_read_capacity(), block_write(), edd_describe(), efi_describe(), identify_device(), intf_close(), job_progress(), peerdisc_stat(), resolv_done(), scsi_command(), scsi_response(), xfer_alloc_iob(), xfer_buffer(), xfer_deliver(), and xfer_window().

◆ INTF_COL

#define INTF_COL ( intf )

Value:

intf_object ( intf_origin ( intf ) )

intf_object

void * intf_object(struct interface *intf)

Get pointer to object containing object interface.

Definition interface.c:160

intf_origin

static struct interface * intf_origin(struct interface *intf)

Get original interface.

Definition interface.h:246

Find debugging colourisation for an object interface.

Parameters

intf	Object interface

Return values

col	Debugging colourisation

Use as the first argument to DBGC() or equivalent macro.

Definition at line 282 of file interface.h.

Referenced by intf_close(), intf_plug(), intf_restart(), intf_shutdown(), intf_unplug(), job_progress(), resolv_done(), xfer_alloc_iob(), xfer_deliver(), xfer_open_socket(), xfer_open_uri(), xfer_open_uri_string(), xfer_seek(), xfer_vopen(), and xfer_vredirect().

◆ INTF_FMT

#define INTF_FMT "%p+%zx"

printf() format string for INTF_DBG()

Definition at line 285 of file interface.h.

Referenced by intf_plug(), intf_restart(), intf_shutdown(), xfer_open_socket(), xfer_open_uri(), xfer_open_uri_string(), xfer_seek(), and xfer_vopen().

◆ INTF_DBG

#define INTF_DBG ( intf )

Value:

intf_object ( intf_origin ( intf ) ), \

intf_origin ( intf )->desc->offset

printf() arguments for representing an object interface

Parameters

intf	Object interface

Return values

args	printf() argument list corresponding to INTF_FMT

Definition at line 293 of file interface.h.

#define INTF_DBG( intf )                                                \
        intf_object ( intf_origin ( intf ) ),                           \
        intf_origin ( intf )->desc->offset

Referenced by intf_plug(), intf_restart(), intf_shutdown(), xfer_open_socket(), xfer_open_uri(), xfer_open_uri_string(), xfer_seek(), and xfer_vopen().

◆ INTF_INTF_FMT

#define INTF_INTF_FMT INTF_FMT "->" INTF_FMT

printf() format string for INTF_INTF_DBG()

Definition at line 298 of file interface.h.

Referenced by intf_close(), intf_plug(), intf_unplug(), job_progress(), resolv_done(), xfer_alloc_iob(), xfer_deliver(), and xfer_vredirect().

◆ INTF_INTF_DBG

#define INTF_INTF_DBG	(		intf,
			dest )

Value:

INTF_DBG ( intf ), INTF_DBG ( dest )

INTF_DBG

#define INTF_DBG(intf)

printf() arguments for representing an object interface

Definition interface.h:293

printf() arguments for representing an object interface pair

Parameters

intf	Object interface
dest	Destination object interface

Return values

args	printf() argument list corresponding to INTF_INTF_FMT

Definition at line 307 of file interface.h.

Referenced by intf_close(), intf_plug(), intf_unplug(), job_progress(), resolv_done(), xfer_alloc_iob(), xfer_deliver(), and xfer_vredirect().

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

◆ intf_plug()

void intf_plug	(	struct interface *	intf,
		struct interface *	dest )

extern

Plug an object interface into a new destination object interface.

Parameters

intf	Object interface
dest	New destination object interface

The reference to the existing destination interface is dropped, a reference to the new destination interface is obtained, and the interface is updated to point to the new destination interface.

Definition at line 84 of file interface.c.

                                                                  {
 
        if ( intf == &null_intf )
                return;
 
        DBGC ( INTF_COL ( intf ),
               "INTF " INTF_INTF_FMT " replug to " INTF_FMT "\n",
               INTF_INTF_DBG ( intf, intf->dest ), INTF_DBG ( dest ) );
 
        intf_get ( dest );
        intf_put ( intf->dest );
        intf->dest = dest;
}

References DBGC, dest, interface::dest, interface::intf, INTF_COL, INTF_DBG, INTF_FMT, intf_get(), INTF_INTF_DBG, INTF_INTF_FMT, intf_put(), and null_intf.

Referenced by intf_plug_plug(), and xfer_vredirect().

◆ intf_plug_plug()

void intf_plug_plug	(	struct interface *	a,
		struct interface *	b )

extern

Plug two object interfaces together.

Parameters

a	Object interface A
b	Object interface B

Plugs interface A into interface B, and interface B into interface A. (The basic plug() function is unidirectional; this function is merely a shorthand for two calls to plug(), hence the name.)

Definition at line 108 of file interface.c.

                                                                 {
        intf_plug ( a, b );
        intf_plug ( b, a );
}

References intf_plug().

Referenced by aoedev_ata_command(), aoedev_cfg_command(), ata_open(), atadev_command(), create_downloader(), create_pinger(), create_validator(), dns_resolv(), efi_local_open(), fc_els_request(), fc_els_respond(), fc_port_open(), fc_xchg_originate(), fcpdev_scsi_command(), ftp_open(), http_connect(), http_open(), http_transfer_complete(), hw_open(), ib_cmrc_open(), ifpoller_wait(), intf_insert(), ipair_create(), iscsi_scsi_command(), nfs_open(), numeric_resolv(), peerblk_open(), peermux_filter(), ping_open(), resolv(), resolv_setting(), scsi_open(), scsidev_command(), slam_open(), srp_open(), srpdev_scsi_command(), start_dhcp(), start_dhcpv6(), start_ipv6conf(), start_ntp(), start_pxebs(), sync(), tcp_open(), tftp_core_open(), udp_open_common(), usbblk_scsi_command(), and xfer_open_named_socket().

◆ intf_unplug()

void intf_unplug ( struct interface * intf )

extern

Unplug an object interface.

Parameters

intf	Object interface

Definition at line 118 of file interface.c.

                                            {
        DBGC ( INTF_COL ( intf ), "INTF " INTF_INTF_FMT " unplug\n",
               INTF_INTF_DBG ( intf, intf->dest ) );
        intf_put ( intf->dest );
        intf->dest = &null_intf;
}

References DBGC, interface::dest, interface::intf, INTF_COL, INTF_INTF_DBG, INTF_INTF_FMT, intf_put(), and null_intf.

Referenced by intf_shutdown(), named_resolv_done(), and xfer_vredirect().

◆ intf_nullify()

void intf_nullify ( struct interface * intf )

extern

Ignore all further operations on an object interface.

Parameters

intf	Object interface

Definition at line 130 of file interface.c.

                                             {
        intf->desc = &null_intf_desc;
}

References interface::desc, interface::intf, and null_intf_desc.

Referenced by intf_shutdown(), intfs_vshutdown(), named_resolv_done(), and peermux_close().

◆ intf_get()

struct interface * intf_get ( struct interface * intf )

extern

Increment reference count on an object interface.

Parameters

intf	Object interface

Return values

intf	Object interface

Definition at line 140 of file interface.c.

                                                       {
        ref_get ( intf->refcnt );
        return intf;
}

References interface::intf, ref_get, and interface::refcnt.

Referenced by intf_get_dest_op_no_passthru_untyped(), intf_insert(), and intf_plug().

◆ intf_put()

void intf_put ( struct interface * intf )

extern

Decrement reference count on an object interface.

Parameters

intf	Object interface

Definition at line 150 of file interface.c.

                                         {
        ref_put ( intf->refcnt );
}

References interface::intf, ref_put, and interface::refcnt.

Referenced by acpi_describe(), ata_command(), block_capacity(), block_read(), block_read_capacity(), block_write(), edd_describe(), efi_describe(), identify_device(), intf_close(), intf_get_dest_op_untyped(), intf_insert(), intf_plug(), intf_poke(), intf_unplug(), job_progress(), peerdisc_stat(), resolv_done(), scsi_command(), scsi_response(), xfer_alloc_iob(), xfer_buffer(), xfer_deliver(), xfer_vredirect(), and xfer_window().

◆ attribute()

void * __attribute__ ( (pure) )

extern

References dest, rc, and type.

◆ intf_get_dest_op_no_passthru_untyped()

void * intf_get_dest_op_no_passthru_untyped	(	struct interface *	intf,
		void *	type,
		struct interface **	dest )

extern

Get object interface destination and operation method (without pass-through)

Parameters

intf	Object interface
type	Operation type

Return values

dest	Destination interface
func	Implementing method, or NULL

Definition at line 188 of file interface.c.

                                                                        {
        struct interface_descriptor *desc;
        struct interface_operation *op;
        unsigned int i;
 
        *dest = intf_get ( intf->dest );
        desc = (*dest)->desc;
        for ( i = desc->num_op, op = desc->op ; i ; i--, op++ ) {
                if ( op->type == type )
                        return op->func;
        }
 
        return NULL;
}

References desc, dest, interface::dest, intf_get(), NULL, op, and type.

Referenced by intf_get_dest_op_untyped().

◆ intf_get_dest_op_untyped()

void * intf_get_dest_op_untyped	(	struct interface *	intf,
		void *	type,
		struct interface **	dest )

extern

Get object interface destination and operation method.

Parameters

intf	Object interface
type	Operation type

Return values

dest	Destination interface
func	Implementing method, or NULL

Definition at line 213 of file interface.c.

                                                            {
        void *func;
 
        while ( 1 ) {
 
                /* Search for an implementing method provided by the
                 * current destination interface.
                 */
                func = intf_get_dest_op_no_passthru_untyped( intf, type, dest );
                if ( func )
                        return func;
 
                /* Pass through to the underlying interface, if applicable */
                if ( ! ( intf = intf_get_passthru ( *dest ) ) )
                        return NULL;
                intf_put ( *dest );
        }
}

References dest, interface_operation::func, intf_get_dest_op_no_passthru_untyped(), intf_get_passthru(), intf_put(), NULL, and type.

Referenced by intf_poke().

◆ intf_close()

void intf_close	(	struct interface *	intf,
		int	rc )

extern

Close an object interface.

Parameters

intf	Object interface
rc	Reason for close

Note that this function merely informs the destination object that the interface is about to be closed; it doesn't actually disconnect the interface. In most cases, you probably want to use intf_shutdown() or intf_restart() instead.

Definition at line 250 of file interface.c.

                                                   {
        struct interface *dest;
        intf_close_TYPE ( void * ) *op =
                intf_get_dest_op ( intf, intf_close, &dest );
        void *object = intf_object ( dest );
 
        DBGC ( INTF_COL ( intf ), "INTF " INTF_INTF_FMT " close (%s)\n",
               INTF_INTF_DBG ( intf, dest ), strerror ( rc ) );
 
        if ( op ) {
                op ( object, rc );
        } else {
                /* Default is to restart the interface */
                intf_restart ( dest, rc );
        }
 
        intf_put ( dest );
}

References DBGC, dest, interface::intf, intf_close(), intf_close_TYPE, INTF_COL, intf_get_dest_op, INTF_INTF_DBG, INTF_INTF_FMT, intf_object(), intf_put(), intf_restart(), op, rc, and strerror().

Referenced by ifconf_progress(), iflinkwait_progress(), intf_close(), intf_shutdown(), netdev_close(), sync_progress(), and xfer_vredirect().

◆ intf_shutdown()

void intf_shutdown	(	struct interface *	intf,
		int	rc )

extern

Shut down an object interface.

Parameters

intf	Object interface
rc	Reason for close

Blocks further operations from being received via the interface, executes a close operation on the destination interface, and unplugs the interface.

Definition at line 279 of file interface.c.

                                                      {
        struct interface tmp;
 
        DBGC ( INTF_COL ( intf ), "INTF " INTF_FMT " shutting down (%s)\n",
               INTF_DBG ( intf ), strerror ( rc ) );
 
        /* Block further operations */
        intf_nullify ( intf );
 
        /* Transfer destination to temporary interface */
        intf_temp_init ( &tmp, intf );
        tmp.dest = intf->dest;
        intf->dest = &null_intf;
 
        /* Notify destination of close via temporary interface */
        intf_close ( &tmp, rc );
 
        /* Unplug temporary interface */
        intf_unplug ( &tmp );
}

References DBGC, interface::dest, interface::intf, intf_close(), INTF_COL, INTF_DBG, INTF_FMT, intf_nullify(), intf_temp_init(), intf_unplug(), null_intf, rc, strerror(), and tmp.

Referenced by aoecmd_close(), aoedev_close(), aoedev_config_done(), atacmd_close(), atadev_close(), blktrans_close(), comboot_resolv_close(), dhcp_finished(), dhcpv6_finished(), dns_done(), downloader_finished(), efi_download_close(), efi_local_close(), fc_els_close(), fc_ns_query_close(), fc_peer_close(), fc_port_close(), fc_ulp_close(), fc_xchg_close(), fcoe_close(), fcpcmd_close(), fcpdev_close(), ftp_done(), http_conn_close(), http_transfer_complete(), hw_finished(), ib_cmrc_close(), ib_srp_close(), imux_shutdown(), intf_restart(), intfs_vshutdown(), ipair_close(), ipv6conf_done(), named_close(), nfs_deliver(), nfs_done(), nfs_pm_deliver(), nslookup_close(), ntp_close(), numeric_step(), peerblk_close(), peermux_close(), peermux_info_close(), ping_close(), pinger_close(), posix_file_finished(), pxe_tftp_close(), resmux_close(), slam_finished(), srpcmd_close(), srpdev_close(), tcp_close(), tftp_done(), tls_close(), udp_close(), validator_finished(), and xcm_destroy().

◆ intfs_vshutdown()

void intfs_vshutdown	(	va_list	intfs,
		int	rc )

extern

Shut down multiple object interfaces.

Parameters

intfs	Object interfaces
rc	Reason for close

Definition at line 306 of file interface.c.

                                               {
        struct interface *intf;
        va_list tmp;
 
        /* Nullify all interfaces to avoid potential loops */
        va_copy ( tmp, intfs );
        while ( ( intf = va_arg ( tmp, struct interface * ) ) )
                intf_nullify ( intf );
        va_end ( tmp );
 
        /* Shut down all interfaces */
        while ( ( intf = va_arg ( intfs, struct interface * ) ) )
                intf_shutdown ( intf, rc );
}

References interface::intf, intf_nullify(), intf_shutdown(), rc, tmp, va_arg, va_copy, and va_end.

Referenced by intfs_shutdown(), and intfs_vrestart().

◆ intfs_shutdown()

void intfs_shutdown	(	int	rc,
			... )

extern

Shut down multiple object interfaces.

Parameters

rc	Reason for close
...	Object interfaces

Definition at line 327 of file interface.c.

                                    {
        va_list intfs;
 
        va_start ( intfs, rc );
        intfs_vshutdown ( intfs, rc );
        va_end ( intfs );
}

References intfs_vshutdown(), rc, va_end, and va_start.

Referenced by http_close(), iscsi_close(), scsicmd_close(), scsidev_close(), and usbblk_remove().

◆ intf_restart()

void intf_restart	(	struct interface *	intf,
		int	rc )

extern

Shut down and restart an object interface.

Parameters

intf	Object interface
rc	Reason for close

Shuts down the interface, then unblocks operations that were blocked during shutdown.

Definition at line 344 of file interface.c.

                                                     {
 
        /* Shut down the interface */
        intf_shutdown ( intf, rc );
 
        DBGC ( INTF_COL ( intf ), "INTF " INTF_FMT " restarting\n",
               INTF_DBG ( intf ) );
 
        /* Restore the interface descriptor.  Must be done after
         * shutdown (rather than inhibiting intf_shutdown() from
         * nullifying the descriptor) in order to avoid a potential
         * infinite loop as the intf_close() operations on each side
         * of the link call each other recursively.
         */
        intf_reinit ( intf );
}

References DBGC, interface::intf, INTF_COL, INTF_DBG, INTF_FMT, intf_reinit(), intf_shutdown(), and rc.

Referenced by apply_syslog_settings(), apply_syslogs_settings(), efi_pxe_tftp_close(), efi_pxe_udp_close(), fc_peer_plogi(), fc_peer_plogi_done(), fc_port_examine(), fc_port_flogi_done(), fc_port_login(), fc_port_ns_plogi_done(), fc_ulp_examine(), fc_ulp_prli_done(), fcoe_reset(), http_block_read(), http_block_read_capacity(), http_conn_close(), http_conn_xfer_close(), http_reopen(), http_transfer_complete(), imux_close(), imux_start_pair(), intf_close(), iscsi_close_connection(), iscsi_command_close(), iscsi_scsi_done(), monojob_close(), netdev_config_close(), netdev_configure(), peerblk_raw_close(), peerblk_raw_open(), peerblk_raw_rx(), peerblk_reset(), peerblk_retrieval_close(), peerblk_retrieval_open(), peerblk_retrieval_rx(), peerdisc_socket_close(), peerdisc_socket_open(), peermux_block_close(), pxenv_udp_close(), pxenv_udp_open(), resmux_child_close(), sandev_command_close(), sanpath_close(), scsicmd_done(), scsidev_ready(), syslogs_close(), tftp_reopen(), tftp_reopen_mc(), tftp_timer_expired(), tls_validator_done(), usbblk_stop(), validator_start_download(), validator_start_ocsp(), validator_xfer_close(), xcm_close(), xcm_reopen(), and xfer_vreopen().

◆ intfs_vrestart()

void intfs_vrestart	(	va_list	intfs,
		int	rc )

extern

Shut down and restart multiple object interfaces.

Parameters

intfs	Object interfaces
rc	Reason for close

Definition at line 367 of file interface.c.

                                              {
        struct interface *intf;
        va_list tmp;
 
        /* Shut down all interfaces */
        va_copy ( tmp, intfs );
        intfs_vshutdown ( tmp, rc );
        va_end ( tmp );
 
        /* Reinitialise all interfaces */
        while ( ( intf = va_arg ( intfs, struct interface * ) ) )
                intf_reinit ( intf );
}

References interface::intf, intf_reinit(), intfs_vshutdown(), rc, tmp, va_arg, va_copy, and va_end.

Referenced by intfs_restart().

◆ intfs_restart()

void intfs_restart	(	int	rc,
			... )

extern

Shut down and restart multiple object interfaces.

Parameters

rc	Reason for close
...	Object interfaces

Definition at line 387 of file interface.c.

                                   {
        va_list intfs;
 
        va_start ( intfs, rc );
        intfs_vrestart ( intfs, rc );
        va_end ( intfs );
}

References intfs_vrestart(), rc, va_end, and va_start.

Referenced by http_transfer_complete(), sanpath_close(), and usbblk_scsi_close().

◆ intf_insert()

void intf_insert	(	struct interface *	intf,
		struct interface *	upper,
		struct interface *	lower )

extern

Insert a filter interface.

Parameters

intf	Object interface
upper	Upper end of filter
lower	Lower end of filter

Definition at line 402 of file interface.c.

                                             {
        struct interface *dest = intf->dest;
 
        intf_get ( dest );
        intf_plug_plug ( intf, upper );
        intf_plug_plug ( lower, dest );
        intf_put ( dest );
}

References dest, interface::dest, interface::intf, intf_get(), intf_plug_plug(), and intf_put().

Referenced by add_tls(), and block_translate().

◆ intf_poke()

void intf_poke	(	struct interface *	intf,
		void(type)(struct interface *intf)	)

extern

Poke an object interface.

Parameters

intf	Object interface
type	Operation type

This is a helper function to implement methods which take no parameters and return nothing.

Definition at line 421 of file interface.c.

                                                            {
        struct interface *dest;
        intf_poke_TYPE ( void * ) *op =
                intf_get_dest_op_untyped ( intf, type, &dest );
        void *object = intf_object ( dest );
 
        if ( op ) {
                op ( object );
        } else {
                /* Default is to do nothing */
        }
 
        intf_put ( dest );
}

References dest, interface::intf, intf_get_dest_op_untyped(), intf_object(), intf_poke_TYPE, intf_put(), op, and type.

Referenced by pool_recycle(), pool_reopen(), and xfer_window_changed().

◆ intf_init()

void intf_init	(	struct interface *	intf,
		struct interface_descriptor *	desc,
		struct refcnt *	refcnt )

inlinestatic

Initialise an object interface.

Parameters

intf	Object interface
desc	Object interface descriptor
refcnt	Containing object reference counter, or NULL

Definition at line 204 of file interface.h.

                                                       {
        intf->dest = &null_intf;
        intf->refcnt = refcnt;
        intf->desc = desc;
        intf->original.desc = desc;
}

References desc, interface::desc, interface::dest, interface::intf, null_intf, interface::original, and interface::refcnt.

Referenced by add_tls(), alloc_netdev(), alloc_sandev(), aoecmd_create(), aoedev_open(), ata_open(), atadev_command(), block_translate(), create_downloader(), create_pinger(), create_validator(), dns_resolv(), efi_download_start(), efi_local_open(), efi_pxe_install(), fc_els_create(), fc_ns_query(), fc_peer_create(), fc_port_open(), fc_ulp_create(), fc_xchg_create(), fcoe_probe(), fcpdev_open(), fcpdev_scsi_command(), ftp_open(), http_connect(), http_open(), hw_open(), ib_cmrc_open(), ib_srp_open(), imux_probe(), ipair_create(), iscsi_open(), nfs_open(), numeric_resolv(), open(), peerblk_open(), peermux_filter(), ping_open(), pxe_tftp_open(), resolv(), resolv_setting(), scsi_open(), scsidev_command(), slam_open(), srp_open(), srpdev_scsi_command(), start_dhcp(), start_dhcpv6(), start_ipv6conf(), start_ntp(), start_pxebs(), tcp_open(), tftp_core_open(), udp_open_common(), usbblk_probe(), xcm_create(), and xfer_open_named_socket().

◆ intf_temp_init()

void intf_temp_init	(	struct interface *	intf,
		struct interface *	original )

inlinestatic

Initialise a temporary outbound-only object interface.

Parameters

intf	Temporary outbound-only object interface
original	Original object interface

Definition at line 233 of file interface.h.

                                                                 {
        intf->dest = &null_intf;
        intf->desc = NULL;
        intf->original.intf = original;
}

References interface::desc, interface::dest, interface::intf, NULL, null_intf, and interface::original.

Referenced by intf_shutdown(), and xfer_vredirect().

◆ intf_origin()

struct interface * intf_origin ( struct interface * intf )

inlinestatic

Get original interface.

Parameters

intf	Object interface (possibly a temporary interface)

Return values

intf	Original object interface

Definition at line 246 of file interface.h.

                                                                        {
        return ( intf->desc ? intf : intf->original.intf );
}

References interface::desc, interface::intf, and interface::original.

◆ intf_reinit()

void intf_reinit ( struct interface * intf )

inlinestatic

Reinitialise an object interface.

Parameters

intf	Object interface

Definition at line 314 of file interface.h.

                                                          {
 
        /* Restore original interface descriptor */
        intf->desc = intf->original.desc;
}

References interface::desc, interface::intf, and interface::original.

Referenced by intf_restart(), and intfs_vrestart().

Variable Documentation

◆ null_intf_desc

struct interface_descriptor null_intf_desc

extern

Null interface descriptor.

Definition at line 62 of file interface.c.

Referenced by intf_nullify(), and numeric_resolv().

◆ null_intf

struct interface null_intf

extern

The null interface.

Definition at line 66 of file interface.c.

Referenced by intf_init(), intf_plug(), intf_shutdown(), intf_temp_init(), and intf_unplug().

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ INTF_OP

◆ UNUSED_INTF_OP

◆ intf_offset

◆ INTF_DESC

◆ INTF_DESC_PASSTHRU

◆ INTF_DESC_PURE

◆ intf_close_TYPE

◆ intf_poke_TYPE

◆ INTF_INIT

◆ intf_get_dest_op_no_passthru

◆ intf_get_dest_op

◆ INTF_COL

◆ INTF_FMT

◆ INTF_DBG

◆ INTF_INTF_FMT

◆ INTF_INTF_DBG

Function Documentation

◆ FILE_LICENCE()

◆ FILE_SECBOOT()

◆ intf_plug()

◆ intf_plug_plug()

◆ intf_unplug()

◆ intf_nullify()

◆ intf_get()

◆ intf_put()

◆ __attribute__()

◆ intf_get_dest_op_no_passthru_untyped()

◆ intf_get_dest_op_untyped()

◆ intf_close()

◆ intf_shutdown()

◆ intfs_vshutdown()

◆ intfs_shutdown()

◆ intf_restart()

◆ intfs_vrestart()

◆ intfs_restart()

◆ intf_insert()

◆ intf_poke()

◆ intf_init()

◆ intf_temp_init()

◆ intf_origin()

◆ intf_reinit()

Variable Documentation

◆ null_intf_desc

◆ null_intf

◆ attribute()