]>
Commit | Line | Data |
---|---|---|
177a8ead | 1 | // -*- C++ -*- |
73f52eb4 | 2 | // Copyright (C) 2005-2012 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> |
985892de | 23 | #include <stdexcept> |
177a8ead | 24 | |
1d3a40b6 | 25 | extern "C" { |
2dce8c42 | 26 | #include <signal.h> |
1d3a40b6 DS |
27 | #include <elfutils/libdw.h> |
28 | } | |
29 | ||
3892d516 | 30 | #include "privilege.h" |
0d98c8da | 31 | #include "util.h" |
177a8ead FCE |
32 | |
33 | // forward decls for all referenced systemtap types | |
dec33462 | 34 | class stap_hash; |
b9aa5bb4 | 35 | class match_node; |
177a8ead FCE |
36 | struct stapfile; |
37 | struct vardecl; | |
cfd621bc | 38 | struct token; |
177a8ead | 39 | struct functiondecl; |
b20febf3 FCE |
40 | struct derived_probe; |
41 | struct be_derived_probe_group; | |
42 | struct dwarf_derived_probe_group; | |
e6fe60e7 | 43 | struct kprobe_derived_probe_group; |
dd225250 | 44 | struct hwbkpt_derived_probe_group; |
83ea76b1 | 45 | struct perf_derived_probe_group; |
888af770 | 46 | struct uprobe_derived_probe_group; |
935447c8 | 47 | struct utrace_derived_probe_group; |
a96d1db0 | 48 | struct itrace_derived_probe_group; |
935447c8 | 49 | struct task_finder_derived_probe_group; |
b20febf3 | 50 | struct timer_derived_probe_group; |
8d9609f5 | 51 | struct netfilter_derived_probe_group; |
b20febf3 FCE |
52 | struct profile_derived_probe_group; |
53 | struct mark_derived_probe_group; | |
0a6f5a3f | 54 | struct tracepoint_derived_probe_group; |
b20febf3 | 55 | struct hrtimer_derived_probe_group; |
604eef3b | 56 | struct procfs_derived_probe_group; |
f31a77f5 | 57 | struct dynprobe_derived_probe_group; |
177a8ead | 58 | struct embeddedcode; |
b9aa5bb4 | 59 | class translator_output; |
177a8ead FCE |
60 | struct unparser; |
61 | struct semantic_error; | |
405b71b8 | 62 | struct module_cache; |
f80d9004 | 63 | struct update_visitor; |
eff14db3 | 64 | struct compile_server_cache; |
177a8ead | 65 | |
177a8ead FCE |
66 | // XXX: a generalized form of this descriptor could be associated with |
67 | // a vardecl instead of out here at the systemtap_session level. | |
68 | struct statistic_decl | |
69 | { | |
70 | statistic_decl() | |
dff50e09 | 71 | : type(none), |
177a8ead | 72 | linear_low(0), linear_high(0), linear_step(0) |
dff50e09 | 73 | {} |
177a8ead | 74 | enum { none, linear, logarithmic } type; |
177a8ead FCE |
75 | int64_t linear_low; |
76 | int64_t linear_high; | |
77 | int64_t linear_step; | |
07c17d67 GH |
78 | bool operator==(statistic_decl const & other) |
79 | { | |
dff50e09 | 80 | return type == other.type |
07c17d67 GH |
81 | && linear_low == other.linear_low |
82 | && linear_high == other.linear_high | |
83 | && linear_step == other.linear_step; | |
84 | } | |
177a8ead FCE |
85 | }; |
86 | ||
fe410f52 SM |
87 | struct macrodecl; // defined in parse.h |
88 | ||
177a8ead FCE |
89 | struct systemtap_session |
90 | { | |
abc15290 JS |
91 | private: |
92 | // disable implicit constructors by not implementing these | |
93 | systemtap_session (const systemtap_session& other); | |
94 | systemtap_session& operator= (const systemtap_session& other); | |
95 | ||
96 | // copy constructor used by ::clone() | |
97 | systemtap_session (const systemtap_session& other, | |
98 | const std::string& arch, | |
99 | const std::string& kern); | |
100 | ||
101 | public: | |
177a8ead | 102 | systemtap_session (); |
b0e5fa85 | 103 | ~systemtap_session (); |
aa4d21c0 | 104 | |
b96901b7 CM |
105 | // To reset the tmp_dir |
106 | void create_tmp_dir(); | |
107 | void remove_tmp_dir(); | |
108 | void reset_tmp_dir(); | |
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; |
08fce398 | 131 | std::vector<std::string> c_macros; |
177a8ead | 132 | std::vector<std::string> args; |
633e5ca7 | 133 | std::vector<std::string> kbuildflags; // -B var=val |
bb25d08f | 134 | std::vector<std::string> globalopts; // -G var=val |
633e5ca7 | 135 | std::vector<std::string> modinfos; // --modinfo tag=value |
8dfad013 | 136 | |
e2012a7a | 137 | std::string release; |
177a8ead | 138 | std::string kernel_release; |
197a4d62 | 139 | std::string kernel_base_release; |
7471ea1f | 140 | std::string kernel_build_tree; |
d4393459 | 141 | std::string kernel_source_tree; |
8dfad013 JS |
142 | std::map<std::string,std::string> kernel_config; |
143 | std::set<std::string> kernel_exports; | |
2a639817 | 144 | std::set<std::string> kernel_functions; |
8dfad013 JS |
145 | int parse_kernel_config (); |
146 | int parse_kernel_exports (); | |
2a639817 | 147 | int parse_kernel_functions (); |
8dfad013 | 148 | |
05fb3e0c WF |
149 | std::string sysroot; |
150 | std::map<std::string,std::string> sysenv; | |
151 | bool update_release_sysroot; | |
e2012a7a | 152 | std::string machine; |
44ce8ed5 | 153 | std::string architecture; |
50f2545f | 154 | bool native_build; |
177a8ead | 155 | std::string runtime_path; |
2fad97fd | 156 | bool runtime_specified; |
1b78aef5 | 157 | std::string data_path; |
177a8ead | 158 | std::string module_name; |
4441e344 | 159 | const std::string module_filename() const; |
de0db58a | 160 | std::string stapconf_name; |
177a8ead | 161 | std::string output_file; |
701c41be | 162 | std::string size_option; |
177a8ead | 163 | std::string cmd; |
db135493 | 164 | std::string compatible; // use (strverscmp(s.compatible.c_str(), "N.M") >= 0) |
177a8ead FCE |
165 | int target_pid; |
166 | int last_pass; | |
e0b4e89d | 167 | unsigned perpass_verbose[5]; |
b0ee93c4 | 168 | unsigned verbose; |
a9e8f7e0 | 169 | bool timing; |
e2012a7a | 170 | bool save_module; |
5c854d7c | 171 | bool modname_given; |
177a8ead FCE |
172 | bool keep_tmpdir; |
173 | bool guru_mode; | |
16442b90 | 174 | bool listing_mode; |
8c39844b | 175 | bool listing_mode_vars; |
177a8ead | 176 | bool bulk_mode; |
cbfbbf69 | 177 | bool unoptimized; |
a9e8f7e0 | 178 | bool suppress_warnings; |
57a56e00 | 179 | bool panic_warnings; |
177a8ead | 180 | int buffer_size; |
44f75386 | 181 | bool prologue_searching; |
c3a3c0c9 | 182 | bool tapset_compile_coverage; |
6274464e | 183 | bool need_uprobes; |
08badca8 | 184 | bool need_unwind; |
8af41ec2 | 185 | bool need_symbols; |
474d17ad | 186 | std::string uprobes_path; |
7d26ee02 | 187 | std::string uprobes_hash; |
2fa2a091 | 188 | bool load_only; // flight recorder mode |
2dce8c42 | 189 | bool omit_werror; |
42e38653 | 190 | privilege_t privilege; |
73f52eb4 | 191 | bool privilege_set; |
a07a2c28 | 192 | bool systemtap_v_check; |
305fac7d | 193 | bool tmpdir_opt_set; |
b82d77b4 | 194 | bool dump_probe_types; |
ea60076d | 195 | int download_dbinfo; |
7baf48e9 | 196 | bool suppress_handler_errors; |
152fa051 | 197 | bool suppress_time_limits; |
2dce8c42 | 198 | |
4441e344 | 199 | enum { kernel_runtime, dyninst_runtime } runtime_mode; |
ac3af990 | 200 | bool runtime_usermode_p() const { return runtime_mode == dyninst_runtime; } |
4441e344 | 201 | |
2dce8c42 | 202 | // NB: It is very important for all of the above (and below) fields |
85007c04 | 203 | // to be cleared in the systemtap_session ctor (session.cxx). |
2dce8c42 DB |
204 | |
205 | // Client/server | |
48e74294 | 206 | #if HAVE_NSS |
44edbcd6 | 207 | static bool NSPR_Initialized; // only once for all sessions |
3d9dfde6 | 208 | void NSPR_init (); |
48e74294 | 209 | #endif |
e2012a7a | 210 | bool client_options; |
372c6458 | 211 | std::string client_options_disallowed_for_unprivileged; |
2dce8c42 DB |
212 | std::vector<std::string> server_status_strings; |
213 | std::vector<std::string> specified_servers; | |
a46f9abe | 214 | bool automatic_server_mode; |
c77af0d0 | 215 | std::string server_trust_spec; |
2fad97fd | 216 | std::vector<std::string> server_args; |
920be590 | 217 | std::string winning_server; |
eff14db3 | 218 | compile_server_cache* server_cache; |
ce286ff0 | 219 | |
44edbcd6 JS |
220 | // NB: It is very important for all of the above (and below) fields |
221 | // to be cleared in the systemtap_session ctor (session.cxx). | |
222 | ||
223 | // Mechanism for retrying compilation with a compile server should it fail due | |
224 | // to lack of resources on the local host. | |
225 | // Once it has been decided not to try the server (e.g. syntax error), | |
226 | // that decision cannot be changed. | |
227 | int try_server_status; | |
228 | bool use_server_on_error; | |
229 | ||
3e1ec884 | 230 | enum { try_server_unset, dont_try_server, do_try_server }; |
44edbcd6 JS |
231 | void init_try_server (); |
232 | void set_try_server (int t = do_try_server); | |
233 | bool try_server () const { return try_server_status == do_try_server; } | |
234 | ||
235 | // NB: It is very important for all of the above (and below) fields | |
236 | // to be cleared in the systemtap_session ctor (session.cxx). | |
237 | ||
daa75206 JS |
238 | // Remote execution |
239 | std::vector<std::string> remote_uris; | |
756cfd49 | 240 | bool use_remote_prefix; |
ebff2ed0 JS |
241 | typedef std::map<std::pair<std::string, std::string>, systemtap_session*> session_map_t; |
242 | session_map_t subsessions; | |
243 | systemtap_session* clone(const std::string& arch, const std::string& release); | |
daa75206 | 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 | |
1b78aef5 | 248 | // Cache data |
d105f664 JS |
249 | bool use_cache; // control all caching |
250 | bool use_script_cache; // control caching of pass-3/4 output | |
251 | bool poison_cache; // consider the cache to be write-only | |
252 | std::string cache_path; // usually ~/.systemtap/cache | |
253 | std::string hash_path; // path to the cached script module | |
254 | std::string stapconf_path; // path to the cached stapconf | |
dec33462 | 255 | stap_hash *base_hash; // hash common to all caching |
1b78aef5 | 256 | |
5f0a03a6 JK |
257 | // dwarfless operation |
258 | bool consult_symtab; | |
259 | std::string kernel_symtab_path; | |
5f0a03a6 | 260 | |
3bd0d4df RA |
261 | // Skip bad $ vars |
262 | bool skip_badvars; | |
263 | ||
28f569c2 | 264 | // NB: It is very important for all of the above (and below) fields |
85007c04 | 265 | // to be cleared in the systemtap_session ctor (session.cxx). |
28f569c2 | 266 | |
177a8ead FCE |
267 | // temporary directory for module builds etc. |
268 | // hazardous - it is "rm -rf"'d at exit | |
269 | std::string tmpdir; | |
270 | std::string translated_source; // C source code | |
271 | ||
272 | match_node* pattern_root; | |
273 | void register_library_aliases(); | |
274 | ||
f7a557ae | 275 | // data for various preprocessor library macros |
fe410f52 SM |
276 | std::map<std::string, macrodecl*> library_macros; |
277 | std::vector<stapfile*> library_macro_files; // for error reporting purposes | |
f7a557ae | 278 | |
177a8ead FCE |
279 | // parse trees for the various script files |
280 | stapfile* user_file; | |
281 | std::vector<stapfile*> library_files; | |
282 | ||
f80d9004 JS |
283 | // filters to run over all code before symbol resolution |
284 | // e.g. @cast expansion | |
285 | std::vector<update_visitor*> code_filters; | |
286 | ||
177a8ead FCE |
287 | // resolved globals/functions/probes for the run as a whole |
288 | std::vector<stapfile*> files; | |
289 | std::vector<vardecl*> globals; | |
f76427a2 | 290 | std::map<std::string,functiondecl*> functions; |
3689db05 SC |
291 | // probe counter name -> probe associated with counter |
292 | std::map<std::string, std::pair<std::string,derived_probe*> > perf_counters; | |
b20febf3 | 293 | std::vector<derived_probe*> probes; // see also *_probes groups below |
177a8ead FCE |
294 | std::vector<embeddedcode*> embeds; |
295 | std::map<std::string, statistic_decl> stat_decls; | |
c3a3c0c9 WC |
296 | // track things that are removed |
297 | std::vector<vardecl*> unused_globals; | |
298 | std::vector<derived_probe*> unused_probes; // see also *_probes groups below | |
299 | std::vector<functiondecl*> unused_functions; | |
177a8ead FCE |
300 | // XXX: vector<*> instead please? |
301 | ||
b20febf3 FCE |
302 | // Every probe in these groups must also appear in the |
303 | // session.probes vector. | |
304 | be_derived_probe_group* be_derived_probes; | |
305 | dwarf_derived_probe_group* dwarf_derived_probes; | |
e6fe60e7 | 306 | kprobe_derived_probe_group* kprobe_derived_probes; |
dd225250 | 307 | hwbkpt_derived_probe_group* hwbkpt_derived_probes; |
83ea76b1 | 308 | perf_derived_probe_group* perf_derived_probes; |
888af770 | 309 | uprobe_derived_probe_group* uprobe_derived_probes; |
935447c8 | 310 | utrace_derived_probe_group* utrace_derived_probes; |
a96d1db0 | 311 | itrace_derived_probe_group* itrace_derived_probes; |
935447c8 | 312 | task_finder_derived_probe_group* task_finder_derived_probes; |
b20febf3 | 313 | timer_derived_probe_group* timer_derived_probes; |
8d9609f5 | 314 | netfilter_derived_probe_group* netfilter_derived_probes; |
b20febf3 FCE |
315 | profile_derived_probe_group* profile_derived_probes; |
316 | mark_derived_probe_group* mark_derived_probes; | |
0a6f5a3f | 317 | tracepoint_derived_probe_group* tracepoint_derived_probes; |
b20febf3 | 318 | hrtimer_derived_probe_group* hrtimer_derived_probes; |
604eef3b | 319 | procfs_derived_probe_group* procfs_derived_probes; |
f31a77f5 | 320 | dynprobe_derived_probe_group* dynprobe_derived_probes; |
28f569c2 | 321 | |
f9355a6c | 322 | // NB: It is very important for all of the above (and below) fields |
85007c04 | 323 | // to be cleared in the systemtap_session ctor (session.cxx). |
177a8ead FCE |
324 | |
325 | // unparser data | |
326 | translator_output* op; | |
a4b9c3b3 | 327 | std::vector<translator_output*> auxiliary_outputs; |
177a8ead FCE |
328 | unparser* up; |
329 | ||
84048984 FCE |
330 | // some symbol addresses |
331 | // XXX: these belong elsewhere; perhaps the dwflpp instance | |
332 | Dwarf_Addr sym_kprobes_text_start; | |
333 | Dwarf_Addr sym_kprobes_text_end; | |
334 | Dwarf_Addr sym_stext; | |
1d3a40b6 | 335 | |
a8368458 | 336 | // List of libdwfl module names to extract symbol/unwind data for. |
1a0dbc5a | 337 | std::set<std::string> unwindsym_modules; |
ef06c938 | 338 | bool unwindsym_ldd; |
cbf5ebe1 | 339 | struct module_cache* module_cache; |
ecd129af | 340 | std::vector<std::string> build_ids; |
a8368458 | 341 | |
28f569c2 | 342 | // NB: It is very important for all of the above (and below) fields |
85007c04 | 343 | // to be cleared in the systemtap_session ctor (session.cxx). |
28f569c2 | 344 | |
7e41d3dc | 345 | std::set<std::string> seen_errors; |
ab54fa85 | 346 | std::set<std::string> seen_warnings; |
57a56e00 | 347 | unsigned num_errors () { return seen_errors.size() + (panic_warnings ? seen_warnings.size() : 0); } |
cfd621bc | 348 | |
2ed04863 WC |
349 | std::set<std::string> rpms_to_install; |
350 | ||
a4b9c3b3 FCE |
351 | translator_output* op_create_auxiliary(); |
352 | ||
177a8ead | 353 | // void print_error (const parse_error& e); |
cfd621bc FCE |
354 | const token* last_token; |
355 | void print_token (std::ostream& o, const token* tok); | |
177a8ead | 356 | void print_error (const semantic_error& e); |
1b1b4ceb | 357 | void print_error_source (std::ostream&, std::string&, const token* tok); |
cfd621bc | 358 | void print_warning (const std::string& w, const token* tok = 0); |
aa4d21c0 | 359 | void printscript(std::ostream& o); |
b20febf3 | 360 | |
28f569c2 | 361 | // NB: It is very important for all of the above (and below) fields |
85007c04 DB |
362 | // to be cleared in the systemtap_session ctor (session.cxx). |
363 | }; | |
364 | ||
177a8ead | 365 | |
e2d0f787 JS |
366 | struct exit_exception: public std::runtime_error |
367 | { | |
368 | int rc; | |
369 | exit_exception (int rc): | |
370 | runtime_error (_F("early exit requested, rc=%d", rc)), rc(rc) {} | |
371 | }; | |
372 | ||
373 | ||
49abf162 | 374 | // global counter of SIGINT/SIGTERM's received |
85007c04 DB |
375 | extern int pending_interrupts; |
376 | ||
985892de CM |
377 | // Interrupt exception subclass for catching |
378 | // interrupts (i.e. ctrl-c). | |
379 | struct interrupt_exception: public std::runtime_error | |
380 | { | |
381 | interrupt_exception (): | |
382 | runtime_error (_("interrupt received")){} | |
383 | }; | |
384 | ||
e19ebcf7 CM |
385 | void assert_no_interrupts(); |
386 | ||
177a8ead | 387 | #endif // SESSION_H |
73267b89 JS |
388 | |
389 | /* vim: set sw=2 ts=8 cino=>4,n-2,{2,^-2,t0,(0,u0,w1,M1 : */ |