summaryrefslogtreecommitdiffstats
path: root/src/vnet/snap/snap.c
blob: 64482bfcfbbf83b641c3e7a3c75ebef46846468b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
 * Copyright (c) 2015 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 * snap.c: snap support
 *
 * Copyright (c) 2010 Eliot Dresselhaus
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#include <vnet/vnet.h>
#include <vnet/snap/snap.h>
#include <vnet/ethernet/ethernet.h>

/* Global main structure. */
snap_main_t snap_main;

static u8 *
format_cisco_snap_protocol (u8 * s, va_list * args)
{
  snap_header_t *h = va_arg (*args, snap_header_t *);
  u16 protocol = clib_net_to_host_u16 (h->protocol);
  char *t = 0;
  switch (protocol)
    {
#define _(n,f) case n: t = #f; break;
      foreach_snap_cisco_protocol;
#undef _
    default:
      break;
    }
  if (t)
    return format (s, "%s", t);
  else
    return format (s, "unknown 0x%x", protocol);
}

u8 *
format_snap_protocol (u8 * s, va_list * args)
{
  snap_header_t *h = va_arg (*args, snap_header_t *);
  u32 oui = snap_header_get_oui (h);
  u16 protocol = clib_net_to_host_u16 (h->protocol);

  switch (oui)
    {
    case IEEE_OUI_ethernet:
      return format (s, "ethernet %U", format_ethernet_type, h->protocol);

    case IEEE_OUI_cisco:
      return format (s, "cisco %U", format_cisco_snap_protocol, h);

    default:
      return format (s, "oui 0x%06x 0x%04x", oui, protocol);
    }
}

u8 *
format_snap_header_with_length (u8 * s, va_list * args)
{
  snap_main_t *sm = &snap_main;
  snap_header_t *h = va_arg (*args, snap_header_t *);
  snap_protocol_info_t *pi = snap_get_protocol_info (sm, h);
  u32 max_header_bytes = va_arg (*args, u32);
  uword indent, header_bytes;

  header_bytes = sizeof (h[0]);
  if (max_header_bytes != 0 && header_bytes > max_header_bytes)
    return format (s, "snap header truncated");

  indent = format_get_indent (s);

  s = format (s, "SNAP %U", format_snap_protocol, h);

  if (max_header_bytes != 0 && header_bytes > max_header_bytes && pi != 0)
    {
      vlib_node_t *node = vlib_get_node (sm->vlib_main, pi->node_index);
      if (node->format_buffer)
	s = format (s, "\n%U%U",
		    format_white_space, indent,
		    node->format_buffer, (void *) (h + 1),
		    max_header_bytes - header_bytes);
    }

  return s;
}

u8 *
format_snap_header (u8 * s, va_list * args)
{
  snap_header_t *h = va_arg (*args, snap_header_t *);
  return format (s, "%U", format_snap_header_with_length, h, 0);
}

/* Returns snap protocol as an int in host byte order. */
uword
unformat_snap_protocol (unformat_input_t * input, va_list * args)
{
  snap_header_t *result = va_arg (*args, snap_header_t *);
  snap_main_t *sm = &snap_main;
  snap_oui_and_protocol_t p;
  u32 i;

  /* Numeric type. */
  if (unformat (input, "0x%x 0x%x", &p.oui, &p.protocol))
    {
      if (p.oui >= (1 << 24))
	return 0;
      if (p.protocol >= (1 << 16))
	return 0;
    }

  /* Named type. */
  else if (unformat_user (input, unformat_vlib_number_by_name,
			  sm->protocol_info_by_name, &i))
    {
      snap_protocol_info_t *pi = vec_elt_at_index (sm->protocols, i);
      p = pi->oui_and_protocol;
    }

  else
    return 0;

  snap_header_set_protocol (result, &p);
  return 1;
}

uword
unformat_snap_header (unformat_input_t * input, va_list * args)
{
  u8 **result = va_arg (*args, u8 **);
  snap_header_t _h, *h = &_h;

  if (!unformat (input, "%U", unformat_snap_protocol, h))
    return 0;

  /* Add header to result. */
  {
    void *p;
    u32 n_bytes = sizeof (h[0]);

    vec_add2 (*result, p, n_bytes);
    clib_memcpy (p, h, n_bytes);
  }

  return 1;
}

