Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
new tracing functions to deal with trace markers
[simgrid.git] / include / instr / instr.h
1 /* Copyright (c) 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef INSTR_H_
8 #define INSTR_H_
9
10 #ifdef HAVE_TRACING
11
12 #define NO_TRACE                0
13 #define TRACE_PLATFORM  1
14 #define TRACE_PROCESS   2
15 #define TRACE_TASK      4
16 #define TRACE_VOLUME    8
17
18 #include "xbt.h"
19 #include "msg/msg.h"
20
21 /* Trace error codes (used in exceptions) */
22 #define TRACE_ERROR_COMPLEX_ROUTES 100
23 #define TRACE_ERROR_TYPE_NOT_DEFINED 200
24 #define TRACE_ERROR_TYPE_ALREADY_DEFINED 201
25 #define TRACE_ERROR_CATEGORY_NOT_DEFINED 300
26 #define TRACE_ERROR_CATEGORY_ALREADY_DEFINED 301
27 #define TRACE_ERROR_MASK 400
28 #define TRACE_ERROR_FILE_OPEN 401
29 #define TRACE_ERROR_START 500
30
31 XBT_PUBLIC(int) TRACE_start_with_mask (const char *filename, int mask);
32 XBT_PUBLIC(int) TRACE_start (const char *filename);
33 XBT_PUBLIC(int) TRACE_end (void);
34 XBT_PUBLIC(int) TRACE_category (const char *category);
35 XBT_PUBLIC(void) TRACE_define_type (const char *type, const char *parent_type, int final);
36 XBT_PUBLIC(int) TRACE_create_category (const char *category, const char *type, const char *parent_category);
37 XBT_PUBLIC(void) TRACE_msg_set_task_category (m_task_t task, const char *category);
38 XBT_PUBLIC(void) TRACE_msg_set_process_category (m_process_t process, const char *category);
39 XBT_PUBLIC(void) TRACE_set_mask (int mask);
40 XBT_PUBLIC(void) __TRACE_host_variable (double time, const char *variable, double value, const char *what);
41 XBT_PUBLIC(void) __TRACE_link_variable (double time, const char *src, const char *dst, const char *variable, double value, const char *what);
42 XBT_PUBLIC(void) TRACE_declare_mark (const char *mark_type);
43 XBT_PUBLIC(void) TRACE_mark (const char *mark_type, const char *mark_value);
44
45 #define TRACE_host_variable_declare(var) \
46         __TRACE_host_variable(0,var,0,"declare");
47
48 #define TRACE_host_variable_set_with_time(time,var,value) \
49         __TRACE_host_variable(time,var,value,"set");
50
51 #define TRACE_host_variable_add_with_time(time,var,value) \
52         __TRACE_host_variable(time,var,value,"add");
53
54 #define TRACE_host_variable_sub_with_time(time,var,value) \
55         __TRACE_host_variable(time,var,value,"sub");
56
57 #define TRACE_host_variable_set(var,value) \
58         __TRACE_host_variable(MSG_get_clock(),var,value,"set");
59
60 #define TRACE_host_variable_add(var,value) \
61         __TRACE_host_variable(MSG_get_clock(),var,value,"add");
62
63 #define TRACE_host_variable_sub(var,value) \
64         __TRACE_host_variable(MSG_get_clock(),var,value,"sub");
65
66 #define TRACE_link_variable_declare(var) \
67         __TRACE_link_variable(0,NULL,NULL,var,0,"declare");
68
69 #define TRACE_link_variable_set_with_time(time,src,dst,var,value) \
70         __TRACE_link_variable(time,src,dst,var,value,"set");
71
72 #define TRACE_link_variable_add_with_time(time,src,dst,var,value) \
73         __TRACE_link_variable(time,src,dst,var,value,"add");
74
75 #define TRACE_link_variable_sub_with_time(time,src,dst,var,value) \
76         __TRACE_link_variable(time,src,dst,var,value,"sub");
77
78 #define TRACE_link_variable_set(src,dst,var,value) \
79         __TRACE_link_variable(MSG_get_clock(),src,dst,var,value,"set");
80
81 #define TRACE_link_variable_add(src,dst,var,value) \
82         __TRACE_link_variable(MSG_get_clock(),src,dst,var,value,"add");
83
84 #define TRACE_link_variable_sub(src,dst,var,value) \
85         __TRACE_link_variable(MSG_get_clock(),src,dst,var,value,"sub");
86
87 #else /* HAVE_TRACING */
88
89 #define TRACE_start(filename)
90 #define TRACE_start_with_mask(filename,mask)
91 #define TRACE_end()
92 #define TRACE_category(cat)
93 #define TRACE_define_type(cat,supercat,final)
94 #define TRACE_create_category(inst,cat)
95 #define TRACE_msg_set_task_category(task,cat)
96 #define TRACE_msg_set_process_category(proc,cat)
97 #define TRACE_set_mask(mask)
98
99 #define TRACE_host_variable_declare(var)
100 #define TRACE_host_variable_set_with_time(time,var,value)
101 #define TRACE_host_variable_add_with_time(time,var,value)
102 #define TRACE_host_variable_sub_with_time(time,var,value)
103 #define TRACE_host_variable_set(var,value)
104 #define TRACE_host_variable_add(var,value)
105 #define TRACE_host_variable_sub(var,value)
106 #define TRACE_link_variable_declare(var)
107 #define TRACE_link_variable_set_with_time(time,src,dst,var,value)
108 #define TRACE_link_variable_add_with_time(time,src,dst,var,value)
109 #define TRACE_link_variable_sub_with_time(time,src,dst,var,value)
110 #define TRACE_link_variable_set(src,dst,var,value)
111 #define TRACE_link_variable_add(src,dst,var,value)
112 #define TRACE_link_variable_sub(src,dst,var,value)
113 #define TRACE_declare_mark (mark_type)
114 #define TRACE_mark (mark_type, mark_value)
115
116 #endif /* HAVE_TRACING */
117
118 #endif /* INSTR_H_ */