1 /*
2 * Copyright (C) 2019 The Android Open Source Project
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the
13 * distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #pragma once
30
31 #include <bionic/pthread_internal.h>
32 #include <platform/bionic/malloc.h>
33 #include <stddef.h>
34
35 // Expected to be called in a single-threaded context during libc init, so no
36 // synchronization required.
37 void SetDefaultHeapTaggingLevel();
38
39 // Lock for the heap tagging level. You may find ScopedPthreadMutexLocker
40 // useful for RAII on this lock.
41 extern pthread_mutex_t g_heap_tagging_lock;
42
43 // This function can be called in a multithreaded context, and thus should
44 // only be called when holding the `g_heap_tagging_lock`.
45 bool SetHeapTaggingLevel(HeapTaggingLevel level);
46
47 // This is static because libc_nomalloc uses this but does not need to link the
48 // cpp file.
DescribeTaggingLevel(HeapTaggingLevel level)49 __attribute__((unused)) static inline const char* DescribeTaggingLevel(
50 HeapTaggingLevel level) {
51 switch (level) {
52 case M_HEAP_TAGGING_LEVEL_NONE:
53 return "none";
54 case M_HEAP_TAGGING_LEVEL_TBI:
55 return "tbi";
56 case M_HEAP_TAGGING_LEVEL_ASYNC:
57 return "async";
58 case M_HEAP_TAGGING_LEVEL_SYNC:
59 return "sync";
60 }
61 }
62