1/*
2 * Copyright (C) 2016 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 <link.h>
32#include <stddef.h>
33
34#include <string>
35#include <unordered_map>
36
37#include <async_safe/log.h>
38
39#define DL_ERR(fmt, x...) \
40    do { \
41      async_safe_format_buffer(linker_get_error_buffer(), linker_get_error_buffer_size(), fmt, ##x); \
42    } while (false)
43
44#define DL_WARN(fmt, x...) \
45    do { \
46      async_safe_format_log(ANDROID_LOG_WARN, "linker", fmt, ##x); \
47      async_safe_format_fd(2, "WARNING: linker: "); \
48      async_safe_format_fd(2, fmt, ##x); \
49      async_safe_format_fd(2, "\n"); \
50    } while (false)
51
52void DL_WARN_documented_change(int api_level, const char* doc_link, const char* fmt, ...);
53
54#define DL_ERR_AND_LOG(fmt, x...) \
55  do { \
56    DL_ERR(fmt, x); \
57    PRINT(fmt, x); \
58  } while (false)
59
60constexpr ElfW(Versym) kVersymNotNeeded = 0;
61constexpr ElfW(Versym) kVersymGlobal = 1;
62
63// These values are used to call constructors for .init_array && .preinit_array
64extern int g_argc;
65extern char** g_argv;
66extern char** g_envp;
67
68struct soinfo;
69struct android_namespace_t;
70
71extern android_namespace_t g_default_namespace;
72
73extern std::unordered_map<uintptr_t, soinfo*> g_soinfo_handles_map;
74
75// Error buffer "variable"
76char* linker_get_error_buffer();
77size_t linker_get_error_buffer_size();
78
79class DlErrorRestorer {
80 public:
81  DlErrorRestorer() {
82    saved_error_msg_ = linker_get_error_buffer();
83  }
84  ~DlErrorRestorer() {
85    strlcpy(linker_get_error_buffer(), saved_error_msg_.c_str(), linker_get_error_buffer_size());
86  }
87 private:
88  std::string saved_error_msg_;
89};
90