vlib-api/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 };
  35
  36 /*
  37  * Delete a client registration
  38  */
  39 manual_print
  40 define memclnt_delete {
  41     u32 index;                  /* index, used e.g. by API trace replay */
  42     u64 handle;               /* handle by which vlib knows this client */
  43 };
  44
  45 define memclnt_delete_reply {
  46     i32 response;               /* Non-negative = success */
  47     u64 handle;               /* in case the client wonders */
  48 };
  49
  50 /*
  51  * Client RX thread exit
  52  */
  53
  54 define rx_thread_exit {
  55     u8 dummy;
  56 };
  57
  58 /*
  59  * RPC
  60  */
  61 define rpc_call {
  62     u32 client_index;
  63     u32 context;
  64     u64 function;
  65     u8 multicast;
  66     u8 need_barrier_sync;
  67     u8 send_reply;
  68     u8 data[0];
  69 };
  70
  71 define rpc_reply {
  72     i32 retval;
  73     u32 context;
  74 };
  75
  76 /*
  77  * Lookup message-ID base by name
  78  */
  79 define get_first_msg_id {
  80     u32 client_index;
  81     u32 context;
  82     u8 name[64];
  83 };
  84
  85 define get_first_msg_id_reply {
  86     u32 client_index;
  87     u32 context;
  88     i32 retval;
  89     u16 first_msg_id;
  90 };