T11 SM-HBA-2 FIP statistics T11/12-377v2

and additional FIP data Prepared 21 November 2012

FIP statistics and additional FIP data

Heather Lanigan

Heather.Lanigan@NetApp.com

Version 2: Correction for 12-377v1.pdf uploaded as 1 page instead of 12.

Version 1: Updates from October 1 Meeting including:
Moving FLOGI/FLOGO counts from FIPStatistics to FCPhyStatistics.
Section 2.2 updated to reference 12-226v3.

1 Overview

Approached as described in T11/10-510, many changes and additions are needed to extend SM-HBA-2 in
its current state to include the current FC virtualization architecture and FCoE. The impacts are in two
areas: data structures and function calls.

This proposal will attempt to specify changes to T11/12-297v1 and T11/12-226v3 to incorporate FIP statis-
tics and additional FIP data. Some changes to subclause numbering are also included for a more consis-
tent document structure.

2 Instructions to editor

2.1 Conventions

This proposal references T11/12-297v1 and T11/12-226v3 for numbers of clauses, subclauses, tables,
figures, etc. Deletions are indicated by red strikeout text. Additions are indicated by blue text. Because it is
tedious both to do and undo, the marking of text within additions and deletions of whole tables will be
foregone, and only the table title will be marked for these cases.
T11/v12-297v1 functions are listed with a comment explaining the reason for their proposed disposition.
Their dispositions are one of:

a) keep, listed in black text, indicates the function appears to be useful with no change in
parameterization needed;
b) replace, listed in red strikeout text, indicates the function appears to be useful but with
change(s) in parameterization needed; or
c) discard, listed in red strikeout text, indicates the function appears to no longer be relevant.

Functions not present in T11/12-297v1 are listed with a comment indicating their proposed parameteriza-
tion. Their dispositions are one of:

a) revised, listed in blue text, indicates the function is a revision of an older function with neces-
sary parameterization changes; or
b) new, listed in blue text, indicates the function meets needs unique to the new architecture,
and had no closely related older function.

1
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

2.2 Detailed changes to T11/12-297v1 - Function set changes for virtualization and
FCoE

...

Statistics functions

SMHBA2_GetPortStatistics revised Given a port handle, returns port sta-

tistics

(SMHBA_GetPortStatistics was acci-

dentally lost in the great purge of
FCHBA functions)

SMHBA2_GetProtocolStatistics revised Given a port handle and FC-4 type,

returns protocol statistics

SMHBA2_GetPhyStatistics revised Given a Phy handle, returns Phy sta-

tistics

SMHBA2_GetFIPStatistics new Given an FCoE ENode Controller

Handle, returns FIP statistics.

...

2
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

2.3 Detailed changes to T11/12-226v2 - SM-HBA-2 Data structure enhancements

6 Attributes and Data Structures

6.1 Basic Attributes Types

...
6.7.3.3 ENode FCoE Controller Attributes Data Declarations

...
Any data object of type SMHBA2_DiscoveredFCFMACAddr shall have the format defined in this structure:
typedef struct SMHBA2_DiscoveredFCFMACAddr {
SMHBA2_MACADDR FCFMACAddr;
HBA_UINT8 MaxFCoESizeVerifiedBit;
HBA_UINT8 AvailableForLoginBit;
} SMHBA2_DISCOVEREDFCFMACADDR, *PSMHBA2_DISCOVEREDFCFMACADDR;
Any data object of type SMHBA2_DiscoveredFCFMACAddrList shall have the format defined in this
structure:
typedef struct SMHBA2_DiscoveredFCFMACAddrList {
HBA_UINT32 NumberOfEntries;
HBA_HANDLE DiscoveredFCFMACAddr[1];
} SMHBA2_DISCOVEREDFCFMACADDRLIST, *PSMHBA2_DISCOVEREDFCFMACADDRLIST;/* A list of
Discovered FCF-MAC Addresses */
A data object of type SMHBA2_FCOE_CTLR shall only be associated with an N_Port Controller that has
NPCType (see 6.7.1.2) set to SMHBA2_NPCTYPE_FCOE.
Any data object of type SMHBA2_FCOE_CTLR shall have the format defined in this structure:
typedef struct SMHBA2_FCOE_CTLR {
SMHBA2_FCOECTLROPTIONS FCoEOptions;
SMHBA2_MACADDR ENodeMAC;
HBA_UINT32 FCoECtlrVLTag;
SMHBA2_DISCOVEREDFCFMACADDRLIST *DiscoveredFCFMACAddrList;
} SMHBA2_FCOE_CTLR, *PSMHBA2_FCOE_CTLR;

