3 * Gateway Control Protocol -- Context Tracking
7 * Wireshark - Network traffic analyzer
8 * By Gerald Combs <gerald@wireshark.org>
9 * Copyright 1998 Gerald Combs
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 * - handle text-encoded termination wildcards adequtelly
29 * - avoid persistent tracking of NULL and ALL contexts
34 #include <epan/emem.h>
38 static wmem_tree_t* msgs = NULL;
39 static wmem_tree_t* trxs = NULL;
40 static wmem_tree_t* ctxs_by_trx = NULL;
41 static wmem_tree_t* ctxs = NULL;
43 const value_string gcp_cmd_type[] = {
44 { GCP_CMD_NONE, "NoCommand"},
45 { GCP_CMD_ADD_REQ, "addReq"},
46 { GCP_CMD_MOVE_REQ, "moveReq"},
47 { GCP_CMD_MOD_REQ, "modReq"},
48 { GCP_CMD_SUB_REQ, "subtractReq"},
49 { GCP_CMD_AUDITCAP_REQ, "auditCapRequest"},
50 { GCP_CMD_AUDITVAL_REQ, "auditValueRequest"},
51 { GCP_CMD_NOTIFY_REQ, "notifyReq"},
52 { GCP_CMD_SVCCHG_REQ, "serviceChangeReq"},
53 { GCP_CMD_TOPOLOGY_REQ, "topologyReq"},
54 { GCP_CMD_CTX_ATTR_AUDIT_REQ, "ctxAttrAuditReq"},
55 { GCP_CMD_ADD_REPLY, "addReply"},
56 { GCP_CMD_MOVE_REPLY, "moveReply"},
57 { GCP_CMD_MOD_REPLY, "modReply"},
58 { GCP_CMD_SUB_REPLY, "subtractReply"},
59 { GCP_CMD_AUDITCAP_REPLY, "auditCapReply"},
60 { GCP_CMD_AUDITVAL_REPLY, "auditValReply"},
61 { GCP_CMD_NOTIFY_REPLY, "notifyReply"},
62 { GCP_CMD_SVCCHG_REPLY, "serviceChangeReply"},
63 { GCP_CMD_TOPOLOGY_REPLY, "topologyReply"},
67 const value_string gcp_term_types[] = {
68 { GCP_TERM_TYPE_AAL1, "aal1" },
69 { GCP_TERM_TYPE_AAL2, "aal2" },
70 { GCP_TERM_TYPE_AAL1_STRUCT, "aal1struct" },
71 { GCP_TERM_TYPE_IP_RTP, "ipRtp" },
72 { GCP_TERM_TYPE_TDM, "tdm" },
78 static gboolean gcp_initialized = FALSE;
83 msgs = wmem_tree_new_autoreset(wmem_epan_scope(), wmem_file_scope());
84 trxs = wmem_tree_new_autoreset(wmem_epan_scope(), wmem_file_scope());
85 ctxs_by_trx = wmem_tree_new_autoreset(wmem_epan_scope(), wmem_file_scope());
86 ctxs = wmem_tree_new_autoreset(wmem_epan_scope(), wmem_file_scope());
87 gcp_initialized = TRUE;
90 gcp_msg_t* gcp_msg(packet_info* pinfo, int o, gboolean keep_persistent_data) {
92 guint32 framenum = (guint32)pinfo->fd->num;
93 guint32 offset = (guint32)o;
94 address* src = &(pinfo->src);
95 address* dst = &(pinfo->dst);
99 if (keep_persistent_data) {
100 wmem_tree_key_t key[3];
103 key[0].key = &(framenum);
105 key[1].key = &offset;
109 if (( m = (gcp_msg_t *)wmem_tree_lookup32_array(msgs,key) )) {
113 m = wmem_new(wmem_file_scope(), gcp_msg_t);
114 m->framenum = framenum;
115 m->time = pinfo->fd->abs_ts;
119 wmem_tree_insert32_array(msgs,key,m);
122 m = wmem_new0(wmem_packet_scope(), gcp_msg_t);
123 m->framenum = framenum;
128 if (CMP_ADDRESS(src, dst) < 0) {
136 switch(lo_addr->type) {
142 memcpy((guint8*)&(m->hi_addr),hi_addr->data,4);
143 memcpy((guint8*)&(m->lo_addr),lo_addr->data,4);
146 m->hi_addr = mtp3_pc_hash((const mtp3_addr_pc_t *)hi_addr->data);
147 m->lo_addr = mtp3_pc_hash((const mtp3_addr_pc_t *)lo_addr->data);
150 /* XXX: heuristic and error prone */
151 m->hi_addr = g_str_hash(ep_address_to_str(hi_addr));
152 m->lo_addr = g_str_hash(ep_address_to_str(lo_addr));
159 gcp_trx_t* gcp_trx(gcp_msg_t* m ,guint32 t_id , gcp_trx_type_t type, gboolean keep_persistent_data) {
161 gcp_trx_msg_t* trxmsg;
163 if ( !m ) return NULL;
165 if (keep_persistent_data) {
168 for ( trxmsg = m->trxs; trxmsg; trxmsg = trxmsg->next) {
169 if (trxmsg->trx && trxmsg->trx->id == t_id) {
173 DISSECTOR_ASSERT_NOT_REACHED();
175 wmem_tree_key_t key[4];
178 key[0].key = &(m->hi_addr);
180 key[1].key = &(m->lo_addr);
182 key[2].key = &(t_id);
186 trxmsg = wmem_new(wmem_file_scope(), gcp_trx_msg_t);
187 t = (gcp_trx_t *)wmem_tree_lookup32_array(trxs,key);
190 t = wmem_new(wmem_file_scope(), gcp_trx_t);
198 wmem_tree_insert32_array(trxs,key,t);
201 /* XXX: request, reply and ack + point to frames where they are */
203 case GCP_TRX_PENDING:
212 t = wmem_new(wmem_packet_scope(), gcp_trx_t);
213 trxmsg = wmem_new(wmem_packet_scope(), gcp_trx_msg_t);
222 DISSECTOR_ASSERT(trxmsg);
226 trxmsg->last = trxmsg;
229 m->trxs->last = m->trxs->last->next = trxmsg;
238 gcp_ctx_t* gcp_ctx(gcp_msg_t* m, gcp_trx_t* t, guint32 c_id, gboolean persistent) {
239 gcp_ctx_t* context = NULL;
240 gcp_ctx_t** context_p = NULL;
242 if ( !m || !t ) return NULL;
246 wmem_tree_key_t ctx_key[4];
247 wmem_tree_key_t trx_key[4];
249 ctx_key[0].length = 1;
250 ctx_key[0].key = &(m->hi_addr);
251 ctx_key[1].length = 1;
252 ctx_key[1].key = &(m->lo_addr);
253 ctx_key[2].length = 1;
254 ctx_key[2].key = &(c_id);
255 ctx_key[3].length = 0;
256 ctx_key[3].key = NULL;
258 trx_key[0].length = 1;
259 trx_key[0].key = &(m->hi_addr);
260 trx_key[1].length = 1;
261 trx_key[1].key = &(m->lo_addr);
262 trx_key[2].length = 1;
263 trx_key[2].key = &(t->id);
264 trx_key[3].length = 0;
265 trx_key[3].key = NULL;
268 if (( context = (gcp_ctx_t *)wmem_tree_lookup32_array(ctxs_by_trx,trx_key) )) {
270 } if ((context_p = (gcp_ctx_t **)wmem_tree_lookup32_array(ctxs,ctx_key))) {
271 context = *context_p;
274 if (context->initial->framenum <= m->framenum) {
277 } while(( context = context->prev ));
279 DISSECTOR_ASSERT(! "a context should exist");
282 if (c_id == CHOOSE_CONTEXT) {
283 if (! ( context = (gcp_ctx_t *)wmem_tree_lookup32_array(ctxs_by_trx,trx_key))) {
284 context = wmem_new(wmem_file_scope(), gcp_ctx_t);
285 context->initial = m;
286 context->cmds = NULL;
288 context->terms.last = &(context->terms);
289 context->terms.next = NULL;
290 context->terms.term = NULL;
292 wmem_tree_insert32_array(ctxs_by_trx,trx_key,context);
295 if (( context = (gcp_ctx_t *)wmem_tree_lookup32_array(ctxs_by_trx,trx_key) )) {
296 if (( context_p = (gcp_ctx_t **)wmem_tree_lookup32_array(ctxs,ctx_key) )) {
297 if (context != *context_p) {
298 if(context->id != CHOOSE_CONTEXT) {
299 context = wmem_new(wmem_file_scope(), gcp_ctx_t);
301 context->initial = m;
303 context->cmds = NULL;
304 context->terms.last = &(context->terms);
305 context->terms.next = NULL;
306 context->terms.term = NULL;
308 context->prev = *context_p;
309 *context_p = context;
312 context_p = wmem_new(wmem_file_scope(), gcp_ctx_t*);
313 *context_p = context;
314 context->initial = m;
316 wmem_tree_insert32_array(ctxs,ctx_key,context_p);
318 } else if (! ( context_p = (gcp_ctx_t**)wmem_tree_lookup32_array(ctxs,ctx_key) )) {
319 context = wmem_new(wmem_file_scope(), gcp_ctx_t);
320 context->initial = m;
322 context->cmds = NULL;
323 context->terms.last = &(context->terms);
324 context->terms.next = NULL;
325 context->terms.term = NULL;
327 context_p = wmem_new(wmem_file_scope(), gcp_ctx_t*);
328 *context_p = context;
329 wmem_tree_insert32_array(ctxs,ctx_key,context_p);
331 context = *context_p;
336 context = wmem_new(wmem_packet_scope(), gcp_ctx_t);
337 context->initial = m;
338 context->cmds = NULL;
340 context->terms.last = &(context->terms);
341 context->terms.next = NULL;
342 context->terms.term = NULL;
348 gcp_cmd_t* gcp_cmd(gcp_msg_t* m, gcp_trx_t* t, gcp_ctx_t* c, gcp_cmd_type_t type, guint offset, gboolean persistent) {
350 gcp_cmd_msg_t* cmdtrx;
351 gcp_cmd_msg_t* cmdctx;
353 if ( !m || !t || !c ) return NULL;
357 DISSECTOR_ASSERT(t->cmds != NULL);
359 for (cmdctx = t->cmds; cmdctx; cmdctx = cmdctx->next) {
361 if (cmd->msg == m && cmd->offset == offset) {
366 DISSECTOR_ASSERT(!"called for a command that does not exist!");
370 cmd = wmem_new(wmem_file_scope(), gcp_cmd_t);
371 cmdtrx = wmem_new(wmem_file_scope(), gcp_cmd_msg_t);
372 cmdctx = wmem_new(wmem_file_scope(), gcp_cmd_msg_t);
375 cmd = wmem_new(wmem_packet_scope(), gcp_cmd_t);
376 cmdtrx = wmem_new(wmem_packet_scope(), gcp_cmd_msg_t);
377 cmdctx = wmem_new(wmem_packet_scope(), gcp_cmd_msg_t);
381 cmd->offset = offset;
382 cmd->terms.term = NULL;
383 cmd->terms.next = NULL;
384 cmd->terms.last = &(cmd->terms);
391 cmdctx->cmd = cmdtrx->cmd = cmd;
392 cmdctx->next = cmdtrx->next = NULL;
393 cmdctx->last = cmdtrx->last = NULL;
396 t->cmds->last->next = cmdtrx;
397 t->cmds->last = cmdtrx;
400 t->cmds->last = cmdtrx;
404 c->cmds->last->next = cmdctx;
405 c->cmds->last = cmdctx;
408 c->cmds->last = cmdctx;
415 gcp_term_t* gcp_cmd_add_term(gcp_msg_t* m, gcp_trx_t* tr, gcp_cmd_t* c, gcp_term_t* t, gcp_wildcard_t wildcard, gboolean persistent) {
419 static gcp_term_t all_terms = {"$",(const guint8*)"",1,GCP_TERM_TYPE_UNKNOWN,NULL,NULL,NULL};
421 if ( !c ) return NULL;
423 if ( wildcard == GCP_WILDCARD_CHOOSE) {
428 if ( c->msg->commited ) {
429 if (wildcard == GCP_WILDCARD_ALL) {
430 for (ct = c->ctx->terms.next; ct; ct = ct->next) {
431 /* XXX not handling more wilcards in one msg */
432 if ( ct->term->start == m ) {
438 for (ct = c->ctx->terms.next; ct; ct = ct->next) {
439 if ( g_str_equal(ct->term->str,t->str) ) {
447 for (ct = c->ctx->terms.next; ct; ct = ct->next) {
448 if ( g_str_equal(ct->term->str,t->str) || ct->term->start == m) {
455 if (wildcard == GCP_WILDCARD_ALL) {
456 ct = wmem_new(wmem_file_scope(), gcp_terms_t);
458 ct->term = wmem_new0(wmem_file_scope(), gcp_term_t);
462 ct->term->buffer = NULL;
465 c->terms.last = c->terms.last->next = ct;
467 ct2 = wmem_new0(wmem_file_scope(), gcp_terms_t);
468 ct2->term = ct->term;
470 c->ctx->terms.last->next = ct2;
471 c->ctx->terms.last = ct2;
475 for (ct = c->ctx->terms.next; ct; ct = ct->next) {
476 /* XXX not handling more wilcards in one msg */
477 if ( ct->term->buffer == NULL && tr->cmds->cmd->msg == ct->term->start ) {
478 ct->term->str = wmem_strdup(wmem_file_scope(), t->str);
479 ct->term->buffer = (const guint8 *)wmem_memdup(wmem_file_scope(), t->buffer,t->len);
480 ct->term->len = t->len;
482 ct2 = wmem_new0(wmem_file_scope(), gcp_terms_t);
483 ct2->term = ct->term;
485 c->terms.last = c->terms.last->next = ct2;
490 if ( g_str_equal(ct->term->str,t->str) ) {
491 ct2 = wmem_new0(wmem_file_scope(), gcp_terms_t);
492 ct2->term = ct->term;
494 c->terms.last = c->terms.last->next = ct2;
500 ct = wmem_new(wmem_file_scope(), gcp_terms_t);
502 ct->term = wmem_new0(wmem_file_scope(), gcp_term_t);
505 ct->term->str = wmem_strdup(wmem_file_scope(), t->str);
506 ct->term->buffer = (const guint8 *)wmem_memdup(wmem_file_scope(), t->buffer,t->len);
507 ct->term->len = t->len;
509 ct2 = wmem_new0(wmem_file_scope(), gcp_terms_t);
510 ct2->term = ct->term;
512 c->terms.last = c->terms.last->next = ct2;
514 ct2 = wmem_new0(wmem_file_scope(), gcp_terms_t);
515 ct2->term = ct->term;
517 c->ctx->terms.last = c->ctx->terms.last->next = ct2;
522 ct2 = wmem_new0(wmem_file_scope(), gcp_terms_t);
523 ct2->term = ct->term;
525 c->terms.last = c->terms.last->next = ct2;
529 DISSECTOR_ASSERT_NOT_REACHED();
532 ct = wmem_new(wmem_packet_scope(), gcp_terms_t);
535 c->terms.last = c->terms.last->next = ct;
542 const gchar* gcp_cmd_to_str(gcp_cmd_t* c, gboolean persistent) {
546 if ( !c ) return "-";
552 case GCP_CMD_ADD_REQ:
555 case GCP_CMD_MOVE_REQ:
558 case GCP_CMD_MOD_REQ:
561 case GCP_CMD_SUB_REQ:
564 case GCP_CMD_AUDITCAP_REQ:
567 case GCP_CMD_AUDITVAL_REQ:
570 case GCP_CMD_NOTIFY_REQ:
573 case GCP_CMD_SVCCHG_REQ:
576 case GCP_CMD_TOPOLOGY_REQ:
579 case GCP_CMD_CTX_ATTR_AUDIT_REQ:
580 s = "CtxAttribAuditReq {";
582 case GCP_CMD_ADD_REPLY:
585 case GCP_CMD_MOVE_REPLY:
588 case GCP_CMD_MOD_REPLY:
591 case GCP_CMD_SUB_REPLY:
594 case GCP_CMD_AUDITCAP_REPLY:
595 s = "AuditCapReply {";
597 case GCP_CMD_AUDITVAL_REPLY:
598 s = "AuditValReply {";
600 case GCP_CMD_NOTIFY_REPLY:
603 case GCP_CMD_SVCCHG_REPLY:
606 case GCP_CMD_TOPOLOGY_REPLY:
607 s = "TopologyReply {";
612 case GCP_CMD_OTHER_REQ:
620 for (term = c->terms.next; term; term = term->next) {
621 s = wmem_strdup_printf(wmem_packet_scope(), "%s %s",s,term->term->str);
625 s = wmem_strdup_printf(wmem_packet_scope(), "%s Error=%i",s,c->error);
628 s = wmem_strdup_printf(wmem_packet_scope(), "%s }", s);
631 if (! c->str) c->str = wmem_strdup(wmem_file_scope(), s);
639 static const gchar* gcp_trx_to_str(gcp_msg_t* m, gcp_trx_t* t, gboolean persistent) {
643 if ( !m || !t ) return "-";
645 s = wmem_strdup_printf(wmem_packet_scope(), "T %x { ",t->id);
648 if (t->cmds->cmd->ctx) {
649 s = wmem_strdup_printf(wmem_packet_scope(), "%s C %x {",s,t->cmds->cmd->ctx->id);
651 for (c = t->cmds; c; c = c->next) {
652 if (c->cmd->msg == m) {
653 s = wmem_strdup_printf(wmem_packet_scope(), "%s %s",s,gcp_cmd_to_str(c->cmd,persistent));
657 s = wmem_strdup_printf(wmem_packet_scope(), "%s %s",s,"}");
662 s = wmem_strdup_printf(wmem_packet_scope(), "%s Error=%i",s,t->error);
665 return wmem_strdup_printf(wmem_packet_scope(), "%s %s",s,"}");
668 const gchar* gcp_msg_to_str(gcp_msg_t* m, gboolean persistent) {
672 if ( !m ) return "-";
674 for (t = m->trxs; t; t = t->next) {
675 s = wmem_strdup_printf(wmem_packet_scope(), "%s %s",s,gcp_trx_to_str(m,t->trx, persistent));
681 typedef struct _gcp_ctxs_t {
682 struct _gcp_ctx_t* ctx;
683 struct _gcp_ctxs_t* next;
686 /*static const gchar* trx_types[] = {"None","Req","Reply","Pending","Ack"};*/
688 void gcp_analyze_msg(proto_tree* gcp_tree, packet_info* pinfo, tvbuff_t* gcp_tvb, gcp_msg_t* m, gcp_hf_ett_t* ids, expert_field* command_err) {
690 gcp_ctxs_t contexts = {NULL,NULL};
691 gcp_ctxs_t* ctx_node;
695 for (t = m->trxs; t; t = t->next) {
696 for (c = t->trx->cmds; c; c = c->next) {
697 gcp_ctx_t* ctx = c->cmd->ctx;
699 for (ctx_node = contexts.next; ctx_node; ctx_node = ctx_node->next) {
700 if (ctx_node->ctx->id == ctx->id) {
706 ctx_node = wmem_new(wmem_packet_scope(), gcp_ctxs_t);
708 ctx_node->next = contexts.next;
709 contexts.next = ctx_node;
714 for (ctx_node = contexts.next; ctx_node; ctx_node = ctx_node->next) {
715 gcp_ctx_t* ctx = ctx_node->ctx;
716 proto_item* ctx_item = proto_tree_add_uint(gcp_tree,ids->hf.ctx,gcp_tvb,0,0,ctx->id);
717 proto_tree* ctx_tree = proto_item_add_subtree(ctx_item,ids->ett.ctx);
718 gcp_terms_t *ctx_term;
720 PROTO_ITEM_SET_GENERATED(ctx_item);
723 proto_item* history_item = proto_tree_add_text(ctx_tree,gcp_tvb,0,0,"[ Command History ]");
724 proto_tree* history_tree = proto_item_add_subtree(history_item,ids->ett.ctx_cmds);
726 for (c = ctx->cmds; c; c = c->next) {
727 proto_item* cmd_item = proto_tree_add_uint(history_tree,ids->hf.ctx_cmd,gcp_tvb,0,0,c->cmd->msg->framenum);
728 if (c->cmd->str) proto_item_append_text(cmd_item," %s ",c->cmd->str);
729 PROTO_ITEM_SET_GENERATED(cmd_item);
731 expert_add_info(pinfo, cmd_item, command_err);
736 if (( ctx_term = ctx->terms.next )) {
737 proto_item* terms_item = proto_tree_add_text(ctx_tree,gcp_tvb,0,0,"[ Terminations Used ]");
738 proto_tree* terms_tree = proto_item_add_subtree(terms_item,ids->ett.ctx_terms);
740 for (; ctx_term; ctx_term = ctx_term->next ) {
741 if ( ctx_term->term && ctx_term->term->str) {
742 proto_item* pi = proto_tree_add_string(terms_tree,ids->hf.ctx_term,gcp_tvb,0,0,ctx_term->term->str);
743 proto_tree* term_tree = proto_item_add_subtree(pi,ids->ett.ctx_term);
745 PROTO_ITEM_SET_GENERATED(pi);
747 if (ctx_term->term->type) {
748 pi = proto_tree_add_uint(term_tree,ids->hf.ctx_term_type,gcp_tvb,0,0,ctx_term->term->type);
749 PROTO_ITEM_SET_GENERATED(pi);
752 if (ctx_term->term->bir) {
753 pi = proto_tree_add_string(term_tree,ids->hf.ctx_term_bir,gcp_tvb,0,0,ctx_term->term->bir);
754 PROTO_ITEM_SET_GENERATED(pi);
757 if (ctx_term->term->nsap) {
758 pi = proto_tree_add_string(term_tree,ids->hf.ctx_term_nsap,gcp_tvb,0,0,ctx_term->term->nsap);
759 PROTO_ITEM_SET_GENERATED(pi);
762 if (ctx_term->term->bir && ctx_term->term->nsap) {
763 gchar* tmp_key = wmem_strdup_printf(wmem_packet_scope(), "%s:%s",ctx_term->term->nsap,ctx_term->term->bir);
764 gchar* key = g_ascii_strdown(tmp_key, -1);
765 alcap_tree_from_bearer_key(term_tree, gcp_tvb, pinfo, key);