File: libstatspull_lazy.cpp

package info (click to toggle)
android-platform-tools 34.0.5-12
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 150,900 kB
  • sloc: cpp: 805,786; java: 293,500; ansic: 128,288; xml: 127,491; python: 41,481; sh: 14,245; javascript: 9,665; cs: 3,846; asm: 2,049; makefile: 1,917; yacc: 440; awk: 368; ruby: 183; sql: 140; perl: 88; lex: 67
file content (190 lines) | stat: -rw-r--r-- 7,396 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/*
 * Copyright (C) 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "libstatspull_lazy.h"

#include <mutex>

#include <dlfcn.h>
#include <stdatomic.h>

#include "log/log.h"

#include "stats_pull_atom_callback.h"

// This file provides a lazy interface to libstatspull.so to address early boot dependencies.
// Specifically bootanimation, surfaceflinger, and lmkd run before the statsd APEX is loaded and
// libstatspull.so is in the statsd APEX.

// Method pointers to libstatspull methods are held in an array which simplifies checking
// all pointers are initialized.
enum MethodIndex {
    // PullAtomMetadata APIs in stats_pull_atom_callback.h.
    k_AStatsManager_PullAtomMetadata_obtain,
    k_AStatsManager_PullAtomMetadata_release,
    k_AStatsManager_PullAtomMetadata_setCoolDownMillis,
    k_AStatsManager_PullAtomMetadata_getCoolDownMillis,
    k_AStatsManager_PullAtomMetadata_setTimeoutMillis,
    k_AStatsManager_PullAtomMetadata_getTimeoutMillis,
    k_AStatsManager_PullAtomMetadata_setAdditiveFields,
    k_AStatsManager_PullAtomMetadata_getNumAdditiveFields,
    k_AStatsManager_PullAtomMetadata_getAdditiveFields,

    // AStatsEventList APIs in stats_pull_atom_callback.h
    k_AStatsEventList_addStatsEvent,

    // PullAtomCallback APIs in stats_pull_atom_callback.h
    k_AStatsManager_setPullAtomCallback,
    k_AStatsManager_clearPullAtomCallback,

    // Marker for count of methods
    k_MethodCount
};

// Table of methods pointers in libstatspull APIs.
static void* g_Methods[k_MethodCount];

//
// Libstatspull lazy loading.
//

static atomic_bool gPreventLibstatspullLoading = false;  // Allows tests to block loading.

void PreventLibstatspullLazyLoadingForTests() {
    gPreventLibstatspullLoading.store(true);
}

static void* LoadLibstatspull(int dlopen_flags) {
    if (gPreventLibstatspullLoading.load()) {
        return nullptr;
    }
    return dlopen("libstatspull.so", dlopen_flags);
}

//
// Initialization and symbol binding.

static void BindSymbol(void* handle, const char* name, enum MethodIndex index) {
    void* symbol = dlsym(handle, name);
    LOG_ALWAYS_FATAL_IF(symbol == nullptr, "Failed to find symbol '%s' in libstatspull.so: %s",
                        name, dlerror());
    g_Methods[index] = symbol;
}

static void InitializeOnce() {
    void* handle = LoadLibstatspull(RTLD_NOW);
    LOG_ALWAYS_FATAL_IF(handle == nullptr, "Failed to load libstatspull.so: %s", dlerror());

#undef BIND_SYMBOL
#define BIND_SYMBOL(name) BindSymbol(handle, #name, k_##name);
    // PullAtomMetadata APIs in stats_pull_atom_callback.h.
    BIND_SYMBOL(AStatsManager_PullAtomMetadata_obtain);
    BIND_SYMBOL(AStatsManager_PullAtomMetadata_release);
    BIND_SYMBOL(AStatsManager_PullAtomMetadata_setCoolDownMillis);
    BIND_SYMBOL(AStatsManager_PullAtomMetadata_getCoolDownMillis);
    BIND_SYMBOL(AStatsManager_PullAtomMetadata_setTimeoutMillis);
    BIND_SYMBOL(AStatsManager_PullAtomMetadata_getTimeoutMillis);
    BIND_SYMBOL(AStatsManager_PullAtomMetadata_setAdditiveFields);
    BIND_SYMBOL(AStatsManager_PullAtomMetadata_getNumAdditiveFields);
    BIND_SYMBOL(AStatsManager_PullAtomMetadata_getAdditiveFields);

    // AStatsEventList APIs in stats_pull_atom_callback.h
    BIND_SYMBOL(AStatsEventList_addStatsEvent);

    // PullAtomCallback APIs in stats_pull_atom_callback.h
    BIND_SYMBOL(AStatsManager_setPullAtomCallback);
    BIND_SYMBOL(AStatsManager_clearPullAtomCallback);

#undef BIND_SYMBOL

    // Check every symbol is bound.
    for (int i = 0; i < k_MethodCount; ++i) {
        LOG_ALWAYS_FATAL_IF(g_Methods[i] == nullptr,
                            "Uninitialized method in libstatspull_lazy at index: %d", i);
    }
}

static void EnsureInitialized() {
    static std::once_flag initialize_flag;
    std::call_once(initialize_flag, InitializeOnce);
}

#define INVOKE_METHOD(name, args...)                            \
    do {                                                        \
        EnsureInitialized();                                    \
        void* method = g_Methods[k_##name];                     \
        return reinterpret_cast<decltype(&name)>(method)(args); \
    } while (0)

//
// Forwarding for methods in stats_pull_atom_callback.h.
//

AStatsManager_PullAtomMetadata* AStatsManager_PullAtomMetadata_obtain() {
    INVOKE_METHOD(AStatsManager_PullAtomMetadata_obtain);
}

void AStatsManager_PullAtomMetadata_release(AStatsManager_PullAtomMetadata* metadata) {
    INVOKE_METHOD(AStatsManager_PullAtomMetadata_release, metadata);
}

void AStatsManager_PullAtomMetadata_setCoolDownMillis(AStatsManager_PullAtomMetadata* metadata,
                                                      int64_t cool_down_millis) {
    INVOKE_METHOD(AStatsManager_PullAtomMetadata_setCoolDownMillis, metadata, cool_down_millis);
}

int64_t AStatsManager_PullAtomMetadata_getCoolDownMillis(AStatsManager_PullAtomMetadata* metadata) {
    INVOKE_METHOD(AStatsManager_PullAtomMetadata_getCoolDownMillis, metadata);
}

void AStatsManager_PullAtomMetadata_setTimeoutMillis(AStatsManager_PullAtomMetadata* metadata,
                                                     int64_t timeout_millis) {
    INVOKE_METHOD(AStatsManager_PullAtomMetadata_setTimeoutMillis, metadata, timeout_millis);
}

int64_t AStatsManager_PullAtomMetadata_getTimeoutMillis(AStatsManager_PullAtomMetadata* metadata) {
    INVOKE_METHOD(AStatsManager_PullAtomMetadata_getTimeoutMillis, metadata);
}

void AStatsManager_PullAtomMetadata_setAdditiveFields(AStatsManager_PullAtomMetadata* metadata,
                                                      int32_t* additive_fields,
                                                      int32_t num_fields) {
    INVOKE_METHOD(AStatsManager_PullAtomMetadata_setAdditiveFields, metadata, additive_fields,
                  num_fields);
}

int32_t AStatsManager_PullAtomMetadata_getNumAdditiveFields(
        AStatsManager_PullAtomMetadata* metadata) {
    INVOKE_METHOD(AStatsManager_PullAtomMetadata_getNumAdditiveFields, metadata);
}

void AStatsManager_PullAtomMetadata_getAdditiveFields(AStatsManager_PullAtomMetadata* metadata,
                                                      int32_t* fields) {
    INVOKE_METHOD(AStatsManager_PullAtomMetadata_getAdditiveFields, metadata, fields);
}

AStatsEvent* AStatsEventList_addStatsEvent(AStatsEventList* pull_data) {
    INVOKE_METHOD(AStatsEventList_addStatsEvent, pull_data);
}

void AStatsManager_setPullAtomCallback(int32_t atom_tag, AStatsManager_PullAtomMetadata* metadata,
                                       AStatsManager_PullAtomCallback callback, void* cookie) {
    INVOKE_METHOD(AStatsManager_setPullAtomCallback, atom_tag, metadata, callback, cookie);
}

void AStatsManager_clearPullAtomCallback(int32_t atom_tag) {
    INVOKE_METHOD(AStatsManager_clearPullAtomCallback, atom_tag);
}