2014-07-29 Ed Smith-Rowland <3dw4rd@verizon.net>
[official-gcc.git] / gcc / asan.h
blob08d5063c9e1f41197443a140a60dc436320d31db
1 /* AddressSanitizer, a fast memory error detector.
2 Copyright (C) 2011-2014 Free Software Foundation, Inc.
3 Contributed by Kostya Serebryany <kcc@google.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 #ifndef TREE_ASAN
22 #define TREE_ASAN
24 extern void asan_function_start (void);
25 extern void asan_finish_file (void);
26 extern rtx asan_emit_stack_protection (rtx, rtx, unsigned int, HOST_WIDE_INT *,
27 tree *, int);
28 extern bool asan_protect_global (tree);
29 extern void initialize_sanitizer_builtins (void);
30 extern tree asan_dynamic_init_call (bool);
32 extern gimple_stmt_iterator create_cond_insert_point
33 (gimple_stmt_iterator *, bool, bool, bool, basic_block *, basic_block *);
35 /* Alias set for accessing the shadow memory. */
36 extern alias_set_type asan_shadow_set;
38 /* Shadow memory is found at
39 (address >> ASAN_SHADOW_SHIFT) + targetm.asan_shadow_offset (). */
40 #define ASAN_SHADOW_SHIFT 3
42 /* Red zone size, stack and global variables are padded by ASAN_RED_ZONE_SIZE
43 up to 2 * ASAN_RED_ZONE_SIZE - 1 bytes. */
44 #define ASAN_RED_ZONE_SIZE 32
46 /* Shadow memory values for stack protection. Left is below protected vars,
47 the first pointer in stack corresponding to that offset contains
48 ASAN_STACK_FRAME_MAGIC word, the second pointer to a string describing
49 the frame. Middle is for padding in between variables, right is
50 above the last protected variable and partial immediately after variables
51 up to ASAN_RED_ZONE_SIZE alignment. */
52 #define ASAN_STACK_MAGIC_LEFT 0xf1
53 #define ASAN_STACK_MAGIC_MIDDLE 0xf2
54 #define ASAN_STACK_MAGIC_RIGHT 0xf3
55 #define ASAN_STACK_MAGIC_PARTIAL 0xf4
56 #define ASAN_STACK_MAGIC_USE_AFTER_RET 0xf5
58 #define ASAN_STACK_FRAME_MAGIC 0x41b58ab3
59 #define ASAN_STACK_RETIRED_MAGIC 0x45e0360e
61 /* Return true if DECL should be guarded on the stack. */
63 static inline bool
64 asan_protect_stack_decl (tree decl)
66 return DECL_P (decl) && !DECL_ARTIFICIAL (decl);
69 /* Return the size of padding needed to insert after a protected
70 decl of SIZE. */
72 static inline unsigned int
73 asan_red_zone_size (unsigned int size)
75 unsigned int c = size & (ASAN_RED_ZONE_SIZE - 1);
76 return c ? 2 * ASAN_RED_ZONE_SIZE - c : ASAN_RED_ZONE_SIZE;
79 #endif /* TREE_ASAN */