src/vnet/devices/virtio/vhost_user.api

   1 /*
   2  * Copyright (c) 2015-2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 option version = "2.0.0";
  17
  18 /** \brief vhost-user interface create request
  19     @param client_index - opaque cookie to identify the sender
  20     @param is_server - our side is socket server
  21     @param sock_filename - unix socket filename, used to speak with frontend
  22     @param use_custom_mac - enable or disable the use of the provided hardware address
  23     @param disable_mrg_rxbuf - disable the use of merge receive buffers
  24     @param disable_indirect_desc - disable the use of indirect descriptors which driver can use
  25     @param mac_address - hardware address to use if 'use_custom_mac' is set
  26 */
  27 define create_vhost_user_if
  28 {
  29   u32 client_index;
  30   u32 context;
  31   u8 is_server;
  32   u8 sock_filename[256];
  33   u8 renumber;
  34   u8 disable_mrg_rxbuf;
  35   u8 disable_indirect_desc;
  36   u32 custom_dev_instance;
  37   u8 use_custom_mac;
  38   u8 mac_address[6];
  39   u8 tag[64];
  40 };
  41
  42 /** \brief vhost-user interface create response
  43     @param context - sender context, to match reply w/ request
  44     @param retval - return code for the request
  45     @param sw_if_index - interface the operation is applied to
  46 */
  47 define create_vhost_user_if_reply
  48 {
  49   u32 context;
  50   i32 retval;
  51   u32 sw_if_index;
  52 };
  53
  54 /** \brief vhost-user interface modify request
  55     @param client_index - opaque cookie to identify the sender
  56     @param is_server - our side is socket server
  57     @param sock_filename - unix socket filename, used to speak with frontend
  58 */
  59 autoreply define modify_vhost_user_if
  60 {
  61   u32 client_index;
  62   u32 context;
  63   u32 sw_if_index;
  64   u8 is_server;
  65   u8 sock_filename[256];
  66   u8 renumber;
  67   u32 custom_dev_instance;
  68 };
  69
  70 /** \brief vhost-user interface delete request
  71     @param client_index - opaque cookie to identify the sender
  72 */
  73 autoreply define delete_vhost_user_if
  74 {
  75   u32 client_index;
  76   u32 context;
  77   u32 sw_if_index;
  78 };
  79
  80 /** \brief Vhost-user interface details structure (fix this)
  81     @param sw_if_index - index of the interface
  82     @param interface_name - name of interface
  83     @param virtio_net_hdr_sz - net header size
  84     @param features - interface features
  85     @param is_server - vhost-user server socket
  86     @param sock_filename - socket filename
  87     @param num_regions - number of used memory regions
  88 */
  89 define sw_interface_vhost_user_details
  90 {
  91   u32 context;
  92   u32 sw_if_index;
  93   u8 interface_name[64];
  94   u32 virtio_net_hdr_sz;
  95   u64 features;
  96   u8 is_server;
  97   u8 sock_filename[256];
  98   u32 num_regions;
  99   i32 sock_errno;
 100 };
 101
 102 define sw_interface_vhost_user_dump
 103 {
 104   u32 client_index;
 105   u32 context;
 106 };
 107 /*
 108  * Local Variables:
 109  * eval: (c-set-style "gnu")
 110  * End:
 111  */