src/vlibmemory/memclnt.api

   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 define rx_thread_exit {
  55     u8 dummy;
  56 };
  57
  58 /*
  59  * Client RX thread suspend
  60  */
  61 define memclnt_rx_thread_suspend {
  62     u8 dummy;
  63 };
  64
  65 /*
  66  * Client read timeout
  67  */
  68 define memclnt_read_timeout {
  69     u8 dummy;
  70 };
  71
  72 /*
  73  * RPC
  74  */
  75 autoreply define rpc_call {
  76     u32 client_index;
  77     u32 context;
  78     u64 function;
  79     u8 multicast;
  80     u8 need_barrier_sync;
  81     u8 send_reply;
  82     u8 data[0];
  83 };
  84
  85 /*
  86  * Lookup message-ID base by name
  87  */
  88 define get_first_msg_id {
  89     u32 client_index;
  90     u32 context;
  91     u8 name[64];
  92 };
  93
  94 define get_first_msg_id_reply {
  95     u32 client_index;
  96     u32 context;
  97     i32 retval;
  98     u16 first_msg_id;
  99 };
 100
 101 /*
 102  * Trace the plugin message-id allocator
 103  * so we stand a chance of dealing with different sets of plugins
 104  * at api trace replay time
 105  */
 106
 107 manual_print define trace_plugin_msg_ids
 108 {
 109     u32 client_index;
 110     u32 context;
 111     u8 plugin_name[128];
 112     u16 first_msg_id;
 113     u16 last_msg_id;
 114 };
 115
 116 /*
 117  * Create a socket client registration.
 118  */
 119 define sockclnt_create {
 120     u8 name[64];                /* for show, find by name, whatever */
 121     u32 context;                /* opaque value to be returned in the reply */
 122 };
 123
 124 define sockclnt_create_reply {
 125     i32 response;               /* Non-negative = success */
 126     u64 handle;                 /* handle by which vlib knows this client */
 127     u32 index;                  /* index, used e.g. by API trace replay */
 128     u32 context;                /* opaque value from the create request */
 129 };
 130
 131 /*
 132  * Delete a client registration
 133  */
 134 define sockclnt_delete {
 135     u32 index;                  /* index, used e.g. by API trace replay */
 136     u64 handle;                 /* handle by which vlib knows this client */
 137 };
 138
 139 define sockclnt_delete_reply {
 140     i32 response;               /* Non-negative = success */
 141     u64 handle;                 /* in case the client wonders */
 142 };
 143
 144 /*
 145  * Ask vpp for a memfd shared segment
 146  */
 147 define memfd_segment_create {
 148     u32 client_index;
 149     u32 context;
 150     u64 requested_size;
 151 };
 152
 153 /*
 154  * Reply
 155  */
 156 define memfd_segment_create_reply
 157 {
 158   u32 context;
 159   i32 retval;
 160   u32 master_fd;
 161 };
 162
 163 /*
 164  * Memory client ping / response
 165  * Only sent on inactive connections
 166  */
 167 autoreply define memclnt_keepalive
 168 {
 169   u32 client_index;
 170   u32 context;
 171 };