aboutsummaryrefslogtreecommitdiffstats
path: root/src/vnet/snap/snap.h
blob: 08c3a8b9c181143b47d7c69e41b53c353fa04e2f (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
205
206
/*
 * 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.h: SNAP definitions
 *
 * Copyright (c) 2008 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.
 */

#ifndef included_snap_h
#define included_snap_h

#include <vnet/vnet.h>
#include <vnet/pg/pg.h>

#define foreach_ieee_oui			\
  _ (0x000000, ethernet)			\
  _ (0x00000c, cisco)

typedef enum
{
#define _(n,f) IEEE_OUI_##f = n,
  foreach_ieee_oui
#undef _
} ieee_oui_t;

#define foreach_snap_cisco_protocol		\
  _ (0x0102, drip)				\
  _ (0x0104, port_aggregation_protocol)		\
  _ (0x0105, mls_hello)				\
  _ (0x010b, per_vlan_spanning_tree)		\
  _ (0x010c, vlan_bridge)			\
  _ (0x0111, unidirectional_link_detection)	\
  _ (0x2000, cdp)				\
  _ (0x2001, cgmp)				\
  _ (0x2003, vtp)				\
  _ (0x2004, dtp)				\
  _ (0x200a, stp_uplink_fast)

typedef enum
{
#define _(n,f) SNAP_cisco_##f = n,
  foreach_snap_cisco_protocol
#undef _
} snap_cisco_protocol_t;

typedef union
{
  /* *INDENT-OFF* */
  CLIB_PACKED (struct {
    /* OUI: organization unique identifier. */
    u8 oui[3];

    /* Per-OUI protocol. */
    u16 protocol;
  });
  /* *INDENT-ON* */

  u8 as_u8[5];
} snap_header_t;

typedef struct
{
  u32 oui;
  u32 protocol;
} snap_oui_and_protocol_t;

typedef struct
{
  /* Name vector string. */
  u8 *name;

  snap_oui_and_protocol_t oui_and_protocol;

  /* Node which handles this type. */
  u32 node_index;

  /* snap-input next index for this type. */
  u32 next_index;
} snap_protocol_info_t;

always_inline void
snap_header_set_protocol (snap_header_t * h, snap_oui_and_protocol_t * p)
{
  u16 protocol = p->protocol;
  u32 oui = p->oui;
  h->protocol = clib_host_to_net_u16 (protocol);
  h->oui[0] = (oui >> 16) & 0xff;
  h->oui[1] = (oui >> 8) & 0xff;
  h->oui[2] = (oui >> 0) & 0xff;
}

#define foreach_snap_error			\
  _ (NONE, "no error")				\
  _ (UNKNOWN_PROTOCOL, "unknown oui/snap protocol")

typedef enum
{
#define _(f,s) SNAP_ERROR_##f,
  foreach_snap_error
#undef _
    SNAP_N_ERROR,
} snap_error_t;

typedef struct
{
  vlib_main_t *vlib_main;

  /* Vector of known SNAP oui/protocol pairs. */
  snap_protocol_info_t *protocols;

  /* Hash table mapping oui/protocol to protocol index. */
  mhash_t protocol_hash;

  /* Hash table mapping protocol by name. */
  uword *protocol_info_by_name;
} snap_main_t;

always_inline u32
snap_header_get_oui (snap_header_t * h)
{
  return (h->oui[0] << 16) | (h->oui[1] << 8) | h->oui[2];
}

always_inline snap_protocol_info_t *
snap_get_protocol_info (snap_main_t * sm, snap_header_t * h)
{
  snap_oui_and_protocol_t key;
  uword *p;

  key.oui = snap_header_get_oui (h);
  key.protocol = h->protocol;

  p = mhash_get (&sm->protocol_hash, &key);
  return p ? vec_elt_at_index (sm->protocols, p[0]) : 0;
}

extern snap_main_t snap_main;

/* Register given node index to take input for given snap type. */
void
snap_register_input_protocol (vlib_main_t * vm,
			      char *name,
			      u32 ieee_oui, u16 protocol, u32 node_index);

format_function_t format_snap_protocol;
format_function_t format_snap_header;
format_function_t format_snap_header_with_length;

/* Parse snap protocol as 0xXXXX or protocol name. */
unformat_function_t unformat_snap_protocol;

/* Parse snap header. */
unformat_function_t unformat_snap_header;
unformat_function_t unformat_pg_snap_header;

always_inline void
snap_setup_node (vlib_main_t * vm, u32 node_index)
{
  vlib_node_t *n = vlib_get_node (vm, node_index);
  pg_node_t *pn = pg_get_node (node_index);

  n->format_buffer = format_snap_header_with_length;
  n->unformat_buffer = unformat_snap_header;
  pn->unformat_edit = unformat_pg_snap_header;
}

#endif /* included_snap_h */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
pp->pid_value = pid; s_pidhash[bucket] = pp; g_npids++; return(pp); } while (pp) { if (pp->pid_value == pid) return(pp); pp = pp->next; } pp = g_malloc0(sizeof(pid_data_t)); pp->pid_value = pid; pp->next = s_pidhash[bucket]; s_pidhash[bucket] = pp; g_npids++; return(pp); } /**************************************************************************** * pid_cmp ****************************************************************************/ int pid_cmp(const void *a1, const void *a2) { pid_sort_t *p1 = (pid_sort_t *)a1; pid_sort_t *p2 = (pid_sort_t *)a2; if (p1->pid_value < p2->pid_value) return(-1); else if (p1->pid_value == p2->pid_value) return(0); else return(1); } /**************************************************************************** * make_sorted_pid_vector ****************************************************************************/ static void make_sorted_pid_vector(void) { pid_data_t *pp; pid_data_t **p_previous; pid_sort_t *psp; int i; psp = g_pids = g_malloc0(sizeof(pid_sort_t)*g_npids); for (i = 0; i < PIDHASH_NBUCKETS; i++) { pp = s_pidhash[i]; while(pp) { psp->pid = pp; psp->pid_value = pp->pid_value; psp++; pp = pp->next; } } qsort(&g_pids[0], g_npids, sizeof(pid_sort_t), pid_cmp); /* put the sort order into the pid objects */ psp = g_pids; /* * This is rather gross. * * We happen to know that whenever this function is called, the hash table * structure itself is immediately torn down. So the "next" pointers in the * pid_data_t elements are about to become useless. * * So we re-use them, to link all the pid_data_t elements together into a * single unified linked list, with g_pid_data_list pointing to the head. * This means we can walk all the pid_data_t objects if we really want to. * Reading snapshots from disk is one example. * * Alternatively we could just leave the hash table in place; this is * far nicer, but as it happens, trading O(n) lookups for O(1) lookups * isn't actually a problem for the restricted post-tear-down usage. So for * now we take the memory savings and swap our hash table for a list. */ p_previous = &g_pid_data_list; for (i = 0; i < g_npids; i++) { pp = psp->pid; pp->pid_index = i; *p_previous = pp; p_previous = &pp->next; psp++; } *p_previous = NULL; /* * Squirrel away original (sorted) vector, so we can * toggle between "chase" mode, snapshots, and the original * display method on short notice */ g_original_pids = g_malloc0(sizeof(pid_sort_t)*g_npids); memcpy (g_original_pids, g_pids, sizeof(pid_sort_t)*g_npids); } /**************************************************************************** * read_events ****************************************************************************/ void read_events(char *filename) { ulong *ulp; ulong size; event_t *ep; raw_event_t *rep; ulonglong start_time=0ULL; ulonglong low_time; boolean once=TRUE; int i; char tmpbuf [128]; ulp = (ulong *)mapfile(filename, &size); if (ulp == NULL) { snprintf(tmpbuf, sizeof(tmpbuf), "Couldn't open %s\n", filename); infobox("Read Event Log Failure", tmpbuf); return; } g_nevents = ntohl(*ulp); if (size != (g_nevents*sizeof(raw_event_t) + sizeof(g_nevents))) { snprintf(tmpbuf, sizeof(tmpbuf), "%s was damaged, or isn't an event log.\n", filename); infobox("Bad Input File", tmpbuf); g_nevents = 0; unmapfile((char *)ulp, size); return; } rep = (raw_event_t *)(ulp+1); if (g_events) g_free(g_events); g_events = (event_t *)g_malloc(g_nevents * sizeof(event_t)); ep = g_events; while (g_npids > 0) { g_free((g_pids + g_npids-1)->pid); g_npids--; } if (g_pids) { g_free(g_pids); g_free(g_original_pids); g_pids = 0; g_original_pids = 0; } s_pidhash = (pid_data_t **)g_malloc0( PIDHASH_NBUCKETS*sizeof(pid_data_t *)); /* $$$ add a SEGV handler... */ for (i = 0; i < g_nevents; i++) { if (once) { once = FALSE; start_time = ((ulonglong)ntohl(rep->time[0])); start_time <<= 32; low_time = ntohl(rep->time[1]); low_time &= 0xFFFFFFFF; start_time |= low_time; ep->time = 0LL; } else { ep->time = ((ulonglong)ntohl(rep->time[0])); ep->time <<= 32; low_time = ntohl(rep->time[1]); low_time &= 0xFFFFFFFF; ep->time |= low_time; ep->time -= start_time; ep->time /= ticks_per_ns; } ep->code = ntohl(rep->code); ep->pid = find_or_add_pid(ntohl(rep->pid)); ep->datum = ntohl(rep->datum); ep->flags = 0; ep++; rep++; } unmapfile((char *)ulp, size); make_sorted_pid_vector(); g_free(s_pidhash); s_pidhash = 0; /* Give the view-1 world a chance to reset a few things... */ view1_read_events_callback(); } static event_t *add_ep; /**************************************************************************** * cpel_event_init ****************************************************************************/ void cpel_event_init (ulong nevents) { g_nevents = nevents; if (g_events) g_free(g_events); add_ep = g_events = (event_t *)g_malloc(g_nevents * sizeof(event_t)); while (g_npids > 0) { g_free((g_pids + g_npids-1)->pid); g_npids--; } if (g_pids) { g_free(g_pids); g_free(g_original_pids); g_pids = 0; g_original_pids = 0; } s_pidhash = (pid_data_t **)g_malloc0( PIDHASH_NBUCKETS*sizeof(pid_data_t *)); } /**************************************************************************** * add_cpel_event ****************************************************************************/ void add_cpel_event(ulonglong delta, ulong track, ulong event, ulong datum) { event_t *ep; ep = add_ep++; ep->time = delta; ep->pid = find_or_add_pid(track); ep->code = event; ep->datum = datum; ep->flags = 0; } /**************************************************************************** * add_clib_event ****************************************************************************/ void add_clib_event(double delta, unsigned short track, unsigned short event, unsigned int index) { event_t *ep; ep = add_ep++; ep->time = (ulonglong) (delta * 1e9); /* time in integer nanoseconds */ ep->pid = find_or_add_pid(track); ep->code = event; ep->datum = index; ep->flags = EVENT_FLAG_CLIB; } /**************************************************************************** * cpel_event_finalize ****************************************************************************/ void cpel_event_finalize(void) { make_sorted_pid_vector(); g_free(s_pidhash); s_pidhash = 0; /* Give the view-1 world a chance to reset a few things... */ view1_read_events_callback(); } /**************************************************************************** * mapfile ****************************************************************************/ char *mapfile (char *file, ulong *sizep) { struct stat statb; char *rv; int maphfile; size_t mapfsize; maphfile = open (file, O_RDONLY); if (maphfile < 0) return (NULL); if (fstat (maphfile, &statb) < 0) { return (NULL); } /* Don't try to mmap directories, FIFOs, semaphores, etc. */ if (! (statb.st_mode & S_IFREG)) { return (NULL); } mapfsize = statb.st_size; if (mapfsize < 3) { close (maphfile); return (NULL); } rv = mmap (0, mapfsize, PROT_READ, MAP_SHARED, maphfile, 0); if (rv == 0) { g_error ("%s mapping problem, I quit...\n", file); } close (maphfile); if (madvise (rv, mapfsize, MADV_SEQUENTIAL) < 0) { return (rv); } if (sizep) { *sizep = mapfsize; } return (rv); } /**************************************************************************** * unmapfile ****************************************************************************/ boolean unmapfile (char *addr, ulong size) { if (munmap (addr, size) < 0) { g_warning("Unmap error, addr 0x%lx size 0x%x\n", (unsigned long) addr, (unsigned int)size); return(FALSE); } return(TRUE); } /**************************************************************************** * find_event_index * Binary search for first event whose time is >= t ****************************************************************************/ int find_event_index (ulonglong t) { int index, bottom, top; event_t *ep; bottom = g_nevents-1; top = 0; while (1) { index = (bottom + top) / 2; ep = (g_events + index); if (ep->time == t) return(index); if (top >= bottom) { while (index > 0 && ep->time > t) { ep--; index--; } while (index < g_nevents && ep->time < t) { ep++; index++; } return(index); } if (ep->time < t) top = index + 1; else bottom = index - 1; } } /**************************************************************************** * events_about ****************************************************************************/ void events_about (char *tmpbuf) { snprintf(tmpbuf+strlen(tmpbuf), 1024 - strlen(tmpbuf), "%d total events, %.3f ticks per us\n", (int)g_nevents, ticks_per_ns); }