Update copyright to LGPL on all files
[dyninst.git] / testsuite / src / dyninst / ParseThat.h
1 /*
2  * Copyright (c) 1996-2009 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31 #ifndef __PARSE_THAT_H__
32 #define __PARSE_THAT_H__
33
34 #include <string>
35 #include <vector>
36 #include "test_lib.h"
37 //#include "dyninst_comp.h"
38 #include "util.h"
39 //  A (hopefully simple) c++ class interface for issuing parseThat commands
40 //  inside the testsuite
41
42 class ParseThat {
43         public:
44
45         typedef enum {
46                 T_None,
47                 T_Func,
48                 T_Mod,
49                 T_Proc
50         } InstTransaction;
51
52         typedef enum {
53                 PL_Module = 0,
54                 PL_Func = 1,
55                 PL_CFG = 2
56         } ParseLevel;
57
58         typedef enum {
59                 IL_None = 0,
60                 IL_FuncEntry = 1,
61                 IL_FuncExit = 2,
62                 IL_BasicBlock = 3,
63                 IL_MemRead = 4,
64                 IL_MemWrite = 5 
65         } InstLevel;
66
67         TESTLIB_DLL_EXPORT ParseThat();
68         TESTLIB_DLL_EXPORT ~ParseThat();
69
70         TESTLIB_DLL_EXPORT void pt_output_redirect(std::string fname) {pt_out_name = fname;}
71         TESTLIB_DLL_EXPORT void cmd_stdout_redirect(std::string fname) {cmd_stdout_name = fname;}
72         TESTLIB_DLL_EXPORT void cmd_stderr_redirect(std::string fname) {cmd_stderr_name = fname;}
73         TESTLIB_DLL_EXPORT void func_only(std::string fname) {limit_func = fname;}
74         TESTLIB_DLL_EXPORT void module_only(std::string mname) {limit_mod = mname;}
75         TESTLIB_DLL_EXPORT void set_transactions(InstTransaction t) {trans = t;}
76         TESTLIB_DLL_EXPORT void skip_functions_matching(std::string regex) {skip_funcs = regex;}
77         TESTLIB_DLL_EXPORT void skip_modules_matching(std::string regex) {skip_mods = regex;}
78         TESTLIB_DLL_EXPORT void suppress_ipc_messages() {suppress_ipc  = true;}
79         TESTLIB_DLL_EXPORT void set_verbosity(int v) {verbosity = v;}
80         TESTLIB_DLL_EXPORT void dont_fork() {nofork = true;}
81         TESTLIB_DLL_EXPORT void set_timeout(unsigned secs) {timeout_secs  = secs;}
82         TESTLIB_DLL_EXPORT void set_tracing() {do_trace = true;}
83         TESTLIB_DLL_EXPORT void set_tracesize(unsigned ntraces) {tracelength  = ntraces;}
84         TESTLIB_DLL_EXPORT void print_summary() {print_summary_ = true;}
85         TESTLIB_DLL_EXPORT void recursive() {do_recursive = true;}
86         TESTLIB_DLL_EXPORT void setParseLevel(ParseLevel pl) {parse_level = pl;}
87         TESTLIB_DLL_EXPORT void use_rewriter(std::string dest) {rewrite_filename = dest;}
88         TESTLIB_DLL_EXPORT void use_merge() {merge_tramps = true;}
89         TESTLIB_DLL_EXPORT void inst_level(InstLevel il) {inst_level_ = il;}
90         TESTLIB_DLL_EXPORT void include_libs() {include_libs_ = true;}
91
92         TESTLIB_DLL_EXPORT test_results_t operator()(std::string exec_path, 
93                         std::vector<std::string> &args);
94         TESTLIB_DLL_EXPORT test_results_t operator()(int pid);
95
96         TESTLIB_DLL_EXPORT static test_results_t sys_execute(std::string cmd, 
97                         std::vector<std::string> &args, 
98                         std::string stdout_redirect = emptyString, 
99                         std::string stderr_redirect = emptyString);
100
101         static std::string emptyString;
102         private:
103         std::string pt_path;
104         std::string cmd_stdout_name;
105         std::string cmd_stderr_name;
106         std::string pt_out_name;
107         std::string rewrite_filename;
108         InstTransaction trans;
109         std::string skip_mods; // regex string
110         std::string skip_funcs; // regex string
111         std::string limit_mod;  // only use this module
112         std::string limit_func; // only use this func
113
114         bool suppress_ipc; //
115         bool nofork;
116         unsigned verbosity; // presently can be 0-7
117         unsigned int timeout_secs;
118         bool do_trace;
119         unsigned tracelength;
120         bool print_summary_;
121         ParseLevel parse_level;
122         bool do_recursive;
123         bool merge_tramps;
124         InstLevel inst_level_;
125         bool include_libs_;
126
127         bool setup_args(std::vector<std::string> &);
128         test_results_t pt_execute(std::vector<std::string> &);
129
130 };
131 #endif