iPXE
Macros | Functions | Variables
stp.c File Reference

Spanning Tree Protocol (STP) More...

#include <errno.h>
#include <byteswap.h>
#include <ipxe/netdevice.h>
#include <ipxe/ethernet.h>
#include <ipxe/iobuf.h>
#include <ipxe/timer.h>
#include <ipxe/stp.h>

Go to the source code of this file.

Macros

#define ENOTSUP_PROTOCOL   __einfo_error ( EINFO_ENOTSUP_PROTOCOL )
 
#define EINFO_ENOTSUP_PROTOCOL
 
#define ENOTSUP_VERSION   __einfo_error ( EINFO_ENOTSUP_VERSION )
 
#define EINFO_ENOTSUP_VERSION
 
#define ENOTSUP_TYPE   __einfo_error ( EINFO_ENOTSUP_TYPE )
 
#define EINFO_ENOTSUP_TYPE
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
static int stp_rx (struct io_buffer *iobuf, struct net_device *netdev, const void *ll_dest __unused, const void *ll_source __unused, unsigned int flags __unused)
 Process incoming STP packets. More...
 
static const char * stp_ntoa (const void *net_addr __unused)
 Transcribe STP address. More...
 

Variables

struct net_protocol stp_protocol __net_protocol
 STP network protocol. More...
 

Detailed Description

Spanning Tree Protocol (STP)

Definition in file stp.c.

Macro Definition Documentation

◆ ENOTSUP_PROTOCOL

#define ENOTSUP_PROTOCOL   __einfo_error ( EINFO_ENOTSUP_PROTOCOL )

Definition at line 41 of file stp.c.

◆ EINFO_ENOTSUP_PROTOCOL

#define EINFO_ENOTSUP_PROTOCOL
Value:
__einfo_uniqify ( EINFO_ENOTSUP, 0x02, \
"Non-STP packet received" )
EINFO_ENOTSUP
#define EINFO_ENOTSUP
Definition: errno.h:590
__einfo_uniqify
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 42 of file stp.c.

◆ ENOTSUP_VERSION

#define ENOTSUP_VERSION   __einfo_error ( EINFO_ENOTSUP_VERSION )

Definition at line 45 of file stp.c.

◆ EINFO_ENOTSUP_VERSION

#define EINFO_ENOTSUP_VERSION
Value:
__einfo_uniqify ( EINFO_ENOTSUP, 0x03, \
"Legacy STP packet received" )
EINFO_ENOTSUP
#define EINFO_ENOTSUP
Definition: errno.h:590
__einfo_uniqify
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 46 of file stp.c.

◆ ENOTSUP_TYPE

#define ENOTSUP_TYPE   __einfo_error ( EINFO_ENOTSUP_TYPE )

Definition at line 49 of file stp.c.

◆ EINFO_ENOTSUP_TYPE

#define EINFO_ENOTSUP_TYPE
Value:
__einfo_uniqify ( EINFO_ENOTSUP, 0x04, \
"Non-RSTP packet received" )
EINFO_ENOTSUP
#define EINFO_ENOTSUP
Definition: errno.h:590
__einfo_uniqify
#define __einfo_uniqify(einfo_base, uniq, desc)
Declare disambiguated error.
Definition: errno.h:180

Definition at line 50 of file stp.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ stp_rx()

static int stp_rx ( struct io_buffer *  iobuf,
struct net_device *  netdev,
const void *ll_dest  __unused,
const void *ll_source  __unused,
unsigned int flags  __unused 
)
static

Process incoming STP packets.

Parameters
iobufI/O buffer
netdevNetwork device
ll_sourceLink-layer source address
flagsPacket flags
Return values
rcReturn status code

Definition at line 63 of file stp.c.

