fix usage of "if(tree) {" to display the right things, even if no coloring rule is set
[obnox/wireshark/wip.git] / epan / dissectors / packet-pn-rt.c
1 /* packet-pn-rt.c
2  * Routines for pn-rt (PROFINET Real-Time) packet dissection.
3  * This is the base for other PROFINET protocols like IO, CBA, DCP, ...
4  * (the "content subdissectors" will register themselves using a heuristic)
5  *
6  * $Id$
7  *
8  * Ethereal - Network traffic analyzer
9  * By Gerald Combs <gerald@ethereal.com>
10  * Copyright 1999 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 /* we do not use this dissector as a plugin any longer... */
32 #define __ETHEREAL_STATIC__
33
34 #ifndef __ETHEREAL_STATIC__
35 #include "plugins/plugin_api.h"
36 #include "moduleinfo.h"
37 #endif
38
39
40 #ifdef HAVE_SYS_TYPES_H
41 # include <sys/types.h>
42 #endif
43
44 #ifdef HAVE_NETINET_IN_H
45 #include <netinet/in.h>
46 #endif
47
48 #include <stdio.h>
49 #include <stdlib.h>
50 #include <gmodule.h>
51 #include <ctype.h>
52 #include <time.h>
53 #include <string.h>
54 #include <epan/packet.h>
55 #include <epan/addr_resolv.h>
56 #include "prefs.h"
57 #include <epan/strutil.h>
58 #include <etypes.h>
59
60
61 #ifndef __ETHEREAL_STATIC__
62 #include "plugins/plugin_api_defs.h"
63
64 G_MODULE_EXPORT const gchar version[] = VERSION;
65 #endif
66
67 void proto_reg_handoff_pn_rt(void);
68
69 /* Define the pn-rt proto */
70 static int proto_pn_rt     = -1;
71
72 /* Define many header fields for pn-rt */
73 static int hf_pn_rt_id = -1;
74 static int hf_pn_rt_data = -1;
75 static int hf_pn_rt_cycle_counter = -1;
76 static int hf_pn_rt_transfer_status = -1;
77 static int hf_pn_rt_data_status = -1;
78 static int hf_pn_rt_data_status_res67 = -1;
79 static int hf_pn_rt_data_status_ok = -1;
80 static int hf_pn_rt_data_status_operate = -1;
81 static int hf_pn_rt_data_status_res3 = -1;
82 static int hf_pn_rt_data_status_valid = -1;
83 static int hf_pn_rt_data_status_res1 = -1;
84 static int hf_pn_rt_data_status_primary = -1;
85 static int hf_pn_rt_malformed = -1;
86
87 /* 
88  * Define the trees for pn-rt
89  * We need one tree for pn-rt itself and one for the pn-rt data status subtree
90  */
91 static int ett_pn_rt = -1;
92 static int ett_pn_rt_data_status = -1;
93
94 /* 
95  * Here are the global variables associated with  
96  * the various user definable characteristics of the dissection
97  */
98 /* Place summary in proto tree */
99 static gboolean pn_rt_summary_in_tree = TRUE;
100
101 /* heuristic to find the right pn-rt payload dissector */
102 static heur_dissector_list_t heur_subdissector_list;
103
104 /* the official "we don't know that data" dissector */
105 static dissector_handle_t data_handle;
106
107
108 /*
109  * dissect_pn_rt - The dissector for the Soft-Real-Time protocol
110  */
111 static void
112 dissect_pn_rt(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
113 {
114   gint tvb_len;
115   gint data_len;
116   guint16 u16FrameID;
117   guint8 u8DataStatus;
118   guint8 u8TransferStatus;
119   guint16 u16CycleCounter;
120   gchar *pszProtAddInfo;
121   gchar *pszProtShort;
122   gchar *pszProtSummary;
123   gchar *pszProtComment;
124   proto_item *item = NULL;
125   proto_tree *ds_tree = NULL;
126   proto_tree *pn_rt_tree, *ti;
127   gchar szFieldSummary[100];
128   tvbuff_t *next_tvb;
129   gboolean  bCyclic;
130
131
132   /* Initialize variables */
133   tvb_len = tvb_length(tvb);
134   pn_rt_tree = NULL;
135   ds_tree = NULL;
136   ti = NULL;
137   
138   /*
139    * Set the columns now, so that they'll be set correctly if we throw
140    * an exception.  We can set them (or append things) later again ....
141    */
142   if (check_col(pinfo->cinfo, COL_PROTOCOL))
143     col_add_str(pinfo->cinfo, COL_PROTOCOL, "PN-RT");
144   if (check_col(pinfo->cinfo, COL_INFO))
145     col_add_str(pinfo->cinfo, COL_INFO, "PROFINET Real-Time");
146
147   if (tvb_len < 6) {
148                 /* packet is too short, mark it as malformed */
149                 proto_tree_add_bytes(tree, hf_pn_rt_malformed, tvb, 0, 10000, 
150                         tvb_get_ptr(tvb, 0, 10000));
151                 return;
152   }
153
154
155     /* build some "raw" data */
156         u16FrameID = tvb_get_ntohs(tvb, 0);
157     if (u16FrameID < 0x0100) {
158         pszProtShort    = "PN-RTC0";
159         pszProtAddInfo  = "Synchronization, ";
160         pszProtSummary  = "Isochronous-Real-Time";
161         pszProtComment  = "0x0000-0x00FF: Isochronous-Real-Time: Time-sync";
162         bCyclic         = TRUE;
163     } else if (u16FrameID < 0x8000){
164         pszProtShort    = "PN-RTC3";
165         pszProtAddInfo  = "RTC3, ";
166         pszProtSummary  = "Isochronous-Real-Time";
167         pszProtComment  = "0x0100-0x7FFF: Isochronous-Real-Time(class=3): Cyclic";
168         bCyclic         = TRUE;
169     } else if (u16FrameID < 0xbf00){
170         pszProtShort    = "PN-RTC2";
171         pszProtAddInfo  = "RTC2, ";
172         pszProtSummary  = "cyclic Real-Time";
173         pszProtComment  = "0x8000-0xBEFF: Real-Time(class=2): Cyclic";
174         bCyclic         = TRUE;
175     } else if (u16FrameID < 0xc000){
176         pszProtShort    = "PN-RTC2";
177         pszProtAddInfo  = "Multicast, ";
178         pszProtSummary  = "cyclic Real-Time";
179         pszProtComment  = "0xBF00-0xBFFF: Real-Time(class=2 multicast): Cyclic";
180         bCyclic         = TRUE;
181     } else if (u16FrameID < 0xfb00){
182         pszProtShort    = "PN-RTC1";
183         pszProtAddInfo  = "RTC1, ";
184         pszProtSummary  = "cyclic Real-Time";
185         pszProtComment  = "0xC000-0xFAFF: Real-Time(class=1): Cyclic";
186         bCyclic         = TRUE;
187     } else if (u16FrameID < 0xfc00){
188         pszProtShort    = "PN-RTC1";
189         pszProtAddInfo  = "Multicast, ";
190         pszProtSummary  = "cyclic Real-Time";
191         pszProtComment  = "0xFB00-0xFBFF: Real-Time(class=1 multicast): Cyclic";
192         bCyclic         = TRUE;
193     } else if (u16FrameID < 0xfe00){
194         pszProtShort    = "PN-RTA";
195         pszProtAddInfo  = "Reserved, ";
196         pszProtSummary  = "acyclic Real-Time";
197         pszProtComment  = "0xFC00-0xFDFF: Real-Time: Acyclic high priority";
198         bCyclic         = FALSE;
199         if (u16FrameID == 0xfc01) {
200                         pszProtShort    = "PN-RTA";
201             pszProtAddInfo  = "Alarm High, ";
202                 pszProtSummary  = "acyclic Real-Time";
203                 pszProtComment  = "Real-Time: Acyclic PN-IO Alarm high priority";
204         }
205     } else if (u16FrameID < 0xff00){
206         pszProtShort    = "PN-RTA";
207         pszProtAddInfo  = "Reserved, ";
208         pszProtSummary  = "acyclic Real-Time";
209         pszProtComment  = "0xFE00-0xFEFF: Real-Time: Acyclic low priority";
210         bCyclic         = FALSE;
211         if (u16FrameID == 0xfe01) {
212                         pszProtShort    = "PN-RTA";
213             pszProtAddInfo  = "Alarm Low, ";
214                 pszProtSummary  = "acyclic Real-Time";
215                 pszProtComment  = "Real-Time: Acyclic PN-IO Alarm low priority";
216         }
217         if (u16FrameID == 0xfefd) {
218                         pszProtShort    = "PN-RTA";
219             pszProtAddInfo  = "";
220                 pszProtSummary  = "acyclic Real-Time";
221                 pszProtComment  = "Real-Time: DCP (Dynamic Configuration Protocol)";
222         }
223         if (u16FrameID == 0xfefe) {
224                         pszProtShort    = "PN-RTA";
225             pszProtAddInfo  = "";
226                 pszProtSummary  = "acyclic Real-Time";
227                 pszProtComment  = "Real-Time: DCP (Dynamic Configuration Protocol) multicast response";
228         }
229         if (u16FrameID == 0xfeff) {
230                         pszProtShort    = "PN-RTA";
231             pszProtAddInfo  = "";
232                 pszProtSummary  = "acyclic Real-Time";
233                 pszProtComment  = "Real-Time: DCP (Dynamic Configuration Protocol) multicast";
234         }
235     } else {
236                 pszProtShort    = "PN-RT";
237         pszProtAddInfo  = "Reserved";
238         pszProtSummary  = "Real-Time";
239         pszProtComment  = "0xFF00-0xFFFF: reserved ID";
240         bCyclic         = FALSE;
241         }
242
243     /* decode optional cyclic fields at the packet end and build the summary line */
244     if (bCyclic) {
245         /* cyclic transfer has cycle counter, data status and transfer status fields at the end */
246                 u16CycleCounter = tvb_get_ntohs(tvb, tvb_len - 4);
247                 u8DataStatus = tvb_get_guint8(tvb, tvb_len - 2);
248             u8TransferStatus = tvb_get_guint8(tvb, tvb_len - 1);
249
250                 snprintf (szFieldSummary, sizeof(szFieldSummary),
251                                   "%sFrameID: 0x%04x, DataLen: %4u, Cycle: %5u (%s,%s,%s,%s)",
252                                 pszProtAddInfo, u16FrameID, tvb_len - 2 - 4, u16CycleCounter,
253                             (u8DataStatus & 0x04) ? "Valid" : "Invalid",
254                             (u8DataStatus & 0x01) ? "Primary" : "Backup",
255                             (u8DataStatus & 0x20) ? "Ok" : "Problem",
256                             (u8DataStatus & 0x10) ? "Run" : "Stop");
257
258         /* user data length is packet len - frame id - optional cyclic status fields */
259         data_len = tvb_len - 2 - 4;
260     } else {
261         /* satisfy the gcc compiler, so it won't throw an "uninitialized" warning */
262                 u16CycleCounter     = 0;
263                 u8DataStatus        = 0;
264             u8TransferStatus    = 0;
265
266         /* acyclic transfer has no fields at the end */
267                 snprintf (szFieldSummary, sizeof(szFieldSummary),
268                                   "%sFrameID: 0x%04x, DataLen: %4u",
269                                 pszProtAddInfo, u16FrameID, tvb_len - 2);
270
271         /* user data length is packet len - frame id field */
272         data_len = tvb_len - 2;
273     }
274
275     /* build protocol tree only, if tree is really used */
276     if (tree) {
277                 /* build pn_rt protocol tree with summary line */
278             if (pn_rt_summary_in_tree) {
279               ti = proto_tree_add_protocol_format(tree, proto_pn_rt, tvb, 0, -1,
280                                 "PROFINET %s, %s", pszProtSummary, szFieldSummary);
281             } else {
282                         ti = proto_tree_add_item(tree, proto_pn_rt, tvb, 0, -1, FALSE);
283             }
284                 pn_rt_tree = proto_item_add_subtree(ti, ett_pn_rt);
285
286                 /* add frame ID */
287         proto_tree_add_uint_format(pn_rt_tree, hf_pn_rt_id, tvb,
288           0, 2, u16FrameID, "FrameID: 0x%04x (%s)", u16FrameID, pszProtComment);
289
290         if (bCyclic) {
291                     /* add cycle counter */
292             proto_tree_add_uint_format(pn_rt_tree, hf_pn_rt_cycle_counter, tvb,
293               tvb_len - 4, 2, u16CycleCounter, "CycleCounter: %u", u16CycleCounter);
294                     
295             /* add data status subtree */
296                     item = proto_tree_add_uint_format(pn_rt_tree, hf_pn_rt_data_status, 
297                             tvb, tvb_len - 2, 1, u8DataStatus,
298                             "DataStatus: 0x%02x (Frame: %s and %s, Provider: %s and %s)", 
299                             u8DataStatus, 
300                             (u8DataStatus & 0x04) ? "Valid" : "Invalid",
301                             (u8DataStatus & 0x01) ? "Primary" : "Backup",
302                             (u8DataStatus & 0x20) ? "Ok" : "Problem",
303                             (u8DataStatus & 0x10) ? "Run" : "Stop");
304                     ds_tree = proto_item_add_subtree(item, ett_pn_rt_data_status);
305                 proto_tree_add_uint(ds_tree, hf_pn_rt_data_status_res67, tvb, tvb_len - 2, 1, u8DataStatus);
306                 proto_tree_add_uint(ds_tree, hf_pn_rt_data_status_ok, tvb, tvb_len - 2, 1, u8DataStatus);
307                 proto_tree_add_uint(ds_tree, hf_pn_rt_data_status_operate, tvb, tvb_len - 2, 1, u8DataStatus);
308                 proto_tree_add_uint(ds_tree, hf_pn_rt_data_status_res3, tvb, tvb_len - 2, 1, u8DataStatus);
309                 proto_tree_add_uint(ds_tree, hf_pn_rt_data_status_valid, tvb, tvb_len - 2, 1, u8DataStatus);
310                 proto_tree_add_uint(ds_tree, hf_pn_rt_data_status_res1, tvb, tvb_len - 2, 1, u8DataStatus);
311                 proto_tree_add_uint(ds_tree, hf_pn_rt_data_status_primary, tvb, tvb_len - 2, 1, u8DataStatus);
312
313                 /* add transfer status */
314                 if (u8TransferStatus) {
315                         proto_tree_add_uint_format(pn_rt_tree, hf_pn_rt_transfer_status, tvb,
316                             tvb_len - 1, 1, u8TransferStatus, 
317                                     "TransferStatus: 0x%02x (ignore this frame)", u8TransferStatus);
318                     } else {
319                         proto_tree_add_uint_format(pn_rt_tree, hf_pn_rt_transfer_status, tvb,
320                             tvb_len - 1, 1, u8TransferStatus, 
321                                     "TransferStatus: 0x%02x (OK)", u8TransferStatus);
322                     }
323         }
324     }
325                 
326         /* update column info now */
327     if (check_col(pinfo->cinfo, COL_INFO))
328       col_add_fstr(pinfo->cinfo, COL_INFO, szFieldSummary);
329         if (check_col(pinfo->cinfo, COL_PROTOCOL))
330             col_add_str(pinfo->cinfo, COL_PROTOCOL, pszProtShort);
331
332     pinfo->private_data = GUINT_TO_POINTER( (guint32) u16FrameID);
333
334         /* get frame user data tvb (without header and footer) */
335         next_tvb = tvb_new_subset(tvb, 2, data_len, data_len);
336
337     /* ask heuristics, if some sub-dissector is interested in this packet payload */
338     if(!dissector_try_heuristic(heur_subdissector_list, next_tvb, pinfo, tree)) {
339         /*if (check_col(pinfo->cinfo, COL_INFO))
340               col_add_fstr(pinfo->cinfo, COL_INFO, "Unknown");*/
341
342         /* Oh, well, we don't know this; dissect it as data. */
343         call_dissector(data_handle, next_tvb, pinfo, tree);
344     }
345 }
346
347
348 /* Register all the bits needed by the filtering engine */
349 void 
350 proto_register_pn_rt(void)
351 {
352   static hf_register_info hf[] = {
353     { &hf_pn_rt_id,
354       { "FrameID", "pn_rt.frame_id", FT_UINT16, BASE_DEC, NULL, 0x0, "", HFILL }},
355     { &hf_pn_rt_data,
356       { "Data", "pn_rt.data", FT_BYTES, BASE_HEX, NULL, 0x0, "", HFILL }},
357         { &hf_pn_rt_cycle_counter, { 
358                 "CycleCounter", "pn_rt.cycle_counter", FT_UINT16, BASE_DEC, NULL, 0x0, "", HFILL }},
359         { &hf_pn_rt_data_status, { 
360                 "DataStatus", "pn_rt.ds", FT_UINT8, BASE_HEX, 0, 0x0, "", HFILL }},
361         { &hf_pn_rt_data_status_res67, { 
362                 "Reserved (should be zero)", "pn_rt.ds_res67", FT_UINT8, BASE_HEX, 0, 0xc0, "", HFILL }},
363         { &hf_pn_rt_data_status_ok, { 
364                 "StationProblemIndicator (1:Ok/0:Problem)", "pn_rt.ds_ok", FT_UINT8, BASE_HEX, 0, 0x20, "", HFILL }},
365         { &hf_pn_rt_data_status_operate, { 
366                 "ProviderState (1:Run/0:Stop)", "pn_rt.ds_operate", FT_UINT8, BASE_HEX, 0, 0x10, "", HFILL }},
367         { &hf_pn_rt_data_status_res3, { 
368                 "Reserved (should be zero)", "pn_rt.ds_res3", FT_UINT8, BASE_HEX, 0, 0x08, "", HFILL }},
369         { &hf_pn_rt_data_status_valid, { 
370                 "DataValid (1:Valid/0:Invalid)", "pn_rt.ds_valid", FT_UINT8, BASE_HEX, 0, 0x04, "", HFILL }},
371         { &hf_pn_rt_data_status_res1, { 
372                 "Reserved (should be zero)", "pn_rt.ds_res1", FT_UINT8, BASE_HEX, 0, 0x02, "", HFILL }},
373         { &hf_pn_rt_data_status_primary, { 
374                 "State (1:Primary/0:Backup)", "pn_rt.ds_primary", FT_UINT8, BASE_HEX, 0, 0x01, "", HFILL }},
375     { &hf_pn_rt_transfer_status,
376       { "TransferStatus", "pn_rt.transfer_status", FT_UINT8, BASE_DEC, NULL, 0x0, "", HFILL }},
377         { &hf_pn_rt_malformed,
378         { "Malformed", "pn_rt.malformed", FT_BYTES, BASE_HEX, NULL, 0x0, "", HFILL }}
379   };
380   static gint *ett[] = {
381     &ett_pn_rt,
382     &ett_pn_rt_data_status,
383   };
384   module_t *pn_rt_module; 
385
386   proto_pn_rt = proto_register_protocol("PROFINET Real-Time Protocol",
387                                        "PN-RT", "pn_rt");
388
389   proto_register_field_array(proto_pn_rt, hf, array_length(hf));
390   proto_register_subtree_array(ett, array_length(ett));
391
392   /* Register our configuration options */
393
394   pn_rt_module = prefs_register_protocol(proto_pn_rt, proto_reg_handoff_pn_rt);
395
396   prefs_register_bool_preference(pn_rt_module, "summary_in_tree",
397             "Show PN-RT summary in protocol tree",
398             "Whether the PN-RT summary line should be shown in the protocol tree",
399             &pn_rt_summary_in_tree);
400
401   /* register heuristics anchor for payload dissectors */
402   register_heur_dissector_list("pn_rt", &heur_subdissector_list);
403 }
404
405
406 /* The registration hand-off routine 
407  * Is called at startup, and everytime the preferences of this protocol changed. */
408 void
409 proto_reg_handoff_pn_rt(void)
410 {
411   static int pn_rt_prefs_initialized = FALSE;
412   static dissector_handle_t pn_rt_handle;
413
414
415   if (!pn_rt_prefs_initialized) {
416     pn_rt_handle = create_dissector_handle(dissect_pn_rt, proto_pn_rt);
417     pn_rt_prefs_initialized = TRUE;
418   }
419   else {
420     dissector_delete("ethertype", ETHERTYPE_PROFINET, pn_rt_handle);
421   }
422
423   dissector_add("ethertype", ETHERTYPE_PROFINET, pn_rt_handle);
424
425         /* the official "we don't know that data" dissector */
426   data_handle = find_dissector("data");
427 }
428
429
430
431
432 /* Start the functions we need for the plugin stuff */
433
434 #ifndef __ETHEREAL_STATIC__
435
436 G_MODULE_EXPORT void
437 plugin_reg_handoff(void){
438   proto_reg_handoff_pn_rt();
439 }
440
441 G_MODULE_EXPORT void
442 plugin_init(plugin_address_table_t *pat
443 #ifndef PLUGINS_NEED_ADDRESS_TABLE
444 _U_
445 #endif
446 ){
447   /* initialise the table of pointers needed in Win32 DLLs */
448   plugin_address_table_init(pat);
449   /* register the new protocol, protocol fields, and subtrees */
450   if (proto_pn_rt == -1) { /* execute protocol initialization only once */
451     proto_register_pn_rt();
452   }
453 }
454
455 #endif /* __ETHEREAL_STATIC__ */
456
457 /* End the functions we need for plugin stuff */