From Wes Hardaker:
[obnox/wireshark/wip.git] / packet-ethertype.c
1 /* ethertype.c
2  * Routines for calling the right protocol for the ethertype.
3  *
4  * $Id: packet-ethertype.c,v 1.33 2002/10/22 22:04:21 jmayer Exp $
5  *
6  * Gilbert Ramirez <gram@alumni.rice.edu>
7  *
8  * Ethereal - Network traffic analyzer
9  * By Gerald Combs <gerald@ethereal.com>
10  * Copyright 1998 Gerald Combs
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25  */
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <glib.h>
32 #include <epan/packet.h>
33 #include "packet-ip.h"
34 #include "packet-ipv6.h"
35 #include "packet-ipx.h"
36 #include "packet-vlan.h"
37 #include "packet-vines.h"
38 #include "etypes.h"
39 #include "ppptypes.h"
40
41 static dissector_table_t ethertype_dissector_table;
42
43 static dissector_handle_t data_handle;
44
45 const value_string etype_vals[] = {
46     {ETHERTYPE_IP,              "IP"                            },
47     {ETHERTYPE_IPv6,            "IPv6"                          },
48     {ETHERTYPE_X25L3,           "X.25 Layer 3"                  },
49     {ETHERTYPE_ARP,             "ARP"                           },
50     {ETHERTYPE_REVARP,          "RARP"                          },
51     {ETHERTYPE_DEC_LB,          "DEC LanBridge"                 },
52     {ETHERTYPE_ATALK,           "Appletalk"                     },
53     {ETHERTYPE_SNA,             "SNA-over-Ethernet"             },
54     {ETHERTYPE_AARP,            "AARP"                          },
55     {ETHERTYPE_IPX,             "Netware IPX/SPX"               },
56     {ETHERTYPE_VINES,           "Vines"                         },
57     {ETHERTYPE_TRAIN,           "Netmon Train"                  },
58     {ETHERTYPE_LOOP,            "Loopback"                      }, /* Ethernet Loopback */
59     {ETHERTYPE_WCP,             "Wellfleet Compression Protocol" },
60     {ETHERTYPE_PPPOED,          "PPPoE Discovery"               },
61     {ETHERTYPE_PPPOES,          "PPPoE Session"                 },
62     {ETHERTYPE_VLAN,            "802.1Q Virtual LAN"            },
63     {ETHERTYPE_EAPOL,           "802.1X Authentication"         },
64     {ETHERTYPE_MPLS,            "MPLS label switched packet"    },
65     {ETHERTYPE_MPLS_MULTI,      "MPLS multicast label switched packet" },
66     {ETHERTYPE_3C_NBP_DGRAM,    "3Com NBP Datagram"             },
67     {ETHERTYPE_DEC,             "DEC proto"                     },
68     {ETHERTYPE_DNA_DL,          "DEC DNA Dump/Load"             },
69     {ETHERTYPE_DNA_RC,          "DEC DNA Remote Console"        },
70     {ETHERTYPE_DNA_RT,          "DEC DNA Routing"               },
71     {ETHERTYPE_LAT,             "DEC LAT"                       },
72     {ETHERTYPE_DEC_DIAG,        "DEC Diagnostics"               },
73     {ETHERTYPE_DEC_CUST,        "DEC Customer use"              },
74     {ETHERTYPE_DEC_SCA,         "DEC LAVC/SCA"                  },
75     {ETHERTYPE_ETHBRIDGE,       "Transparent Ethernet bridging" },
76     {ETHERTYPE_CGMP,            "Cisco Group Management Protocol" },
77     {ETHERTYPE_SLOW_PROTOCOLS,  "Slow Protocols"                },
78
79     /*
80      * NDISWAN on Windows translates Ethernet frames from higher-level
81      * protocols into PPP frames to hand to the PPP driver, and translates
82      * PPP frames from the PPP driver to hand to the higher-level protocols.
83      *
84      * Apparently the PPP driver, on at least some versions of Windows,
85      * passes frames for internal-to-PPP protocols up through NDISWAN;
86      * the protocol type field appears to be passed through unchanged
87      * (unlike what's done with, for example, the protocol type field
88      * for IP, which is mapped from its PPP value to its Ethernet value).
89      *
90      * This means that we may see, on Ethernet captures, frames for
91      * protocols internal to PPP, so we list as "Ethernet" protocol
92      * types the PPP protocol types we've seen.
93      */
94     {PPP_IPCP,                  "PPP IP Control Protocol" },
95     {PPP_LCP,                   "PPP Link Control Protocol" },
96     {PPP_PAP,                   "PPP Password Authentication Protocol" },
97     {PPP_CCP,                   "PPP Compression Control Protocol" },
98     {0,                         NULL                            } };
99
100 static void add_trailer(proto_tree *fh_tree, int trailer_id, tvbuff_t *tvb,
101     tvbuff_t *next_tvb, int offset_after_etype, guint length_before);
102
103 void
104 capture_ethertype(guint16 etype, const guchar *pd, int offset, int len,
105                   packet_counts *ld)
106 {
107   switch (etype) {
108     case ETHERTYPE_ARP:
109       ld->arp++;
110       break;
111     case ETHERTYPE_IP:
112       capture_ip(pd, offset, len, ld);
113       break;
114     case ETHERTYPE_IPv6:
115       capture_ipv6(pd, offset, len, ld);
116       break;
117     case ETHERTYPE_IPX:
118       capture_ipx(ld);
119       break;
120     case ETHERTYPE_VLAN:
121       capture_vlan(pd, offset, len, ld);
122       break;
123     case ETHERTYPE_VINES:
124       capture_vines(ld);
125       break;
126     default:
127       ld->other++;
128       break;
129   }
130 }
131
132 void
133 ethertype(guint16 etype, tvbuff_t *tvb, int offset_after_etype,
134                 packet_info *pinfo, proto_tree *tree, proto_tree *fh_tree,
135                 int etype_id, int trailer_id)
136 {
137         char                    *description;
138         tvbuff_t                *next_tvb;
139         guint                   length_before;
140         volatile gboolean       dissector_found;
141
142         /* Add to proto_tree */
143         if (tree) {
144                 proto_tree_add_uint(fh_tree, etype_id, tvb,
145                     offset_after_etype - 2, 2, etype);
146         }
147
148         /* Tvbuff for the payload after the Ethernet type. */
149         next_tvb = tvb_new_subset(tvb, offset_after_etype, -1, -1);
150
151         pinfo->ethertype = etype;
152
153         /* Remember how much data there is in it. */
154         length_before = tvb_reported_length(next_tvb);
155
156         /* Look for sub-dissector, and call it if found.
157            Catch BoundsError and ReportedBoundsError, so that if the
158            reported length of "next_tvb" was reduced by some dissector
159            before an exception was thrown, we can still put in an item
160            for the trailer. */
161         TRY {
162                 dissector_found = dissector_try_port(ethertype_dissector_table,
163                     etype, next_tvb, pinfo, tree);
164         }
165         CATCH2(BoundsError, ReportedBoundsError) {
166                 /* Well, somebody threw an exception; that means that a
167                    dissector was found, so we don't need to dissect
168                    the payload as data or update the protocol or info
169                    columns. */
170                 dissector_found = TRUE;
171
172                 /* Add the trailer, if appropriate. */
173                 add_trailer(fh_tree, trailer_id, tvb, next_tvb,
174                     offset_after_etype, length_before);
175
176                 /* Rrethrow the exception, so the "Short Frame" or "Mangled
177                    Frame" indication can be put into the tree. */
178                 RETHROW;
179
180                 /* XXX - RETHROW shouldn't return. */
181                 g_assert_not_reached();
182         }
183         ENDTRY;
184
185         if (!dissector_found) {
186                 /* No sub-dissector found.
187                    Label rest of packet as "Data" */
188                 call_dissector(data_handle,next_tvb, pinfo, tree);
189
190                 /* Label protocol */
191                 switch (etype) {
192
193                 case ETHERTYPE_LOOP:
194                         if (check_col(pinfo->cinfo, COL_PROTOCOL)) {
195                                 col_add_fstr(pinfo->cinfo, COL_PROTOCOL, "LOOP");
196                         }
197                         break;
198
199                 default:
200                         if (check_col(pinfo->cinfo, COL_PROTOCOL)) {
201                                 col_add_fstr(pinfo->cinfo, COL_PROTOCOL, "0x%04x",
202                                     etype);
203                         }
204                         break;
205                 }
206                 if (check_col(pinfo->cinfo, COL_INFO)) {
207                         description = match_strval(etype, etype_vals);
208                         if (description) {
209                                 col_add_fstr(pinfo->cinfo, COL_INFO, "%s",
210                                     description);
211                         }
212                 }
213         }
214
215         add_trailer(fh_tree, trailer_id, tvb, next_tvb, offset_after_etype,
216             length_before);
217 }
218
219 static void
220 add_trailer(proto_tree *fh_tree, int trailer_id, tvbuff_t *tvb,
221     tvbuff_t *next_tvb, int offset_after_etype, guint length_before)
222 {
223         guint           length;
224         tvbuff_t        *volatile trailer_tvb;
225
226         if (fh_tree == NULL)
227                 return; /* we're not building a protocol tree */
228
229         if (trailer_id == -1)
230                 return; /* our caller doesn't care about trailers */
231
232         /* OK, how much is there in that tvbuff now? */
233         length = tvb_reported_length(next_tvb);
234
235         /* If there's less than there was before, what's left is
236            a trailer. */
237         if (length < length_before) {
238                 /*
239                  * Create a tvbuff for the padding.
240                  */
241                 TRY {
242                         trailer_tvb = tvb_new_subset(tvb,
243                             offset_after_etype + length, -1, -1);
244                 }
245                 CATCH2(BoundsError, ReportedBoundsError) {
246                         /* The packet doesn't have "length" bytes worth of
247                            captured data left in it.  No trailer to display. */
248                         trailer_tvb = NULL;
249                 }
250                 ENDTRY;
251         } else
252                 trailer_tvb = NULL;     /* no trailer */
253
254         /* If there's some bytes left over, and we were given an item ID
255            for a trailer, mark those bytes as a trailer. */
256         if (trailer_tvb) {
257                 guint   trailer_length;
258
259                 trailer_length = tvb_length(trailer_tvb);
260                 if (trailer_length != 0) {
261                         proto_tree_add_item(fh_tree, trailer_id, trailer_tvb, 0,
262                             trailer_length, FALSE);
263                 }
264         }
265 }
266
267
268 void
269 proto_register_ethertype(void)
270 {
271         /* subdissector code */
272         ethertype_dissector_table = register_dissector_table("ethertype",
273             "Ethertype", FT_UINT16, BASE_HEX);
274 }
275
276 void
277 proto_reg_handoff_ethertype(void){
278   data_handle = find_dissector("data");
279 }