6.7.3.4 ENode FCoE Controller Attributes Specifications

6.7.3.4.1 FCoEOptions

...

6.7.3.4.2 ENodeMAC

ENodeMAC shall be the MAC address of the ENode MAC address associated with this FCoE Controller.

6.7.3.4.3 FCoECtlrVLTag

FCoECtlrVLTag shall be the VLAN tag value that this FCoE Controller.

3
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

6.7.3.4.d FCFMACAddr

FCFMACAddr shall be the value of one FCF-MAC in the list of FCF-MACs created by the FCoE Controller
of an ENode MAC during ENode/FCF Discovery (see FC-BB-6).

6.7.3.4.e MaxFCoESizeVerifiedBit

MaxFCoESizeVerifiedBit shall be the value of the Max FCoE Size Verified bit for FCFMACAddr (see
FC-BB-6).

6.7.3.4.f AvailableForLoginBit

AvailableForLoginBit shall be the value of the AvailableForLogin bit for FCFMACAddr (see FC-BB-6).

6.7.4 FCoE Link Endpoint

...

6.7.4.2 FCoE Link Endpoint Attributes Data Desclarations

Any data object of type SMHBA2_FCOE_LEP shall have the format defined in this structure:
typedef struct SMHBA2_FCoE_LEP {
SMHBA2_MACADDR LEPVNPortMAC;
SMHBA2_MACADDR LEPFCFMAC;
HBA_UINT32 LEPVLTag;
HBA_UINT8 BeaconPeriod;
HBA_UINT8 FKAADVPeriod;
} SMHBA2_ENODE_CTLR, *PSMHBA2_ENODE_CTLR;

6.7.4.3 ENode Link Endpoint Specifications

6.7.4.3.1 LEPVNPortMAC

LEPVNPortMAC shall be the Ethernet MAC that this Link Endpoint uses to conduct FCoE protocol in
behalf of its associated VN_Port (see FC-BB-6).

6.7.4.3.2 LEPFCFMAC

LEPFCFMAC shall be the Ethernet MAC that this Link Endpoint uses to communicate with its associated
VF_Port (see FC-BB-6).

6.7.4.3.3 LEPVLTag

LEPVLTag shall be the VLAN tag value that this Link Endpoint uses to conduct FCoE protocols (see
FC-BB-6).

6.7.4.3.d BeaconPeriod

BeaconPerdiod shall contain a value equal to the Locally Unique N_Port_ID timer BEACON_PERIOD, in
milliseconds, for VN2VN Enode MACs (see FC-BB-6).

4
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

6.7.4.3.e FKAADVPeriod

FDAADVPeriod shall contain a value equal to the advertised FKA_ADV_PERIOD, in milliseconds (see
FC-BB-6)

...

6.9 Statistics

...
6.9.3.1 Phy Statistics Data Declaration

Any data object of type SMHBA2_PHYSTATISTICS shall represent activity for a single Phy and shall have
the format defined in this structure:
typedef union SMHBA2_PhyStatistics {
SMHBA_SASPHYSTATISTICS * SASPhyStatistics;
SMHBASMHBA2_FCPHYSTATISTICS * FCPhyStatistics;
SMHBA2_ENPHYSTATISTICS * ENPhyStatistics;
} SMHBA2_PHYSTATISTICS, *PSMHBA2_PHYSTATISTICS;

...
6.9.5 FC Phy Statistics

...
6.9.5.2 FC Phy Statistics Data Declaration

/* Statistical counters for FC-0, FC-1, and FC-2 */

