src/vnet/osi/osi.h

   1 /*
   2  * Copyright (c) 2015 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  * osi.h: OSI definitions
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #ifndef included_osi_h
  41 #define included_osi_h
  42
  43 #include <vnet/vnet.h>
  44
  45 #define foreach_osi_protocol                    \
  46   _ (null, 0x0)                                 \
  47   _ (x_29, 0x01)                                \
  48   _ (x_633, 0x03)                               \
  49   _ (q_931, 0x08)                               \
  50   _ (q_933, 0x08)                               \
  51   _ (q_2931, 0x09)                              \
  52   _ (q_2119, 0x0c)                              \
  53   _ (snap, 0x80)                                \
  54   _ (clnp, 0x81)                                \
  55   _ (esis, 0x82)                                \
  56   _ (isis, 0x83)                                \
  57   _ (idrp, 0x85)                                \
  58   _ (x25_esis, 0x8a)                            \
  59   _ (iso10030, 0x8c)                            \
  60   _ (iso11577, 0x8d)                            \
  61   _ (ip6, 0x8e)                                 \
  62   _ (compressed, 0xb0)                          \
  63   _ (sndcf, 0xc1)                               \
  64   _ (ip4, 0xcc)                                 \
  65   _ (ppp, 0xcf)
  66
  67 typedef enum
  68 {
  69 #define _(f,n) OSI_PROTOCOL_##f = n,
  70   foreach_osi_protocol
  71 #undef _
  72 } osi_protocol_t;
  73
  74 typedef struct
  75 {
  76   u8 protocol;
  77
  78   u8 payload[0];
  79 } osi_header_t;
  80
  81 typedef struct
  82 {
  83   /* Name (a c string). */
  84   char *name;
  85
  86   /* OSI protocol (SAP type). */
  87   osi_protocol_t protocol;
  88
  89   /* Node which handles this type. */
  90   u32 node_index;
  91
  92   /* Next index for this type. */
  93   u32 next_index;
  94 } osi_protocol_info_t;
  95
  96 #define foreach_osi_error                       \
  97   _ (NONE, "no error")                          \
  98   _ (UNKNOWN_PROTOCOL, "unknown osi protocol")
  99
 100 typedef enum
 101 {
 102 #define _(f,s) OSI_ERROR_##f,
 103   foreach_osi_error
 104 #undef _
 105     OSI_N_ERROR,
 106 } osi_error_t;
 107
 108 typedef struct
 109 {
 110   vlib_main_t *vlib_main;
 111
 112   osi_protocol_info_t *protocol_infos;
 113
 114   /* Hash tables mapping name/protocol to protocol info index. */
 115   uword *protocol_info_by_name, *protocol_info_by_protocol;
 116
 117   /* osi-input next index indexed by protocol. */
 118   u8 input_next_by_protocol[256];
 119 } osi_main_t;
 120
 121 always_inline osi_protocol_info_t *
 122 osi_get_protocol_info (osi_main_t * m, osi_protocol_t protocol)
 123 {
 124   uword *p = hash_get (m->protocol_info_by_protocol, protocol);
 125   return p ? vec_elt_at_index (m->protocol_infos, p[0]) : 0;
 126 }
 127
 128 extern osi_main_t osi_main;
 129
 130 /* Register given node index to take input for given osi type. */
 131 void osi_register_input_protocol (osi_protocol_t protocol, u32 node_index);
 132
 133 format_function_t format_osi_protocol;
 134 format_function_t format_osi_header;
 135 format_function_t format_osi_header_with_length;
 136
 137 /* Parse osi protocol as 0xXXXX or protocol name. */
 138 unformat_function_t unformat_osi_protocol;
 139
 140 /* Parse osi header. */
 141 unformat_function_t unformat_osi_header;
 142 unformat_function_t unformat_pg_osi_header;
 143
 144 void osi_register_input_protocol (osi_protocol_t protocol, u32 node_index);
 145
 146 format_function_t format_osi_header;
 147
 148 #endif /* included_osi_h */
 149
 150 /*
 151  * fd.io coding-style-patch-verification: ON
 152  *
 153  * Local Variables:
 154  * eval: (c-set-style "gnu")
 155  * End:
 156  */