summaryrefslogtreecommitdiff
path: root/cesar/cp/inc/trace.h
blob: f16e7f10bf955e2f78bbd5b578296b677f8d289c (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
#ifndef cp_inc_trace_h
#define cp_inc_trace_h
/* Cesar project {{{
 *
 * Copyright (C) 2007 Spidcom
 *
 * <<<Licence>>>
 *
 * }}} */
/**
 * \file    cp/inc/trace.h
 * \brief   Define CP trace events.
 * \ingroup cp
 */
#include "lib/trace.h"
#include "cp/inc/variant.h"

/** Shortcut for tracing inside CP. */
#define CP_TRACE(id, args...) \
    TRACE_SHORT (CP_TRACE_, &ctx->trace, id, ## args)

/** Shortcut for verbose tracing inside CP. */
#define CP_TRACE_VERBOSE(id, args...) \
    TRACE_FAST_SHORT (CP_TRACE_, &ctx->trace_verbose, id, ## args)

#if CONFIG_TRACE

enum
{
    CP_TRACE_FSM_POST,
    CP_TRACE_FSM_TRIGGER,
    CP_TRACE_FSM_POST_URGENT,
    CP_TRACE_FSM_HANDLE_EVENT,
    CP_TRACE_FSM_HANDLE_URGENT_EVENT,
    CP_TRACE_FSM_CHANGE_STATE,
    CP_TRACE_MME_ERROR_IND,
    CP_TRACE_BEACON_BEACON_PROCESS,
    CP_TRACE_MSG_DISPATCH,
    CP_TRACE_MSG_DISPATCH_DROP,
    CP_TRACE_MSG_SEND,
    CP_TRACE_CL_INTERF_PROCESS_MME,
    CP_TRACE_CL_INTERF_MME_NOT_CORRECT,
    CP_TRACE_CL_INTERF_MME_VS_WITH_FMI,
    CP_TRACE_CL_INTERF_GET_BUFFER_TX,
    CP_TRACE_CL_INTERF_MME_SEND,
    CP_TRACE_CL_INTERF_BUFFER_ADD,
    CP_TRACE_CL_INTERF_MME_RX,
    CP_TRACE_CL_INTERF_MME_RX_DROP,
    CP_TRACE_CCO_ASSOC,
    CP_TRACE_CCO_ASSOC_RENEW,
    CP_TRACE_CCO_TEI_EXPIRED,
    CP_TRACE_CE_TX_NEW_TONEMAP,
    CP_TRACE_CE_TX_NEW_DEFAULT_TMI,
    CP_TRACE_CE_TX_DEFAULT_TMI_UNAVAILABLE,
    CP_TRACE_CE_TX_TMI_AVAILABLE_LIST,
    CP_TRACE_CE_TX_TM_EXPIRATION,
    CP_TRACE_CE_TX_RESETED_BY_PBPROC,
    CP_TRACE_CE_TX_RESETED_BY_PEER,
    CP_TRACE_CE_TX_MME_CHAN_EST_ERROR,
    CP_TRACE_CE_TX_MME_TM_UPDATE_ERROR,
    CP_TRACE_SPOC,

    /* This enum must be use to restart this list with
     * specific event in cp/{projet}/inc/trace.h. */
    CP_TRACE_LAST_ENUM,
};

#define TRACE_COMMON_EVENT \
    TRACE_EVENT (CP_TRACE_FSM_POST, "fsm post <%E>"), \
    TRACE_EVENT (CP_TRACE_FSM_TRIGGER, "fsm trigger <%E>"), \
    TRACE_EVENT (CP_TRACE_FSM_POST_URGENT, "fsm post urgent <%E>"), \
    TRACE_EVENT (CP_TRACE_FSM_HANDLE_EVENT, "fsm handle <%E>"), \
    TRACE_EVENT (CP_TRACE_FSM_HANDLE_URGENT_EVENT, \
                     "fsm handle urgent <%E>"), \
    TRACE_EVENT (CP_TRACE_FSM_CHANGE_STATE, "fsm %S => %S"), \
    TRACE_EVENT (CP_TRACE_MME_ERROR_IND, \
                 "mme error ind tei %d reason %d mmv %d mmtype %d offset %d"), \
    TRACE_EVENT (CP_TRACE_BEACON_BEACON_PROCESS, \
                 "Beacon processing, nid : %x, snid : %x, stei : %x, bt : %x, bts : %x", \
                 TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_MSG_DISPATCH, "[MSG] receive %M from %d", \
                 TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_MSG_DISPATCH_DROP, "[MSG] drop %M from %d, cause %Y", \
                 TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_MSG_SEND, "[MSG] send %M to %d", \
                 TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CL_INTERF_PROCESS_MME, \
                 "[CL Interf] PROCESS MME buffer : %x, length : %d, tei : %x, FMI %x", \
                 TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CL_INTERF_MME_NOT_CORRECT, \
                 "[CL Interf] MME NOT CORRECT buffer : %x"), \
    TRACE_EVENT (CP_TRACE_CL_INTERF_MME_VS_WITH_FMI, \
                 "[CL Interf] VS received with FMI mmv %x mmtype %x"), \
    TRACE_EVENT (CP_TRACE_CL_INTERF_GET_BUFFER_TX, \
                 "[CL Interf] GET BUFFER TX buffer : %x", TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CL_INTERF_MME_SEND, \
                 "[CL Interf] MME SEND buffer : %x, length : %d, tei : %x"), \
    TRACE_EVENT (CP_TRACE_CL_INTERF_BUFFER_ADD, \
                 "[CL Interf] BUFFER ADD buffer : %x"), \
    TRACE_EVENT (CP_TRACE_CL_INTERF_MME_RX, \
                 "[CL Interf] MME RX buffer : %x, length : %d", \
                 TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CL_INTERF_MME_RX_DROP, \
                 "[CL Interf] MME RX DROPPED buffer : %x, length : %d, mac: %m", \
                 TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CCO_ASSOC, "[CCo] Assoc, Mac addr : %m, tei : %x"), \
    TRACE_EVENT (CP_TRACE_CCO_ASSOC_RENEW, \
                 "[CCo] Assoc renew, Mac addr : %m, tei : %x"), \
    TRACE_EVENT (CP_TRACE_CCO_TEI_EXPIRED, \
                 "[CCo] tei expired, Mac addr : %m, tei : %x"), \
    TRACE_EVENT (CP_TRACE_CE_TX_NEW_TONEMAP, "[ce_tx] tei %d: " \
                 "new tone map received: tmi %d", TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CE_TX_NEW_DEFAULT_TMI, "[ce_tx] tei %d: " \
                 "default tmi changed: %d -> %d", TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CE_TX_DEFAULT_TMI_UNAVAILABLE, "[ce_tx] tei " \
                 "%d: default tmi unavailable: %d", TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CE_TX_TMI_AVAILABLE_LIST, "[ce_tx] tei %d: " \
                 "tmi enabled list: %T (default %d)", TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CE_TX_TM_EXPIRATION, "[ce_tx] tei %d: " \
                 "TM expiration", TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CE_TX_RESETED_BY_PBPROC, "[ce_tx] " \
                 "reseted (%d) by PBProc", TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CE_TX_RESETED_BY_PEER, "[ce_tx] tei %d: " \
                 "reset by peer", TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CE_TX_MME_CHAN_EST_ERROR, "[ce_tx] tei %d: " \
                 "error in CM_CHAN_EST: %Z", TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_CE_TX_MME_TM_UPDATE_ERROR, "[ce_tx] tei %d: " \
                 "error in CM_TM_UPDATE: %Z", TIMESTAMP), \
    TRACE_EVENT (CP_TRACE_SPOC, "SPOC compute with rho_q30 %x")

BEGIN_DECLS

/**
 * Initialise trace buffer.
 * \param  ctx  cp context
 */
#define cp_trace_init \
    CP_VARIANT_FUNCTION(trace_init)
void
cp_trace_init (cp_t *ctx);

/**
 * Uninitialise trace buffer.
 * \param  ctx  cp context
 */
void
cp_trace_uninit (cp_t *ctx);

/**
 * initialise common trace module between av and eoc.
 * \param  ctx  cp context
 * \param  ns   namespace
 * \param  event_ids  table with all event (common and after specific to
 * projet)
 */
void
cp_trace_common_init (cp_t *ctx, trace_namespace_t *ns,
                      const trace_event_id_t *event_ids);
END_DECLS

#else /* !CONFIG_TRACE */

# define cp_trace_init(ctx) ((void) 0)
# define cp_trace_uninit(ctx) ((void) 0)

#endif /* !CONFIG_TRACE */

#endif /* cp_inc_trace_h */