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   int socket;
  26   struct sockaddr_in tx_addr;
  27 } mc_multicast_socket_t;
  28
  29 /* TCP catchup socket */
  30 typedef struct {
  31   int socket;
  32   u32 unix_file_index;
  33
  34   u8 * input_vector;
  35   u8 * output_vector;
  36   u32 output_vector_n_written;
  37
  38   u32 connect_in_progress;
  39 } mc_socket_catchup_t;
  40
  41 typedef struct mc_socket_main_t {
  42   mc_main_t mc_main;
  43
  44   /* Multicast mastership/to-relay/from-relay sockets. */
  45   mc_multicast_socket_t multicast_sockets[MC_N_TRANSPORT_TYPE];
  46
  47   /* Unicast UDP ack sockets */
  48   int ack_socket;
  49
  50   /* TCP catchup server socket */
  51   int catchup_server_socket;
  52
  53   /* Pool of stream-private catchup sockets */
  54   mc_socket_catchup_t *catchups;
  55
  56   uword * catchup_index_by_file_descriptor;
  57
  58   u32 rx_mtu_n_bytes;
  59
  60   /* Receive MTU in bytes and VLIB buffers. */
  61   u32 rx_mtu_n_buffers;
  62
  63   /* Vector of RX VLIB buffers. */
  64   u32 * rx_buffers;
  65   /* Vector of scatter/gather descriptors for sending/receiving VLIB buffers
  66      via kernel. */
  67   struct iovec * iovecs;
  68
  69   /* IP address of interface to use for multicast. */
  70   u32 if_ip4_address_net_byte_order;
  71
  72   u32 ack_udp_port;
  73   u32 catchup_tcp_port;
  74
  75   /* Interface on which to listen for multicasts. */
  76   char * multicast_interface_name;
  77
  78   /* Multicast address to use (e.g. 0xefff0000).
  79      Host byte order. */
  80   u32 multicast_tx_ip4_address_host_byte_order;
  81
  82   /* TTL to use for multicasts. */
  83   u32 multicast_ttl;
  84
  85   /* Multicast ports for mastership, joins, etc. will be chosen
  86      starting at the given port in host byte order.
  87      A total of MC_N_TRANSPORT_TYPE ports will be used. */
  88   u32 base_multicast_udp_port_host_byte_order;
  89 } mc_socket_main_t;
  90
  91 always_inline u32
  92 mc_socket_peer_id_get_address (mc_peer_id_t i)
  93 {
  94   u32 a = ((i.as_u8[0] << 24)
  95            | (i.as_u8[1] << 16)
  96            | (i.as_u8[2] << 8)
  97            | (i.as_u8[3] << 0));
  98   return clib_host_to_net_u32 (a);
  99 }
 100
 101 always_inline u32
 102 mc_socket_peer_id_get_port (mc_peer_id_t i)
 103 { return clib_host_to_net_u16 ((i.as_u8[4] << 8) | i.as_u8[5]); }
 104
 105 static_always_inline mc_peer_id_t
 106 mc_socket_set_peer_id (u32 address_net_byte_order, u32 port_host_byte_order)
 107 {
 108   mc_peer_id_t i;
 109   u32 a = ntohl (address_net_byte_order);
 110   u32 p = port_host_byte_order;
 111   i.as_u8[0] = (a >> 24) & 0xff;
 112   i.as_u8[1] = (a >> 16) & 0xff;
 113   i.as_u8[2] = (a >>  8) & 0xff;
 114   i.as_u8[3] = (a >>  0) & 0xff;
 115   i.as_u8[4] = (p >>  8) & 0xff;
 116   i.as_u8[5] = (p >>  0) & 0xff;
 117   i.as_u8[6] = 0;
 118   i.as_u8[7] = 0;
 119   return i;
 120 }
 121
 122 clib_error_t *
 123 mc_socket_main_init (mc_socket_main_t * msm, char **intfc_probe_list,
 124                      int n_intfcs_to_probe);
 125 #endif /* __included_mc_socket_h__ */
 126