66  {
67  struct stp_bpdu *stp;
68  unsigned int hello;
69  int rc;
70 
71  /* Sanity check */
72  if ( iob_len ( iobuf ) < sizeof ( *stp ) ) {
73  DBGC ( netdev, "STP %s received underlength packet (%zd "
74  "bytes):\n", netdev->name, iob_len ( iobuf ) );
75  DBGC_HDA ( netdev, 0, iobuf->data, iob_len ( iobuf ) );
76  rc = -EINVAL;
77  goto done;
78  }
79  stp = iobuf->data;
80 
81  /* Ignore non-RSTP packets */
82  if ( stp->protocol != htons ( STP_PROTOCOL ) ) {
83  DBGC ( netdev, "STP %s ignoring non-STP packet (protocol "
84  "%#04x)\n", netdev->name, ntohs ( stp->protocol ) );
85  rc = -ENOTSUP_PROTOCOL;
86  goto done;
87  }
88  if ( stp->version < STP_VERSION_RSTP ) {
89  DBGC ( netdev, "STP %s received legacy STP packet (version "
90  "%#02x)\n", netdev->name, stp->version );
91  rc = -ENOTSUP_VERSION;
92  goto done;
93  }
94  if ( stp->type != STP_TYPE_RSTP ) {
95  DBGC ( netdev, "STP %s received non-RSTP packet (type %#02x)\n",
96  netdev->name, stp->type );
97  rc = -ENOTSUP_TYPE;
98  goto done;
99  }
100 
101  /* Dump information */
102  DBGC2 ( netdev, "STP %s %s port %#04x flags %#02x hello %d delay %d\n",
103  netdev->name, eth_ntoa ( stp->sender.mac ), ntohs ( stp->port ),
104  stp->flags, ntohs ( stp->hello ), ntohs ( stp->delay ) );
105 
106  /* Check if port is forwarding */
107  if ( ! ( stp->flags & STP_FL_FORWARDING ) ) {
108  /* Port is not forwarding: block link for two hello times */
109  DBGC ( netdev, "STP %s %s port %#04x flags %#02x is not "
110  "forwarding\n",
111  netdev->name, eth_ntoa ( stp->sender.mac ),
112  ntohs ( stp->port ), stp->flags );
113  hello = ( ntohs ( stp->hello ) * ( TICKS_PER_SEC / 256 ) );
114  netdev_link_block ( netdev, ( hello * 2 ) );
115  rc = -ENETUNREACH;
116  goto done;
117  }
118 
119  /* Success */
120  if ( netdev_link_blocked ( netdev ) ) {
121  DBGC ( netdev, "STP %s %s port %#04x flags %#02x is "
122  "forwarding\n",
123  netdev->name, eth_ntoa ( stp->sender.mac ),
124  ntohs ( stp->port ), stp->flags );
125  }
126  netdev_link_unblock ( netdev );
127  rc = 0;
128 
129  done:
130  free_iob ( iobuf );
131  return rc;
132 }
EINVAL
#define EINVAL
Invalid argument.
Definition: errno.h:428
rc
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
TICKS_PER_SEC
#define TICKS_PER_SEC
Number of ticks per second.
Definition: timer.h:15
ENOTSUP_TYPE
#define ENOTSUP_TYPE
Definition: stp.c:49
stp_bpdu::protocol
uint16_t protocol
Protocol ID.
Definition: stp.h:39
stp_bpdu
A Spanning Tree bridge protocol data unit.
Definition: stp.h:31
stp_bpdu::version
uint8_t version
Protocol version.
Definition: stp.h:41
free_iob
void free_iob(struct io_buffer *iobuf)
Free I/O buffer.
Definition: iobuf.c:146
stp_bpdu::sender
struct stp_switch sender
Sender switch.
Definition: stp.h:51
DBGC
#define DBGC(...)
Definition: compiler.h:505
ntohs
#define ntohs(value)
Definition: byteswap.h:136
netdev_link_blocked
static int netdev_link_blocked(struct net_device *netdev)
Check link block state of network device.
Definition: netdevice.h:647
ENOTSUP_VERSION
#define ENOTSUP_VERSION
Definition: stp.c:45
stp_bpdu::flags
uint8_t flags
Flags.
Definition: stp.h:45
netdev_link_block
void netdev_link_block(struct net_device *netdev, unsigned long timeout)
Mark network device link as being blocked.
Definition: netdevice.c:247
DBGC_HDA
#define DBGC_HDA(...)
Definition: compiler.h:506
netdev_link_unblock
void netdev_link_unblock(struct net_device *netdev)
Mark network device link as being unblocked.
Definition: netdevice.c:262
STP_TYPE_RSTP
#define STP_TYPE_RSTP
Rapid Spanning Tree bridge PDU type.
Definition: stp.h:71
netdev
static struct net_device * netdev
Definition: gdbudp.c:52
stp_bpdu::delay
uint16_t delay
Forward delay.
Definition: stp.h:61
iob_len
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:155
eth_ntoa
const char * eth_ntoa(const void *ll_addr)
Transcribe Ethernet address.
Definition: ethernet.c:175
hello
uint16_t hello
Hello time.
Definition: stp.h:38
stp_bpdu::type
uint8_t type
Message type.
Definition: stp.h:43
stp_bpdu::port
uint16_t port
Port.
Definition: stp.h:53
stp_switch::mac
uint8_t mac[ETH_ALEN]
MAC address.
Definition: stp.h:27
STP_FL_FORWARDING
#define STP_FL_FORWARDING
Port is forwarding.
Definition: stp.h:74
STP_PROTOCOL
#define STP_PROTOCOL
Spanning Tree protocol ID.
Definition: stp.h:65
ENOTSUP_PROTOCOL
#define ENOTSUP_PROTOCOL
Definition: stp.c:41
net_device::name
char name[NETDEV_NAME_LEN]
Name of this network device.
Definition: netdevice.h:362
DBGC2
#define DBGC2(...)
Definition: compiler.h:522
io_buffer::data
void * data
Start of data.
Definition: iobuf.h:48
STP_VERSION_RSTP
#define STP_VERSION_RSTP
Rapid Spanning Tree protocol version.
Definition: stp.h:68
stp_bpdu::hello
uint16_t hello
Hello time.
Definition: stp.h:59
ENETUNREACH
#define ENETUNREACH
Network unreachable.
Definition: errno.h:488
htons
#define htons(value)
Definition: byteswap.h:135
done
struct bofm_section_header done
Definition: bofm_test.c:46

