vlib/vlib/unix/mc_socket.h

   1 /*
   2  * mc_socket.h: socket based multicast for vlib mc
   3  *
   4  * Copyright (c) 2010 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef __included_mc_socket_h__
  19 #define __included_mc_socket_h__
  20
  21 #include <vlib/unix/unix.h>
  22 #include <netinet/in.h>
  23
  24 typedef struct
  25 {
  26   int socket;
  27   struct sockaddr_in tx_addr;
  28 } mc_multicast_socket_t;
  29
  30 /* TCP catchup socket */
  31 typedef struct
  32 {
  33   int socket;
  34   u32 unix_file_index;
  35
  36   u8 *input_vector;
  37   u8 *output_vector;
  38   u32 output_vector_n_written;
  39
  40   u32 connect_in_progress;
  41 } mc_socket_catchup_t;
  42
  43 typedef struct mc_socket_main_t
  44 {
  45   mc_main_t mc_main;
  46
  47   /* Multicast mastership/to-relay/from-relay sockets. */
  48   mc_multicast_socket_t multicast_sockets[MC_N_TRANSPORT_TYPE];
  49
  50   /* Unicast UDP ack sockets */
  51   int ack_socket;
  52
  53   /* TCP catchup server socket */
  54   int catchup_server_socket;
  55
  56   /* Pool of stream-private catchup sockets */
  57   mc_socket_catchup_t *catchups;
  58
  59   uword *catchup_index_by_file_descriptor;
  60
  61   u32 rx_mtu_n_bytes;
  62
  63   /* Receive MTU in bytes and VLIB buffers. */
  64   u32 rx_mtu_n_buffers;
  65
  66   /* Vector of RX VLIB buffers. */
  67   u32 *rx_buffers;
  68   /* Vector of scatter/gather descriptors for sending/receiving VLIB buffers
  69      via kernel. */
  70   struct iovec *iovecs;
  71
  72   /* IP address of interface to use for multicast. */
  73   u32 if_ip4_address_net_byte_order;
  74
  75   u32 ack_udp_port;
  76   u32 catchup_tcp_port;
  77
  78   /* Interface on which to listen for multicasts. */
  79   char *multicast_interface_name;
  80
  81   /* Multicast address to use (e.g. 0xefff0000).
  82      Host byte order. */
  83   u32 multicast_tx_ip4_address_host_byte_order;
  84
  85   /* TTL to use for multicasts. */
  86   u32 multicast_ttl;
  87
  88   /* Multicast ports for mastership, joins, etc. will be chosen
  89      starting at the given port in host byte order.
  90      A total of MC_N_TRANSPORT_TYPE ports will be used. */
  91   u32 base_multicast_udp_port_host_byte_order;
  92 } mc_socket_main_t;
  93
  94 always_inline u32
  95 mc_socket_peer_id_get_address (mc_peer_id_t i)
  96 {
  97   u32 a = ((i.as_u8[0] << 24)
  98            | (i.as_u8[1] << 16) | (i.as_u8[2] << 8) | (i.as_u8[3] << 0));
  99   return clib_host_to_net_u32 (a);
 100 }
 101
 102 always_inline u32
 103 mc_socket_peer_id_get_port (mc_peer_id_t i)
 104 {
 105   return clib_host_to_net_u16 ((i.as_u8[4] << 8) | i.as_u8[5]);
 106 }
 107
 108 static_always_inline mc_peer_id_t
 109 mc_socket_set_peer_id (u32 address_net_byte_order, u32 port_host_byte_order)
 110 {
 111   mc_peer_id_t i;
 112   u32 a = ntohl (address_net_byte_order);
 113   u32 p = port_host_byte_order;
 114   i.as_u8[0] = (a >> 24) & 0xff;
 115   i.as_u8[1] = (a >> 16) & 0xff;
 116   i.as_u8[2] = (a >> 8) & 0xff;
 117   i.as_u8[3] = (a >> 0) & 0xff;
 118   i.as_u8[4] = (p >> 8) & 0xff;
 119   i.as_u8[5] = (p >> 0) & 0xff;
 120   i.as_u8[6] = 0;
 121   i.as_u8[7] = 0;
 122   return i;
 123 }
 124
 125 clib_error_t *mc_socket_main_init (mc_socket_main_t * msm,
 126                                    char **intfc_probe_list,
 127                                    int n_intfcs_to_probe);
 128 #endif /* __included_mc_socket_h__ */
 129
 130
 131 /*
 132  * fd.io coding-style-patch-verification: ON
 133  *
 134  * Local Variables:
 135  * eval: (c-set-style "gnu")
 136  * End:
 137  */