FD.io VPP  v17.01.1-3-gc6833f8
Vector Packet Processing
memclnt.api
Go to the documentation of this file.
1 /* Hey Emacs use -*- mode: C -*- */
2 /*
3  * Copyright (c) 2015 Cisco and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /*
18  * Create a client registration
19  */
20 manual_print
21 define memclnt_create {
22  i32 ctx_quota; /* requested punt context quota */
23  u32 context; /* opaque value to be returned in the reply */
24  u64 input_queue; /* client's queue */
25  u8 name[64]; /* for show, find by name, whatever */
26  u32 api_versions[8]; /* client-server pairs use as desired */
27 };
28 
29 define memclnt_create_reply {
30  i32 response; /* Non-negative = success */
31  u64 handle; /* handle by which vlib knows this client */
32  u32 index; /* index, used e.g. by API trace replay */
33  u32 context; /* opaque value from the create request */
34  u64 message_table; /* serialized message table in shmem */
35 };
36 
37 /*
38  * Delete a client registration
39  */
40 manual_print
41 define memclnt_delete {
42  u32 index; /* index, used e.g. by API trace replay */
43  u64 handle; /* handle by which vlib knows this client */
44 };
45 
46 define memclnt_delete_reply {
47  i32 response; /* Non-negative = success */
48  u64 handle; /* in case the client wonders */
49 };
50 
51 /*
52  * Client RX thread exit
53  */
54 
55 define rx_thread_exit {
57 };
58 
59 /*
60  * RPC
61  */
62 define rpc_call {
65  u64 function;
69  u8 data[0];
70 };
71 
72 define rpc_reply {
75 };
76 
77 /*
78  * Lookup message-ID base by name
79  */
80 define get_first_msg_id {
83  u8 name[64];
84 };
85 
86 define get_first_msg_id_reply {
91 };
int i32
Definition: types.h:81
unsigned long u64
Definition: types.h:89
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56