]>
Commit | Line | Data |
---|---|---|
177a8ead | 1 | // -*- C++ -*- |
44edbcd6 | 2 | // Copyright (C) 2005-2011 Red Hat Inc. |
177a8ead FCE |
3 | // |
4 | // This file is part of systemtap, and is free software. You can | |
5 | // redistribute it and/or modify it under the terms of the GNU General | |
6 | // Public License (GPL); either version 2, or (at your option) any | |
7 | // later version. | |
8 | ||
9 | #ifndef SESSION_H | |
10 | #define SESSION_H | |
11 | ||
9456e4c1 | 12 | #include "config.h" |
79bc39ab LB |
13 | #include <libintl.h> |
14 | #include <locale.h> | |
9456e4c1 | 15 | |
aa4d21c0 | 16 | #include <list> |
177a8ead FCE |
17 | #include <string> |
18 | #include <vector> | |
19 | #include <iostream> | |
20 | #include <sstream> | |
21 | #include <map> | |
7e41d3dc | 22 | #include <set> |
177a8ead | 23 | |
1d3a40b6 | 24 | extern "C" { |
2dce8c42 | 25 | #include <signal.h> |
1d3a40b6 DS |
26 | #include <elfutils/libdw.h> |
27 | } | |
28 | ||
ce4086c8 | 29 | #if ENABLE_NLS |
79bc39ab | 30 | #define _(string) gettext(string) |
46a1a151 JS |
31 | #define _N(string, string_plural, count) \ |
32 | ngettext((string), (string_plural), (count)) | |
ce4086c8 LB |
33 | #else |
34 | #define _(string) (string) | |
46a1a151 JS |
35 | #define _N(string, string_plural, count) \ |
36 | ( (count) == 1 ? (string) : (string_plural) ) | |
ce4086c8 | 37 | #endif |
46a1a151 JS |
38 | #define _F(format, ...) autosprintf(_(format), __VA_ARGS__) |
39 | #define _NF(format, format_plural, count, ...) \ | |
40 | autosprintf(_N((format), (format_plural), (count)), __VA_ARGS__) | |
177a8ead FCE |
41 | |
42 | // forward decls for all referenced systemtap types | |
9b3c54b2 | 43 | struct hash; |
177a8ead FCE |
44 | struct match_node; |
45 | struct stapfile; | |
46 | struct vardecl; | |
cfd621bc | 47 | struct token; |
177a8ead | 48 | struct functiondecl; |
b20febf3 FCE |
49 | struct derived_probe; |
50 | struct be_derived_probe_group; | |
51 | struct dwarf_derived_probe_group; | |
e6fe60e7 | 52 | struct kprobe_derived_probe_group; |
dd225250 | 53 | struct hwbkpt_derived_probe_group; |
83ea76b1 | 54 | struct perf_derived_probe_group; |
888af770 | 55 | struct uprobe_derived_probe_group; |
935447c8 | 56 | struct utrace_derived_probe_group; |
a96d1db0 | 57 | struct itrace_derived_probe_group; |
935447c8 | 58 | struct task_finder_derived_probe_group; |
b20febf3 FCE |
59 | struct timer_derived_probe_group; |
60 | struct profile_derived_probe_group; | |
61 | struct mark_derived_probe_group; | |
0a6f5a3f | 62 | struct tracepoint_derived_probe_group; |
b20febf3 | 63 | struct hrtimer_derived_probe_group; |
604eef3b | 64 | struct procfs_derived_probe_group; |
177a8ead FCE |
65 | struct embeddedcode; |
66 | struct translator_output; | |
67 | struct unparser; | |
68 | struct semantic_error; | |
405b71b8 | 69 | struct module_cache; |
f80d9004 | 70 | struct update_visitor; |
eff14db3 | 71 | struct compile_server_cache; |
177a8ead | 72 | |
177a8ead FCE |
73 | // XXX: a generalized form of this descriptor could be associated with |
74 | // a vardecl instead of out here at the systemtap_session level. | |
75 | struct statistic_decl | |
76 | { | |
77 | statistic_decl() | |
dff50e09 | 78 | : type(none), |
177a8ead | 79 | linear_low(0), linear_high(0), linear_step(0) |
dff50e09 | 80 | {} |
177a8ead | 81 | enum { none, linear, logarithmic } type; |
177a8ead FCE |
82 | int64_t linear_low; |
83 | int64_t linear_high; | |
84 | int64_t linear_step; | |
07c17d67 GH |
85 | bool operator==(statistic_decl const & other) |
86 | { | |
dff50e09 | 87 | return type == other.type |
07c17d67 GH |
88 | && linear_low == other.linear_low |
89 | && linear_high == other.linear_high | |
90 | && linear_step == other.linear_step; | |
91 | } | |
177a8ead FCE |
92 | }; |
93 | ||
177a8ead FCE |
94 | struct systemtap_session |
95 | { | |
abc15290 JS |
96 | private: |
97 | // disable implicit constructors by not implementing these | |
98 | systemtap_session (const systemtap_session& other); | |
99 | systemtap_session& operator= (const systemtap_session& other); | |
100 | ||
101 | // copy constructor used by ::clone() | |
102 | systemtap_session (const systemtap_session& other, | |
103 | const std::string& arch, | |
104 | const std::string& kern); | |
105 | ||
106 | public: | |
177a8ead | 107 | systemtap_session (); |
b0e5fa85 | 108 | ~systemtap_session (); |
aa4d21c0 | 109 | |
28f569c2 | 110 | // NB: It is very important for all of the above (and below) fields |
85007c04 | 111 | // to be cleared in the systemtap_session ctor (session.cxx). |
e2012a7a | 112 | void setup_kernel_release (const char* kstr); |
bb153adb | 113 | void insert_loaded_modules (); |
e2012a7a DB |
114 | |
115 | // command line parsing | |
116 | int parse_cmdline (int argc, char * const argv []); | |
117 | void version (); | |
118 | void usage (int exitcode); | |
119 | void check_options (int argc, char * const argv []); | |
120 | static const char* morehelp; | |
177a8ead | 121 | |
aa4d21c0 | 122 | // NB: It is very important for all of the above (and below) fields |
85007c04 | 123 | // to be cleared in the systemtap_session ctor (session.cxx). |
aa4d21c0 | 124 | |
177a8ead | 125 | // command line args |
e2012a7a DB |
126 | std::string script_file; // FILE |
127 | std::string cmdline_script; // -e PROGRAM | |
128 | bool have_script; | |
177a8ead | 129 | std::vector<std::string> include_path; |
2fad97fd | 130 | int include_arg_start; |
177a8ead FCE |
131 | std::vector<std::string> macros; |
132 | std::vector<std::string> args; | |
1392896d | 133 | std::vector<std::string> kbuildflags; |
bb25d08f | 134 | std::vector<std::string> globalopts; // -G var=val |
e2012a7a | 135 | std::string release; |
177a8ead | 136 | std::string kernel_release; |
197a4d62 | 137 | std::string kernel_base_release; |
7471ea1f | 138 | std::string kernel_build_tree; |
d4393459 | 139 | std::string kernel_source_tree; |
561079c8 | 140 | std::map<std::string,std::string> kernel_config; |
70e6d6c9 | 141 | std::set<std::string> kernel_exports; |
e2012a7a | 142 | std::string machine; |
44ce8ed5 | 143 | std::string architecture; |
177a8ead | 144 | std::string runtime_path; |
2fad97fd | 145 | bool runtime_specified; |
1b78aef5 | 146 | std::string data_path; |
177a8ead | 147 | std::string module_name; |
de0db58a | 148 | std::string stapconf_name; |
177a8ead | 149 | std::string output_file; |
701c41be | 150 | std::string size_option; |
177a8ead | 151 | std::string cmd; |
db135493 | 152 | std::string compatible; // use (strverscmp(s.compatible.c_str(), "N.M") >= 0) |
177a8ead FCE |
153 | int target_pid; |
154 | int last_pass; | |
e0b4e89d | 155 | unsigned perpass_verbose[5]; |
b0ee93c4 | 156 | unsigned verbose; |
a9e8f7e0 | 157 | bool timing; |
e2012a7a | 158 | bool save_module; |
5c854d7c | 159 | bool modname_given; |
177a8ead FCE |
160 | bool keep_tmpdir; |
161 | bool guru_mode; | |
16442b90 | 162 | bool listing_mode; |
8c39844b | 163 | bool listing_mode_vars; |
177a8ead | 164 | bool bulk_mode; |
cbfbbf69 | 165 | bool unoptimized; |
a9e8f7e0 | 166 | bool suppress_warnings; |
57a56e00 | 167 | bool panic_warnings; |
177a8ead | 168 | int buffer_size; |
44f75386 | 169 | bool prologue_searching; |
c3a3c0c9 | 170 | bool tapset_compile_coverage; |
6274464e | 171 | bool need_uprobes; |
08badca8 | 172 | bool need_unwind; |
474d17ad | 173 | std::string uprobes_path; |
7d26ee02 | 174 | std::string uprobes_hash; |
2fa2a091 | 175 | bool load_only; // flight recorder mode |
2dce8c42 DB |
176 | bool omit_werror; |
177 | bool unprivileged; | |
a07a2c28 | 178 | bool systemtap_v_check; |
305fac7d | 179 | bool tmpdir_opt_set; |
2dce8c42 DB |
180 | |
181 | // NB: It is very important for all of the above (and below) fields | |
85007c04 | 182 | // to be cleared in the systemtap_session ctor (session.cxx). |
2dce8c42 DB |
183 | |
184 | // Client/server | |
48e74294 | 185 | #if HAVE_NSS |
44edbcd6 | 186 | static bool NSPR_Initialized; // only once for all sessions |
3d9dfde6 | 187 | void NSPR_init (); |
48e74294 | 188 | #endif |
e2012a7a DB |
189 | bool client_options; |
190 | std::string client_options_disallowed; | |
2dce8c42 DB |
191 | std::vector<std::string> server_status_strings; |
192 | std::vector<std::string> specified_servers; | |
a46f9abe | 193 | bool automatic_server_mode; |
c77af0d0 | 194 | std::string server_trust_spec; |
2fad97fd | 195 | std::vector<std::string> server_args; |
920be590 | 196 | std::string winning_server; |
eff14db3 | 197 | compile_server_cache* server_cache; |
ce286ff0 | 198 | |
44edbcd6 JS |
199 | // NB: It is very important for all of the above (and below) fields |
200 | // to be cleared in the systemtap_session ctor (session.cxx). | |
201 | ||
202 | // Mechanism for retrying compilation with a compile server should it fail due | |
203 | // to lack of resources on the local host. | |
204 | // Once it has been decided not to try the server (e.g. syntax error), | |
205 | // that decision cannot be changed. | |
206 | int try_server_status; | |
207 | bool use_server_on_error; | |
208 | ||
3e1ec884 | 209 | enum { try_server_unset, dont_try_server, do_try_server }; |
44edbcd6 JS |
210 | void init_try_server (); |
211 | void set_try_server (int t = do_try_server); | |
212 | bool try_server () const { return try_server_status == do_try_server; } | |
213 | ||
214 | // NB: It is very important for all of the above (and below) fields | |
215 | // to be cleared in the systemtap_session ctor (session.cxx). | |
216 | ||
daa75206 JS |
217 | // Remote execution |
218 | std::vector<std::string> remote_uris; | |
756cfd49 | 219 | bool use_remote_prefix; |
ebff2ed0 JS |
220 | typedef std::map<std::pair<std::string, std::string>, systemtap_session*> session_map_t; |
221 | session_map_t subsessions; | |
222 | systemtap_session* clone(const std::string& arch, const std::string& release); | |
daa75206 | 223 | |
28f569c2 | 224 | // NB: It is very important for all of the above (and below) fields |
85007c04 | 225 | // to be cleared in the systemtap_session ctor (session.cxx). |
28f569c2 | 226 | |
1b78aef5 | 227 | // Cache data |
d105f664 JS |
228 | bool use_cache; // control all caching |
229 | bool use_script_cache; // control caching of pass-3/4 output | |
230 | bool poison_cache; // consider the cache to be write-only | |
231 | std::string cache_path; // usually ~/.systemtap/cache | |
232 | std::string hash_path; // path to the cached script module | |
233 | std::string stapconf_path; // path to the cached stapconf | |
234 | hash *base_hash; // hash common to all caching | |
1b78aef5 | 235 | |
5f0a03a6 JK |
236 | // dwarfless operation |
237 | bool consult_symtab; | |
238 | std::string kernel_symtab_path; | |
239 | bool ignore_vmlinux; | |
240 | bool ignore_dwarf; | |
241 | ||
3bd0d4df RA |
242 | // Skip bad $ vars |
243 | bool skip_badvars; | |
244 | ||
28f569c2 | 245 | // NB: It is very important for all of the above (and below) fields |
85007c04 | 246 | // to be cleared in the systemtap_session ctor (session.cxx). |
28f569c2 | 247 | |
177a8ead FCE |
248 | // temporary directory for module builds etc. |
249 | // hazardous - it is "rm -rf"'d at exit | |
250 | std::string tmpdir; | |
251 | std::string translated_source; // C source code | |
252 | ||
253 | match_node* pattern_root; | |
254 | void register_library_aliases(); | |
255 | ||
256 | // parse trees for the various script files | |
257 | stapfile* user_file; | |
258 | std::vector<stapfile*> library_files; | |
259 | ||
f80d9004 JS |
260 | // filters to run over all code before symbol resolution |
261 | // e.g. @cast expansion | |
262 | std::vector<update_visitor*> code_filters; | |
263 | ||
177a8ead FCE |
264 | // resolved globals/functions/probes for the run as a whole |
265 | std::vector<stapfile*> files; | |
266 | std::vector<vardecl*> globals; | |
f76427a2 | 267 | std::map<std::string,functiondecl*> functions; |
b20febf3 | 268 | std::vector<derived_probe*> probes; // see also *_probes groups below |
177a8ead FCE |
269 | std::vector<embeddedcode*> embeds; |
270 | std::map<std::string, statistic_decl> stat_decls; | |
c3a3c0c9 WC |
271 | // track things that are removed |
272 | std::vector<vardecl*> unused_globals; | |
273 | std::vector<derived_probe*> unused_probes; // see also *_probes groups below | |
274 | std::vector<functiondecl*> unused_functions; | |
177a8ead FCE |
275 | // XXX: vector<*> instead please? |
276 | ||
b20febf3 FCE |
277 | // Every probe in these groups must also appear in the |
278 | // session.probes vector. | |
279 | be_derived_probe_group* be_derived_probes; | |
280 | dwarf_derived_probe_group* dwarf_derived_probes; | |
e6fe60e7 | 281 | kprobe_derived_probe_group* kprobe_derived_probes; |
dd225250 | 282 | hwbkpt_derived_probe_group* hwbkpt_derived_probes; |
83ea76b1 | 283 | perf_derived_probe_group* perf_derived_probes; |
888af770 | 284 | uprobe_derived_probe_group* uprobe_derived_probes; |
935447c8 | 285 | utrace_derived_probe_group* utrace_derived_probes; |
a96d1db0 | 286 | itrace_derived_probe_group* itrace_derived_probes; |
935447c8 | 287 | task_finder_derived_probe_group* task_finder_derived_probes; |
b20febf3 FCE |
288 | timer_derived_probe_group* timer_derived_probes; |
289 | profile_derived_probe_group* profile_derived_probes; | |
290 | mark_derived_probe_group* mark_derived_probes; | |
0a6f5a3f | 291 | tracepoint_derived_probe_group* tracepoint_derived_probes; |
b20febf3 | 292 | hrtimer_derived_probe_group* hrtimer_derived_probes; |
604eef3b | 293 | procfs_derived_probe_group* procfs_derived_probes; |
28f569c2 | 294 | |
f9355a6c | 295 | // NB: It is very important for all of the above (and below) fields |
85007c04 | 296 | // to be cleared in the systemtap_session ctor (session.cxx). |
177a8ead FCE |
297 | |
298 | // unparser data | |
299 | translator_output* op; | |
300 | unparser* up; | |
301 | ||
84048984 FCE |
302 | // some symbol addresses |
303 | // XXX: these belong elsewhere; perhaps the dwflpp instance | |
304 | Dwarf_Addr sym_kprobes_text_start; | |
305 | Dwarf_Addr sym_kprobes_text_end; | |
306 | Dwarf_Addr sym_stext; | |
1d3a40b6 | 307 | |
a8368458 | 308 | // List of libdwfl module names to extract symbol/unwind data for. |
1a0dbc5a | 309 | std::set<std::string> unwindsym_modules; |
ef06c938 | 310 | bool unwindsym_ldd; |
cbf5ebe1 | 311 | struct module_cache* module_cache; |
a8368458 | 312 | |
28f569c2 | 313 | // NB: It is very important for all of the above (and below) fields |
85007c04 | 314 | // to be cleared in the systemtap_session ctor (session.cxx). |
28f569c2 | 315 | |
7e41d3dc | 316 | std::set<std::string> seen_errors; |
ab54fa85 | 317 | std::set<std::string> seen_warnings; |
57a56e00 | 318 | unsigned num_errors () { return seen_errors.size() + (panic_warnings ? seen_warnings.size() : 0); } |
cfd621bc | 319 | |
2ed04863 WC |
320 | std::set<std::string> rpms_to_install; |
321 | ||
177a8ead | 322 | // void print_error (const parse_error& e); |
cfd621bc FCE |
323 | const token* last_token; |
324 | void print_token (std::ostream& o, const token* tok); | |
177a8ead | 325 | void print_error (const semantic_error& e); |
1b1b4ceb | 326 | void print_error_source (std::ostream&, std::string&, const token* tok); |
cfd621bc | 327 | void print_warning (const std::string& w, const token* tok = 0); |
aa4d21c0 | 328 | void printscript(std::ostream& o); |
b20febf3 | 329 | |
28f569c2 | 330 | // NB: It is very important for all of the above (and below) fields |
85007c04 DB |
331 | // to be cleared in the systemtap_session ctor (session.cxx). |
332 | }; | |
333 | ||
177a8ead | 334 | |
49abf162 | 335 | // global counter of SIGINT/SIGTERM's received |
85007c04 DB |
336 | extern int pending_interrupts; |
337 | ||
177a8ead | 338 | #endif // SESSION_H |
73267b89 JS |
339 | |
340 | /* vim: set sw=2 ts=8 cino=>4,n-2,{2,^-2,t0,(0,u0,w1,M1 : */ |