pub_core_tooliface.h revision 975618137c5e56cc8f633d5747727f26e2fbc90b 
1
2/*--------------------------------------------------------------------*/
3/*--- The core/tool interface.                pub_core_tooliface.h ---*/
4/*--------------------------------------------------------------------*/
5
6/*
7   This file is part of Valgrind, a dynamic binary instrumentation
8   framework.
9
10   Copyright (C) 2000-2006 Julian Seward
11      jseward@acm.org
12
13   This program is free software; you can redistribute it and/or
14   modify it under the terms of the GNU General Public License as
15   published by the Free Software Foundation; either version 2 of the
16   License, or (at your option) any later version.
17
18   This program is distributed in the hope that it will be useful, but
19   WITHOUT ANY WARRANTY; without even the implied warranty of
20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21   General Public License for more details.
22
23   You should have received a copy of the GNU General Public License
24   along with this program; if not, write to the Free Software
25   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26   02111-1307, USA.
27
28   The GNU General Public License is contained in the file COPYING.
29*/
30
31#ifndef __PUB_CORE_TOOLIFACE_H
32#define __PUB_CORE_TOOLIFACE_H
33
34#include "pub_tool_tooliface.h"
35
36//--------------------------------------------------------------------
37// PURPOSE: This module encapsulates the key parts of the core/tool
38// interface: 'details', 'needs' and 'trackable events'.
39//--------------------------------------------------------------------
40
41// Note the use of C's comma operator here -- it means that we execute both
42// statements, and the rvalue of the whole thing is the rvalue of the last
43// statement.  This lets us say "x = VG_TDICT_CALL(...)" in the required
44// places, while still checking the assertion.
45#define VG_TDICT_CALL(fn, args...) \
46   ( tl_assert2(VG_(tdict).fn, \
47                "you forgot to set VgToolInterface function '" #fn "'"), \
48     VG_(tdict).fn(args) )
49
50#define VG_TRACK(fn, args...) 			\
51   do {						\
52      if (VG_(tdict).track_##fn)		\
53	 VG_(tdict).track_##fn(args);           \
54   } while(0)
55
56/* These structs are not exposed to tools to mitigate possibility of
57   binary-incompatibilities when the core/tool interface changes.  Instead,
58   set functions are provided (see include/pub_tool_tooliface.h). */
59
60/* ---------------------------------------------------------------------
61   'Details'
62   ------------------------------------------------------------------ */
63
64typedef
65   struct {
66      Char* name;
67      Char* version;
68      Char* description;
69      Char* copyright_author;
70      Char* bug_reports_to;
71      UInt  avg_translation_sizeB;
72   }
73   VgDetails;
74
75extern VgDetails VG_(details);
76
77/* ---------------------------------------------------------------------
78   'Needs'
79   ------------------------------------------------------------------ */
80
81typedef
82   struct {
83      Bool libc_freeres;
84      Bool core_errors;
85      Bool tool_errors;
86      Bool basic_block_discards;
87      Bool command_line_options;
88      Bool client_requests;
89      Bool syscall_wrapper;
90      Bool sanity_checks;
91      Bool data_syms;
92      Bool malloc_replacement;
93      Bool xml_output;
94   }
95   VgNeeds;
96
97extern VgNeeds VG_(needs);
98
99/* ---------------------------------------------------------------------
100   The dictionary of callable tool functions
101   ------------------------------------------------------------------ */
102
103typedef struct {
104   // -- 'Needs'-related functions ----------------------------------
105   // Basic functions
106   void  (*tool_pre_clo_init) (void);
107   void  (*tool_post_clo_init)(void);
108   IRBB* (*tool_instrument)   (VgCallbackClosure*,
109                               IRBB*,
110                               VexGuestLayout*, VexGuestExtents*,
111                               IRType, IRType);
112   void  (*tool_fini)         (Int);
113
114   // VG_(needs).core_errors
115   // (none)
116
117   // VG_(needs).tool_errors
118   Bool  (*tool_eq_Error)                    (VgRes, Error*, Error*);
119   void  (*tool_pp_Error)                    (Error*);
120   UInt  (*tool_update_extra)                (Error*);
121   Bool  (*tool_recognised_suppression)      (Char*, Supp*);
122   Bool  (*tool_read_extra_suppression_info) (Int, Char*, Int, Supp*);
123   Bool  (*tool_error_matches_suppression)   (Error*, Supp*);
124   Char* (*tool_get_error_name)              (Error*);
125   void  (*tool_print_extra_suppression_info)(Error*);
126
127   // VG_(needs).basic_block_discards
128   void (*tool_discard_basic_block_info)(Addr64, VexGuestExtents);
129
130   // VG_(needs).command_line_options
131   Bool (*tool_process_cmd_line_option)(Char*);
132   void (*tool_print_usage)            (void);
133   void (*tool_print_debug_usage)      (void);
134
135   // VG_(needs).client_requests
136   Bool (*tool_handle_client_request)(ThreadId, UWord*, UWord*);
137
138   // VG_(needs).syscall_wrapper
139   void (*tool_pre_syscall) (ThreadId, UInt);
140   void (*tool_post_syscall)(ThreadId, UInt, SysRes);
141
142   // VG_(needs).sanity_checks
143   Bool (*tool_cheap_sanity_check)(void);
144   Bool (*tool_expensive_sanity_check)(void);
145
146   // VG_(needs).malloc_replacement
147   void* (*tool_malloc)              (ThreadId, SizeT);
148   void* (*tool___builtin_new)       (ThreadId, SizeT);
149   void* (*tool___builtin_vec_new)   (ThreadId, SizeT);
150   void* (*tool_memalign)            (ThreadId, SizeT, SizeT);
151   void* (*tool_calloc)              (ThreadId, SizeT, SizeT);
152   void  (*tool_free)                (ThreadId, void*);
153   void  (*tool___builtin_delete)    (ThreadId, void*);
154   void  (*tool___builtin_vec_delete)(ThreadId, void*);
155   void* (*tool_realloc)             (ThreadId, void*, SizeT);
156   SizeT tool_client_redzone_szB;
157
158   // -- Event tracking functions ------------------------------------
159   void (*track_new_mem_startup)     (Addr, SizeT, Bool, Bool, Bool);
160   void (*track_new_mem_stack_signal)(Addr, SizeT);
161   void (*track_new_mem_brk)         (Addr, SizeT);
162   void (*track_new_mem_mmap)        (Addr, SizeT, Bool, Bool, Bool);
163
164   void (*track_copy_mem_remap)      (Addr src, Addr dst, SizeT);
165   void (*track_change_mem_mprotect) (Addr, SizeT, Bool, Bool, Bool);
166   void (*track_die_mem_stack_signal)(Addr, SizeT);
167   void (*track_die_mem_brk)         (Addr, SizeT);
168   void (*track_die_mem_munmap)      (Addr, SizeT);
169
170   void VG_REGPARM(1) (*track_new_mem_stack_4)  (Addr);
171   void VG_REGPARM(1) (*track_new_mem_stack_8)  (Addr);
172   void VG_REGPARM(1) (*track_new_mem_stack_12) (Addr);
173   void VG_REGPARM(1) (*track_new_mem_stack_16) (Addr);
174   void VG_REGPARM(1) (*track_new_mem_stack_32) (Addr);
175   void VG_REGPARM(1) (*track_new_mem_stack_112)(Addr);
176   void VG_REGPARM(1) (*track_new_mem_stack_128)(Addr);
177   void VG_REGPARM(1) (*track_new_mem_stack_144)(Addr);
178   void VG_REGPARM(1) (*track_new_mem_stack_160)(Addr);
179   void (*track_new_mem_stack)(Addr, SizeT);
180
181   void VG_REGPARM(1) (*track_die_mem_stack_4)  (Addr);
182   void VG_REGPARM(1) (*track_die_mem_stack_8)  (Addr);
183   void VG_REGPARM(1) (*track_die_mem_stack_12) (Addr);
184   void VG_REGPARM(1) (*track_die_mem_stack_16) (Addr);
185   void VG_REGPARM(1) (*track_die_mem_stack_32) (Addr);
186   void VG_REGPARM(1) (*track_die_mem_stack_112)(Addr);
187   void VG_REGPARM(1) (*track_die_mem_stack_128)(Addr);
188   void VG_REGPARM(1) (*track_die_mem_stack_144)(Addr);
189   void VG_REGPARM(1) (*track_die_mem_stack_160)(Addr);
190   void (*track_die_mem_stack)(Addr, SizeT);
191
192   void (*track_ban_mem_stack)(Addr, SizeT);
193
194   void (*track_pre_mem_read)       (CorePart, ThreadId, Char*, Addr, SizeT);
195   void (*track_pre_mem_read_asciiz)(CorePart, ThreadId, Char*, Addr);
196   void (*track_pre_mem_write)      (CorePart, ThreadId, Char*, Addr, SizeT);
197   void (*track_post_mem_write)     (CorePart, ThreadId, Addr, SizeT);
198
199   void (*track_pre_reg_read)  (CorePart, ThreadId, Char*, OffT, SizeT);
200   void (*track_post_reg_write)(CorePart, ThreadId,        OffT, SizeT);
201   void (*track_post_reg_write_clientcall_return)(ThreadId, OffT, SizeT, Addr);
202
203   void (*track_thread_runstate)(ThreadId, Bool, ULong);
204
205   void (*track_post_thread_create)(ThreadId, ThreadId);
206   void (*track_post_thread_join)  (ThreadId, ThreadId);
207
208   void (*track_pre_mutex_lock)   (ThreadId, Addr);
209   void (*track_post_mutex_lock)  (ThreadId, Addr);
210   void (*track_post_mutex_unlock)(ThreadId, Addr);
211
212   void (*track_pre_deliver_signal) (ThreadId, Int sigNo, Bool);
213   void (*track_post_deliver_signal)(ThreadId, Int sigNo);
214
215} VgToolInterface;
216
217extern VgToolInterface VG_(tdict);
218
219/* ---------------------------------------------------------------------
220   Miscellaneous functions
221   ------------------------------------------------------------------ */
222
223Bool VG_(sanity_check_needs) ( Char** failmsg );
224
225#endif   // __PUB_CORE_TOOLIFACE_H
226
227/*--------------------------------------------------------------------*/
228/*--- end                                                          ---*/
229/*--------------------------------------------------------------------*/
230