References io_buffer::data, DBGC, DBGC2, DBGC_HDA, stp_bpdu::delay, done, EINVAL, ENETUNREACH, ENOTSUP_PROTOCOL, ENOTSUP_TYPE, ENOTSUP_VERSION, eth_ntoa(), stp_bpdu::flags, free_iob(), hello, stp_bpdu::hello, htons, iob_len(), stp_switch::mac, net_device::name, netdev, netdev_link_block(), netdev_link_blocked(), netdev_link_unblock(), ntohs, stp_bpdu::port, stp_bpdu::protocol, rc, stp_bpdu::sender, STP_FL_FORWARDING, STP_PROTOCOL, STP_TYPE_RSTP, STP_VERSION_RSTP, TICKS_PER_SEC, stp_bpdu::type, and stp_bpdu::version.

◆ stp_ntoa()

static const char* stp_ntoa ( const void *net_addr  __unused)
static

Transcribe STP address.

Parameters
net_addrSTP address
Return values
string"<STP>"

This operation is meaningless for the STP protocol.

Definition at line 142 of file stp.c.

142  {
143  return "<STP>";
144 }

Variable Documentation

◆ __net_protocol

struct net_protocol stp_protocol __net_protocol
Initial value:
= {
.name = "STP",
.net_proto = htons ( ETH_P_STP ),
.rx = stp_rx,
.ntoa = stp_ntoa,
}
stp_ntoa
static const char * stp_ntoa(const void *net_addr __unused)
Transcribe STP address.
Definition: stp.c:142
stp_rx
static int stp_rx(struct io_buffer *iobuf, struct net_device *netdev, const void *ll_dest __unused, const void *ll_source __unused, unsigned int flags __unused)
Process incoming STP packets.
Definition: stp.c:63
ETH_P_STP
#define ETH_P_STP
"Protocol" value for STP
Definition: stp.h:20
htons
#define htons(value)
Definition: byteswap.h:135

STP network protocol.

AoE protocol.

Definition at line 147 of file stp.c.

Generated by   doxygen 1.8.15