X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvlibmemory%2Fmemclnt.api;h=cc37c7c2f8d45f7744d3baa82a799033c1bdf1f4;hb=75282457;hp=c38b483ca0a9efb6f8a8f9e20bd163d5138a4a93;hpb=dfc9b7cac857a3a49555f9fc448bd2c6aa3400a6;p=vpp.git diff --git a/src/vlibmemory/memclnt.api b/src/vlibmemory/memclnt.api index c38b483ca0a..cc37c7c2f8d 100644 --- a/src/vlibmemory/memclnt.api +++ b/src/vlibmemory/memclnt.api @@ -14,23 +14,35 @@ * limitations under the License. */ +option version = "2.0.0"; + +/* + * Define services not following the normal convetions here + */ +service { + rpc memclnt_rx_thread_suspend returns null; + rpc memclnt_read_timeout returns null; + rpc rx_thread_exit returns null; + rpc trace_plugin_msg_ids returns null; +}; + /* * Create a client registration */ manual_print define memclnt_create { - i32 ctx_quota; /* requested punt context quota */ u32 context; /* opaque value to be returned in the reply */ + i32 ctx_quota; /* requested punt context quota */ u64 input_queue; /* client's queue */ u8 name[64]; /* for show, find by name, whatever */ u32 api_versions[8]; /* client-server pairs use as desired */ }; define memclnt_create_reply { + u32 context; /* opaque value from the create request */ i32 response; /* Non-negative = success */ u64 handle; /* handle by which vlib knows this client */ u32 index; /* index, used e.g. by API trace replay */ - u32 context; /* opaque value from the create request */ u64 message_table; /* serialized message table in shmem */ }; @@ -72,19 +84,15 @@ define memclnt_read_timeout { /* * RPC */ -define rpc_call { +autoreply define rpc_call { u32 client_index; u32 context; u64 function; u8 multicast; u8 need_barrier_sync; u8 send_reply; - u8 data[0]; -}; - -define rpc_reply { - i32 retval; - u32 context; + u32 data_len; + u8 data[data_len]; }; /* @@ -103,6 +111,27 @@ define get_first_msg_id_reply { u16 first_msg_id; }; +/* + * Get API version table (includes built-in and plugins) + */ +typeonly define module_version { + u32 major; + u32 minor; + u32 patch; + u8 name[64]; +}; +define api_versions { + u32 client_index; + u32 context; +}; +define api_versions_reply { + u32 client_index; + u32 context; + i32 retval; + u32 count; + vl_api_module_version_t api_versions[count]; +}; + /* * Trace the plugin message-id allocator * so we stand a chance of dealing with different sets of plugins @@ -117,3 +146,58 @@ manual_print define trace_plugin_msg_ids u16 first_msg_id; u16 last_msg_id; }; + +/* + * Create a socket client registration. + */ +define sockclnt_create { + u32 context; /* opaque value to be returned in the reply */ + u8 name[64]; /* for show, find by name, whatever */ +}; + +define sockclnt_create_reply { + u32 context; /* opaque value from the create request */ + i32 response; /* Non-negative = success */ + u64 handle; /* handle by which vlib knows this client */ + u32 index; /* index, used e.g. by API trace replay */ +}; + +/* + * Delete a client registration + */ +define sockclnt_delete { + u32 index; /* index, used e.g. by API trace replay */ + u64 handle; /* handle by which vlib knows this client */ +}; + +define sockclnt_delete_reply { + i32 response; /* Non-negative = success */ + u64 handle; /* in case the client wonders */ +}; + +/* + * Initialize shm api over socket api + */ +autoreply define sock_init_shm { + u32 client_index; + u32 context; + u32 requested_size; + u8 nitems; + u64 configs[nitems]; +}; + +/* define sock_init_shm_reply { + u32 client_index; + u32 context; + i32 retval; +}; */ + +/* + * Memory client ping / response + * Only sent on inactive connections + */ +autoreply define memclnt_keepalive +{ + u32 client_index; + u32 context; +};