static clib_error_t *
snap_init (vlib_main_t * vm)
{
  snap_main_t *sm = &snap_main;

  memset (sm, 0, sizeof (sm[0]));
  sm->vlib_main = vm;

  mhash_init (&sm->protocol_hash, sizeof (uword),
	      sizeof (snap_oui_and_protocol_t));

  sm->protocol_info_by_name
    = hash_create_string ( /* elts */ 0, sizeof (uword));

  return vlib_call_init_function (vm, snap_input_init);
}

VLIB_INIT_FUNCTION (snap_init);


/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
; u32 nbuckets; u32 log2_nbuckets; u64 memory_size; u8 *name; format_function_t *fmt_fn; void *heap; BVT (clib_bihash_alloc_chunk) * chunks; u64 *freelists; #if BIHASH_32_64_SVM BVT (clib_bihash_shared_header) * sh; int memfd; #else BVT (clib_bihash_shared_header) sh; #endif u64 alloc_arena; /* Base of the allocation arena */ volatile u8 instantiated; u8 dont_add_to_all_bihash_list; /** * A custom format function to print the Key and Value of bihash_key instead of default hexdump */ format_function_t *kvp_fmt_fn; /** Optional statistics-gathering callback */ #if BIHASH_ENABLE_STATS void (*inc_stats_callback) (BVS (clib_bihash) *, int stat_id, u64 count); /** Statistics callback context (e.g. address of stats data structure) */ void *inc_stats_context; #endif } BVT (clib_bihash); typedef struct { BVT (clib_bihash) * h; char *name; u32 nbuckets; uword memory_size; format_function_t *kvp_fmt_fn; u8 instantiate_immediately; u8 dont_add_to_all_bihash_list; } BVT (clib_bihash_init2_args); extern void **clib_all_bihashes; #if BIHASH_32_64_SVM #undef alloc_arena_next #undef alloc_arena_size #undef alloc_arena_mapped #undef alloc_arena #undef CLIB_BIHASH_READY_MAGIC #define alloc_arena_next(h) (((h)->sh)->alloc_arena_next) #define alloc_arena_size(h) (((h)->sh)->alloc_arena_size) #define alloc_arena_mapped(h) (((h)->sh)->alloc_arena_mapped) #define alloc_arena(h) ((h)->alloc_arena) #define CLIB_BIHASH_READY_MAGIC 0xFEEDFACE #else #undef alloc_arena_next #undef alloc_arena_size #undef alloc_arena_mapped #undef alloc_arena #undef CLIB_BIHASH_READY_MAGIC #define alloc_arena_next(h) ((h)->sh.alloc_arena_next) #define alloc_arena_size(h) ((h)->sh.alloc_arena_size) #define alloc_arena_mapped(h) ((h)->sh.alloc_arena_mapped) #define alloc_arena(h) ((h)->alloc_arena) #define CLIB_BIHASH_READY_MAGIC 0 #endif #ifndef BIHASH_STAT_IDS #define BIHASH_STAT_IDS 1 #define foreach_bihash_stat \ _(alloc_add) \ _(add) \ _(split_add) \ _(replace) \ _(update) \ _(del) \ _(del_free) \ _(linear) \ _(resplit) \ _(working_copy_lost) \ _(splits) /* must be last */ typedef enum { #define _(a) BIHASH_STAT_##a, foreach_bihash_stat #undef _ BIHASH_STAT_N_STATS, } BVT (clib_bihash_stat_id); #endif /* BIHASH_STAT_IDS */ static inline void BV (clib_bihash_increment_stat) (BVT (clib_bihash) * h, int stat_id, u64 count) { #if BIHASH_ENABLE_STATS if (PREDICT_FALSE (h->inc_stats_callback != 0)) h->inc_stats_callback (h, stat_id, count); #endif } #if BIHASH_ENABLE_STATS static inline void BV (clib_bihash_set_stats_callback) (BVT (clib_bihash) * h, void (*cb) (BVT (clib_bihash) *, int, u64), void *ctx) { h->inc_stats_callback = cb; h->inc_stats_context = ctx; } #endif static inline void BV (clib_bihash_alloc_lock) (BVT (clib_bihash) * h) { while (__atomic_test_and_set (h->alloc_lock, __ATOMIC_ACQUIRE)) CLIB_PAUSE (); } static inline void BV (clib_bihash_alloc_unlock) (BVT (clib_bihash) * h) { __atomic_clear (h->alloc_lock, __ATOMIC_RELEASE); } static inline void BV (clib_bihash_lock_bucket) (BVT (clib_bihash_bucket) * b) { /* *INDENT-OFF* */ BVT (clib_bihash_bucket) mask = { .lock = 1 }; /* *INDENT-ON* */ u64 old; try_again: old = clib_atomic_fetch_or (&b->as_u64, mask.as_u64); if (PREDICT_FALSE (old & mask.as_u64)) { /* somebody else flipped the bit, try again */ CLIB_PAUSE (); goto try_again; } } static inline void BV (clib_bihash_unlock_bucket) (BVT (clib_bihash_bucket) * b) { b->lock = 0; } static inline void *BV (clib_bihash_get_value) (BVT (clib_bihash) * h, uword offset) { u8 *hp = (u8 *) (uword) alloc_arena (h); u8 *vp = hp + offset; return (void *) vp; } static inline int BV (clib_bihash_bucket_is_empty) (BVT (clib_bihash_bucket) * b) { /* Note: applied to locked buckets, test offset */ if (BIHASH_KVP_AT_BUCKET_LEVEL == 0) return b->offset == 0; else return (b->log2_pages == 0 && b->refcnt == 1); } static inline uword BV (clib_bihash_get_offset) (BVT (clib_bihash) * h, void *v) { u8 *hp, *vp; hp = (u8 *) (uword) alloc_arena (h); vp = (u8 *) v; return vp - hp; } #define BIHASH_ADD 1 #define BIHASH_DEL 0 void BV (clib_bihash_init) (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size); void BV (clib_bihash_init2) (BVT (clib_bihash_init2_args) * a); #if BIHASH_32_64_SVM void BV (clib_bihash_initiator_init_svm) (BVT (clib_bihash) * h, char *name, u32 nbuckets, u64 memory_size); void BV (clib_bihash_responder_init_svm) (BVT (clib_bihash) * h, char *name, int fd); #endif void BV (clib_bihash_set_kvp_format_fn) (BVT (clib_bihash) * h, format_function_t * kvp_fmt_fn); void BV (clib_bihash_free) (BVT (clib_bihash) * h); int BV (clib_bihash_add_del) (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v, int is_add); int BV (clib_bihash_add_or_overwrite_stale) (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * add_v, int (*is_stale_cb) (BVT (clib_bihash_kv) *, void *), void *arg); int BV (clib_bihash_search) (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * search_v, BVT (clib_bihash_kv) * return_v); int BV (clib_bihash_is_initialised) (const BVT (clib_bihash) * h); #define BIHASH_WALK_STOP 0 #define BIHASH_WALK_CONTINUE 1 typedef int (*BV (clib_bihash_foreach_key_value_pair_cb)) (BVT (clib_bihash_kv) *, void *); void BV (clib_bihash_foreach_key_value_pair) (BVT (clib_bihash) * h, BV (clib_bihash_foreach_key_value_pair_cb) cb, void *arg); void *clib_all_bihash_set_heap (void); void clib_bihash_copied (void *dst, void *src); format_function_t BV (format_bihash); format_function_t BV (format_bihash_kvp); format_function_t BV (format_bihash_lru); static inline BVT (clib_bihash_bucket) * BV (clib_bihash_get_bucket) (BVT (clib_bihash) * h, u64 hash) { #if BIHASH_KVP_AT_BUCKET_LEVEL uword offset; offset = (hash & (h->nbuckets - 1)); offset = offset * (sizeof (BVT (clib_bihash_bucket)) + (BIHASH_KVP_PER_PAGE * sizeof (BVT (clib_bihash_kv)))); return ((BVT (clib_bihash_bucket) *) (((u8 *) h->buckets) + offset)); #else return h->buckets + (hash & (h->nbuckets - 1)); #endif } static inline int BV (clib_bihash_search_inline_with_hash) (BVT (clib_bihash) * h, u64 hash, BVT (clib_bihash_kv) * key_result) { BVT (clib_bihash_value) * v; BVT (clib_bihash_bucket) * b; int i, limit; /* *INDENT-OFF* */ static const BVT (clib_bihash_bucket) mask = { .linear_search = 1, .log2_pages = -1 }; /* *INDENT-ON* */ #if BIHASH_LAZY_INSTANTIATE if (PREDICT_FALSE (h->instantiated == 0)) return -1; #endif b = BV (clib_bihash_get_bucket) (h, hash); if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b))) return -1; if (PREDICT_FALSE (b->lock)) { volatile BVT (clib_bihash_bucket) * bv = b; while (bv->lock) CLIB_PAUSE (); } v = BV (clib_bihash_get_value) (h, b->offset); /* If the bucket has unresolvable collisions, use linear search */ limit = BIHASH_KVP_PER_PAGE; if (PREDICT_FALSE (b->as_u64 & mask.as_u64)) { if (PREDICT_FALSE (b->linear_search)) limit <<= b->log2_pages; else v += extract_bits (hash, h->log2_nbuckets, b->log2_pages); } for (i = 0; i < limit; i++) { if (BV (clib_bihash_key_compare) (v->kvp[i].key, key_result->key)) { *key_result = v->kvp[i]; return 0; } } return -1; } static inline int BV (clib_bihash_search_inline) (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * key_result) { u64 hash; hash = BV (clib_bihash_hash) (key_result); return BV (clib_bihash_search_inline_with_hash) (h, hash, key_result); } static inline void BV (clib_bihash_prefetch_bucket) (BVT (clib_bihash) * h, u64 hash) { CLIB_PREFETCH (BV (clib_bihash_get_bucket) (h, hash), BIHASH_BUCKET_PREFETCH_CACHE_LINES * CLIB_CACHE_LINE_BYTES, LOAD); } static inline void BV (clib_bihash_prefetch_data) (BVT (clib_bihash) * h, u64 hash) { BVT (clib_bihash_value) * v; BVT (clib_bihash_bucket) * b; #if BIHASH_LAZY_INSTANTIATE if (PREDICT_FALSE (h->instantiated == 0)) return; #endif b = BV (clib_bihash_get_bucket) (h, hash); if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b))) return; v = BV (clib_bihash_get_value) (h, b->offset); if (PREDICT_FALSE (b->log2_pages && b->linear_search == 0)) v += extract_bits (hash, h->log2_nbuckets, b->log2_pages); CLIB_PREFETCH (v, BIHASH_KVP_PER_PAGE * sizeof (BVT (clib_bihash_kv)), LOAD); } static inline int BV (clib_bihash_search_inline_2_with_hash) (BVT (clib_bihash) * h, u64 hash, BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep) { BVT (clib_bihash_value) * v; BVT (clib_bihash_bucket) * b; int i, limit; /* *INDENT-OFF* */ static const BVT (clib_bihash_bucket) mask = { .linear_search = 1, .log2_pages = -1 }; /* *INDENT-ON* */ ASSERT (valuep); #if BIHASH_LAZY_INSTANTIATE if (PREDICT_FALSE (h->instantiated == 0)) return -1; #endif b = BV (clib_bihash_get_bucket) (h, hash); if (PREDICT_FALSE (BV (clib_bihash_bucket_is_empty) (b))) return -1; if (PREDICT_FALSE (b->lock)) { volatile BVT (clib_bihash_bucket) * bv = b; while (bv->lock) CLIB_PAUSE (); } v = BV (clib_bihash_get_value) (h, b->offset); /* If the bucket has unresolvable collisions, use linear search */ limit = BIHASH_KVP_PER_PAGE; if (PREDICT_FALSE (b->as_u64 & mask.as_u64)) { if (PREDICT_FALSE (b->linear_search)) limit <<= b->log2_pages; else v += extract_bits (hash, h->log2_nbuckets, b->log2_pages); } for (i = 0; i < limit; i++) { if (BV (clib_bihash_key_compare) (v->kvp[i].key, search_key->key)) { *valuep = v->kvp[i]; return 0; } } return -1; } static inline int BV (clib_bihash_search_inline_2) (BVT (clib_bihash) * h, BVT (clib_bihash_kv) * search_key, BVT (clib_bihash_kv) * valuep) { u64 hash; hash = BV (clib_bihash_hash) (search_key); return BV (clib_bihash_search_inline_2_with_hash) (h, hash, search_key, valuep); } #endif /* __included_bihash_template_h__ */ /** @endcond */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */