1
2/*--------------------------------------------------------------------*/
3/*--- Malloc replacement.                     replacemalloc_core.c ---*/
4/*--------------------------------------------------------------------*/
5
6/*
7   This file is part of Valgrind, a dynamic binary instrumentation
8   framework.
9
10   Copyright (C) 2000-2015 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#include "pub_core_basics.h"
32#include "pub_core_libcbase.h"
33#include "pub_core_libcprint.h"
34#include "pub_core_libcassert.h"
35#include "pub_core_tooliface.h"       // VG_(needs)
36#include "pub_core_mallocfree.h"
37#include "pub_core_options.h"
38#include "pub_core_replacemalloc.h"
39
40/*------------------------------------------------------------*/
41/*--- Command line options                                 ---*/
42/*------------------------------------------------------------*/
43
44/* Nb: the allocator always rounds blocks up to a multiple of
45   VG_MIN_MALLOC_SZB.
46*/
47
48/* DEBUG: print malloc details?  default: NO */
49Bool VG_(clo_trace_malloc)  = False;
50
51/* Minimum alignment in functions that don't specify alignment explicitly.
52   default: 0, i.e. use VG_MIN_MALLOC_SZB. */
53UInt VG_(clo_alignment)     = VG_MIN_MALLOC_SZB;
54
55
56Bool VG_(replacement_malloc_process_cmd_line_option)(const HChar* arg)
57{
58   if VG_INT_CLO(arg, "--alignment", VG_(clo_alignment)) {
59      if (VG_(clo_alignment) < VG_MIN_MALLOC_SZB ||
60          VG_(clo_alignment) > 4096 ||
61          VG_(log2)( VG_(clo_alignment) ) == -1 /* not a power of 2 */)
62      {
63         VG_(fmsg_bad_option)(arg,
64            "Alignment must be a power of 2 in the range %d..4096.\n",
65            VG_MIN_MALLOC_SZB);
66      }
67   }
68
69   else if VG_BOOL_CLO(arg, "--trace-malloc",  VG_(clo_trace_malloc)) {}
70   else
71      return False;
72
73   return True;
74}
75
76SizeT VG_(malloc_effective_client_redzone_size)(void)
77{
78   vg_assert(VG_(needs).malloc_replacement);
79
80   return VG_(arena_redzone_size)(VG_AR_CLIENT);
81}
82
83/*------------------------------------------------------------*/
84/*--- Useful functions                                     ---*/
85/*------------------------------------------------------------*/
86
87void* VG_(cli_malloc) ( SizeT align, SizeT nbytes )
88{
89   // 'align' should be valid (ie. big enough and a power of two) by now.
90   // VG_(arena_memalign)() will abort if it's not.
91   if (VG_MIN_MALLOC_SZB == align)
92      return VG_(arena_malloc)   ( VG_AR_CLIENT, "replacemalloc.cm.1",
93                                   nbytes );
94   else
95      return VG_(arena_memalign) ( VG_AR_CLIENT, "replacemalloc.cm.2",
96                                   align, nbytes );
97}
98
99void VG_(cli_free) ( void* p )
100{
101   VG_(arena_free) ( VG_AR_CLIENT, p );
102}
103
104// Useful for querying user blocks.
105SizeT VG_(cli_malloc_usable_size) ( void* p )
106{
107   return VG_(arena_malloc_usable_size)(VG_AR_CLIENT, p);
108}
109
110Bool VG_(addr_is_in_block)( Addr a, Addr start, SizeT size, SizeT rz_szB )
111{
112   return ( start - rz_szB <= a  &&  a < start + size + rz_szB );
113}
114
115/*--------------------------------------------------------------------*/
116/*--- end                                                          ---*/
117/*--------------------------------------------------------------------*/
118