Generic Autonomic Signaling Protocol Application Program Interface (GRASP API)

The assumption of this document is that any Autonomic Service Agent (ASA) needs to call a GRASP module that handles protocol details (security, sending and listening for GRASP messages, waiting, caching discovery results, negotiation looping, sending and receiving sychronization data, etc.) but understands nothing about individual objectives. So this is a high level abstract API for use by ASAs. Individual language bindings should be defined in separate documents. An assumption of this API is that ASAs may fall into various classes: ASAs that only use GRASP for discovery purposes. ASAs that use GRASP negotiation but only as an initiator (client). ASAs that use GRASP negotiation but only as a responder. ASAs that use GRASP negotiation as an initiator or responder. ASAs that use GRASP synchronization but only as an initiator (recipient). ASAs that use GRASP synchronization but only as a responder and/or flooder. ASAs that use GRASP synchronization as an initiator, responder and/or flooder. The API also assumes that one ASA may support multiple objectives. Nothing prevents an ASA from supporting some objectives for synchronization and others for negotiation. This is a preliminary version. Two particular gaps exist: Authorization of ASAs is out of scope. The Rapid mode of GRASP is not supported.

Wherever a 'timeout' parameter appears, it is an integer expressed in milliseconds. If it is zero, the GRASP default timeout (GRASP_DEF_TIMEOUT, see ) will apply. If no response is received before the timeout expires, the call will fail unless otherwise noted. An 'objective' parameter is a data structure with the following components: name (UTF-8 string) - the objective's name neg (Boolean) - True if objective supports negotiation (default False) synch (Boolean) - True if objective supports synchronization (default False) loop_count (integer) - Limit on negotiation steps etc. (default GRASP_DEF_LOOPCT, see ) value - a specific data structure expressing the value of the objective. The format is language dependent, with the constraint that it can be validly represented in CBOR (default integer = 0). An 'ASA_locator' parameter is a data structure with the following contents: locator - The actual locator, either an IP address or an ASCII string. ifi (integer) - The interface identifier index via which this was discovered - probably no use to a normal ASA expire (system dependent type) - The time on the local system clock when this locator will expire from the cache is_ipaddress (Boolean) - True if the locator is an IP address is_fqdn (Boolean) - True if the locator is an FQDN is_uri (Boolean) - True if the locator is a URI diverted (Boolean) - True if the locator was discovered via a Divert option protocol (integer) - Applicable transport protocol (IPPROTO_TCP or IPPROTO_UDP) port (integer) - Applicable port number In most calls, an 'asa_nonce' parameter is required. It is generated when an ASA registers with GRASP, and any call in which an invalid nonce is presented will fail. It is an up to 24-bit opaque value (for example represented as a uint32_t, depending on the language). It should be unpredictable; a possible implementation is to use the same mechanism that GRASP uses to generate Session IDs . Another possible implementation is to hash the name of the ASA with a locally defined secret key. In some calls, a 'session_nonce' parameter is required. This is an opaque data structure as far as the ASA is concerned, used to identify calls to the API as belonging to a specific GRASP session. In fully threaded implementations this parameter might not be needed, but it is included to act as a session handle if necessary. It will also allow GRASP to detect and ignore malicious calls or calls from timed-out sessions. A possible implementation is to form the nonce from the underlying GRASP Session ID and the source address of the session. Other parameters are described in the following sections.

