src/vnet/tcp/tcp.api

   1 /*
   2  * Copyright (c) 2015-2019 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 = "1.0.0";
  17
  18 /** \brief Configure TCP source addresses, for active-open TCP sessions
  19
  20     TCP src/dst ports are 16 bits, with the low-order 1024 ports
  21     reserved. So, it's necessary to provide a considerable number of
  22     source IP addresses if one wishes to initiate a large number of
  23     connections.
  24
  25     Each of those addresses needs to have a receive adjacency -
  26     either a /32 or a /128 - and vpp needs to answer (proxy) arps or
  27     neighbor discovery requests for the addresses.
  28
  29     @param client_index - opaque cookie to identify the sender
  30     @param context - sender context, to match reply w/ request
  31     @param is_ipv6 - 1 for ipv6, 0 for ipv4
  32     @param vrf_id - fib table / vrf id for local adjacencies
  33     @param first_address - first address that TCP will use
  34     @param last_address - last address that TCP will use
  35 */
  36 autoreply define tcp_configure_src_addresses {
  37     u32 client_index;
  38     u32 context;
  39     u8 is_ipv6;
  40     u32 vrf_id;
  41     u8 first_address[16];
  42     u8 last_address[16];
  43  };
  44