Network Working Group A. Doria Internet-Draft ETRI Expires: March 3, 2006 August 30, 2005 GSMPv3 Base Specification draft-ietf-gsmp-v3-base-spec-07 Status of this Memo By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet- Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. This Internet-Draft will expire on March 3, 2006. Copyright Notice Copyright (C) The Internet Society (2005). Abstract This document describes the base General Switch Management Protocol Version 3 (GSMPv3). The GSMPv3 is an asymmetric protocol that allows one or more external switch controllers to establish and maintain the state of a label switch. The GSMPv3 allows control of both unicast and multicast switch connection state as well as control of switch system resources and QoS features. Acknowledgment Doria Expires March 3, 2006 [Page 1] Internet-Draft GSMPv3 August 2005 GSMP was created by P. Newman, W. Edwards, R. Hinden, E. Hoffman, F. Ching Liaw, T. Lyon, and G. Minshall (see [refs.rfc1987] and [refs.rfc2297] ). All versions of GSMP are based on their work. Table of Contents 1. Discussion Venue . . . . . . . . . . . . . . . . . . . . . . 5 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5 3. GSMP Packet Encapsulation . . . . . . . . . . . . . . . . . 7 4. Common Definitions and Procedures . . . . . . . . . . . . . 7 4.1 GSMP Packet Format . . . . . . . . . . . . . . . . . . . . 8 4.1.1 Basic GSMP Message format . . . . . . . . . . . . . . 8 4.1.2 Fields commonly found in GSMP messages . . . . . . . . 11 4.1.3 Labels . . . . . . . . . . . . . . . . . . . . . . . . 12 4.1.4 Extension TLV . . . . . . . . . . . . . . . . . . . . 14 4.1.5 Failure Response Messages . . . . . . . . . . . . . . 16 5. Switch Connection Management Messages . . . . . . . . . . . 16 5.1 General Message Definitions . . . . . . . . . . . . . . . 16 5.2 Add Branch Message . . . . . . . . . . . . . . . . . . . . 24 5.3 Triggered Add Message . . . . . . . . . . . . . . . . . . 29 5.4 Bulk Add Message . . . . . . . . . . . . . . . . . . . . . 30 5.5 Delete Tree Message . . . . . . . . . . . . . . . . . . . 32 5.6 Verify Tree Message . . . . . . . . . . . . . . . . . . . 32 5.7 Delete All Input Port Message . . . . . . . . . . . . . . 32 5.8 Delete All Output Port Message . . . . . . . . . . . . . . 33 5.9 Delete Branches Message . . . . . . . . . . . . . . . . . 34 5.10 Move Output Branch Message . . . . . . . . . . . . . . . 36 6. Reservation Management Messages . . . . . . . . . . . . . . 38 6.1 Reservation Request Message . . . . . . . . . . . . . . . 39 6.2 Delete Reservation Message . . . . . . . . . . . . . . . . 42 6.3 Delete All Reservations Message . . . . . . . . . . . . . 43 6.4 Create Recovery Reservation Set . . . . . . . . . . . . . 43 7. Management Messages . . . . . . . . . . . . . . . . . . . . 44 7.1 Port Management Message . . . . . . . . . . . . . . . . . 44 7.2 Label Range Message . . . . . . . . . . . . . . . . . . . 49 8. State and Statistics Messages . . . . . . . . . . . . . . . 52 8.1 Connection Activity Message . . . . . . . . . . . . . . . 52 8.2 Statistics Messages . . . . . . . . . . . . . . . . . . . 55 8.2.1 Port Statistics Message . . . . . . . . . . . . . . . 57 8.2.2 Connection Statistics Message . . . . . . . . . . . . 57 8.2.3 QoS Class Statistics Message . . . . . . . . . . . . . 58 8.3 Report Connection State Message . . . . . . . . . . . . . 58 9. Configuration Messages . . . . . . . . . . . . . . . . . . . 62 9.1 Switch Configuration Message . . . . . . . . . . . . . . . 62 9.1.1 Configuration Message Processing . . . . . . . . . . . 65 9.2 Port Configuration Message . . . . . . . . . . . . . . . . 65 9.2.1 PortType Specific Data . . . . . . . . . . . . . . . . 69 9.3 All Ports Configuration Message . . . . . . . . . . . . . 70 Doria Expires March 3, 2006 [Page 2] Internet-Draft GSMPv3 August 2005 9.4 Service Configuration Message . . . . . . . . . . . . . . 71 10. Event Messages . . . . . . . . . . . . . . . . . . . . . . . 74 10.1 Port Up Message . . . . . . . . . . . . . . . . . . . . 76 10.2 Port Down Message . . . . . . . . . . . . . . . . . . . 76 10.3 Invalid Label Message . . . . . . . . . . . . . . . . . 76 10.4 New Port Message . . . . . . . . . . . . . . . . . . . . 77 10.5 Dead Port Message . . . . . . . . . . . . . . . . . . . 77 10.6 Adjacency Update Message . . . . . . . . . . . . . . . . 77 10.7 Recovery Event . . . . . . . . . . . . . . . . . . . . . 77 11. Bulk Transaction Message . . . . . . . . . . . . . . . . . . 77 12. Service Model Definition . . . . . . . . . . . . . . . . . . 79 12.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . 79 12.2 Service Model Definitions . . . . . . . . . . . . . . . 80 12.2.1 Original Specifications . . . . . . . . . . . . . . 80 12.3 Service Definitions . . . . . . . . . . . . . . . . . . 80 12.4 Traffic Controls (TC) Flags . . . . . . . . . . . . . . 81 13. Adjacency Protocol . . . . . . . . . . . . . . . . . . . . . 82 13.1 Packet Format . . . . . . . . . . . . . . . . . . . . . 82 13.2 Procedure . . . . . . . . . . . . . . . . . . . . . . . 85 13.2.1 State Tables . . . . . . . . . . . . . . . . . . . . 87 13.3 Partition Information State . . . . . . . . . . . . . . 88 13.4 Loss of Synchronisation . . . . . . . . . . . . . . . . 89 13.5 Multiple Controllers per switch partition . . . . . . . 89 13.5.1 Multiple Controller Adjacency Process . . . . . . . 90 14. Failure Response Codes . . . . . . . . . . . . . . . . . . . 90 14.1 Description of Failure and Warning Response Messages . . 90 14.1.1 Invalid Message . . . . . . . . . . . . . . . . . . 91 14.1.2 General Message Failure . . . . . . . . . . . . . . 91 14.1.3 Specific Message Failure . . . . . . . . . . . . . . 92 14.1.4 Connection Failures . . . . . . . . . . . . . . . . 92 14.1.5 Virtual Path Connections . . . . . . . . . . . . . . 93 14.1.6 Multicast Failures . . . . . . . . . . . . . . . . . 93 14.1.7 QoS Failures . . . . . . . . . . . . . . . . . . . . 94 14.1.8 General Failures . . . . . . . . . . . . . . . . . . 94 14.1.9 Warnings . . . . . . . . . . . . . . . . . . . . . . 95 15. Summary of Failure Response Codes and Warnings . . . . . . . 95 16. Security Considerations . . . . . . . . . . . . . . . . . . 96 17. Change Log . . . . . . . . . . . . . . . . . . . . . . . . . 96 17.1 Changes since RFC 3292 . . . . . . . . . . . . . . . . . 96 17.2 Changes since draft-ietf-gsmpv3-base-00 . . . . . . . . 97 17.3 Changes since draft-ietf-gsmpv3-base-01 . . . . . . . . 97 17.4 Changes since draft-ietf-gsmpv3-base-02 . . . . . . . . 97 17.5 Changes since draft-ietf-gsmpv3-base-03 . . . . . . . . 98 17.6 changes since draft-ietf-gsmpv3-base-04 . . . . . . . . 98 17.7 changes since draft-ietf-gsmpv3-base-05 . . . . . . . . 98 17.8 changes since draft-ietf-gsmpv3-base-06 . . . . . . . . 98 18. References . . . . . . . . . . . . . . . . . . . . . . . . . 99 Author's Address . . . . . . . . . . . . . . . . . . . . . . 101 Doria Expires March 3, 2006 [Page 3] Internet-Draft GSMPv3 August 2005 A. Summary of Messages . . . . . . . . . . . . . . . . . . . . 101 B. IANA Considerations . . . . . . . . . . . . . . . . . . . . 102 B.1 Message Type Name Space . . . . . . . . . . . . . . . . . 103 B.2 Label Type Name Space . . . . . . . . . . . . . . . . . . 103 B.3 Result Name Space . . . . . . . . . . . . . . . . . . . . 103 B.4 Failure Response Name Space . . . . . . . . . . . . . . . 104 B.5 Adaptation Type Name Space . . . . . . . . . . . . . . . . 104 B.6 Model Type Name Space . . . . . . . . . . . . . . . . . . 104 B.7 Port Type Name Space . . . . . . . . . . . . . . . . . . . 105 B.8 Service ID Name Space . . . . . . . . . . . . . . . . . . 105 B.9 Traffic Control Name Space . . . . . . . . . . . . . . . . 105 B.10 Event Flag Name Space . . . . . . . . . . . . . . . . . 105 B.11 TCP Port . . . . . . . . . . . . . . . . . . . . . . . . 105 Intellectual Property and Copyright Statements . . . . . . . 106 Doria Expires March 3, 2006 [Page 4] Internet-Draft GSMPv3 August 2005 1. Discussion Venue Discussion of this proposal is intended to take place on the GSMP mailing list . 2. Introduction The General Switch Management Protocol (GSMP) is a general purpose protocol to control a label switch. GSMP allows a controller to establish and release connections across the switch, add and delete leaves on a multicast connection, manage switch ports, request configuration information, request and delete reservation of switch resources, and request statistics. It also allows the switch to inform the controller of asynchronous events such as a link going down. The GSMP protocol is asymmetric, the controller being the master and the switch being the slave. Multiple switches may be controlled by a single controller using multiple instantiations of the protocol over separate control connections. Also a switch may be controlled by more than one controller by using the technique of partitioning. A "physical" switch can be partitioned into several virtual switches that are referred to as partitions. The partitions of a physical switch MUST be isolated from each other by the implementation and the controller assumes that the resources allocated to a partition are at all times available to that partition unless notified by a partition manager that the allocation has changed. A partition appears to its controller as a label switch. Throughout the rest of this document, the term switch (or equivalently, label switch) is used to refer to either a physical, non-partitioned switch or to a partition. The resources allocated to a partition appear to the controller as if they were the actual physical resources of the partition. For example if the bandwidth of a port were divided among several partitions, each partition would appear to the controller to have its own independent port. GSMP controls a partitioned switch through the use of a partition identifier that is carried in every GSMP message. Each partition has a one-to-one control relationship with its own logical controller entity (which in the remainder of the document is referred to simply as a controller) and GSMP independently maintains adjacency between each controller-partition pair. Kinds of label switches include frame or cell switches that support connection oriented switching, using the exact match-forwarding algorithm based on labels attached to incoming cells or frames as defined in MPLS. Other variants of label switches include those that switch on optical lambdas or on time division identifiers as defined Doria Expires March 3, 2006 [Page 5] Internet-Draft GSMPv3 August 2005 by GMPLS. A switch is assumed to contain multiple "ports". Each port is a combination of one "input port" and one "output port". Some GSMP requests refer to the port as a whole, whereas other requests are specific to the input port or the output port. Cells or labeled frames arrive at the switch from an external communication link on incoming labeled channels at an input port. Cells or labeled frames depart from the switch to an external communication link on labeled channels from an output port. A switch may support multiple label types, however, each switch port can support only one label type. The label type supported by a given port is indicated by the switch to the controller in a port configuration message. Connections may be established between ports, supporting different label types. Label types including ATM, Frame Relay, MPLS Generic and FEC, Lambda, Optical Burst and TDM labels are defined in technology specific documents. A connection across a switch is formed by connecting an incoming labeled channel to one or more outgoing labeled channels. Connections are referenced by the input port on which they originate and the Label values of their incoming labeled channel. GSMP supports point-to-point and point-to-multipoint connections. A multipoint-to-point connection is specified by establishing multiple point-to-point connections, each of them specifying the same output branch. A multipoint-to-multipoint connection is specified by establishing multiple point-to-multipoint trees each of them specifying the same output branches. In general a connection is established with a certain quality of service (QoS). This version of GSMP includes a default QoS Configuration and additionally allows the negotiation of alternative, optional QoS configurations. The default QoS Configuration includes three QoS Models: a Service Model, a Simple Abstract Model (strict priorities) and a QoS Profile Model. The Service Model is normally based on service definitions found external to GSMP such as in Integrated Services, ATM Service Categories or definitions found in GMPLS. Service models can also be defined in the technology specific specifications or in separate specifications. Each connection is assigned a specific service that defines the handling of the connection by the switch. Additionally, traffic parameters and traffic controls may be assigned to the connection depending on the assigned service. These values are defined in technology specific specifications. All GSMP switches MUST support a default QoS Configuration, the nature of which varies depending on the switch type. [[Ed note: Doria Expires March 3, 2006 [Page 6] Internet-Draft GSMPv3 August 2005 There has been a request to remove this requirement]] A GSMP switch may additionally support one or more alternative QoS Configurations. The QoS models of alternative QoS configurations are defined outside the GSMP specification. GSMP includes a negotiation mechanism that allows a controller to select from the QoS configurations that a switch supports. GSMP contains an adjacency protocol. The adjacency protocol is used to synchronize states across the link, to negotiate which version of the GSMP protocol to use, to discover the identity of the entity at the other end of a link, and to detect when it changes. 3. GSMP Packet Encapsulation GSMP packets may be transported via any suitable medium. GSMP packet encapsulations have been defined in several media types and are defined in separate documents. 4. Common Definitions and Procedures GSMP is a master-slave protocol. The controller issues request messages to the switch. Each request message indicates whether a response is required from the switch and contains a transaction identifier to enable the response to be associated with the request. The switch replies with a response message indicating either a successful result or a failure. There are six classes of GSMP request-response message: Connection Management, Reservation Management, Port Management, State and Statistics, Configuration, and Quality of Service. The switch may also generate asynchronous Event messages to inform the controller of asynchronous events. The controller can be required to acknowledge event messages, but by default does not do so. There is also an adjacency protocol message used to establish synchronization across the link and maintain a handshake. For the request-response messages, each message type has a format for the request message and a format for the success response. Unless otherwise specified a failure response message is identical to the request message that caused the failure, with the Code field indicating the nature of the failure. Switch ports are described by a 32-bit port number. The switch assigns port numbers and it may typically choose to structure the 32 bits into opaque sub-fields that have meaning to the physical structure of the switch (e.g., slot, port). In general, a port in the same physical location on the switch will always have the same port number, even across power cycles. The internal structure of the port number is opaque to the GSMP protocol. However, for the Doria Expires March 3, 2006 [Page 7] Internet-Draft GSMPv3 August 2005 purposes of network management such as logging, port naming, and graphical representation, a switch may declare the physical location (physical slot and port) of each port. Alternatively, this information may be obtained by looking up the product identity in a database. Each switch port also maintains a port session number assigned by the switch. A message, with an incorrect port session number MUST be rejected. This allows the controller to detect a link failure and to keep states synchronized. Except for the adjacency protocol message, no GSMP messages may be sent across the link until the adjacency protocol has achieved synchronization, and all GSMP messages received on a link that do not currently have state synchronization MUST be discarded. 4.1 GSMP Packet Format 4.1.1 Basic GSMP Message format All GSMP messages, except the adjacency protocol message, have the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Message Body ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 1 (The convention in the documentation of Internet Protocols [refs.iana] is to express numbers in decimal. Numbers in hexadecimal format are specified by prefacing them with the characters "0x". Numbers in binary format are specified by prefacing them with the characters "0b". Data is pictured in "big-endian" order. That is, fields are described left to right, with the most significant byte on the left and the least significant byte on the right. Whenever a diagram shows a group of bytes, the order of transmission of those bytes is the normal order in which they are read in English. Doria Expires March 3, 2006 [Page 8] Internet-Draft GSMPv3 August 2005 Whenever a byte represents a numeric quantity, the left most bit in the diagram is the high order or most significant bit. That is, the bit labeled 0 is the most significant bit. Similarly, whenever a multi-byte field represents a numeric quantity, the left most bit of the whole field is the most significant bit. When a multi-byte quantity is transmitted, the most significant byte is transmitted first. This is the same coding convention as is used in the ATM layer [refs.bisdn.atm] and AAL-5 [refs.bisdn.aal] [refs.bisdn.aal5]) Vers The version number of the GSMP protocol being used in this session. It SHOULD be set by the sender of the message to the GSMP protocol version negotiated by the adjacency protocol. This version of the protocol is 3. Sub The sub version number of the GSMP protocol being used in this session. It SHOULD be set by the sender of the message to the GSMP protocol version negotiated by the adjacency protocol. This subversion of the protocol is 1. Message Type The GSMP message type. GSMP messages fall into the following classes: Connection Management, Reservation Management, Port Management, State and Statistics, Configuration, Quality of Service, Events and messages belonging to an Abstract or Resource Model (ARM) extension. Each class has a number of different message types. In addition, one Message Type is allocated to the adjacency protocol. Result Field in a Connection Management request message, a Port Management request message, or a Quality of Service request message that is used to indicate whether a response is required to the request message if the outcome is successful. A value of "NoSuccessAck" indicates that the request message does not expect a response if the outcome is successful, and a value of "AckAll" indicates that a response is expected if the outcome is successful. In both cases a failure response MUST be generated if the request fails. For State and Statistics, and Configuration request messages, a value of "NoSuccessAck" in the request message is ignored and the request message is handled as if the field was set to "AckAll". (This facility was added to reduce the control traffic in the case where the controller periodically checks that the state in the switch is correct. If the controller does not use this capability, all request messages SHOULD be sent with a value of "AckAll".) In a response message, the result field can have three values: "Success," "More," and "Failure". The "Success" and "More" results both indicate a success response. All messages that belong to the same success response will have the same Transaction Identifier. The "Success" result indicates a success response Doria Expires March 3, 2006 [Page 9] Internet-Draft GSMPv3 August 2005 that may be contained in a single message or the final message of a success response spanning multiple messages. "More" in the result indicates that the message, either request or response, exceeds the maximum transmission unit of the data link and that one or more further messages will be sent to complete the success response. This method of indicating segmented message has been deprecated and SHOULD NOT be used. The preferred method that SHOULD be used involves setting the I flag and use of sub-message numbering. This is documented below. ReturnReceipt is a result field used in Events to indicate that an acknowledgment is required for the message. The default for Events Messages is that the controller will not acknowledge Events. In the case where a switch requires acknowledgment, it will set the Result Field to ReturnReceipt in the header of the Event Message. The encoding of the result field is: NoSuccessAck: Result = 1 AckAll: Result = 2 Success: Result = 3 Failure: Result = 4 More: Result = 5 (Obsolete) ReturnReceipt Result = 6 The Result field is not used in an adjacency protocol message Code Field gives further information concerning the result in a response message. It is mostly used to pass an error code in a failure response but can also be used to give further information in a success response message or an event message. In a request message, the code field is not used and is set to zero. In an adjacency protocol message, the Code field is used to determine the function of the message. The encoding is: Base Protocol Codes 0x000 - 0x0FF Packet Switch Codes 0x100 - 0x1FF L2 switch Codes 0x200 - 0x2FF Optical Switch Codes 0x300 - 0x3FF TDM Switch Codes 0x400 - 0x4FF Doria Expires March 3, 2006 [Page 10] Internet-Draft GSMPv3 August 2005 Partition ID Field used to associate the command with a specific switch partition. The format of the Partition ID is not defined in GSMP. If desired, the Partition ID can be divided into multiple sub- identifiers within a single partition. For example: the Partition ID could be subdivided into a 6-bit partition number and a 2-bit sub-identifier which would allow a switch to support 64 partitions with 4 available IDs per partition. Transaction Identifier Used to associate a message with its response message. For messages initiated from a controller, the controller may select any transaction identifier where the first bit is set to 0. For response messages, the transaction identifier is set to the value of the transaction identifier from the message to which it is a response. For messages initiated from a switch, the transaction identifier can be set to any transaction identifier where the first bit is set to 1. For response messages the value is set to the value of the transaction identifier from the message to which it is a response. The Transaction Identifier is not used, and the field is not present, in the adjacency protocol. I flag If I is set then the SubMessage Number field indicates the total number of SubMessage segments that compose the entire message. If it is not set then the SubMessage Number field indicates the sequence number of this SubMessage segment within the whole message. SubMessage Number When a message is segmented because it exceeds the MTU of the link layer, each segment will include a sub-message number to indicate its position. Alternatively, if it is the first sub-message in a sequence of sub-messages, the I flag will be set and this field will contain the total count of sub-message segments. Length Length in bytes of the GSMP message including its header fields and defined GSMP message body. The length of additional data appended to the end of the standard message SHOULD be included in the Length field. 4.1.2 Fields commonly found in GSMP messages The following fields are frequently found in GSMP messages. They are defined here to avoid repetition. Doria Expires March 3, 2006 [Page 11] Internet-Draft GSMPv3 August 2005 Port Gives the port number of the switch port to which the message applies. Port Session Number Each switch port maintains a Port Session Number assigned by the switch. The port session number of a port remains unchanged while the port is continuously in the Available state and the link status is continuously Up. When a port returns to the Available state after it has been Unavailable or in any of the Loopback states, or when the line status returns to the Up state after it has been Down or in Test, or after a power cycle, a new Port Session Number MUST be generated. Port session numbers SHOULD be assigned using some form of random number. If the Port Session Number in a request message does not match the current Port Session Number for the specified port, a failure response message MUST be returned with the Code field indicating, "5: Invalid port session number". The current port session number for a port may be obtained using a Port Configuration or an All Ports Configuration message. 4.1.2.1 Additional General Message Information 1. Any field in a GSMP message that is unused, undefined or defined as "reserved" MUST be set to zero by the sender and ignored by the receiver. 2. Flags that are undefined will be designated as: x: reserved, and will be designated with a x in the message diagram 3. It is not an error for a GSMP message to contain additional data after the end of the Message Body. This is allowed to support proprietary and experimental purposes. However, the maximum transmission unit of the GSMP message, as defined by the data link layer encapsulation, MUST NOT be exceeded. The length of additional data appended to the end of the standard message MUST be included in the message length field. 4. A success response message MUST NOT be sent until the requested operation has been successfully completed. 4.1.3 Labels All labels in GSMP have a common structure composed of tuples, consisting of a Type, a Length, and a Value. Such tuples are commonly known as TLV's, and are a good way of encoding information in a flexible and extensible format. A label TLV is encoded as a 2 octet field that uses 12 bits to specify a Type and four bits to specify certain behaviour specified below, followed by a 2 octet Length field, followed by a variable length Value field. Additionally, a label field can be composed of many stacked labels that together constitute the label. Doria Expires March 3, 2006 [Page 12] Internet-Draft GSMPv3 August 2005 A list of TLV label ranges are listed below: Switch Fabric Type Label Type Range ----------------- ---------------- Packet 0x100 - 0x1FF Layer 2 0x200 - 0x2FF Optical 0x300 - 0x3FF TDM 0x400 - 0x4FF The specific label types will be defined in the specific documents that describe the use of GSMPV3 on that switch type. All Labels will be designated as follow: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x|x|x|x|x|x|x|x|x|x|x|x|x| Label Type | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Label Adaptation | Label Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Label Value ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 5 x: Reserved Flags These are generally used by specific messages and will be defined in those messages. S: Stacked Label Indicator Label Stacking is discussed below in section Section 4.1.3.1 Label Type A 16-bit field indicating the type of label. Label Adaptation A 16-bit field indicating the adaptation treatment for label. If 0 means that no adaptation will be done. Adaptation types TBD Label Length A 16-bit field indicating the length of the Label Value field in bytes. Label Value A variable length field that is an integer number of 32 bit words long. The Label Value field is interpreted according to the Label Type as described in the following sections. Doria Expires March 3, 2006 [Page 13] Internet-Draft GSMPv3 August 2005 4.1.3.1 Label Stacking Label stacking is a technique used in MPLS [refs.rfc3032] that allows hierarchical labeling. MPLS label stacking is similar to, but subtly different from, the VPI/VCI hierarchy of labels in ATM. There is no set limit to the depth of label stacks that can be used in GSMP. When the Stacked Label Indicator S is set to 1 it indicates that an additional label field will be appended to the adjacent label field. For example, a stacked Input Short Label could be designated as follows: +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|1|x|x|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|0|x|x|x|x|x|x|x|x|x|x|x|x|x|x| | ** +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Stacked Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ** Note: There can be zero or more Stacked Labels fields (like those marked **) following an Input or Output Label field. A Stacked Label follows the previous label field if and only if the S Flag in the previous label is set. Figure 6 When a label is extended by stacking, it is treated by the protocol as a single extended label, and all operations on that label are atomic. For example, in an add branch message, the entire input label is switched for the entire output label. Likewise, in Move Input Branch and Move Output Branch messages, the entire label is swapped. For that reason, in all messages that designate a label field, it will be depicted as a single 64-bit field, though it might be instantiated by many 64-bit fields in practice. 4.1.4 Extension TLV In order to provide flexibility many messages include a TLV structure used to extend the messages. In most cases these extensions are for technology specific variations in the message, though they can also be used for optional extensions to messages. Doria Expires March 3, 2006 [Page 14] Internet-Draft GSMPv3 August 2005 There can be at most one extension TLV used per message type. [[Ed Note: There has been a request to remove this limitation]] All Extension TLV's will be designated as follow: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|x|x|x|x|x|x|x| Message Type | Tech Type | Block Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Extension Value ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 7 x: Reserved Flags These are generally used by specific messages and will be defined in those messages. Message Type An 8-bit field corresponding to the message type where the TLV is used. Tech Type An 8-bit field indicating the applicable technology type value. The Message Type plus the Tech Value uniquely define a single Extension Type and can be treated as a single 16 bit extension type. 0x00 Extension block not it use. 0x01 L2 Switch 0x02 Packet Switch 0x03 Optical Switch 0x04 TDM Switch 0x05 - 0xFE Reserved 0xFF Base Specification Use Block Length A 8-bit field indicating the length of the Extension Value field in bytes. When the Tech Type = 0x00, the length value MUST be set to 0. Extension Value A variable length field that is an integer number of 32 bit words long. The Extension Value field is interpreted according to the definitions found in the applicable technology specific documents. Doria Expires March 3, 2006 [Page 15] Internet-Draft GSMPv3 August 2005 4.1.5 Failure Response Messages A failure response message is formed by returning the request message that caused the failure with the Result field in the header indicating failure (Result = 4) and the Code field giving the failure code. The failure code specifies the reason for the switch being unable to satisfy the request message. If the switch issues a failure response in reply to a request message, no change should be made to the state of the switch as a result of the message causing the failure. (For request messages that contain multiple requests, such as the Delete Branches message, the failure response message will specify which requests were successful and which failed. The successful requests may result in changed state.) A warning response message is a success response (Result = 3) with the Code field specifying the warning code. The warning code specifies a warning that was generated during the successful operation. If the switch issues a failure response it MUST choose the most specific failure code according to the following precedence: - Invalid Message - General Message Failure - Specific Message Failure A failure response specified in the text defining the message type. - Connection Failures - Virtual Path Connection Failures - Multicast Failures - QoS Failures - General Failures - Warnings If multiple failures match in any of the categories, the one that is listed first should be returned. Descriptions of the Failure response messages can be found in section Section 14. 5. Switch Connection Management Messages 5.1 General Message Definitions Connection management messages are used by the controller to establish, delete, modify and verify connections across the switch. The Add Branch, Delete Tree, and Delete All connection management messages have the following format, for both request and response messages: Doria Expires March 3, 2006 [Page 16] Internet-Draft GSMPv3 August 2005 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x| Reservation ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Service Selector | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Output Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Output Service Selector | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |IQS|OQS|P|x|N|O| Adaptation Method | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Output Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | RM |x|x|x|x| Recovery Type | Recovery Block | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 9 When required, the Add Branch, Move Input Branch and Move Output Branch messages have an additional, variable length data block appended to the above message. This will be required when indicated by the IQS and OQS flags (if the value of either is set to 0b10) and the service selector. The additional data block has the following format: Doria Expires March 3, 2006 [Page 17] Internet-Draft GSMPv3 August 2005 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input TC Flags|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Traffic Parameters Block ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |Output TC Flags|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Traffic Parameters Block ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 10 Reservation ID Identifies the reservation that MUST be deployed for the branch being added. Reservations are established using reservation management messages (see Chapter Section 6). A value of zero indicates that no Reservation is being deployed for the branch. If a reservation with a corresponding Reservation ID exists, then the reserved resources MUST be applied to the branch. If the numerical value of Reservation ID is greater than the value of Max Reservations (from the Switch Configuration message), a failure response is returned indicating "20: Reservation ID out of Range". If the value of Input Port differs from the input port specified in the reservation, or if the value of Output Port differs from the output port specified in the reservation, a failure response MUST be returned indicating "21: Mismatched reservation ports". If no reservation corresponding to Reservation ID exists, a failure response MUST be returned indicating "23: Non-existent reservation ID". If a valid Reservation ID is specified and the Service Model is used (i.e., IQS or OQS=0b10) then the Traffic Parameters Block may be omitted from the Add Branch message indicating that the Traffic Parameters specified in the corresponding Reservation Request message are to be used. Input Port Identifies a switch input port. Doria Expires March 3, 2006 [Page 18] Internet-Draft GSMPv3 August 2005 Input Label Identifies an incoming labeled channel arriving at the switch input port indicated by the Input Port field. The value in the Input Label field MUST be interpreted according to the Label Type attribute of the switch input port indicated by the Input Port field. Input Service Selector Identifies details of the service specification being used for the connection. The interpretation depends upon the Input QoS Model Selector (IQS). IQS = 00: In this case, the Input Service Selector indicates a simple priority. IQS = 01: In this case, the Input Service Selector is an opaque service profile identifier. The definition of these service profiles is outside the scope of this specification. Service Profiles can be used to indicate pre-defined Differentiated Service Per Hop Behaviors. IQS = 10: In this case, the Input Service Selector corresponds to a Service Spec as defined in Chapter 8.2. When the value of either IQS or OQS is set to 0b10, then a Traffic Parameters Block is appended to the message. IQS = 11: In this case the Input Service Selector corresponds to an ARM service specification. Definition of ARM service specifications is outside the scope of this specification and is determined by the MType as defined in section Section 9.1.1. Output Port Identifies a switch output port. Output Label Identifies an outgoing labeled channel departing at the switch output port indicated by the Output Port field. The value in the Output Label field MUST be interpreted according to the Label Type attribute of the switch input port indicated by the Output Port field Output Service Selector Identifies details of the service model being used. The interpretation depends upon the Output QoS Model selector (OQS). OQS = 00: In this case the Output Service Selector indicates a simple priority. OQS = 01: In this case the Output Service Selector is an opaque service profile identifier. The definition of these service profiles is outside the scope of this specification. Service Profiles can be used to indicate pre-defined Differentiated Service Per Hop Behaviors. Doria Expires March 3, 2006 [Page 19] Internet-Draft GSMPv3 August 2005 OQS = 10: In this case the Output Service Selector corresponds to a Service Spec as described in Chapter 8.2 and defined in detail in the technology specific specification. When the value of either IQS or OQS is set to 0b10 then a Traffic Parameters Block is appended to the message. OQS = 11: In this case the Output Service Selector corresponds to an ARM service specification. Definition of ARM service specifications is outside the scope of this specification and is determined by the MType as defined in section Section 9.1.1. IQS, OQS - Input and Output QoS Model Selector: The QoS Model Selector is used to specify a QoS Model for the connection. The values of IQS and OQS determine respectively the interpretation of the Input Service Selector and the Output Service Selector, and SHOULD be interpreted as a priority, a QoS profile, a service specification, or an ARM specification as shown: IQS/OQS QoS Model Service Selector ------- --------- ---------------- 00 Simple Abstract Model Priority 01 QoS Profile Model QoS Profile 10 Default Service Model Service Specification 11 Optional ARM ARM Specification P Flag If the Parameter flag is set it indicates that a single instance of the Traffic Parameter block is provided. This occurs in cases where the Input Traffic Parameters are identical to Output Traffic Parameters. N Flag The Null flag is used to indicate a null adaptation method. This occurs when the branch is connecting two ports of the same type. O Flag The Opaque flag indicates whether the adaptation fields are opaque, or whether they are defined by the protocol. See the definition of Adaptation Method below for further information. Adaptation Method The adaptation method is used to define an adaptation framing method that may be in use when moving traffic from one port type to another port type; e.g., from a frame relay port to an ATM port. The content of this field is defined by the Opaque flag. If the Opaque flag is set, then this field is defined by the switch manufacturer. If the Opaque flag is not used, then the field is used to defines technology specific conditions that apply to the use of adaption methods included in the specific input and output labels. The technology specific conditions are defined in the technology specific documentation. Doria Expires March 3, 2006 [Page 20] Internet-Draft GSMPv3 August 2005 RM: Recovery Method Flag The Recovery Method flag indicates the type of Recovery information included in the message. The values of RM are defined as: RM Value Use of Recovery Block -------- --------------------- 0x0 Message itself defines recovery connection 0x1 Recovery block defined by reservation 0x2 Recovery block defined with port and labels Recovery Type The Recovery Type field indicates which type of recovery the resources will be applied to. The defined types are: 0x00 0:1 No protection 0x01 1+1 Dedicated Protection 0x02 1:1 Protection 0x03 1:1 Restoration 0x04 1:N Shared Recovery 0x05 M:N Shared Recovery 0x06 - 0xFF Reserved Recovery Block Depending on the RM flag, the Recovery block will be structured differently. The supported Recovery Block structures are: 0x0 Message itself defines the recovery connection to be used as indicated by the Recovery Type field. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | RM |x|x|x|x| Recovery Type | Reserved = 0 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 0x1 Recovery Block includes a reservation ID that is to be used for recovery purposes. The Recovery ID can represent either a single reservation or a reservation set. All reservations used in the recovery block must be completely qualified in that the contain all the information necessary for deploying a connection. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |RM |x|x|x|x|x|x| Recovery Type | Reserved | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |A| Recovery Reservation ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Doria Expires March 3, 2006 [Page 21] Internet-Draft GSMPv3 August 2005 Length The length of the Recovery Block in Bytes. A Flag The A flag indicates whether the Reservation ID in the next field is for a single connection or for a set of reservations. 0b0 Individual Recovery Connection 0b1 Recovery Connection Set 0x2 The Recovery Block contains the port and label definitions necessary for establishing the recovery connection. The recovery link will refer to the link defined elsewhere in the same message and will be setup with the same capabilities, service selector, encapsulations and traffic conditions as the primary connection. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |RM |x|x|x|x|x|x| Recovery Type | Reserved | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Output Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Output Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Length The length of the Recovery Block in Bytes. Input and Output TC Flags TC (Traffic Control) Flags are used in Add Branch, Move Input Branch and Move Output Branch messages for connections using the Service Model (i.e., when IQS or OQS=0b10). The TC Flags field is defined in Section Section 12.4. Input and Output Traffic Parameters Block This variable length field is used in Add Branch, Move Input Branch and Move Output Branch messages for connections using the Service Model (i.e., when IQS or OQS=0b10). Traffic Parameters Block is defined in Section Figure 10. The Traffic Parameters Doria Expires March 3, 2006 [Page 22] Internet-Draft GSMPv3 August 2005 Block may be omitted if a valid, non-zero Reservation ID is specified, in which case the Traffic Parameters of the corresponding Reservation Request message are used. If the P flag is set, then the appended message block will only include a single traffic parameter block which will be used for both input and output traffic. For all connection management messages, except the Delete Branches message, the success response message is a copy of the request message returned with the Result field indicating success. The Code field is not used in a connection management success response message. The failure response message is a copy of the request message returned with a Result field indicating failure. Fundamentally, no distinction is made between point-to-point and point-to-multipoint connections. By default, the first Add Branch message for a particular Input Port and Input Label will establish a point-to-point connection. The second Add Branch message with the same Input Port and Input Label fields will convert the connection to a point-to-multipoint connection with two branches. However, to avoid possible inefficiency with some switch designs, the Multicast Flag is provided. If the controller knows that a new connection is point-to-multipoint when establishing the first branch, it may indicate this in the Multicast Flag. Subsequent Add Branch messages with the same Input Port and Input Label fields will add further branches to the point-to-multipoint connection. Use of the Delete Branch message on a point-to-multipoint connection with two branches will result in a point-to-point connection. However, the switch may structure this connection as a point-to-multipoint connection with a single output branch if it chooses. (For some switch designs this structure may be more convenient.) Use of the Delete Branch message on a point-to-point connection will delete the point-to-point connection. There is no concept of a connection with zero output branches. All connections are unidirectional, one input labeled channel to one or more output labeled channels. In GSMP a multipoint-to-point connection is specified by establishing multiple point-to-point connections, each of them specifying the same output branch. (An output branch is specified by an output port and output label.) The connection management messages may be issued regardless of the Port Status of the switch port. Connections may be established or deleted when a switch port is in the Available, Unavailable, or any of the Loopback states. However, all connection states on an input port will be deleted when the port returns to the Available state Doria Expires March 3, 2006 [Page 23] Internet-Draft GSMPv3 August 2005 from any other state, i.e., when a Port Management message is received for that port with the Function field indicating either Bring Up, or Reset Input Port. 5.2 Add Branch Message The Add Branch message is a connection management message used to establish a connection or to add an additional branch to an existing connection. It may also be used to check the connection state stored in the switch. The connection is specified by the Input Port and Input Label fields. The output branch is specified by the Output Port and Output Label fields. The quality of service requirements of the connection are specified by the QoS Model Selector and Service Selector fields. To request a connection the Add Branch message is: Doria Expires March 3, 2006 [Page 24] Internet-Draft GSMPv3 August 2005 Message Type = 16 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x| Reservation ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Service Selector | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Output Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Output Service Selector | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |IQS|OQS|P|x|N|O| Adaptation Method | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|M|B|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|M|R|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Output Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | RM |x|x|x|x| Recovery Type | Recovery Block | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 18 Doria Expires March 3, 2006 [Page 25] Internet-Draft GSMPv3 August 2005 When the value of either IQS or OQS is set to 0b10 then the following Traffic Parameters Block is appended to the above message: +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |Input TC Flags |x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Input Traffic Parameters Block ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |Output TC Flags|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Output Traffic Parameters Block ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general connection message will not be explained in this section. Please refer to section Section 5 for details. Figure 19 M: Multicast Multicast flags are used as a hint for point-to-multipoint or multipoint-to-point connections in the Add Branch message. They are not used in any other connection management messages and in these messages they SHOULD be set to zero. There are two instances of the M-bit in the Add Branch message; one for input branch specified by the Input Port and Input Label fields and one for the output branch specified by the Output Port and Output Label fields. If set for the input branch (in front of Input Label field), it indicates that the connection is very likely to be a point-to-multipoint connection. If zero, it indicates that this connection is very likely to be a point- to-point connection or is unknown. If set for the output branch (in front of the Output Label field), it indicates that the connection is very likely to be a multipoint-to-point connection. If zero, it indicates that this connection is very likely to be a point-to- point connection or is unknown. If M flags are set for input as well as output branches, it indicates that the connection is very likely to be a multipoint- to-multipoint connection. Doria Expires March 3, 2006 [Page 26] Internet-Draft GSMPv3 August 2005 The Multicast flags are only used in the Add Branch message when establishing the first branch of a new connection. It is not required to be set when establishing subsequent branches of a point-to-multipoint or a multipoint-to-point connection and on such connections it SHOULD be ignored by the receiver. (Except in cases where the connection replace bit is enabled and set, the receipt of the second and subsequent Add Branch messages from the receiver indicates a point-to-multipoint or a multipoint-to-point connection.) If it is known that this is the first branch of a point-to-multipoint or a multipoint-to- point connection, this flag SHOULD be set. If it is unknown, or if it is known that the connection is point-to-point, this flag SHOULD be zero. The use of the multicast flag is not mandatory and may be ignored by the switch. If unused, the flags SHOULD be set to zero. Some switches use a different data structure for multicast connections rather than for point-to-point connections. These flags prevent the switch from setting up a point-to-point structure for the first branch of a multicast connection that MUST immediately be deleted and reconfigured as point-to-multipoint or multipoint-to- point when the second branch is established. B: Bi-directional The Bi-directional flag applies only to the Add Branch message. In all other Connection Management messages it is not used. It may only be used when establishing a point-to-point connection. The Bi-directional flag in an Add Branch message, if set, requests that two unidirectional connections be established, one in the forward direction, and one in the reverse direction. It is equivalent to two Add Branch messages, one specifying the forward direction, and one specifying the reverse direction. The forward direction uses the values of Input Port, Input Label, Output Port and Output Label as specified in the Add Branch message. The reverse direction is derived by exchanging the values specified in the Input Port and Input Label fields, with those of the Output Port and Output Label fields respectively. Thus, a connection in the reverse direction originates at the input port specified by the Output Port field, on the label specified by the Output Label field. It departs from the output port specified by the Input Port field, on the label specified by the Input Label field. The Bi-directional flag is simply a convenience to establish two unidirectional connections in opposite directions between the same two ports, with identical Labels, using a single Add Branch message. In all future messages the two unidirectional connections MUST be handled separately. There is no bi- directional delete message. However, a single Delete Branches message with two Delete Branch Elements, one for the forward connection and one for the reverse, may be used. Doria Expires March 3, 2006 [Page 27] Internet-Draft GSMPv3 August 2005 R: Connection Replace The Connection Replace flag applies only to the Add Branch message and is not used in any other Connection Management messages. The R flag is used in cases when creation of multipoint-to-point connections is undesirable (e.g., POTS applications where fan-in is meaningless). If the R flag is set, the new connection replaces any existing connection if the label is already in use at the same Output Port. The Connection Replace mechanism allows a single Add Connection command to function as either a Move Branch message or a combination of Delete Branch/Add Branch messages. This mechanism is provided to support existing 64k call handling applications, such as emulating 64k voice switches. The use of R flag is optional and MUST be pre-configured in the Port Management message [see section Section 7.1] to activate its use. The R flag MUST NOT be set if it is not pre-configured with the Port Management message. The switch MUST then return a Failure Response message: "36: Replace of connection is not activated on switch". Information about whether the function is active or not, can be obtained by using the Port Configuration message [see section Section 9.2]. If a switch receives an Add connection request that has the R flag set with either the B or the M flag set, it MAY return a failure response message of: "37: Connection replacement mode cannot be combined with Bi-directional or Multicast mode" If the connection specified by the Input Port and Input Label fields does not already exist, it MUST be established with the single output branch specified in the request message. If the Bi-directional Flag in the Flags field is set, the reverse connection MUST also be established. The output branch SHOULD have the QoS attributes specified by the Class of Service field. If the connection specified by the Input Port and Input Label fields already exists and the R flag is not set, but the specified output branch does not, the new output branch MUST be added. The new output branch SHOULD have the QoS attributes specified by the Class of Service field. If the connection specified by the Input Port and Input Label fields already exists and the specified output branch also already exists, the QoS attributes of the connection, specified by the Class of Service field, if different from the request message, SHOULD be changed to that in the request message. A success response message MUST be sent if the Result field of the request message is "AckAll". This allows the controller to periodically reassert the state of a connection or to change its priority. If the result field of the request message is "NoSuccessAck" a success response message SHOULD Doria Expires March 3, 2006 [Page 28] Internet-Draft GSMPv3 August 2005 NOT be returned. This may be used to reduce the traffic on the control link for messages that are reasserting a previously established state. For messages that are reasserting a previously established state, the switch MUST always check that this state is correctly established in the switch hardware (i.e., the actual connection tables used to forward cells or frames). If the connection specified by the Input Port and Input Label fields already exists, and the Bi-directional Flag in the Flags field is set, a failure response MUST be returned indicating: "15: Point-to- point bi-directional connection already exists". It should be noted that different switches support multicast in different ways. There may be a limit to the total number of point- to-multipoint or multipoint-to-point connections certain switches can support, and possibly a limit on the maximum number of branches that a point-to-multipoint or multipoint-to-point connection may specify. Some switches also impose a limit on the number of different Label values that may be assigned e.g., to the output branches of a point- to-multipoint connection. Many switches are incapable of supporting more than a single branch of any particular point-to-multipoint connection on the same output port. Specific failure codes are defined for some of these conditions. 5.3 Triggered Add Message The Triggered Add message is a connection management message used to establish a connection or to add an additional branch to an existing connection. The connection is specified by the Reservation ID. To request a connection the Triggered Add message is: Doria Expires March 3, 2006 [Page 29] Internet-Draft GSMPv3 August 2005 Message Type = 24 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x| Reservation ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | RM |x|x|x|x| Recovery Type | Recovery Block | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 20 The Triggered Add message establishes a connections based on the reservation identified the Reservation Id. The behavior of the Triggered Add message is similar to that of the Add Branch message with the exception that the arguments are contained in the hard reservation state associated with the Reservation Id If the reservation is incomplete a failure response MUST be returned with the Code field indicating: X: The Triggered Add could not be completed because the reservation was incomplete. 5.4 Bulk Add Message The Bulk Add message is a connection management message used to establish multiple connections or to add multiple additional branches to existing connections. The connections are specified by the Reservation ID. All reservations referred to by the Bulk Add MUST be on the same port and must refer to complete reservations; i.e. reservations that are fully specified in terms of input and output ports and required traffic parameters. To request a connection the Bulk Add message: Doria Expires March 3, 2006 [Page 30] Internet-Draft GSMPv3 August 2005 Message Type = 25 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Unused | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x| Reservation ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | RM |x|x|x|x| Recovery Type | Recovery Block | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ~ ... ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Unused | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x| Reservation ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | RM |x|x|x|x| Recovery Type | Recovery Block | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 22 The Bulk Add message establishes a connections based on the reservations identified the Reservation Id. The behavior of the Bulk Add message is similar to that of the Add Branch message with the exception that the arguments are contained in the hard reservation state associated with the Reservation Id. Additionally each Reservation Id, has a Result and Code field associated with it. This field is used to indicate the success or failure of each individual action in the Bulk Add message. The Result and Code fields in the header are used to indicate message failure of a general nature, while the Result and Codes fields pertaining to each of the reservations is used to indicate the success or failure of the individual transactions. In the case that any transaction fails, the Result in the message header must be set to Fail with the Code If any reservation is incomplete a failure response for that Doria Expires March 3, 2006 [Page 31] Internet-Draft GSMPv3 August 2005 reservation MUST be returned with the Result field set to Fail and Code field must indicate the nature of the failure. X: The Triggered Add could not be completed because the reservation was incomplete. 5.5 Delete Tree Message The Delete Tree message is a Connection Management message used to delete an entire connection. All remaining branches of the connection are deleted. A connection is defined by the Input Port and the Input Label fields. The Output Port and Output Label fields are not used in this message. The Delete Tree message is: Message Type = 18 If the Result field of the request message is "AckAll" a success response message MUST be sent upon successful deletion of the specified connection. The success message MUST NOT be sent until the delete operation has been completed and if possible, not until all data on the connection, queued for transmission, has been transmitted. 5.6 Verify Tree Message The Verify Tree message has been removed from this version of GSMP. Message Type = 19 If a request message is received with Message Type = 19, a failure response MUST be returned with the Code field indicating: 3: The specified request is not implemented on this switch. 5.7 Delete All Input Port Message The Delete All Input Port message is a connection management message used to delete all connections on a switch input port. All connections that originate at the specified input port MUST be deleted. On completion of the operation all dynamically assigned Label values for the specified port MUST be unassigned, i.e., there MUST be no connections established in the Label space that GSMP controls on this port. The Service Selectors, Output Port, Input Label and Output Label fields are not used in this message. The Delete All Input Port message is: Doria Expires March 3, 2006 [Page 32] Internet-Draft GSMPv3 August 2005 Message Type = 20 If the Result field of the request message is "AckAll", a success response message MUST be sent upon completion of the operation. The success response message MUST NOT be sent until the operation has been completed. The following failure response messages may be returned to a Delete All Input Port request. 3: The specified request is not implemented on this switch. 4: One or more of the specified ports does not exist. 5: Invalid Port Session Number. If any field in a Delete All Input Port message not covered by the above failure codes is invalid, a failure response MUST be returned indicating: "2: Invalid request message". Else, the Delete All Input Port operation MUST be completed successfully and a success message returned. No other failure messages are permitted. 5.8 Delete All Output Port Message The Delete All message is a connection management message used to delete all connections on a switch output port. All connections that have the specified output port MUST be deleted. On completion of the operation all dynamically assigned Label values for the specified port MUST be unassigned, i.e., there MUST be no connections established in the Label space that GSMP controls on this port. The Service Selectors, Input Port, Input Label and Output Label fields are not used in this message. The Delete All Output Port message is: Message Type = 21 If the Result field of the request message is "AckAll", a success response message MUST be sent upon completion of the operation. The success response message MUST NOT be sent until the operation has been completed. The following failure response messages may be returned to a Delete All Output Port request. 3: The specified request is not implemented on this switch. 4: One or more of the specified ports does not exist. 5: Invalid Port Session Number. Doria Expires March 3, 2006 [Page 33] Internet-Draft GSMPv3 August 2005 If any field in a Delete All Output Port message not covered by the above failure codes is invalid, a failure response MUST be returned indicating: "2: Invalid request message". Else, the delete all operation MUST be completed successfully and a success message returned. No other failure messages are permitted. 5.9 Delete Branches Message The Delete Branches message is a connection management message used to request one or more delete branch operations. Each delete branch operation deletes a branch of a channel, or in the case of the last branch of a connection, it deletes the connection. The Delete Branches message is: Message Type = 17 The request message has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x| Number of Elements | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Delete Branch Elements ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general connection message will not be explained in this section. Please refer to section Section 5 for details. Figure 31 Specifies the number of Delete Branch Elements to follow in the message. The number of Delete Branch Elements in a Delete Branches message MUST NOT cause the packet length to exceed the maximum transmission unit defined by the encapsulation. Doria Expires March 3, 2006 [Page 34] Internet-Draft GSMPv3 August 2005 Each Delete Branch Element specifies a branch to be deleted and has the following structure: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Error |x|x|x|x|x|x|x|x|x|x|x|x| Element Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Output Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x+x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Output Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general connection message will not be explained in this section. Please refer to section Section 5 for details. Figure 32 Error Is used to return a failure code indicating the reason for the failure of a specific Delete Branch Element in a Delete Branches failure response message. The Error field is not used in the request message and MUST be set to zero. A value of zero is used to indicate that the delete operation specified by this Delete Branch Element was successful. Values for the other failure codes are specified in Section Section 14, "Failure Response Codes". All other fields of the Delete Branch Element have the same definition as specified for the other connection management messages. In each Delete Branch Element, a connection is specified by the Input Port and Input Label fields. The specific branch to be deleted is indicated by the Output Port and Output Label fields. Doria Expires March 3, 2006 [Page 35] Internet-Draft GSMPv3 August 2005 If the Result field of the Delete Branches request message is "AckAll" a success response message MUST be sent upon successful deletion of the branches specified by all of the Delete Branch Elements. The success response message MUST NOT be sent until all of the delete branch operations have been completed. The success response message is only sent if all of the requested delete branch operations were successful. No Delete Branch Elements are returned in a Delete Branches success response message and the Number of Elements field MUST be set to zero. If there is a failure in any of the Delete Branch Elements, a Delete Branches failure response message MUST be returned. The Delete Branches failure response message is a copy of the request message with the Code field of the entire message set to "10: General Message Failure" and the Error field of each Delete Branch Element indicating the result of each requested delete operation. A failure in any of the Delete Branch Elements MUST NOT interfere with the processing of any other Delete Branch Elements. 5.10 Move Output Branch Message The Move Output Branch message is a connection management message used to move a single output branch of connection from its current output port and Output Label, to a new output port and Output Label on the same connection. None of the connection's other output branches are modified. When the operation is complete the original Output Label on the original output port will be deleted from the connection. Doria Expires March 3, 2006 [Page 36] Internet-Draft GSMPv3 August 2005 Message Type = 22 The Move Output Branch connection management message has the following format for both request and response messages. 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Service Selector | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Old Output Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | New Output Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Output Service Selector | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |IQS|OQS|P|x|N|O| Adaptation Method | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Old Output Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | New Output Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | RM |x|x|x|x| Recovery Type | Recovery Block | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 33 Doria Expires March 3, 2006 [Page 37] Internet-Draft GSMPv3 August 2005 When the value of either IQS or OQS is set to 0b10 then the following Traffic Parameters Block is appended to the above message: +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |Input TC Flags |x x x x x x x x x x x x x x x x x x x x x x x x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Input Traffic Parameters Block ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |Output TC Flags|x x x x x x x x x x x x x x x x x x x x x x x x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Output Traffic Parameters Block ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general connection message will not be explained in this section. Please refer to section Section 5 for details. Figure 34 For the Move Output Branch message, if the connection specified by the Input Port and Input Label fields already exists, and the output branch specified by the Old Output Port and Old Output Label fields exists as a branch on that connection, the output branch specified by the New Output Port and New Output Label fields is added to the connection and the branch specified by the Old Output Port and Old Output Label fields is deleted. If the Result field of the request message is "AckAll", a success response message MUST be sent upon successful completion of the operation. The success response message MUST NOT be sent until the Move Branch operation has been completed. For the Move Output Branch message, if the connection specified by the Input Port and Input Label fields already exists, but the output branch specified by the Old Output Port and Old Output Label fields does not exist as a branch on that connection, a failure response MUST be returned with the Code field indicating, "12: The specified branch does not exist". 6. Reservation Management Messages GSMP allows switch resources (e.g., bandwidth, buffers, queues, labels, etc.) to be reserved for connections before the connections themselves are established. This is achieved through the manipulation of Reservations in the switch. Doria Expires March 3, 2006 [Page 38] Internet-Draft GSMPv3 August 2005 Reservations are hard state objects in the switch that can be created by the controller by sending a Reservation Request message. Each Reservation is uniquely identified by an identifying number called a Reservation ID. Reservation objects can be deleted with the Delete Reservation message or the Delete All Reservations message. A reservation object is also deleted when the Reservation is deployed by specifying a Reservation ID in a valid Add Branch message. The reserved resources MUST remain reserved until either the reservation is deployed, in which case the resources are applied to a branch, or the reservation is explicitly deleted (with a Delete Reservation message or a Delete All Reservations message), in which case the resources are freed. Reservations and reserved resources are deleted if the switch is reset. A Reservation object includes its Reservation ID plus all the connection state associated with a branch with the exception that the branch's input label and/or output label may be unspecified. The Request Reservation message is therefore almost identical to the Add Branch message. The switch establishes the maximum number of reservations it can store by setting the value of Max Reservations in the Switch Configuration response message. The switch indicates that it does not support reservations by setting Max Reservations to 0. The valid range of Reservation IDs is 1 to Max Reservations). 6.1 Reservation Request Message The Reservation Request message creates a Reservation in the switch and reserves switch resources for a connection that may later be established using an Add Branch message. The Reservation Request Message is: Doria Expires March 3, 2006 [Page 39] Internet-Draft GSMPv3 August 2005 Message Type = 70 The Reservation Request message has the following format for the request message: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x| Reservation ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Service Selector | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Output Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Output Service Selector | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |IQS|OQS|P|x|N|O| Adaptation Method | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|M|B|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|M|x|x|x|x|x|x|x|x|x|x|x|x|x| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Output Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 35 Doria Expires March 3, 2006 [Page 40] Internet-Draft GSMPv3 August 2005 When the value of either IQS or OQS is set to 0b10 then the following Traffic Parameters Block is appended to the above message: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |Input TC Flags |x x x x x x x x x x x x x x x x x x x x x x x x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Input Traffic Parameters Block ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |Output TC Flags|x x x x x x x x x x x x x x x x x x x x x x x x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Output Traffic Parameters Block ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general connection message will not be explained in this section. Please refer to section Section 5 for details. Figure 36 All the fields of the Reservation Request message have the same meanings as they do in the Add Branch message with the following exceptions: Reservation ID Specifies the Reservation ID of the Reservation. If the numerical value of the Reservation ID is greater than the value of the Max Reservations (from the Switch Configuration message), a failure response is returned indicating "20: the Reservation ID out of Range". If the value of Reservation ID matches that of an extant Reservation, a failure response is returned indicating "22: Reservation ID in use". Input Label If a specific input label is specified, then that label is reserved along with the required resources. If the Input Label is 0 then the switch reserves the resources, but will not bind them to a label until the add branch command is given, which references the Reservation Id. If the input label is 0, then all stacked labels MUST also be zeroed. Doria Expires March 3, 2006 [Page 41] Internet-Draft GSMPv3 August 2005 Output Label If a specific Output Label is specified then that label is reserved along with the required resources. If the Output Label is 0 then the switch reserves the resources, but will not bind them to a label until the add branch command is given which references the Reservation Id. If the Output Label is 0, then all stacked labels MUST also be zeroed When the switch receives a valid Reservation Request it reserves all the appropriate switch resources needed to establish a branch with corresponding attributes. If sufficient resources are not available, a failure response is returned indicating "18: Insufficient resources". Other failure responses are as defined for the Add Branch message. 6.2 Delete Reservation Message The Delete Reservation message deletes a Reservation object in the switch and frees the reserved switch resources associated with that reservation object. The Reservation Request Message is: Message Type = 71 The Delete Reservation message has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |A| Reservation ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 37 The result of the Delete Reservation message depends on whether it is for a individual reservation or a recovery reservation set. A Flag = 0b0 - Individual Reservation If the Reservation ID matches that of an extant Reservation then the reservation is deleted and corresponding switch resources are freed. If the numerical value of the Reservation ID is greater than the value of the Max Reservations (from the Switch Configuration message), a Doria Expires March 3, 2006 [Page 42] Internet-Draft GSMPv3 August 2005 failure response is returned indicating "20: Reservation ID out of Range". If the value of Reservation ID does not match that of any extant Reservation, a failure response is returned indicating A flag = 0b1 - Recovery Reservation Set If the reservation ID matches that of an extant Recovery Reservations Set that the reservation set is deleted. this will not, however delete the individual reservations, or the resources, that were included in that Recovery Reservation Set. Possible Failure codes include: 23: Non-existent reservation ID 6.3 Delete All Reservations Message The Delete All Reservation message deletes all extant Reservation objects in the switch and frees the reserved switch resources of these reservations. Message Type = 72 The Delete All Reservation message has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 39 6.4 Create Recovery Reservation Set The Create Recovery Reservation Set takes a set of existing reservations and groups them together into a single aggregate reservation. Doria Expires March 3, 2006 [Page 43] Internet-Draft GSMPv3 August 2005 Message Type = 73 The Create Recovery Reservation Set message has the following format for the request message: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |A| Recovery Reservation Set ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Reserved | Count | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x| Reservation ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x| Reservation ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 40 The A flag indicates whether the reservation ID applies to an individual reservation of a Recovery Reservation Set. It must be set to 0b1 by the Create Reservation Set Message. TBD The Count field provides a count of the Reservation IDs to be aggregated into the Recovery Reservation Set The reservation ID has the same definition as given in the Reservation Message. 7. Management Messages 7.1 Port Management Message The Port Management message allows a port to be brought into service, to be taken out of service, to be set to loop back, reset, or to change the transmit data rate. Only the Bring Up and the Reset Input Port functions change the connection state (established connections) Doria Expires March 3, 2006 [Page 44] Internet-Draft GSMPv3 August 2005 on the input port. Only the Bring Up function changes the value of the Port Session Number. The Port Management message MAY also be used for enabling the replace connection mechanism. The Port Management message is also used as part of the Event Message flow control mechanism. If the Result field of the request message is "AckAll", a success response message MUST be sent upon successful completion of the operation. The success response message MUST NOT be sent until the operation has been completed. Message Type = 32 The Port Management message has the following format for the request and success response messages: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Event Sequence Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |R|x|x|x|x|x|x|x| Duration | Function | X-Function | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Event Flags | Flow Control Flags | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|x|x|x|x|x|x|x| Message Type | Tech Type | Block Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Extension Value ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 41 Doria Expires March 3, 2006 [Page 45] Internet-Draft GSMPv3 August 2005 Event Sequence Number The success response message gives the current value of the Event Sequence Number of the switch port indicated by the Port field. The Event Sequence Number is set to zero when the port is initialized. It is incremented by one each time the port detects an asynchronous event that the switch would normally report via an Event message. If the Event Sequence Number in the success response differs from the Event Sequence Number of the most recent Event message received for that port, events have occurred that were not reported via an Event message. This is most likely to be due to the flow control that restricts the rate at which a switch can send Event messages for each port. In the request message this field is not used. R: Connection Replace The R flag shall only be checked when the Function field = 1 (Bring Up). If the R flag is set in the Port Management request message, it indicates that a switch controller requests the switch port to support the Connection Replace mechanism. Connection Replace behaviour is described in chapter 4.2. If a switch does not support the Connection Replace mechanism, it MUST reply with the failure response: "45: Connection Replace mechanism not supported on switch" and reset the R-flag. Upon successful response, the R flag SHOULD remain set in the response message. Duration Is the length of time in seconds, that any of the loopback states remain in operation. When the duration has expired, the port will automatically be returned to service. If another Port Management message is received for the same port before the duration has expired, the loopback will continue to remain in operation for the length of time specified by the Duration field in the new message. The Duration field is only used in request messages with the Function field set to Internal Loopback, External Loopback, or Bothway Loopback. Function Specifies the action to be taken. The specified action will be taken regardless of the current status of the port (Available, Unavailable, or any Loopback state). If the specified function requires a new Port Session Number to be generated, the new Port Session Number MUST be returned in the success response message. The defined values of the Function field are: Bring Up: Function = 0x1. Bring the port into service. All connections that originate at the specified input port MUST be deleted and a new Port Session Number MUST be selected, preferably using some form of random number. On completion of the operation all dynamically assigned Label values for the specified input port MUST be unassigned, i.e., no connections will be established in Doria Expires March 3, 2006 [Page 46] Internet-Draft GSMPv3 August 2005 the Label space that GSMP controls on this input port. Afterward, the Port Status of the port will be Available. Take Down: Function = 0x2. Take the port out of service. Any data received at this port will be discarded. No data will be transmitted from this port. After-wards, the Port Status of the port will be Unavailable. The behaviour is undefined if the port is taken down over which the GSMP session that controls the switch is running. (In this case the most probable behaviour would be for the switch either to ignore the message or to terminate the current GSMP session and to initiate another session, possibly with the backup controller, if any.) The correct method to reset the link over which GSMP is running is to issue an RSTACK message in the adjacency protocol. Internal Loopback: Function = 0x3. Data arriving at the output port from the switch fabric are looped through to the input port to return to the switch fabric. All of the functions of the input port above the physical layer, e.g., header translation, are performed upon the looped back data. Afterward, the Port Status of the port will be Internal Loopback. External Loopback: Function = 0x4. Data arriving at the input port from the external communications link are immediately looped back to the communications link at the physical layer without entering the input port. None of the functions of the input port, above the physical layer are performed upon the looped back data. Afterward, the Port Status of the port will be External Loopback. Bothway Loopback: Function = 0x5. Both internal and external loopbacks are performed. Afterward, the Port Status of the port will be Bothway Loopback Reset Input Port: Function = 0x6. All connections that originate at the specified input port MUST be deleted and the input and output port hardware re-initialized. On completion of the operation, all dynamically assigned Label values for the specified input port MUST be unassigned, i.e., no connections will be established in the Label space that GSMP controls on this input port. The range of labels that may be controlled by GSMP on this port will be set to the default values specified in the Port Configuration message. The transmit data rate of the output port MUST be set to its default value. The Port Session Number is not changed by the Reset Input Port function. Afterward, the Port Status of the port will be Unavailable. Doria Expires March 3, 2006 [Page 47] Internet-Draft GSMPv3 August 2005 Reset Flags: Function = 0x7. This function is used to reset the Event Flags and Flow Control Flags. For each bit that is set in the Event Flags field, the corresponding Event Flag in the switch port MUST be reset to 0. For each bit that is set in the Flow Control Flags field, the corresponding Flow Control Flag in the switch port MUST be toggled; i.e., flow control for the corresponding event is turned off if is currently on and it is turned on if it is currently off. The Port Status of the port is not changed by this function. Event Flags Field in the request message that is used to reset the Event Flags in the switch port indicated by the Port field. Each Event Flag in a switch port corresponds to a type of Event message. When a switch port sends an Event message, it sets the corresponding Event Flag on that port. Depending on the setting in the Flow Control Flag, a port is either subject to flow control or not. If it is subject to flow control, then it is not permitted to send another Event message of the same type before the Event Flag has been reset. To reset an event flag, the Function field in the request message is set to "Reset Flags". For each bit that is set in the Event Flags field, the corresponding Event Flag in the switch port is reset. The Event Flags field is only used in a request message with the Function field set to "Reset Event Flags". For all other values of the Function field, the Event Flags field is not used. In the success response message the Event Flags field MUST be set to the current value of the Event Flags for the port, after the completion of the operation specified by the request message, for all values of the Function field. Setting the Event Flags field to all zeros in a "Reset Event Flags" request message allows the controller to obtain the current state of the Event Flags and the current Event Sequence Number of the port without changing the state of the Event Flags. The correspondence between the types of Event messages and the bits of the Event Flags field is as follows: Doria Expires March 3, 2006 [Page 48] Internet-Draft GSMPv3 August 2005 1 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |U|D|I|N|Z|A|C|x|x|x|x|x|x|x|x|x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ U: Port Up Bit 0, (most significant bit) D: Port Down Bit 1, I: Invalid Label Bit 2, N: New Port Bit 3, Z: Dead Port Bit 4, A: Adjacency Event Bit 5, C; Recovery Event Bit 6, x: Unused Bits 7-15. Flow Control Flags Field The flags in this field are used to indicate whether the flow control mechanism described in the Events Flag field is turned on or not. If the Flow Control Flag is set, then the flow control mechanism for that event on that port is activated. To toggle the flow control mechanism, the Function field in the request message is set to "Reset Flags". When doing a reset, for each flag that is set in the Flow Control Flags field, the corresponding flow control mechanism MUST be toggled. The Flow Control Flags correspond to the same event definitions as defined for the Event Flag. 7.2 Label Range Message The default label range, Min Label to Max Label, is specified for each port by the Port Configuration or the All Ports Configuration messages. When the protocol is initialized, before the transmission of any Label Range messages, the label range of each port will be set to the default label range. (The default label range is dependent upon the switch design and configuration and is not specified by the GSMP protocol.) The Label Range message allows the range of labels supported by a specified port, to be changed. Each switch port MUST declare whether it supports the Label Range message in the Port Configuration or the All Ports Configuration messages. Doria Expires March 3, 2006 [Page 49] Internet-Draft GSMPv3 August 2005 Message Type = 33 The Label Range message has the following format for the request and success response messages: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |Q|M|D|x| Range Count | Range Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Label Range Block ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 43 Each element of the Label Range Block has the following format: +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|x|V|C| | +-+-+-+-+ Min Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|x|x|x| | +-+-+-+-+ Max Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Remaining Labels | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 44 Flags Doria Expires March 3, 2006 [Page 50] Internet-Draft GSMPv3 August 2005 Q: Query If the Query flag is set in a request message, the switch MUST respond with the current range of valid labels. The current label range is not changed by a request message with the Query flag set. If the Query flag is zero, the message is requesting a label change operation. M: Multipoint Query If the Multipoint Query flag is set the switch MUST respond with the current range of valid specialized multipoint labels. The current label range is not changed by a request message with the Multipoint Query flag set. D: Non-contiguous Label Range Indicator This flag will be set in a Query response if the labels available for assignment belong to a non-contiguous set. V: Label The Label flag use is port type specific. C: Multipoint Capable Indicates label range that can be used for multipoint connections. Range Count Count of Label Range elements contained in the Label Range Block. Range Length Byte count in the Label Range Block. Min Label The minimum label value in the range. Max Label The maximum label value in the range. Remaining Labels The maximum number of remaining labels that could be requested for allocation on the specified port. The success response to a Label Range message requesting a change of label range is a copy of the request message with the Remaining Labels field updated to the new values after the Label Range operation. If the switch is unable to satisfy a request to change the Label range, it MUST return a failure response message with the Code field set to: "40: Cannot support one or more requested label ranges". In this failure response message, the switch MUST use the Min Label and Max Label fields to suggest a label range that it is able to satisfy. A Label Range request message may be issued regardless of the Port Status or the Line Status of the target switch port. If the Port field of the request message contains an invalid port (a port that does not exist or a port that has been removed from the switch) a failure response message MUST be returned with the Code field set to, "4: One or more of the specified ports does not exist". Doria Expires March 3, 2006 [Page 51] Internet-Draft GSMPv3 August 2005 If the Query flag is set in the request message, the switch MUST reply with a success response message containing the current range of valid labels that are supported by the port. The Min Label and Max Label fields are not used in the request message. If the Multipoint Query flag is set in the request message and the switch does not support a range of valid multipoint labels, then the switch MUST reply with a failure response message with the Code field set to, "42: Specialized multipoint labels not supported". The Min Label and Max Label fields are not used in the Multipoint request message. If a label range changes and there are extant connection states with labels used by the previous label range, a success response message MUST be returned with the Code field set to, "46: One or more labels are still used in the previous Label Range". This action indicates that the label range has successfully changed but with a warning that there are extant connection states for the previous label range. 8. State and Statistics Messages The state and statistics messages permit the controller to request the values of various hardware counters associated with the switch input and output ports and connections. They also permit the controller to request the connection state of a switch input port. The Connection Activity message is used to determine whether one or more specific connections have recently been carrying traffic. The Statistics message is used to query the various port and connection traffic and error counters. The Report Connection State message is used to request an input port to report the connection state for a single connection, a single virtual path connection, or for the entire input port. 8.1 Connection Activity Message The Connection Activity message is used to determine whether one or more specific connections have recently been carrying traffic. The Connection Activity message contains one or more Activity Records. Each Activity Record is used to request and return activity information concerning a single connection. Each connection is specified by its input port and Input Label which are specified in the Input Port and Input Label fields of each Activity Record. Two forms of activity detection are supported. If the switch supports per connection traffic accounting, the current value of the traffic counter for each specified connection MUST be returned. The units of traffic counted are not specified but will typically be Doria Expires March 3, 2006 [Page 52] Internet-Draft GSMPv3 August 2005 either cells or frames. The controller MUST compare the traffic counts returned in the message with previous values for each of the specified connections to determine whether each connection has been active in the intervening period. If the switch does not support per connection traffic accounting, but is capable of detecting per connection activity by some other unspecified means, the result may be indicated for each connection using the Flags field. Message Type = 48 The Connection Activity request and success response messages have the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message type |Result | Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Number of Records |x x x x x x x x x x x x x x x x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Activity Records ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 45 Number of Records Field specifies the number of Activity Records to follow. The number of Activity records in a single Connection Activity message MUST NOT cause the packet length to exceed the maximum transmission unit defined by the encapsulation. Doria Expires March 3, 2006 [Page 53] Internet-Draft GSMPv3 August 2005 Each Activity Record has the following format: +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |V|C|A|x| TC Count | TC Block Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | + Traffic Count + | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x| | +-+-+-+-+ Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 46 Flags V: Valid Record In the success response message the Valid Record flag is used to indicate an invalid Activity Record. The flag MUST be zero if any of the fields in this Activity Record are invalid, if the input port specified by the Input Port field does not exist, or if the specified connection does not exist. If the Valid Record flag is zero in a success response message, the Counter flag, the Activity flag, and the Traffic Count field are undefined. If the Valid Record flag is set, the Activity Record is valid, and the Counter and Activity flags are valid. The Valid Record flag is not used in the request message. C: Counter In a success response message, if the Valid Record flag is set, the Counter flag, if zero, indicates that the value in the Traffic Count field is valid. If set, it indicates that the value in the Activity flag is valid. The Counter flag is not used in the request message. A: Activity In a success response message, if the Valid Record and Counter flags are set, the Activity flag, if set, indicates that there has been some activity on this connection since the last Connection Activity message for this connection. If zero, it indicates that there has been no activity on this connection since the last Connection Activity message for this connection. The Activity flag is not used in the request message. Doria Expires March 3, 2006 [Page 54] Internet-Draft GSMPv3 August 2005 TC Count In cases where per connection traffic counting is supported, this field contains the count of Traffic Count entries. TC Block Length In cases where per connection traffic counting is supported, this field contains the Traffic Count block size in bytes. Input Port Identifies the port number of the input port on which the connection of interest originates in order to identify the connection (regardless of whether the traffic count for the connection is maintained on the input port or the output port). Input Label Fields identify the specific connection for which statistics are being requested. Traffic Count Field is not used in the request message. In the success response message, if the switch supports per connection traffic counting, the Traffic Count field MUST be set to the value of a free running, connection specific, 64-bit traffic counter counting traffic flowing across the specified connection. The value of the traffic counter is not modified by reading it. If per connection traffic counting is supported, the switch MUST report the Connection Activity result using the traffic count rather than using the Activity flag. The format of the failure response is the same as the request message with the Number of Records field set to zero and no Connection Activity records returned in the message. If the switch is incapable of detecting per connection activity, a failure response MUST be returned indicating, "3: The specified request is not implemented on this switch". 8.2 Statistics Messages The Statistics messages are used to query the various port, connection and error counters. Doria Expires March 3, 2006 [Page 55] Internet-Draft GSMPv3 August 2005 The Statistics request messages have the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x| | +-+-+-+-+ Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 47 Doria Expires March 3, 2006 [Page 56] Internet-Draft GSMPv3 August 2005 The response for the Statistics message is technology specific and has the following form: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x| | +-+-+-+-+ Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|x|x|x|x|x|x|x| Message Type | Tech Type | Block Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Extension Value ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 48 8.2.1 Port Statistics Message The Port Statistics message requests the statistics for the switch port specified in the Port field. The contents of the Label field in the Port Statistics request message is ignored. All of the count fields in the success response message refer to per-port counts regardless of the connection to which the cells or frames belong. Any of the count fields in the success response message not supported by the port MUST be set to zero. The Port Statistics message is: Message Type = 49 8.2.2 Connection Statistics Message The Connection Statistics message requests the statistics for the connection specified in the Label field that originates on the switch input port specified in the Port field. All of the count fields in the success response message refer only to the specified connection. The Header Checksum Error Count and Invalid Label Count fields are not connection specific and MUST be set to zero. Any of the other count fields not supported on a per connection basis MUST be set to Doria Expires March 3, 2006 [Page 57] Internet-Draft GSMPv3 August 2005 zero in the success response message. The Connection Statistics message is: Message Type = 50 8.2.3 QoS Class Statistics Message The QoS Class Statistics message is not supported in this version of GSMP. Message Type = 51 is reserved. 8.3 Report Connection State Message The Report Connection State message is used to request an input port to report the connection state for a single connection or for the entire input port. Message Type = 52 The Report Connection State request message has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|A|V| | +-+-+-+-+ Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Field and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 49 Input Port Identifies the port number of the input port for which the connection state is being requested. Doria Expires March 3, 2006 [Page 58] Internet-Draft GSMPv3 August 2005 Flags A: All Connections If the All Connections flag is set, the message requests the connection state for all connections that originate at the input port specified by the Input Port field. In this case the Input Label field and the Label flag are unused. V: Virtual Path The VP flag may only be set for ports that support virtual paths. If the switch receives a Report Connection State message in which the VP flag set and in which the input port specified by the Input Port field does not support virtual paths, the switch MUST return a Failure response "28: Virtual Path switching is not supported on this port ports". Input Label Field identifies the specific connection for which the connection state is being requested. For requests that do not require a connection to be specified, the Input Label field is not used. The Report Connection State success response message has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Input Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Sequence Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Connection Records ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 50 Doria Expires March 3, 2006 [Page 59] Internet-Draft GSMPv3 August 2005 Input Port Is the same as the Input Port field in the request message. It identifies the port number of the input port for which the connection state is being reported. Sequence Number In the case that the requested connection state cannot be reported in a single success response message, each successive success response message, in reply to the same request message, MUST increment the Sequence Number. The Sequence Number of the first success response message, in response to a new request message, MUST be zero. Connection Records Each success response message MUST contain one or more Connection Records. Each Connection Record specifies a single point-to-point or point-to-multipoint connection. The number of Connection Records in a single Report Connection State success response MUST NOT cause the packet length to exceed the maximum transmission unit defined by the encapsulation. If the requested connection state cannot be reported in a single success response message, multiple success response messages MUST be sent. All success response messages that are sent in response to the same request message MUST have the same Input Port and Transaction Identifier fields as the request message. A single Connection Record MUST NOT be split across multiple success response messages. "More" in the Result field of a response message indicates that one or more further success response messages should be expected in response to the same request message. "Success" in the Result field indicates that the response to the request has been completed. The Result values are defined in chapter 3.1.1. Each Connection Record has the following format: +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |A|V|P| Record Count | Record Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x| | +-+-+-+-+ Input Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Output Branch Records ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 51 Doria Expires March 3, 2006 [Page 60] Internet-Draft GSMPv3 August 2005 Flags A: All Connections V: virtual path For the first Connection Record in each success response message, the All Connections and the VP flags MUST be the same as those of the request message. For successive Connection Records in the same success response message, these flags are not used. P: Virtual Path Connection record The VPC flag may only be set for ports that support virtual paths. The VPC flag, if set and only if set, indicates that the Connection Record refers to an virtual path connection. Input Label The input label of the connection specified in this Connection Record. Record Count Count of Output Branch Records included in a response message. Record Length Length in bytes of Output Branch Records field Output Branch Records Each Connection Record MUST contain one or more Output Branch Records. Each Output Branch Record specifies a single output branch belonging to the connection identified by the Input Label field of the Connection Record and the Input Port field of the Report Connection State message. A point-to-point connection will require only a single Output Branch Record. A point-to-multipoint connection will require multiple Output Branch Records. If a point-to-multipoint connection has more output branches than can fit in a single Connection Record contained within a single success response message, that connection may be reported using multiple Connection Records in multiple success response messages. Each Output Branch Record has the following format: +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Output Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x| | +-+-+-+-+ Output Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 52 Doria Expires March 3, 2006 [Page 61] Internet-Draft GSMPv3 August 2005 Output Port The output port of the switch to which this output branch is routed. Output Label The output label of the output branch specified in this Output Branch Record. A Report Connection State request message may be issued regardless of the Port Status or the Line Status of the target switch port. If the Input Port of the request message is valid, and the All Connections flag is set, but there are no connections established on that port, a failure response message MUST be returned with the Code field set to, "10: General Message Failure". For the Report Connection State message, this failure code indicates that no connections matching the request message were found. This failure message SHOULD also be returned if the Input Port of the request message is valid, the All Connections flag is zero, and no connections are found on that port matching the specified connection. 9. Configuration Messages The configuration messages permit the controller to discover the capabilities of the switch. Three configuration request messages have been defined: Switch, Port, and All Ports. 9.1 Switch Configuration Message The Switch Configuration message requests the global (non port- specific) configuration for the switch. Doria Expires March 3, 2006 [Page 62] Internet-Draft GSMPv3 August 2005 Message Type = 64 The Port field is not used in the switch configuration message. The Switch Configuration message has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | MType | MType | MType | MType | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Firmware Version Number | Window Size | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Switch Type | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Switch Name | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x| Max Reservations | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|x|x|x|x|x|x|x| Message Type | Tech Type | Block Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Extension Value ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 53 MType Represents an alternative QoS Configuration type. In the request message the requested MType is in the most significant (leftmost) MType byte; the other three MType bytes are unused. The reply message will either accept the MType request by including the requested MType in the leftmost MType field of the response message or it will reject the MType request by responding with MType=0, the default MType, in the first MType field. Optionally, in the case of a rejection, the switch reply can include up to 3 Doria Expires March 3, 2006 [Page 63] Internet-Draft GSMPv3 August 2005 additional MType values, each of which indicates an available alternative QoS Configuration. A switch that supports only the default QoS Configuration always returns MType=0 in all four MType fields. MType negotiation is discussed in section Section 9.1.1. 0 - Indicates use of the default GSMP model 1-200 - Reserved 201-255 - Experimental Firmware Version Number The version number of the switch control firmware installed. Window Size The maximum number of unacknowledged request messages that may be transmitted by the controller without the possibility of loss. This field is used to prevent request messages being lost in the switch because of overflow in the receive buffer. The field is a hint to the controller. In using the window, a controller MAY include both messages requiring an acknowledgment, as well as message that require an acknowledgment only after failure. If the controller includes messages requiring acknowledgment only after failure, then the controller SHOULD use a timer to determine when to remove these messages from the window buffer. The choice of timer interval is an implementation specific value and is not defined in this specification. If desired, the controller may experiment with higher and lower window sizes to determine heuristically the best window size. Switch Type A 16-bit field allocated by the manufacturer of the switch. (For these purposes, the manufacturer of the switch is assumed to be the organization identified by the OUI in the Switch Name field.) The Switch Type identifies the product. When the Switch Type is combined with the OUI from the Switch Name the product is uniquely identified. Network Management may use this identification to obtain product related information from a database. Switch Name A 48-bit quantity that is unique within the operational context of the device. A 48-bit IEEE 802 MAC address, if available, may be used as the Switch Name. The most significant 24 bits of the Switch Name MUST be an Organizationally Unique Identifier (OUI) that identifies the manufacturer of the switch. Max Reservations The maximum number of Reservations that the switch can support (see Chapter Section 6). A value of 0 indicates that the switch does not support Reservations. Doria Expires March 3, 2006 [Page 64] Internet-Draft GSMPv3 August 2005 9.1.1 Configuration Message Processing After adjacency between a controller and after a switch is first established the controller that opts to use a QoS Configuration model other then the default would send the Switch Configuration request including the requested QoS Configuration's MType value in the request message. This request MUST be sent before any connection messages are exchanged. If the switch can support the requested QoS configuration, then the switch includes the requested MType value in the response message as an indication that it accepts the request. If the switch cannot support the requested QoS Configuration, it replaces the MType value in the request message with that of the default QoS Configuration, i.e., MType=0. The switch configuration response messages may additionally include the MType values of up to three alternative QoS Configurations that the switch supports and that the controller may choose between. The exchange continues until the controller sends a requested MType that the switch accepts or until it sends a connection request message. If the exchange ends without confirmation of an alternate switch model, then the default Mtype=0 is be used. Once an MType has been established for the switch, it cannot be changed without full restart, that is the re-establishment of adjacency with the resetting of all connections. 9.2 Port Configuration Message The Port Configuration message requests the switch for the configuration information of a single switch port. The Port field in the request message specifies the port for which the configuration is requested. Doria Expires March 3, 2006 [Page 65] Internet-Draft GSMPv3 August 2005 Message Type = 65. The Port Configuration success response message has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Event Sequence Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Event Flags | Port Attribute Flags | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PortType |S|x|x|x|x|x|x|x| Data Fields Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ PortType Specific Data ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x x x x x x x x x x x x x x x x| Number of Service Specs | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-| | | ~ Service Specs List ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x x x x x x x x x x x x x x x x| Number of Adaptation Types | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-| | | ~ Supported Label Adaptation Types ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 55 Doria Expires March 3, 2006 [Page 66] Internet-Draft GSMPv3 August 2005 Port The switch port to which the configuration information refers. Configuration information relating to both the input and the output sides of the switch port is given. Port numbers are 32 bits wide and allocated by the switch. The switch may choose to structure the 32 bits into subfields that have meaning to the physical structure of the switch hardware (e.g., physical slot and port). This structure may be indicated in the Physical Slot Number and Physical Port Number fields. Event Sequence Number The Event Sequence Number is set to zero when the port is initialized. It is incremented by one each time the port detects an asynchronous event that the switch would normally report via an Event message. The Event Sequence Number is explained in section Section 10. Event Flags Event Flags in a switch port corresponds to a type of Event message. Port Attribute Flags Port Attribute Flags indicate specific behaviour of a switch port. The format of the Port Attribute Flags field is given below: 0 1 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |R|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x|x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ R: Connection Replace flag If set, indicates that connections being established by an Add Branch message with a corresponding R-bit set will replace any previously established connection if a clash between the established output branch and the requested output branch occurs [see Section 5.2]. x: Unused. PortType Port type values are defined in the technology specific documents. S: Service Model If set, indicates that Service Model data follows the PortSpecific port configuration data. Data Fields Length The total length in bytes of the combined PortType Specific Data and Service Model Data fields. The length of each of these fields may be derived from the other data so the value of Data Fields Length serves primarily as a check and to assist parsing of the All Ports Configuration message success response. Doria Expires March 3, 2006 [Page 67] Internet-Draft GSMPv3 August 2005 PortType Specific Data This field contains the configuration data specific to the particular port type as specified by the PortType field. The field format and length also depends on the value of the PortType. PortType Specific Data is defined below. Number of Service Specs Field contains the total number of Service Specs following in the Port Configuration message response or Port Configuration Record. Service Specs List The Service Specs correspond to the Input and Output Service selectors used in Connection Management and Reservation messages. Specifically they define the possible values used when the Service Selector (IQS or OQS) is set to 0b10 indicating the use of the default service specification model defined in Chapter 10. Service Spec The format of each service spec is given below: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Service ID | Capability Set ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Each Service Spec identifies a Service supported by the switch together with the Capability Set ID that identifies the parameters of that instance of the Service. The Service Spec List may contain more than one Service Spec sharing the same Service ID. However, each Service Spec in the Service Specs List MUST be unique. Service ID Field contains the Service ID of a Service supported on the port. Service ID values are defined as part of the Service definition in Chapter 9.6. Capability Set ID Field identifies a Capability Set ID of the Service specified by the Service ID that is supported on the port. Capability Set ID values are defined by the Switch in the Service Configuration response message (see Section Section 9.4). The switch MUST NOT return a {Service ID, Capability Set ID} pair that is not reported in a Service Configuration response message. Field contains the total number of Adaptation types following in the Port Configuration message response or Port Configuration Record. Doria Expires March 3, 2006 [Page 68] Internet-Draft GSMPv3 August 2005 The format of each entry in the Adaptation Type list is given below: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Label Type | Supported Adaptation Type | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 9.2.1 PortType Specific Data The length, format and semantics of the PortType Specific Data field in the Port Configuration message success response and in the Port Records of the All Port Configuration message success response all depend on the PortType value of the same message or record respectively. The specification of the PortType Specific Data field is given below. For each defined PortType value the Min and Max Label fields are given in the subsequent subsections. 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |P|M|L|R|Q| Label Range Count | Label Range Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Default Label Range Block ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|x|x|x|x|x|x|x| Message Type | Tech Type | Block Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Extension Value ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Status | Line Type | Line Status | Priorities | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Physical Slot Number | Physical Port Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 59 Doria Expires March 3, 2006 [Page 69] Internet-Draft GSMPv3 August 2005 9.3 All Ports Configuration Message The All Ports Configuration message requests the switch for the configuration information of all of its ports. The All Ports Configuration message is: Message Type = 66 The Port field is not used in the request message. The All Ports Configuration success response message has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x x x x x x x x x x x x x x x x| Number of Records | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Port Records ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 60 Number of Records Field gives the total number of Port Records to be returned in response to the All Ports Configuration request message. The number of port records in a single All Ports Configuration success response MUST NOT cause the packet length to exceed the maximum transmission unit defined by the encapsulation. If a switch has more ports than can be sent in a single success response message it MUST send multiple success response messages. All success response messages that are sent in response to the same request message MUST have the same Transaction Identifier as the request message and the same value in the Number of Records field. All success response messages that are sent in response to the same request message, except for the last message, MUST have the result field set to "More". The last message, or a single success response message, MUST have the result field set to "Success". Doria Expires March 3, 2006 [Page 70] Internet-Draft GSMPv3 August 2005 All Port records within a success response message MUST be complete, i.e., a single Port record MUST NOT be split across multiple success response messages. Each port record has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Event Sequence Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Event Flags | Port Attribute Flags | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PortType |S|x|x|x|x|x|x|x| Data Fields Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ PortType Specific Data ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x x x x x x x x x x x x x x x x| Number of Service Specs | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Service Specs List ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 61 The definition of the fields in the Port Record is exactly the same as that of the Port Configuration message in section Section 9.2. 9.4 Service Configuration Message The Service Configuration message requests the switch for the configuration information of the Services that are supported. Doria Expires March 3, 2006 [Page 71] Internet-Draft GSMPv3 August 2005 Message Type = 67 The Service Configuration success response message has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x x x x x x x x x x x x x x x x| Number of Service Records | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Service Records ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 62 Number of Service Records Field gives the total number of Service Records to be returned in the Service Records field. Service Records A sequence of zero or more Service Records. The switch returns one Service Record for each Service that it supports on any of its ports. A Service record contains the configuration data of the specified Service. Each Service Record has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Service ID | Number of Cap. Set. Records | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Capability Set Records ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 63 Doria Expires March 3, 2006 [Page 72] Internet-Draft GSMPv3 August 2005 Service ID The Service ID Field identifies the Service supported by the port. The Services are defined with their Service ID values as described in section Section 12.3. Number of Cap. Set. Records Field gives the total number of Capability Set Records to be returned in the Service Record field. Capability Set Records The switch returns one or more Capability Set Records in each Service Record. A Capability Set contains a set of parameters that describe the QoS parameter values and traffic controls that apply to an instance of the Service. Capability Sets are technology specific and MUST be defined in the technology specific specifications. all Capability Set records are of fixed size have the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Cap. Set ID | Traffic Controls | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Block Length | | +-+-+-+-+-+-+-+-+ | | | ~ QOS Parameters ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 64 The value in this Field defines a Capability Set ID supported by the switch. The values of a Capability Set ID are assigned by the switch and used in Port Configuration messages to identify Capability Sets supported by individual ports. Each Capability Set Record within a Service Record MUST have a unique Capability Set ID. Field identifies the availability of Traffic Controls within the Capability Set. Traffic Controls are defined as part of the respective Service definition, see Chapter . Some or all of the Traffic Controls may be undefined for a given Service, in which case the corresponding Flag is ignored by the controller. The Traffic Controls field is formatted into Traffic Control Sub-fields as follows: Doria Expires March 3, 2006 [Page 73] Internet-Draft GSMPv3 August 2005 0 1 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x x|x x|x x|x x|x x|x x|x x|x x| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Each of the traffic Control Sub-fields have the following encoding: 0b00 Indicates that the Traffic Control is not available in the Capability Set. 0b01 Indicates that the Traffic Control is applied to all connections that use the Capability Set. 0b10 Indicates that the Traffic Control is available for application to connections that use the Capability Set on a per connection basis. 0b11 Reserved Traffic Control Sub-fields are defined in the technology specific documents. QoS Parameters The remaining QoS parameter in the Capability Set Record contains the values of QoS Parameters. QoS Parameters are defined as part of their respective Service definition, see Chapter (--insert reference here--), and MUST be defined in technology specific documentation. 10. Event Messages Event messages allow the switch to inform the controller of certain asynchronous events. By default the controller does not acknowledge event messages unless ReturnReceipt is set in the Result field. The Code field is only used in case of Adjacency Update message, otherwise it is not used and SHOULD be set to zero. Event messages are not sent during initialisation. Doria Expires March 3, 2006 [Page 74] Internet-Draft GSMPv3 August 2005 Event messages have the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Port Session Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Event Sequence Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|S|x|x| | +-+-+-+-+ Label | ~ ~ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |x|x|x|x|x|x|x|x| Message Type | Tech Type | Block Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Extension Value ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section Section 4.1 for details. Figure 66 Event Sequence Number The current value of the Event Sequence Number for the specified port. The Event Sequence Number is set to zero when the port is initialized. It is incremented by one each time the port detects an asynchronous event that the switch would normally report via an Event message. The Event Sequence Number MUST be incremented each time an event occurs even if the switch is prevented from sending an Event message due to the action of the flow control. Doria Expires March 3, 2006 [Page 75] Internet-Draft GSMPv3 August 2005 Label Field gives the Label to which the event message refers. If this field is not required by the event message it is set to zero. Each switch port MUST maintain an Event Sequence Number and a set of Event Flags, one Event Flag for each type of Event message. When a switch sends an Event message it MUST set the Event Flag for that port corresponding to the Event type. If Flow Control is activated for this Event type for this Port then the switch MUST NOT send another Event message of the same type for that port until the Event Flag has been reset. Event Flags are reset by the "Reset Event Flags" function of the Port Management message. This is a simple flow control preventing the switch from flooding the controller with event messages. The Event Sequence Number of the port MUST be incremented every time an event is detected on that port even if the port is prevented from reporting the event due to the action of the flow control. This allows the controller to detect that it has not been informed of some events that have occurred on the port due to the action of the flow control. 10.1 Port Up Message The Port Up message informs the controller that the Line Status of a port has changed from, either the Down or Test state to the Up state. When the Line Status of a switch port changes to the Up state from either the Down or Test state a new Port Session Number MUST be generated, preferably using some form of random number. The new Port Session Number is given in the Port Session Number field. The Label field is not used and is set to zero. The Port Up message is: Message Type = 80 10.2 Port Down Message The Port Down message informs the controller that the Line Status of a port has changed from the Up state or Test state to the Down state. This message will be sent to report link failure if the switch is capable of detecting link failure. The port session number that was valid before the port went down is reported in the Port Session Number field. The Label field is not used and is set to zero. The Port Down message is: Message Type = 81 10.3 Invalid Label Message The Invalid Label message is sent to inform the controller that one or more cells or frames have arrived at an input port with a Label that is currently not allocated to an assigned connection. The input ss port is indicated in the Port field, and the Label in the Label Doria Expires March 3, 2006 [Page 76] Internet-Draft GSMPv3 August 2005 field. The Invalid Label message is: Message Type = 82 10.4 New Port Message The New Port message informs the controller that a new port has been added to the switch. The port number of the new port is given in the Port field. A new Port Session Number MUST be assigned, preferably using some form of random number. The new Port Session Number is given in the Port Session Number field. The state of the new port is undefined so the Label field is not used and is set to zero. The New Port message is: Message Type = 83 10.5 Dead Port Message The Dead Port message informs the controller that a port has been removed from the switch. The port number of the port is given in the Port field. The Port Session Number that was valid before the port was removed is reported in the Port Session Number field. The Label fields are not used and are set to zero. The Dead Port message is: Message Type = 84 10.6 Adjacency Update Message The Adjacency Update message informs the controller when adjacencies, i.e., other controllers controlling a specific partition, are joining or leaving. When a new adjacency has been established, the switch sends an Adjacency Update message to every controller with an established adjacency to that partition. The Adjacency Update message is also sent when adjacency is lost between the partition and a controller, provided that there are any remaining adjacencies with that partition. The Code field is used to indicate the number of adjacencies known by the switch partition. The Label field is not used and SHOULD be set to zero. The Adjacency Update message is: Message Type = 85 10.7 Recovery Event The Recovery Event message informs the controller when a recovery event occurs. The fields are technology specific and defined in the relevant technology specific specifications. The Adjacency Update message is: Message Type = 86 11. Bulk Transaction Message A switch MAY support a bulk transaction capability. In a bulk Doria Expires March 3, 2006 [Page 77] Internet-Draft GSMPv3 August 2005 transaction, several messages can be bundled together in a single transaction. Message Type = 13. The Bulk Transaction message has the following format: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Result| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Transaction Identifier | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |I| SubMessage Number | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Reserved | Count | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ~ Message Payload ~ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Note: Fields and Parameters that have been explained in the description of the general messages will not be explained in this section. Please refer to section xref target="pktfmt" /> for details. Figure 67 In a Bulk Transaction Message, each of the message in the payload is framed with a complete header and is acted on individually. The response to the Bulk Transaction message contains the response message that would have been generated by each of the messages had it been sent individually. Each response message will have the appropriate result and code field filled. XX: Bulk Transaction message not supported. Any message can be included in the bulk Transaction message except for: 10. Adjacency Message 13. Bulk Transaction Message Doria Expires March 3, 2006 [Page 78] Internet-Draft GSMPv3 August 2005 64. Switch Configuration Message If a prohibited message is included in a bulk Transaction message, it MUST be include in the Bulk response with a failure response. The response code for that failure is: XX: Message type prohibited in bulk Transaction Note: While the individual message would fail, this would not constitute a failure for the Bulk Transaction message. 12. Service Model Definition 12.1 Overview In the GSMP Service Model a controller may request the switch to establish a connection with a given Service. The requested Service is identified by including a Service ID in the Add Branch message or the Reservation Message. The Service ID refers to a Service Definition provided in this chapter of the GSMP specification. A switch that implements one or more of the Services, as defined below, advertises the availability of these Services in the Service Configuration message response (see Section Section 9.4). Details of the switch's implementation of a given Service that are important to the controller (e.g., the value of delay or loss bounds or the availability of traffic controls such as policers or shapers) are reported in the form of a Capability Set in the Service Configuration message response. Thus a switch's implementation of a Service is defined in two parts: the Service Definition, which is part of the GSMP specification, and the Capability Set, which describes attributes of the Service specific to the switch. A switch may support more than one Capability Set for a given Service. For example if a switch supports one Service with two different values of a delay bound it could do this by reporting two Capability Sets for that Service. The Service Definition is identified in GSMP messages by the Service ID, a sixteen-bit identifier. Assigned numbers for the Service ID are given with the Service Definitions in Section Section 12.3. The Capability Set is identified in GSMP messages by the Capability Set ID, a sixteen-bit identifier. Numbers for the Capability Set ID are assigned by the switch and are advertised in the Service Configuration message response. The switch reports all its supported Services and Capability Sets in the Service Configuration message response. The subset of Services Doria Expires March 3, 2006 [Page 79] Internet-Draft GSMPv3 August 2005 and Capability Sets supported on an individual port is reported in the Port Configuration message response or in the All Ports Configuration message response. In these messages the Services and Capability Sets supported on the specified port are indicated by a list of {Service ID, Capability Set ID} number pairs. 12.2 Service Model Definitions Terms and objects defined for the GSMP Service Model are given in this section. 12.2.1 Original Specifications Services in GSMP are defined largely with reference to Original Specifications, i.e., the standards or implementation agreements published by organizations such as ITU-T, IETF, and ATM Forum that originally defined the Service. 12.3 Service Definitions This section sets forth the definition of Services. The following Service Identifiers are defined: ID Range Service Type 1 - 63 L2 Switch Services 64 - 127 Packet Switch Services 128 - 191 Optical Switch Services 192 - 255 TDM Service 256 - 65535 Reserved Each Service will be defined in its own subsection. Each Service definition includes the following definitions: Service Identifier The reference number used to identify the Service in GSMP messages. Service Characteristics A definition of the Service. Traffic Parameters A definition of the Traffic Parameters used in connection management messages. QoS Parameters A definition of the QoS Parameters that are included in the Capability Set for instances of the Service. Doria Expires March 3, 2006 [Page 80] Internet-Draft GSMPv3 August 2005 Traffic Controls A definition of the Traffic Controls that may be supported by an instance of the Service. Descriptive text is avoided wherever possible in order to minimise any possibility of semantic conflict with the Original Specifications. 12.4 Traffic Controls (TC) Flags The TC Flags field in Add Branch messages for connections using the Service Model are set by the controller to indicate that specific traffic controls are requested for the requested connection. The TC Flags field is shown below: 0 1 2 3 4 5 6 7 +-+-+-+-+-+-+-+-+ |U|D|I|E|S|V|P|x| +-+-+-+-+-+-+-+-+ When set, this flag indicates that Usage Parameter Control is requested. D: Packet Discard When set, this flag indicates that Packet Discard is requested. I: Ingress Shaping When set, this flag indicates the availability of Ingress Traffic Shaping to the Peak Rate and Delay Variation Tolerance is requested. E: Egress Shaping, Peak Rate When set, this flag indicates that Egress Shaping to the Peak Rate and Delay Variation Tolerance is requested. S: Egress Traffic Shaping, Sustainable Rate When set, this flag indicates that Egress Traffic Shaping to the Sustainable Rate and Maximum Burst Size is requested. V: VC Merge When set, this flag indicates that ATM Virtual Channel Merge (i.e., multipoint to point ATM switching with a traffic control to avoid AAL5 PDU interleaving) is requested. P: Port When set indicates that traffic block pertains to Ingress Port. x: Reserved The controller may set (to one) the flag corresponding to the requested Traffic Control if the corresponding Traffic Control has been indicated in the Service Configuration response message defined in Section Section 12.4 as available for application to connections that use the requested Capability Set on a per connection basis. Doria Expires March 3, 2006 [Page 81] Internet-Draft GSMPv3 August 2005 (The requested Capability Set is indicated by the Capability Set ID the least significant byte of the Service Selector field of the Add Branch message.) If the Traffic Control has been indicated in the Service Configuration response message as either not available in the Capability Set or applied to all connections that use the Capability Set then the controller sets the flag to zero and the switch ignores the flag. 13. Adjacency Protocol The adjacency protocol is used to synchronize state across the link, to agree on which version of the protocol to use, to discover the identity of the entity at the other end of a link, and to detect when it changes. GSMP is a hard state protocol. It is therefore important to detect loss of contact between switch and controller, and to detect any change of identity of switch or controller. No GSMP messages other than those of the adjacency protocol may be sent across the link until the adjacency protocol has achieved synchronization. 13.1 Packet Format All GSMP messages belonging to the adjacency protocol have the following structure: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Vers | Sub | Message Type | Timer |M| Code | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Sender Name | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Receiver Name | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Sender Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Receiver Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PType | PFlag | Sender Instance | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Partition ID | Receiver Instance | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Figure 72 Doria Expires March 3, 2006 [Page 82] Internet-Draft GSMPv3 August 2005 Vers, Sub In the adjacency protocol the Version field is used for version negotiation. The version negotiation is performed before synchronization is achieved. In a SYN message the Version field always contains the highest version understood by the sender. A receiver receiving a SYN message with a version higher than understood will ignore that message. A receiver receiving a SYN message with a version lower than its own highest version, but a version that it understands, will reply with a SYNACK with the version from the received SYN in its GSMP Version field. This defines the version of the GSMP protocol to be used while the adjacency protocol remains synchronized. All other messages will use the agreed version in the Version field. The version number for the version of the GSMP protocol defined by this specification is Version = 3, Sub = 1. The adjacency protocol is: Message Type = 10 Timer The Timer field is used to inform the receiver of the timer value used in the adjacency protocol of the sender. The timer specifies the nominal time between periodic adjacency protocol messages. It is a constant for the duration of a GSMP session. The timer field is specified in units of 100ms. M-Flag The M-Flag is used in the SYN message to indicate whether the sender is a master or a slave. If the M-Flag is set in the SYN message, the sender is a master. If zero, the sender is a slave. The GSMP protocol is asymmetric, the controller being the master and the switch being the slave. The M-Flag prevents a master from synchronizing with another master, or a slave with another slave. If a slave receives a SYN message with a zero M-Flag, it MUST ignore that SYN message. If a master receives a SYN message with the M-Flag set, it MUST ignore that SYN message. In all other messages the M-Flag is not used. Code Field specifies the function of the message. Four Codes are defined for the adjacency protocol: SYN: Code = 1 SYNACK: Code = 2 ACK: Code = 3 RSTACK: Code = 4. Sender Name For the SYN, SYNACK, and ACK messages, is the name of the entity sending the message. The Sender Name is a 48-bit quantity that is unique within the operational context of the device. A 48-bit IEEE 802 MAC address, if available, may be used for the Sender Doria Expires March 3, 2006 [Page 83] Internet-Draft GSMPv3 August 2005 Name. If the Ethernet encapsulation is used the Sender Name MUST be the Source Address from the MAC header. For the RSTACK message, the Sender Name field is set to the value of the Receiver Name field from the incoming message that caused the RSTACK message to be generated. Receiver Name For the SYN, SYNACK, and ACK messages, is the name of the entity that the sender of the message believes is at the far end of the link. If the sender of the message does not know the name of the entity at the far end of the link, this field SHOULD be set to zero. For the RSTACK message, the Receiver Name field is set to the value of the Sender Name field from the incoming message that caused the RSTACK message to be generated. Sender Port For the SYN, SYNACK, and ACK messages, is the local port number of the link across which the message is being sent. For the RSTACK message, the Sender Port field is set to the value of the Receiver Port field from the incoming message that caused the RSTACK message to be generated. Receiver Port For the SYN, SYNACK, and ACK messages, is what the sender believes is the local port number for the link, allocated by the entity at the far end of the link. If the sender of the message does not know the port number at the far end of the link, this field SHOULD be set to zero. For the RSTACK message, the Receiver Port field is set to the value of the Sender Port field from the incoming message that caused the RSTACK message to be generated. PType PType is used to specify if partitions are used and how the Partition ID is negotiated. Type of partition being requested. 0 No Partition 1 Fixed Partition Request 2 Fixed Partition Assigned PFlag Used to indicate the type of partition request. 1 - New Adjacency. In the case of a new adjacency, the state of the switch will be reset. 2 - Recovered Adjacency. In the case of a recovered adjacency, the state of the switch will remain, and the Switch Controller will be responsible for confirming that the state of the switch matches the desired state. Doria Expires March 3, 2006 [Page 84] Internet-Draft GSMPv3 August 2005 Sender Instance For the SYN, SYNACK, and ACK messages, is the sender's instance number for the link. It is used to detect when the link comes back up after going down or when the identity of the entity at the other end of the link changes. The instance number is a 24-bit number that is guaranteed to be unique within the recent past and to change when the link or node comes back up after going down. Zero is not a valid instance number. For the RSTACK message, the Sender Instance field is set to the value of the Receiver Instance field from the incoming message that caused the RSTACK message to be generated. Partition ID Field used to associate the message with a specific switch partition. Receiver Instance For the SYN, SYNACK, and ACK messages, is what the sender believes is the current instance number for the link, allocated by the entity at the far end of the link. If the sender of the message does not know the current instance number at the far end of the link, this field SHOULD be set to zero. For the RSTACK message, the Receiver Instance field is set to the value of the Sender Instance field from the incoming message that caused the RSTACK message to be generated. 13.2 Procedure The adjacency protocol is described by the following rules and state tables. The rules and state tables use the following operations: o The "Update Peer Verifier" operation is defined as storing the values of the Sender Instance, Sender Port, Sender Name and Partition ID fields from a SYN or SYNACK message received from the entity at the far end of the link. o The procedure "Reset the link" is defined as: 1. Generate a new instance number for the link 2. Delete the peer verifier (set to zero the values of Sender Instance, Sender Port, and Sender Name previously stored by the Update Peer Verifier operation) 3. Send a SYN message 4. Enter the SYNSENT state. o The state tables use the following Boolean terms and operators: A The Sender Instance in the incoming message matches the value stored from a previous message by the "Update Peer Verifier" operation. Doria Expires March 3, 2006 [Page 85] Internet-Draft GSMPv3 August 2005 B The Sender Instance, Sender Port, Sender Name and Partition ID fields in the incoming message match the values stored from a previous message by the "Update Peer Verifier" operation. C The Receiver Instance, Receiver Port, Receiver Name and Partition ID fields in the incoming message match the values of the Sender Instance, Sender Port, Sender Name and Partition ID currently sent in outgoing SYN, SYNACK, and ACK messages. "&&" Represents the logical AND operation "||" Represents the logical OR operation "!" Represents the logical negation (NOT) operation. o A timer is required for the periodic generation of SYN, SYNACK, and ACK messages. The value of the timer is announced in the Timer field. The period of the timer is unspecified but a value of one second is suggested. There are two independent events: the timer expires, and a packet arrives. The processing rules for these events are: Timer Expires: Reset Timer If state = SYNSENT Send SYN If state = SYNRCVD Send SYNACK If state = ESTAB Send ACK Packet Arrives: If incoming message is an RSTACK: If (A && C && !SYNSENT) Reset the link Else discard the message. If incoming message is a SYN, SYNACK, or ACK: Response defined by the following State Tables. If incoming message is any other GSMP message and state != ESTAB: Discard incoming message. If state = SYNSENT Send SYN (Note 1) If state = SYNRCVD Send SYNACK (Note 1) Note 1: No more than two SYN or SYNACK messages should be sent within any time period of length defined by the timer. o State synchronization across a link is considered to be achieved when the protocol reaches the ESTAB state. All GSMP messages, other than adjacency protocol messages, that are received before synchronization is achieved, will be discarded. Doria Expires March 3, 2006 [Page 86] Internet-Draft GSMPv3 August 2005 13.2.1 State Tables State: SYNSENT +===================================================================+ | Condition | Action | New State | +=================+=====================================+===========+ | SYNACK && C | Update Peer Verifier; Send ACK | ESTAB | +-----------------+-------------------------------------+-----------+ | SYNACK && !C | Send RSTACK | SYNSENT | +-----------------+-------------------------------------+-----------+ | SYN | Update Peer Verifier; Send SYNACK | SYNRCVD | +-----------------+-------------------------------------+-----------+ | ACK | Send RSTACK | SYNSENT | +===================================================================+ State: SYNRCVD +===================================================================+ | Condition | Action | New State | +=================+=====================================+===========+ | SYNACK && C | Update Peer Verifier; Send ACK | ESTAB | +-----------------+-------------------------------------+-----------+ | SYNACK && !C | Send RSTACK | SYNRCVD | +-----------------+-------------------------------------+-----------+ | SYN | Update Peer Verifier; Send SYNACK | SYNRCVD | +-----------------+-------------------------------------+-----------+ | ACK && B && C | Send ACK | ESTAB | +-----------------+-------------------------------------+-----------+ |ACK && !(B && C) | Send RSTACK | SYNRCVD | +===================================================================+ State: ESTAB +===================================================================+ | Condition | Action | New State | +=================+=====================================+===========+ | SYN || SYNACK | Send ACK (note 2) | ESTAB | +-----------------+-------------------------------------+-----------+ | ACK && B && C | Send ACK (note 3) | ESTAB | +-----------------+-------------------------------------+-----------+ |ACK && !(B && C) | Send RSTACK | ESTAB | +===================================================================+ Doria Expires March 3, 2006 [Page 87] Internet-Draft GSMPv3 August 2005 Note 2: No more than two ACKs should be sent within any time period of length defined by the timer. Thus, one ACK MUST be sent every time the timer expires. In addition, one further ACK may be sent between timer expirations if the incoming message is a SYN or SYNACK. This additional ACK allows the adjacency protocol to reach synchronization more quickly. Note 3: No more than one ACK should be sent within any time period of length defined by the timer. Figure 77 13.3 Partition Information State Each instance of a [switch controller-switch partition] pair will need to establish adjacency synchronization independently. Part of the process of establishing synchronization when using partition will be to establish the assignment of partition identifiers. The following scenarios are provided for: o A controller can request a specific partition ID by setting the PType to Fixed Partition Request. o A controller can let the switch decide whether it wants to assign a fixed partition ID or not, by setting the PType to No Partition. o A switch can assign the specific Partition ID to the session by setting the PType to Fixed Partition Assigned. A switch can specify that no partitions are handled in the session by setting the PType to No Partition. The assignment is determined by the following behaviour: o An adjacency message from a controller with PType = 1 and Code = SYN SHOULD be treated as a partition request. o An adjacency message from a switch with PType = 2 and Code = SYN SHOULD be treated as a partition assignment. o An adjacency message from a controller or a switch with PType = 2 and Code = (SYNACK || ACK) SHOULD be treated as a success response, the partition is assigned. o An adjacency message from a controller with PType = 0 and Code = SYN indicates that the controller has not specified if it requests partitions or not. o An adjacency message from a switch with PType = 0 and Code = SYN indicates that the switch does not support partitions. o An adjacency message from a controller or a switch with PType = 0 and Code = (SYNACK || ACK) indicates that the session does not support partitions. o An adjacency message from a controller or a switch with PType = (1 || 2) and Code = RSTACK indicates that requested Partition ID is unavailable. Doria Expires March 3, 2006 [Page 88] Internet-Draft GSMPv3 August 2005 o An adjacency message from a controller or a switch with PType = 0 and Code = RSTACK indicates that an unidentified error has occurred. The session MUST be reset. All other combinations of PType and Code are undefined in this version of GSMP. 13.4 Loss of Synchronisation If after synchronization is achieved, no valid GSMP messages are received in any period of time in excess of three times the value of the Timer field announced in the incoming adjacency protocol messages, loss of synchronization may be declared. While re-establishing synchronization with a controller, a switch SHOULD maintain its connection state, deferring the decision about resetting the state until after synchronization is re-established. Once synchronization is re-established the decision about resetting the connection state SHOULD be made on the following basis: o If PFLAG = 1, then a new adjacency has been established and the state SHOULD be reset o If PFLAG = 2, then adjacency has been re-established and the connection state SHOULD be retained. Verification that controller and connection state are the same is the responsibility of the controller. 13.5 Multiple Controllers per switch partition Multiple switch controllers may jointly control a single switch partition. The controllers may control a switch partition either in a primary/standby fashion or as part of multiple controllers providing load-sharing for the same partition. It is the responsibility of the controllers to co-ordinate their interactions with the switch partition. In order to assist the controllers in tracking multiple controller adjacencies to a single switch partition, the Adjacency Update message is used to inform a controller that there are other controllers interacting with the same partition. It should be noted that the GSMP does not include features that allow the switch to co-ordinate cache synchronization information among controllers. The switch partition will service each command it receives in turn as if it were interacting with a single controller. Controller implementations without controller entity synchronization SHOULD NOT use multiple controllers with a single switch partition. Doria Expires March 3, 2006 [Page 89] Internet-Draft GSMPv3 August 2005 13.5.1 Multiple Controller Adjacency Process The first adjacency for a specific partition is determined by the procedures described in section 11.2 and an Adjacency Update message will be sent. The next adjacencies to the partition are identified by a new partition request with the same Partition ID as the first one but with the different Sender Name. Upon establishing adjacency the Adjacency count will be increased and an Adjacency Update message will be sent. When adjacency between one partition and a controller is lost, the adjacency count will be decremented and an Adjacency Update message will be sent. Example: A switch partition has never been used. When the first controller (A) achieves adjacency, an adjacency count will be initiated and (A) will get an Adjacency Update message about itself with Code field = 1. Since (A) receives an adjacency count of 1 this indicates that it is the only controller for that partition. When a second adjacency (B), using the same Partition ID, achieves adjacency, the adjacency counter will be increased by 1. Both (A) and (B) will receive an Adjacency Update message indicating an adjacency count of 2 in the Code field. Since the count is greater than 1, this will indicate to both (A) and (B) that there is another controller interacting with the switch; identification of the other controller will not be provided by GSMP, but will be the responsibility of the controllers. If (A) looses adjacency, the adjacency count will be decreased and an Adjacency Update message will be sent to (B) indicating an adjacency count of 1 in the Code field. If (B) leaves as well, the partition is regarded as idle and the adjacency count may be reset. 14. Failure Response Codes 14.1 Description of Failure and Warning Response Messages A failure response message is formed by returning the request message that caused the failure with the Result field in the header indicating failure (Result = 4) and the Code field giving the failure code. The failure code specifies the reason for the switch being unable to satisfy the request message. A warning response message is a success response (Result = 3) with the Code field specifying the warning code. The warning code specifies a warning that was generated during the successful Doria Expires March 3, 2006 [Page 90] Internet-Draft GSMPv3 August 2005 operation. If the switch issues a failure response in reply to a request message, no change should be made to the state of the switch as a result of the message causing the failure. (For request messages that contain multiple requests, such as the Delete Branches message, the failure response message will specify which requests were successful and which failed. The successful requests may result in a changed state.) If the switch issues a failure response it MUST choose the most specific failure code according to the following precedence: o Invalid Message o General Message Failure o Specific Message Failure A failure response specified in the text defining the message type. o Connection Failures o Virtual Path Connection Failures o Multicast Failures o QoS Failures o General Failures o Warnings If multiple failures match in any of the following categories, the one that is listed first should be returned. The following failure response messages and failure and warning codes are defined: 14.1.1 Invalid Message 3: The specified request is not implemented on this switch. The Message Type field specifies a message that is not implemented on the switch or contains a value that is not defined in the version of the protocol running in this session of GSMP. 4: One or more of the specified ports does not exist. At least one of the ports specified in the message is invalid. A port is invalid if it does not exist or if it has been removed from the switch. 5: Invalid Port Session Number. The value given in the Port Session Number field does not match the current Port Session Number for the specified port. 7: Invalid Partition ID The value given in the Partition ID field is not legal for this partition. 14.1.2 General Message Failure 10: The meaning of this failure is dependent upon the particular message type and is specified in the text defining the message. Doria Expires March 3, 2006 [Page 91] Internet-Draft GSMPv3 August 2005 14.1.3 Specific Message Failure - A failure response that is only used by a specific message type - Failure response messages used by the Label Range message 40: Cannot support one or more requested label ranges. 41: Cannot support disjoint label ranges. 42: Specialized multipoint labels not supported. - Failure response messages used by the Set Transmit Data Rate function of the Port Management message 43: The transmit data rate of this output port cannot be changed. 44: Requested transmit data rate out of range for this output port. The transmit data rate of the requested output port can be changed, but the value of the Transmit Data Rate field is beyond the range of acceptable values. - Failure response message of the Port Management message 45: Connection Replace mechanism not supported on switch. The R-flag SHOULD be reset in the Response Port Management message. - Failure response message range reserved for the ARM extension 128-159: These failure response codes will be interpreted according to definitions provided by the model description. 14.1.4 Connection Failures 11: The specified connection does not exist. An operation that expects a connection to be specified cannot locate the specified connection. A connection is specified by the input port and input label on which it originates. 12: The specified branch does not exist. An operation that expects a branch of an existing connection to be specified cannot locate the specified branch. A branch of a connection is specified by the connection it belongs to and the output port and output label on which it departs. 13: One or more of the specified Input Labels is invalid. 14: One or more of the specified Output Labels is invalid. 15: Point-to-point bi-directional connection already exists. The connection specified by the Input Port and Input Label fields already exists, and the bi-directional Flag in the Flags field is set. 16: Invalid Service Selector field in a Connection Management message. The value of the Service Selector field is invalid. 17: Insufficient resources for QoS Profile. The resources requested by the QoS Profile in the Service Selector field are not available. Doria Expires March 3, 2006 [Page 92] Internet-Draft GSMPv3 August 2005 18: Insufficient Resources. Switch resources needed to establish a branch are not available. 20: Reservation ID out of Range The numerical value of Reservation ID is greater than the value of Max Reservations (from the Switch Configuration message). 21: Mismatched reservation ports The value of Input Port differs from the input port specified in the reservation or the value of Output Port differs from the output port specified in the reservation. 22: Reservation ID in use The value of Reservation ID matches that of an extant Reservation. 23: Non-existent reservation ID No reservation corresponding to Reservation ID exists. 36: Replace of connection is not activated on switch. Only applicable for Add Branch messages. The Replace Connection mechanism has not been activated on port by the Port Management message. 37: Connection replacement mode cannot be combined with Bi- directional or Multicast mode. The R flag MUST NOT be used in conjunction with either the M flag or the B flag. 14.1.5 Virtual Path Connections 24: Virtual path switching is not supported on this input port. 25: Point-to-multipoint virtual path connections are not supported on either the requested input port or the requested output port. One or both of the requested input and output ports is unable to support point-to-multipoint virtual path connections. 26: Attempt to add an virtual path connection branch to an existing virtual channel connection. It is invalid to mix branches switched as virtual channel connections with branches switched as virtual path connections on the same point-to-multipoint connection. 27: Attempt to add an virtual channel connection branch to an existing virtual path connection. It is invalid to mix branches switched as virtual channel connections with branches switched as virtual path connections on the same point-to- multipoint connection. 28: Virtual path switching is not supported on this port. One or both of the requested input and output ports is not an port that support virtual paths. 14.1.6 Multicast Failures 29: A branch belonging to the specified point-to-multipoint connection is already established on the specified output port and the switch cannot support more than a single branch of any point-to-multipoint connection on the same output port. Doria Expires March 3, 2006 [Page 93] Internet-Draft GSMPv3 August 2005 30: The limit on the maximum number of multicast connections that the switch can support has been reached. 31: The limit on the maximum number of branches that the specified multicast connection can support has been reached. 32: Cannot label each output branch of a point-to-multipoint tree with a different label. Some switch designs, require all output branches of a point-to-multipoint connection to use the same value of Label. 33: Cannot add multi-point branch to bi-directional connection. It is an error to attempt to add an additional branch to an existing connection with the bi-directional flag set. 34: Unable to assign the requested Label value to the requested branch on the specified multicast connection. Although the requested Labels are valid, the switch is unable to support the request using the specified Label values for some reason not covered by the above failure responses. This message implies that a valid value of Labels exists that the switch could support. For example, some switch designs restrict the number of distinct Label values available to a multicast connection. (Most switch designs will not require this message.) 35: General problem related to the manner in which multicast is supported by the switch. Use this message if none of the more specific multicast failure messages apply. (Most switch designs will not require this message.) 14.1.7 QoS Failures 60-79 : These failure response codes will be interpreted according to definitions provided by the model description. 80: Switch does not support different QoS parameters for different branches within a multipoint connection. 14.1.8 General Failures 2: Invalid request message. There is an error in one of the fields of the message not covered by a more specific failure message. 6: One or more of the specified ports is down. A port is down if its Port Status is Unavailable. Connection Management, Connection State, Port Management, and Configuration operations are permitted on a port that is Unavailable. Connection Activity and Statistics operations are not permitted on a port that is Unavailable and will generate this failure response. A Port Management message specifying a Take Down function on a port already in the Unavailable state will also generate this failure response. Doria Expires March 3, 2006 [Page 94] Internet-Draft GSMPv3 August 2005 19: Out of resources. The switch has exhausted a resource not covered by a more specific failure message, for example, running out of memory. 1: Unspecified reason not covered by other failure codes. The failure message of last resort. 14.1.9 Warnings 46 : One or more labels are still used in the previous Label Range. 15. Summary of Failure Response Codes and Warnings The following list gives a summary of the failure codes defined for failure response messages: 1: Unspecified reason not covered by other failure codes. 2: Invalid request message. 3: The specified request is not implemented on this switch. 4: One or more of the specified ports does not exist. 5: Invalid Port Session Number. 6: One or more of the specified ports is down. 7: Invalid Partition ID. 10: General message failure. (The meaning of this failure code depends upon the Message Type. It is defined within the description of any message that uses it.) 11: The specified connection does not exist. 12: The specified branch does not exist. 13: One or more of the specified Input Labels is invalid. 14: One or more of the specified Output Labels is invalid. 15: Point-to-point bi-directional connection already exists. 16: Invalid service selector field in a connection management message. 17: Insufficient resources for QoS profile. 18: Insufficient resources. 19: Out of resources (e.g., memory exhausted, etc.). 20: Reservation ID out of Range 21: Mismatched reservation ports 22: Reservation ID in use 23: Non-existent reservation ID 24: virtual path switching is not supported on this input port. 25: Point-to-multipoint virtual path connections are not supported on either the requested input port or the requested output port. 26: Attempt to add an virtual path connection branch to an existing virtual channel connection. 27: Attempt to add an virtual channel connection branch to an existing virtual path connection. 28: Virtual Path switching is not supported port. Doria Expires March 3, 2006 [Page 95] Internet-Draft GSMPv3 August 2005 29: A branch belonging to the specified point-to-multipoint connection is already established on the specified output port and the switch cannot support more than a single branch of any point- to-multipoint connection on the same output port. 30: The limit on the maximum number of point-to-multipoint connections that the switch can support has been reached. 31: The limit on the maximum number of branches that the specified point-to-multipoint connection can support has been reached. 32: Cannot label each output branch of a point-to-multipoint tree with a different label 33: Cannot add multi-point branch to bi-directional connection. 34: Unable to assign the requested Label value to the requested branch on the specified point-to-multipoint connection. 35: General problem related to the manner in which point-to- multipoint is supported by the switch. 36: Replace of connection is not activated on switch. 37: Connection replacement mode cannot be combined with Bi- directional or Multicast mode. 40: Cannot support one or more requested label ranges. 41: Cannot support disjoint label ranges. 42: Specialized multipoint labels not supported. 43: The transmit data rate of this output port cannot be changed. 44: Requested transmit data rate out of range for this output port. 45: Connection Replace mechanism not supported on switch. 46: Labels are still used in the existing Label Range. 60-79: Reserved for QoS failures. 80: Switch does not support different QoS parameters for different branches within a multipoint connection. 128-159: Reserved for the ARM extensions. 16. Security Considerations The security of GSMP's TCP/IP control channel has been addressed in [refs.rfc3293]. For all uses of GSMP over an IP network it is REQUIRED that GSMP be run over TCP/IP using the security considerations discussed in [refs.rfc3293]. [[Ed. Note: There has been a request for the addition of a security TLV and for the relaxation of the requirements using RFC3293 requirements]] 17. Change Log 17.1 Changes since RFC 3292 1. Created base spec by removing all technology specific information. This will be put into another document 2. Changed from 8 bit Version number to 4 Version and 4 bit Subversion Doria Expires March 3, 2006 [Page 96] Internet-Draft GSMPv3 August 2005 17.2 Changes since draft-ietf-gsmpv3-base-00 1. Decreased size of results field to 1 byte 2. Increase size of Code Fields to 3 bytes 3. Partitioned message code space for Base Spec, Packet Switch, L2 Switch, Optical Switch, and TDM Switch 4. Defined label type ranges to cover Base Spec, Packet Switch, L2 Switch, Optical Switch, and TDM Switch 5. Generalized discussions for port that support virtual path 6. Generalized discussion of connection merge functionality 7. Restored section on traffic control flags 8. Defined ranges for service types according to switch type 17.3 Changes since draft-ietf-gsmpv3-base-01 1. Added MSG 24 - Triggered Add 2. Added MSG 25 - Block Add 3. Generalized Capability Set definition for technology specific use. 4. Remove VPI specific text in Report Connection State MSG. 5. Removed reference to static partitions and added mention of Partition Manager notifying switch and controller of partition resource changes 17.4 Changes since draft-ietf-gsmpv3-base-02 1. Modified transaction identifier to indicate whether it originates in the controller or the switch. 2. Per 3.1.1 of the requirements spec deprecated the More result flag 3. Per 2.9 of the requirements steps removed restriction against use of the Replace bit with the Multicast of bi-directional bit. Altered the requirement for Diagnostic message 37 from a MUST to a MAY. This will allow backward compatibility with stitches that do not support simultaneous use of the R flag with either the M or B flag. 4. Per 2.7.2 of the requirements spec added Bulk Transaction message 13. 5. Per 2.8 of the requirements doc added reservation semantics to the connection messages, the port management message. Added a recovery alarm message. I don't think this is finished yet, but wanted to get opinions and wanted to give editors of the technology specific docs a chance to begin to work with the new structures. One thing that has not been added yet are error messages. Also a recovery status function probably needs to be added. But there were so many changes already at this point I did not want to hold up issuing the draft while working on those issues. 6. Added reservation set message Doria Expires March 3, 2006 [Page 97] Internet-Draft GSMPv3 August 2005 7. Further defined delete reservation behavior to discuss deletion of sets 8. Modified port management message to use extended technology specific functions 17.5 Changes since draft-ietf-gsmpv3-base-03 1. Added Extension TLV to configuration messages 2. Corrected Capability Set definitions 3. Move bulk message to before the Service model description. 17.6 changes since draft-ietf-gsmpv3-base-04 1. change Label TLV * changed length of label type to 16 bits * added 16 bit adaptation type to TLV header 2. changed definition of general adaptation parameter to identify special handling to be given to label adaptations. meaning of opaque bit remains the same. All other behavior to be defined in technology specific documents. 3. added section to port configuration record message to display possible adaptation types 17.7 changes since draft-ietf-gsmpv3-base-05 Version -06 was just a re-dating revision. 17.8 changes since draft-ietf-gsmpv3-base-06 1. Minor cosmetic changes 2. Fixed packet description inconsistencies 3. Update IPR statement to meet requirements 4. Added editor's notes to several requests for changes that have been submitted 5. Various nits 6. Xrefs fixed 7. Add some Ed Notes relevant to requested changes in protocol Contributors In addition to the authors/editors listed in the heading, many members of the GSMP group have made significant contributions to this specification. This version is also based on the work of A. Doria, F. Hellstrand, K. Sundell, T. Worster who served as editors for the previous version of the GSMPv3 specification. Doria Expires March 3, 2006 [Page 98] Internet-Draft GSMPv3 August 2005 18. References [ituQ922] International Telecommunication Union, "Integrated Services Digital Network (ISDN) Data Link Layer Specification For Frame Mode Bearer Services", ITU-T Recommendation Q.922, 1992. [refs.aftm0121] ATM Forum Technical Committee, "Traffic Management Specification Version 4.1", af-tm-0121.000, 1999. [refs.bisdn.aal] International Telecommunication Union, "B-ISDN ATM Adaptation Layer (AAL) Specification", ITU-T Recommendation I.363, March 1993. [refs.bisdn.aal5] International Telecommunication Union, "B-ISDN ATM Adaptation Layer specification: Type 5 AAL", ITU-T, Recommendation I.363.5, August 1996. [refs.bisdn.atm] International Telecommunication Union, "B-ISDN ATM Layer Specification", ITU-T Recommendation I.361, February 1999. [refs.iana] http://www.iana.org, "IANA Assigned Port Numbers", 2002. [refs.ifType] http://www.iana.org, "IANAifType - MIB DEFINITIONS", January 2001. [refs.ituI233] International Telecommunication Union, "Frame Mode Bearer Services, ISDN frame relaying bearer services and ISDN switching bearer service", ITU-T Recommendation I.233, November 1991. [refs.ituQ933] International Telecommunication Union, "Integrated Services Digital Network (ISDN) Digital Subscriber Signaling System No. 1 (DSS 1) Signaling Specifications For Frame Mode Switched And Permanent Virtual Connection Control And Status Monitoring", ITU-T Recommendation Q.933, 1995. [refs.rfc1987] Newman, P, Edwards, W., Hinden, R., Hoffman, E. Ching Doria Expires March 3, 2006 [Page 99] Internet-Draft GSMPv3 August 2005 Liaw, F., Lyon, T. and G. Minshall, "Ipsilon's General Switch Management Protocol Specification Version 1.1", RFC 1987, August 1996. [refs.rfc2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", RFC 2119, BCP 14, March 1997. [refs.rfc2211] Wroclawski, J., "Specification of the Controlled-Load Network Element Service", RFC 2211, September 1997. [refs.rfc2297] Newman, P., Edwards, W., Hinden, R., Hoffman, E., Ching Liaw, F., Lyon, T. and G. Minshall, "Ipsilon's General Switch Management Protocol Specification Version 2.0", RFC 2297, March 1998. [refs.rfc2434] Narten, T. and H. Alvestrand, "Guidelines for Writing an IANA Considerations Section in RFCs", RFC 2434, BCP 26, October 1998. [refs.rfc3026] Anderson, L., Doolan, P., Feldman, N., Fredette, A. and B. Thomas, "LDP Specification", RFC 3026, January 2001. [refs.rfc3032] Rosen, E., Tappan, D., Fedorkow, G., Rekhter, Y., Farinacci, D., Li, T. and A. Conta, "MPLS Label Stack Encoding", RFC 3032, January 2001. [refs.rfc3034] Conta, A., Doolan, P. and A. Malis, "Use of Label Switching Frame Relay Networks Specification", RFC 3034, January 2001. [refs.rfc3212] Jamoussi, B., Andersson, L., Callon, R., Dantu, R., Wu, L., Doolan, P., Worster, T., Feldman, N., Fredette, A., Girish, M., Gray, E., Heinanen, J., Kilty, T. and A. Malis, "Constraint-Based LSP Setup using LDP", RFC 3212, January 2002. [refs.rfc3293] Worster, T., Doria, A. and J. Buerkle, "General Switch Management Protocol (GSMP) Packet Encapsulations for Asynchronous Transfer Mode (ATM), Ethernet and Doria Expires March 3, 2006 [Page 100] Internet-Draft GSMPv3 August 2005 Transmission Control Protocol (TCP)", RFC 3293, June 2002. [refs.rfc3294] Doria, A. and K. Sundell, "General Switch Management Protocol Applicability", RFC 3294, June 2002. [refs.rfc3295] Sjostrand, H., Buerkle, J. and Srinivasan, B., "Definitions of Managed Objects for the General Switch Management Protocol (GSMP)", RFC 3295, June 2002. Author's Address Avri Doria ETRI Providence 02906 USA Email: avri@acm.org URI: psg.com/~avri Appendix A. Summary of Messages Message Name Message Number Status Connection Management Messages Add Branch .......................16 Triggered Add..................24 ATM Specific - VPC.............26 Delete Tree.......................18 Verify Tree.......................19 Obsoleted Delete All Input..................20 Delete All Output.................21 Delete Branches...................17 Move Output Branch................22 ATM Specific - VPC............27 Move Input Branch.................23 ATM Specific - VPC...........28 Port Management Messages Port Management...................32 Label Range.......................33 State and Statistics Messages Connection Activity...............48 Port Statistics...................49 Connection Statistics.............50 Doria Expires March 3, 2006 [Page 101] Internet-Draft GSMPv3 August 2005 QoS Class Statistics..............51 Reserved Report Connection State...........52 Configuration Messages Switch Configuration..............64 Port Configuration................65 All Ports Configuration...........66 Service Configuration.............67 Reservation Messages Reservation Request...............70 Delete Reservation................71 Delete All Reservations...........72 Recovery Block Reservation........73 Event Messages Port Up...........................80 Port Down.........................81 Invalid Label.....................82 New Port..........................83 Dead Port.........................84 Abstract and Resource Model Extension Messages Reserved..........................200-249 Adjacency Protocol....................10 Required Bulk Transaction Message..............13 Appendix B. IANA Considerations Following the policies outlined in "Guidelines for Writing an IANA Considerations Section in RFCs" (RFC 2434 [refs.rfc2434]), the following name spaces are defined in GSMPv3. o Message Type Name Space [Appendix A] o Label Type Name Space (Section 4.1.3) o Result Name Space (Section 4.1.1) o Failure Response Message Name Space (Section 4.1.5,Section 14) o Adaptation Type Name Space (Section 5) o Model Type Name Space (Section 9.1) o Port Type Name Space (Section 9.2) o Service ID Name Space (Section 12.3) o Traffic Control Name Space (Section 9.4) o Event Flag Name Space (Section 7.1) Doria Expires March 3, 2006 [Page 102] Internet-Draft GSMPv3 August 2005 B.1 Message Type Name Space GSMPv3 divides the name space for Message Types into four ranges. The following are the guidelines for managing these ranges. Message Types 0-99 Message Types in this range are part of the GSMPv3 base protocol. Message types in this range are allocated through an IETF consensus action [refs.rfc2434]. Message Types 100-199 Message Types in this range are Specification Required [refs.rfc2434]. Message Types using this range must be documented in an RFC or other permanent and readily available references. Message Types 200-249 Message Types in this range are Specification Required [refs.rfc2434] and are intended for Abstract and Resource Model Extension Messages. Message Types using this range must be documented in an RFC or other permanent and readily available references. Message Types 250-255 Message Types in this range are reserved for vendor private extensions and are the responsibility of individual vendors. IANA management of this range of the Message Type Name Space is unnecessary. B.2 Label Type Name Space GSMPv3 divides the name space for Label Types into three ranges. The following are the guidelines for managing these ranges. Label Types 0x000-0xAFF Label Types in this range are part of the GSMPv3 base protocol. Label Types in this range are allocated through an IETF consensus action [refs.rfc2434]. Label Types 0xB00-0xEFF Label Types in this range are Specification Required [refs.rfc2434]. Label Types using this range must be documented in an RFC or other permanent and readily available reference. Label Types 0xF00-0xFFF Label Types in this range are reserved for vendor private extensions and are the responsibility of individual vendors. IANA management of this range of the Label Type Name Space is unnecessary. B.3 Result Name Space The following is the guideline for managing the Result Name Space: Doria Expires March 3, 2006 [Page 103] Internet-Draft GSMPv3 August 2005 Result values 0-255 Result values in this range need an expert review, i.e., approval by a Designated Expert is required [refs.rfc2434]. B.4 Failure Response Name Space GSMPv3 divides the name space for Failure Responses into three ranges. The following are the guidelines for managing these ranges: Failure Responses 0-59, 80-127, 160-255 Failure responses in these ranges are part of the GSMPv3 base protocol. Failure Responses in these ranges are allocated through an IETF consensus action [refs.rfc2434]. Failure Responses 60-79, 128-159 Failure responses in these ranges are reserved for vendor private extensions and are the responsibility of individual vendors. IANA management of these ranges of the Failure Response Name Space are unnecessary. B.5 Adaptation Type Name Space GSMPv3 divides the name space for Adaptation Types into two ranges. The following are the guidelines for managing these ranges: Adaptation Type 0x000-0x2FF Adaptation Types in this range are part of the GSMPv3 base protocol. Adaptation Types in this range are allocated through an IETF consensus action [refs.rfc2434]. Adaptation Type 0x300-0xFFF Adaptation Types in this range are allocated by the first come first served principle [refs.rfc2434]. B.6 Model Type Name Space GSMPv3 divides the name space for Model Types into three ranges. The following are the guidelines for managing these ranges: Model Type 0 Model Types in this range are part of the GSMPv3 base protocol. Model Types in this range are allocated through an IETF consensus action [refs.rfc2434]. Model Type 1-200 Model Types in this range are Specification Required [refs.rfc2434]. Message Types using this range must be documented in an RFC or other permanent and readily available references. Model Type 201-255 Model Types in this range are reserved for vendor private extensions and are the responsibility of individual vendors. IANA management of these ranges of the Model Type Name Space are unnecessary. Doria Expires March 3, 2006 [Page 104] Internet-Draft GSMPv3 August 2005 B.7 Port Type Name Space GSMPv3 divides the name space for Port Types into two ranges. The following are the guidelines for managing these ranges: Port Type 0-127 Port Types in this range are part of the GSMPv3 base protocol. Port Types in this range are allocated through an IETF consensus action [refs.rfc2434]. Port Type 128-255 Port Types in this range are Specification Required [refs.rfc2434]. Port Types using this range must be documented in an RFC or other permanent and readily available references. B.8 Service ID Name Space GSMPv3 divides the name space for Service IDs into two ranges. The following are the guidelines for managing these ranges: Service ID 0-1023 Service ID's in this range are part of the GSMPv3 base protocol. Service ID's in this range are allocated through an IETF consensus action [refs.rfc2434]. Service ID 1024-65535 Service ID's in this range are Specification Required [refs.rfc2434]. Service ID's using this range must be documented in an RFC or other permanent and readily available references. B.9 Traffic Control Name Space The following are the guidelines for managing Traffic Control Flags in GSMPv3: All Traffic Control Flags are allocated through an expert review, i.e., approval by a Designated Expert [refs.rfc2434]. B.10 Event Flag Name Space The following are the guidelines for managing Event Flags in GSMPv3: All Event Flags are allocated through an expert review, i.e., approval by a Designated Expert [refs.rfc2434]. B.11 TCP Port The TCP port for establishing GSMP connections has been defined as 6068 Doria Expires March 3, 2006 [Page 105] Internet-Draft GSMPv3 August 2005 Intellectual Property Statement The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79. Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org. The IETF has been notified of intellectual property rights claimed in regard to some or all of the specification contained in this document. For more information consult the online list of claimed rights. Disclaimer of Validity This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Copyright Statement Copyright (C) The Internet Society (2005). This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights. Doria Expires March 3, 2006 [Page 106] Internet-Draft GSMPv3 August 2005 Acknowledgment Funding for the RFC Editor function is currently provided by the Internet Society. Doria Expires March 3, 2006 [Page 107]