typedef struct SMHBASMHBA2_FCPhyStatistics {

HBA_INT64 SecondsSinceLastReset;
HBA_INT64 TxFrames;
HBA_INT64 TxWords;
HBA_INT64 RxFrames;
HBA_INT64 RxWords;
HBA_INT64 LIPCount;
HBA_INT64 NOSCount;
HBA_INT64 ErrorFrames;
HBA_INT64 DumpedFrames;
HBA_INT64 LinkFailureCount;
HBA_INT64 LossOfSyncCount;
HBA_INT64 LossOfSignalCount;
HBA_INT64 PrimitiveSeqProtocolErrCount;
HBA_INT64 InvalidTxWordCount;
HBA_INT64 InvalidCRCCount;
HBA_INT64 FLOGICount;
HBA_INT64 FLOGOCount;
}SMHBASMHBA2_FCPHYSTATISTICS, *PSMHBASMHBA2_FCPHYSTATISTICS;

5
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

6.9.5.3 FC Phy Statistics Attribute Specifications

...
6.9.5.3.16 InvalidCRCCount

InvalidCRCCount shall contain a value equal to the value of the Invalid CRC Count field of the Link Error
Status Block for the specified end port (see FC-FS-2). It is a 64-bit signed integer that does not increment
past the maximum value representable by a 32-bit unsigned integer.

6.9.5.3.q FLOGICount

FLOGICount shall contain a value equal to the number of Fabric LOGI Exchanges completed.

6.9.5.3.r FLOGOCount

FLOGOCount shall contain a value equal to the number of Fabric LOGO Exchanges completed.

6.9.f FIP Statistics

6.9.f.1 FIP Statistics requirements

Requirements are specified in annex A for support of the attributes specified in 6.9.a. Unless otherwise
specified, statistics counters shall be 64-bit signed integers that shall wrap to zero after reaching their
maximum value. They shall not be changed other than to count the events they represent.

NOTE 1 - Since statistics counters are not changed other than to count the events they represent, event
rates may be determined by the difference of time and counter values at two successive calls, with appro-
priate algorithms to deal with counter wrap.

6.9.f.2 FIP Statistics Data Declarations

typedef struct SMHBA2_FIPStatistics {

HBA_INT64 SecondsSinceLastReset;
HBA_INT64 FIPVLANNotifications;
HBA_INT64 FCFTimeoutCount;
HBA_INT64 BEACONTimeoutCount;
HBA_INT64 FIPMulticastAdvertReceivedCount;
HBA_INT64 KeepAliveSentCount;
HBA_INT64 ClearVirtualLinksReceivedCount;
}SMHBA2_FIPSTATISTICS, *PSMHBA2_FIPSTATISTICS;

6.9.f.3 FIP Statistics Descriptions

6.9.f.3.1 SecondsSinceLastReset

SecondsSinceLastReset shall contain a value equal to the number of seconds since the statistics were last
reset.

6.9.f.3.2 FIPVLANNotifications

FIPVLANNotifications shall contain a value equal to the number of VLAN notifications received on all
VLANs (see FC-BB-6).

6
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

6.9.f.3.3 FCFTimeoutCount

FCFTimeoutCount shall contain a value equal to the number of times a link has been deinstantiated due to
FCF timeout (i.e., no unsolicited multicast Discovery Advertisement received by the FCoE Controller of the
ENode MAC within 2.5 x FKA_ADV_PERIOD (see FC-BB-6))

6.9.f.3.4 BEACONTimeoutCount

BEACONTimeoutCount shall contain a value equal to the number of times a link has been deinstantiated
due to a Beacon timout (i.e., N_Port_ID Beacon or N_Port_ID P2P Beacon has been received withint 2.5 x
BEACON_PERIOD (see FC-BB-6)).

6.9.f.3.5 FIPMulticastAdvertReceivedCount

FIPMulticastAdvertReceivedCount shall contain a value equal to the number of multicast Discovery

Advertisements received by the FCoE Controller of the ENode MAC (see FC-BB-6).

6.9.f.3.6 KeepAliveSentCount

KeepAliveSentCount shall contain a value equal to the number of FIP Keep Alive frames sent by the FCoE
Controller of the ENode MAC (see FC-BB-6).

6.9.f.3.7 ClearVirtualLinksReceivedCount

