xref: /aosp_15_r20/bionic/linker/linker_debug.h (revision 8d67ca893c1523eb926b9080dbe4e2ffd2a27ba1)
1 /*
2  * Copyright (C) 2008 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 <stdarg.h>
32 #include <unistd.h>
33 
34 #include <string>
35 
36 #include <async_safe/log.h>
37 #include <async_safe/CHECK.h>
38 
39 struct LinkerDebugConfig {
40   // Set automatically if any of the more specific options are set.
41   bool any;
42 
43   // Messages relating to calling ctors/dtors/ifuncs.
44   bool calls;
45   // Messages relating to CFI.
46   bool cfi;
47   // Messages relating to the dynamic section.
48   bool dynamic;
49   // Messages relating to symbol lookup.
50   bool lookup;
51   // Messages relating to relocation processing.
52   bool reloc;
53   // Messages relating to ELF properties.
54   bool props;
55   // TODO: "config" and "zip" seem likely to want to be separate?
56 
57   bool timing;
58   bool statistics;
59 };
60 
61 extern LinkerDebugConfig g_linker_debug_config;
62 
63 __LIBC_HIDDEN__ void init_LD_DEBUG(const std::string& value);
64 __LIBC_HIDDEN__ void __linker_log(int prio, const char* fmt, ...) __printflike(2, 3);
65 __LIBC_HIDDEN__ void __linker_error(const char* fmt, ...) __printflike(1, 2);
66 
67 #define LD_DEBUG(what, x...) \
68   do { \
69     if (g_linker_debug_config.what) { \
70       __linker_log(ANDROID_LOG_INFO, x); \
71     } \
72   } while (false)
73