These functions are used to register an ASA and the objectives that it supports with the GRASP module. If an authorization model is added to GRASP, it would be added here. register_asa() Input parameter: name of the ASA (UTF-8 string) Return parameters: success (Boolean) result if success: asa_nonce (integer) if not success: error message (UTF-8 string) This initialises state in the GRASP module for the calling entity (the ASA). In the case of success, an 'asa_nonce' is returned which the ASA must present in all subsequent calls. In the case of failure, the ASA has not been authorized and cannot operate. deregister_asa() Input parameters: asa_nonce (integer) name of the ASA (UTF-8 string) Return parameters: success (Boolean) result if success: none if not success: error message (UTF-8 string) This removes all state in the GRASP module for the calling entity (the ASA), and deregisters any objectives it has registered. Note that these actions must also happen automatically if an ASA crashes. Note - the ASA name is strictly speaking redundant in this call, but is present for clarity. register_objective() Input parameters: asa_nonce (integer) objective (structure) discoverable (Boolean - default False) Return parameters: success (Boolean) result if success: none if not success: error message (UTF-8 string) This registers an objective that this ASA supports and may modify. The 'objective' becomes a candidate for discovery. However, discovery responses should not be enabled until the ASA calls listen_negotiate() or listen_synchronize(), showing that it is able to act as a responder. This can be overridden by setting the optional parameter 'discoverable' to True, intended for objectives that are only defined for GRASP discovery, and which do not support negotiation or synchronization. The ASA may negotiate the objective or send synchronization or flood data. Registration is not needed if the ASA only wants to receive synchronization or flood data for the objective concerned. This call may be repeated for multiple objectives. deregister_objective() Input parameters: asa_nonce (integer) objective (structure) Return parameters: success (Boolean) result if success: none if not success: error message (UTF-8 string) The 'objective' must have been registered by the calling ASA; if not, this call fails. Otherwise, it removes all state in the GRASP module for the given objective.

discover() Input parameters: asa_nonce (integer) objective (structure) timeout (integer) flush (Boolean - default False) Return parameters: locator_list (structure) This returns a list of discovered 'ASA_locator's for the given objective. If the optional parameter 'flush' is True, any locally cached locators for the objective are deleted first. Otherwise, they are returned immediately. If not, GRASP discovery is performed, and all results obtained before the timeout expires are returned. If no results are obtained, an empty list is returned after the timeout. This should be called in a separate thread if asynchronous operation is required.

request_negotiate() Input parameters: asa_nonce (integer) objective (structure) peer (ASA_locator) timeout (integer) Return parameters: success (Boolean) session_nonce (structure) result if success: objective (structure) if not success: error message (UTF-8 string) This function opens a negotiation session. The 'objective' parameter must include the requested value, and its loop count should be set to a suitable value by the ASA. If not, the GRASP default will apply. The 'peer' parameter is the target node; it must be an 'ASA_locator' as returned by discover(). If the peer is null, GRASP discovery is performed first. If the 'success' parameter is 'true', the negotiation has successfully started. There are then two cases: The 'session_nonce' parameter is null. In this case the negotiation has succeeded (the peer has accepted the request). The returned objective contains the value accepted by the peer. The 'session_nonce' parameter is not null. In this case negotiation must continue. The returned objective contains the first value proffered by the negotiation peer. Note that this instance of the objective must be used in the subsequent negotiation call because it also contains the current loop count. The 'session_nonce' must be presented in all subsequent negotiation steps. This function must be followed by calls to 'negotiate_step' and/or 'negotiate_wait' and/or 'end_negotiate' until the negotiation ends. 'request_negotiate' may then be called again to start a new negotation. If the 'success' parameter is 'false', the negotiation has failed for the reason given in the result parameter. An exponential backoff is recommended before any retry. This should be called in a separate thread if asynchronous operation is required. Special note for the ACP infrastructure ASA: It is likely that this ASA will need to discover and negotiate with its peers in each of its on-link neighbors. It will therefore need to know not only the link-local IP address but also the physical interface and transport port for connecting to each neighbor. One implementation approach to this is to include these details in the 'session_nonce' data structure, which is opaque to normal ASAs. listen_negotiate() Input parameters: asa_nonce (integer) objective (structure) Return parameters: success (Boolean) result if success: session_nonce (structure) if not success: error message (UTF-8 string) requested_objective (structure) This function instructs GRASP to listen for negotiation requests for the given 'objective'. It also enables discovery responses for the objective. It will block waiting for an incoming request, so should be called in a separate thread if asynchronous operation is required. Unless there is an unexpected failure, this call only returns after an incoming negotiation request. When it does so, 'requested_objective' contains the first value requested by the negotiation peer. Note that this instance of the objective must be used in the subsequent negotiation call because it also contains the current loop count. The 'session_nonce' must be presented in all subsequent negotiation steps. This function must be followed by calls to 'negotiate_step' and/or 'negotiate_wait' and/or 'end_negotiate' until the negotiation ends. 'listen_negotiate' may then be called again to await a new negotation. If an ASA is capable of handling multiple negotiations simultaneously, it may call 'listen_negotiate' simultaneously from multiple threads. The API and GRASP implementation must support re-entrant use of the listening state and the negotiation calls. Simultaneous sessions will be distinguished by the threads themselves, the GRASP Session IDs, and the underlying unicast transport sockets. stop_listen_negotiate() Input parameters: asa_nonce (integer) objective (structure) Return parameters: success (Boolean) result if success: null if not success: error message (UTF-8 string) Instructs GRASP to stop listening for negotiation requests for the given objective, i.e., cancels 'listen_negotiate'. Of course, it must be called from a different thread. negotiate_step() Input parameters: asa_nonce (integer) session_nonce (structure) objective (structure) timeout (integer) Return parameters: Exactly as for 'request_negotiate' Executes the next negotation step with the peer. The 'objective' parameter contains the next value being proffered by the ASA in this step. negotiate_wait() Input parameters: asa_nonce (integer) session_nonce (structure) timeout (integer) Return parameters: success (Boolean) result if success: null if not success: error message (UTF-8 string) Delay negotiation session by 'timeout' milliseconds. end_negotiate() Input parameters: asa_nonce (integer) session_nonce (structure) reply (Boolean) reason (UTF-8 string) Return parameters: success (Boolean) result if success: null if not success: error message (UTF-8 string) End the negotiation session. 'reply' = True for accept (successful negotiation), False for decline (failed negotiation). 'reason' = optional string describing reason for decline.