ClearVirtualLinksReceivedCount shall contain a value equal to the number FIP Clear Virtual Links frames
received by the FCoE Controller of the ENode MAC (see FC-BB-6).

...

7
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

Annex A
...

A.1 Functions

Table A.1 specifies the requirements for implementing functions for software that is compliant with this
standard. Different requirements are specified for an SM-HBA-2 API library than for SM-HBA-2 specific
libraries. Functions not listed in this section are prohibited unless they are specified by a prior version of
this standard to which the software is also compliant (e.g., SM-HBA, FC-HBA, and FC-MI).

Table A.1 General Function Requirements

For
For
SM-HBA-2
Function SM-HBA-2 Reference
specific
Library
libraries

...

Statistics Functions

SMHBA2_GetProtocolStatistics M O

SMHBA2_GetPhyStatistics M M

SMHBA2_GetPortStatistics M M

SMHBA2_GetFIPStatistics M O

...

Key:
M designates a function that is mandatory.
O designates a function that is optional.
N indicates a function that is not allowed.

Note - Support requirements for mandatory, optional, and not allowed are described in A.1.

...

A.x SM-HBA-2 ENode Controller

Table Table 0.14 specifies the requirements for implementing ENode Controller for software that is

8
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

compliant with this standard.

Table 0.14 FCoE Controller

For FCoE Ctlr on a

Attribute Name Value indicating unspecified Reference
local end port

FCoECtlrOptions M not applicable

ENodeMAC M not applicable

FCoECtlrVLTag O zero

DiscoveredFCFMACAddrList O null

Key:
M designates a function that is mandatory.
O designates a function that is optional.
N indicates a function that is not allowed.

Note - Support requirements for mandatory, optional, and not allowed are described in A.1.

A.x SM-HBA-2 FCoE Link Endpoint

Table Table 0.15 specifies the requirements for implementing FCoE Link Endpoint for software that is
compliant with this standard.

Table 0.15 FCoE Link Endpoint

For FCoE
Link
Attribute Name Endpoint Value indicating unspecified Reference
on a local
end port

LEPVNPortMAC O eight null bytes

LEPFCFMAC O eight null bytes

LEPVLTag O zero

BeaconPeriod O zero

FKAADVPeriod O zero

Key:
M designates a function that is mandatory.
O designates a function that is optional.
N indicates a function that is not allowed.

Note - Support requirements for mandatory, optional, and not allowed are described in A.1.

9
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

A.10 SM-HBA-2 FC Phy Statistics

Table A.2 specifies the requirements for implementing FC Phy statistics for software that is compliant with
this standard. For any FC Phy statistic, the value indicating unspecified shall be negative one (-1).

Table A.2 SM-HBA-2 FC Phy Statistics

Attribute Name Requirement Reference

SecondsSinceLastReset O

TxFrames O

RxFrames O

TxWords O

RxWords O

LIPCount O

NOSCount O

ErrorFrames O

DumpedFrames O

LinkFailureCount M

LossOfSyncCount M

LossOfSignalCount M

PrimitiveSeqProtocolErrCount M

InvalidTxWordCount M

InvalidCRCCount M

FLOGICount O

FLOGOCount O

Key:
M designates a function that is mandatory.
O designates a function that is optional.
N indicates a function that is not allowed.

Note - Support requirements for mandatory, optional, and not allowed are described
in A.1.

A.k FIP Statistics

Table A.c specifies the requirements for implementing FIP Statistics for software that is compliant with this

10
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

standard.

Table A.c FIP Statistics

Attribute Name Requirement Reference

SecondsSinceLastReset O

FIPVLANNotifications M

FCFTimeoutCount M

BEACONTimeoutCount M

FIPMulticastAdvertRecievedCount M

KeepAlivesSentCount M

ClearVirtualLinksReceivedCount M

Key:
M designates a function that is mandatory.
O designates a function that is optional.
N indicates a function that is not allowed.

Note - Support requirements for mandatory, optional, and not allowed are
described in A.1.

11
T11 SM-HBA-2 FIP statistics T11/12-377v2
FIP statistics for SM-HBA-2 Prepared 21 November 2012

12