Internet Engineering Task Force | J. Hadi Salim |
Internet-Draft | Mojatatu Networks |
Intended status: Informational | March 17, 2014 |
Expires: September 18, 2014 |
ForCES Protocol Extensions
draft-ietf-forces-protoextension-01
Experience in implementing and deploying ForCES architecture has demonstrated need for a few small extensions both to ease programmability and to improve wire efficiency of some transactions. This document describes extensions to the ForCES Protocol Specification[RFC 5810] semantics to achieve that end goal.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
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."
This Internet-Draft will expire on September 18, 2014.
Copyright (c) 2014 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].
This document reiterates the terminology defined by the ForCES architecture in various documents for the sake of clarity.
Experience in implementing and deploying ForCES architecture has demonstrated need for a few small extensions both to ease programmability and to improve wire efficiency of some transactions. This document describes a few extensions to the ForCES Protocol Specification [RFC5810] semantics to achieve that end goal.
This document describes and justifies the need for 2 small extensions which are backward compatible. The document also clarifies on top of [RFC5810] how dumping of large components is achieved.
In this section we present sample use cases to illustrate the challenge being addressed.
Consider, for the sake of illustration, an FE table with 1 million reasonably sized table rows which are sparsely populated. Assume, again for the sake of illustration, that there are 2000 table rows sparsely populated between the row indices 23-10023.
ForCES GET and DEL requests sent from a controller (or control app) are prepended with a path to a component and sent to the FE. In the case of indexed tables, the component path can either be to a table or a table row index. The approaches for retrieving or deleting a sizeable number of table rows is at the programmatically level (from an application point of view) unfriendly, tedious, and abusive of both compute and bandwidth resources.
As an example, a control application attempting to retrieve the first 2000 table rows appearing between row indices 23 and 10023 can achieve its goal in one of:
As argued, while the above options exist - all are tedious.
[RFC5810] has defined a generic set of error codes that are to be returned to the CE from an FE. Deployment experience has shown that it would be useful to have more fine grained error codes. As an example, the error code E_NOT_SUPPORTED could be mapped to many FE error source possibilities that need to be then interpreted by the caller based on some understanding of the nature of the sent request. This makes debugging more time consuming.
This section describes proposals to update the protocol for issues discussed in Section 3
We propose to add a Table-range TLV (type ID 0x117) that will be associated with the PATH-DATA TLV in the same manner the KEYINFO-TLV is.
+---------------------+---------------------+ | Type (0x117) | Length | +---------------------+---------------------+ | Start Index | +-------------------------------------------+ | End Index | +-------------------------------------------+
Figure 1: ForCES table range request Layout
Figure 1 shows how this new TLV is constructed.
OPER = GET PATH-DATA: flags = F_SELTABRANGE, IDCount = 2, IDs = {1,6} TABLERANGE-TLV content = {11,23}
Figure 2: ForCES table range request
Figure 2 illustrates a GET request for a range of rows 11 to 23 of a table with component path of "1/6".
Path flag of F_SELTABRANGE (0x2 i.e bit 1, where bit 0 is F_SELKEY as defined in RFC 5810) is set to indicate the presence of the TABLERANGE-TLV. The pathflag bit F_SELTABRANGE can only be used in a GET or DEL and is mutually exclusive with F_SELKEY. The FE MUST enforce those constraints and reject a request with an error code of E_INVALID_TFLAGS with a description of what the problem is (refer to Section 4.2).
The TABLERANGE-TLV contents constitute:
The response for a table range query will either be:
We propose several things:
EXTENDEDRESULT-TLV Result Value is 32 bits and is a superset of RFC 5810 Result TLV Result Value. The new version code space is 32 bits as opposed to the RFC 5810 code size of 8 bits.
Code | Mnemonic | Details |
---|---|---|
0x100 | E_EMPTY | Table is empty |
0x101 | E_INVALID_TFLAGS | Invalid table flags |
0x102 | E_INVALID_OP | Requested operation is invalid |
0x103 | E_CONGEST_NT | Node Congestion notification |
0x104 | E_COMPONENT_NOT_A_TABLE | Component not a table |
0x105 | E_PERM | Operation not permitted |
0x107 | E_BUSY | System is Busy |
0x108 | E_TIMED_OUT | A time out occured while processing the message |
0x106 | E_UNKNOWN | A generic catch all error code. Carries a string to further extrapolate what the error implies. |
Codes 0x18-0xFE are reserved for use as vendor codes. Since these are freely available it is expected that the FE and CE side will both understand/interpret the semantics of any used codes.
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 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Type = EXTENDEDRESULT-TLV | Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Result Value | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Optional Cause content | . . | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Figure 3: EXTENDEDRESULT-TLV
XXX: Backward compatibility may require that we add a FEPO capability to advertise ability to do extended results so that the CE is able to interpret the results and a FEPO compatibility flag to define what TLV setting would be used. Alternatively, the backward compatibility can be made a configuration option (which helps reduce clutter on FEPO LFB given that it is expected that in the future it makes sense for implementations to support only EXTENDEDRESULT-TLVs).
Imagine a GET request to a path that is a table i.e a table dump. Such a request is sent to the FE with a specific correlator, say X. Imagine this table to have a large number of entries at the FE. For the sake of illustration, lets say millions of rows. This requires that the FE delivers the response over multiple messages, all using the same correlator X.
RFC 5810 does not describe how a GET response is to indicate "I have more messages coming for this correlator".
Implementation experience indicates we can use the transaction flags to indicate that a GET response is the beginning, middle or end of a multi-part message. In other words we mirror the effect of an atomic transaction sent by a CE to an FE.
XXX: Add in the next update diagram and details of how this takes place.
TBA
This document registers two new top Level TLVs and two new path flags.
The following new TLVs are defined:
The following new path flags are defined:
The Defined Result Values are changed:
TBD
[RFC3746] | Yang, L., Dantu, R., Anderson, T. and R. Gopal, "Forwarding and Control Element Separation (ForCES) Framework", RFC 3746, April 2004. |
[RFC5810] | Doria, A., Hadi Salim, J., Haas, R., Khosravi, H., Wang, W., Dong, L., Gopal, R. and J. Halpern, "Forwarding and Control Element Separation (ForCES) Protocol Specification", RFC 5810, March 2010. |
[RFC5811] | Hadi Salim, J. and K. Ogawa, "SCTP-Based Transport Mapping Layer (TML) for the Forwarding and Control Element Separation (ForCES) Protocol", RFC 5811, March 2010. |
[RFC5812] | Halpern, J. and J. Hadi Salim, "Forwarding and Control Element Separation (ForCES) Forwarding Element Model", RFC 5812, March 2010. |
[RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. |