synchronize() Input parameters: asa_nonce (integer) objective (structure) peer (ASA_locator) timeout (integer) Return parameters: success (Boolean) result if success: objective (structure) if not success: error message (UTF-8 string) This call requests the synchronized value of the given 'objective'. If the objective was already flooded, the flooded value is returned immediately in the 'result' parameter. In this case, the 'source' and 'timeout' are ignored. Otherwise, synchronization with a discovered ASA is performed. The 'peer' parameter is an 'ASA_locator' as returned by discover(). If 'peer' is null, GRASP discovery is performed first. This call should be repeated whenever the latest value is needed. Call in a separate thread if asynchronous operation is required. Since this is essentially a read operation, any ASA can use it. Therefore GRASP checks that the calling ASA is registered but the objective doesn't need to be registered by the calling ASA. In the case of failure, an exponential backoff is recommended before retrying. listen_synchronize() Input parameters: asa_nonce (integer) objective (structure) Return parameters: success (Boolean) result if success: null if not success: error message (UTF-8 string) This instructs GRASP to listen for synchronization requests for the given objective, and to respond with the value given in the 'objective' parameter. It also enables discovery responses for the objective. This call is non-blocking and may be repeated whenever the value changes. stop_listen_synchronize() Input parameters: asa_nonce (integer) objective (structure) Return parameters: success (Boolean) result if success: null if not success: error message (UTF-8 string) This call instructs GRASP to stop listening for synchronization requests for the given 'objective', i.e. it cancels a previous listen_synchronize. flood() Input parameters: asa_nonce (integer) objectives (type) Return parameters: success (type) result (type) if success: name (type) if not success: error message (UTF-8 string) This call instructs GRASP to flood the given synchronization objective(s) and their value(s) to all GRASP nodes. The 'objectives' parameter is a list of one or more objectives. Checks that the ASA registered each objective. This call may be repeated whenever any value changes.