15d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines//===-- allocator_interface.h ---------------------------------------------===// 25d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines// 35d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines// The LLVM Compiler Infrastructure 45d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines// 55d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines// This file is distributed under the University of Illinois Open Source 65d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines// License. See LICENSE.TXT for details. 75d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines// 85d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines//===----------------------------------------------------------------------===// 95d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines// 105d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines// Public interface header for allocator used in sanitizers (ASan/TSan/MSan). 115d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines//===----------------------------------------------------------------------===// 125d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines#ifndef SANITIZER_ALLOCATOR_INTERFACE_H 135d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines#define SANITIZER_ALLOCATOR_INTERFACE_H 145d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines 155d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines#include <stddef.h> 165d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines 175d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines#ifdef __cplusplus 185d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hinesextern "C" { 195d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines#endif 205d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines /* Returns the estimated number of bytes that will be reserved by allocator 215d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines for request of "size" bytes. If allocator can't allocate that much 225d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines memory, returns the maximal possible allocation size, otherwise returns 235d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines "size". */ 245d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines size_t __sanitizer_get_estimated_allocated_size(size_t size); 255d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines 265d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines /* Returns true if p was returned by the allocator and 275d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines is not yet freed. */ 285d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines int __sanitizer_get_ownership(const volatile void *p); 295d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines 305d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines /* Returns the number of bytes reserved for the pointer p. 315d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines Requires (get_ownership(p) == true) or (p == 0). */ 325d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines size_t __sanitizer_get_allocated_size(const volatile void *p); 335d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines 345d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines /* Number of bytes, allocated and not yet freed by the application. */ 355d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines size_t __sanitizer_get_current_allocated_bytes(); 365d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines 375d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines /* Number of bytes, mmaped by the allocator to fulfill allocation requests. 385d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines Generally, for request of X bytes, allocator can reserve and add to free 395d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines lists a large number of chunks of size X to use them for future requests. 405d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines All these chunks count toward the heap size. Currently, allocator never 415d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines releases memory to OS (instead, it just puts freed chunks to free 425d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines lists). */ 435d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines size_t __sanitizer_get_heap_size(); 445d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines 455d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines /* Number of bytes, mmaped by the allocator, which can be used to fulfill 465d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines allocation requests. When a user program frees memory chunk, it can first 475d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines fall into quarantine and will count toward __sanitizer_get_free_bytes() 485d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines later. */ 495d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines size_t __sanitizer_get_free_bytes(); 505d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines 515d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines /* Number of bytes in unmapped pages, that are released to OS. Currently, 525d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines always returns 0. */ 535d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines size_t __sanitizer_get_unmapped_bytes(); 545d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines 555d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines /* Malloc hooks that may be optionally provided by user. 565d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines __sanitizer_malloc_hook(ptr, size) is called immediately after 575d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines allocation of "size" bytes, which returned "ptr". 585d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines __sanitizer_free_hook(ptr) is called immediately before 595d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines deallocation of "ptr". */ 605d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines void __sanitizer_malloc_hook(const volatile void *ptr, size_t size); 615d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines void __sanitizer_free_hook(const volatile void *ptr); 625d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines#ifdef __cplusplus 635d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines} // extern "C" 645d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines#endif 655d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines 665d71de26cedae3dafc17449fe0182045c0bd20e8Stephen Hines#endif 67