Skip to content

Commit 427b36d

Browse files
GregoryComerGregoryComer
authored
Add Android standalone log target
Differential Revision: D65268257 Pull Request resolved: #6590
1 parent 289e84e commit 427b36d

File tree

5 files changed

+156
-95
lines changed

5 files changed

+156
-95
lines changed

‎extension/android/CMakeLists.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ set(executorch_DIR ${CMAKE_CURRENT_BINARY_DIR}/../../lib/cmake/ExecuTorch)
6464
find_package(executorch CONFIG REQUIRED)
6565
target_link_options_shared_lib(executorch)
6666

67-
add_library(executorch_jni SHARED jni/jni_layer.cpp)
67+
add_library(executorch_jni SHARED jni/jni_layer.cpp jni/log.cpp)
6868

6969
set(link_libraries)
7070
list(
@@ -146,7 +146,7 @@ if(EXECUTORCH_JNI_CUSTOM_LIBRARY)
146146
endif()
147147

148148
if(EXECUTORCH_BUILD_LLAMA_JNI)
149-
target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp)
149+
target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp jni/log.cpp)
150150
list(APPEND link_libraries llama_runner llava_runner)
151151
target_compile_definitions(executorch_jni PUBLIC EXECUTORCH_BUILD_LLAMA_JNI=1)
152152
add_subdirectory(

‎extension/android/jni/BUCK‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
load("@fbsource//tools/build_defs/android:fb_android_cxx_library.bzl", "fb_android_cxx_library")
22
load("@fbsource//xplat/executorch/backends/xnnpack/third-party:third_party_libs.bzl", "third_party_dep")
3+
load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
34
load("@fbsource//xplat/executorch/codegen:codegen.bzl", "executorch_generated_lib")
45

56
oncall("executorch")
@@ -25,7 +26,7 @@ executorch_generated_lib(
2526

2627
fb_android_cxx_library(
2728
name = "executorch_jni",
28-
srcs = ["jni_layer.cpp"],
29+
srcs = ["jni_layer.cpp", "log.cpp"],
2930
headers = ["jni_layer_constants.h"],
3031
allow_jni_merging = False,
3132
compiler_flags = [
@@ -36,6 +37,7 @@ fb_android_cxx_library(
3637
soname = "libexecutorch.$(ext)",
3738
visibility = ["PUBLIC"],
3839
deps = [
40+
":log_provider_static",
3941
"//fbandroid/libraries/fbjni:fbjni",
4042
"//fbandroid/native/fb:fb",
4143
"//third-party/glog:glog",
@@ -49,7 +51,7 @@ fb_android_cxx_library(
4951

5052
fb_android_cxx_library(
5153
name = "executorch_jni_full",
52-
srcs = ["jni_layer.cpp"],
54+
srcs = ["jni_layer.cpp", "log.cpp"],
5355
headers = ["jni_layer_constants.h"],
5456
allow_jni_merging = False,
5557
compiler_flags = [
@@ -60,6 +62,7 @@ fb_android_cxx_library(
6062
soname = "libexecutorch.$(ext)",
6163
visibility = ["PUBLIC"],
6264
deps = [
65+
":log_provider_static",
6366
":generated_op_lib_optimized_static",
6467
"//fbandroid/libraries/fbjni:fbjni",
6568
"//fbandroid/native/fb:fb",
@@ -88,6 +91,7 @@ fb_android_cxx_library(
8891
soname = "libexecutorch.$(ext)",
8992
visibility = ["PUBLIC"],
9093
deps = [
94+
":log_provider_static",
9195
"//fbandroid/libraries/fbjni:fbjni",
9296
"//fbandroid/native/fb:fb",
9397
"//third-party/glog:glog",
@@ -101,3 +105,18 @@ fb_android_cxx_library(
101105
"//xplat/executorch/extension/threadpool:threadpool_static",
102106
],
103107
)
108+
109+
runtime.cxx_library(
110+
name = "log_provider",
111+
srcs = ["log.cpp"],
112+
exported_headers = ["log.h"],
113+
compiler_flags = [
114+
"-frtti",
115+
"-fexceptions",
116+
"-Wno-unused-variable",
117+
],
118+
deps = [
119+
"//executorch/runtime/core:core",
120+
],
121+
visibility = ["@EXECUTORCH_CLIENTS"],
122+
)

‎extension/android/jni/jni_layer.cpp‎

Lines changed: 21 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
#include "jni_layer_constants.h"
1919

20+
#include <executorch/extension/android/jni/log.h>
2021
#include <executorch/extension/module/module.h>
2122
#include <executorch/extension/runner_util/inputs.h>
2223
#include <executorch/extension/tensor/tensor.h>
@@ -36,76 +37,6 @@
3637
using namespace executorch::extension;
3738
using namespace torch::executor;
3839

39-
#ifdef __ANDROID__
40-
#include <android/log.h>
41-
#include <mutex>
42-
#include <sstream>
43-
44-
// Number of entries to store in the in-memory log buffer.
45-
const size_t log_buffer_length = 16;
46-
47-
struct log_entry {
48-
et_timestamp_t timestamp;
49-
et_pal_log_level_t level;
50-
std::string filename;
51-
std::string function;
52-
size_t line;
53-
std::string message;
54-
55-
log_entry(
56-
et_timestamp_t timestamp,
57-
et_pal_log_level_t level,
58-
const char* filename,
59-
const char* function,
60-
size_t line,
61-
const char* message,
62-
size_t length)
63-
: timestamp(timestamp),
64-
level(level),
65-
filename(filename),
66-
function(function),
67-
line(line),
68-
message(message, length) {}
69-
};
70-
71-
namespace {
72-
std::vector<log_entry> log_buffer_;
73-
std::mutex log_buffer_mutex_;
74-
} // namespace
75-
76-
// For Android, write to logcat
77-
void et_pal_emit_log_message(
78-
et_timestamp_t timestamp,
79-
et_pal_log_level_t level,
80-
const char* filename,
81-
const char* function,
82-
size_t line,
83-
const char* message,
84-
size_t length) {
85-
std::lock_guard<std::mutex> guard(log_buffer_mutex_);
86-
87-
while (log_buffer_.size() >= log_buffer_length) {
88-
log_buffer_.erase(log_buffer_.begin());
89-
}
90-
91-
log_buffer_.emplace_back(
92-
timestamp, level, filename, function, line, message, length);
93-
94-
int android_log_level = ANDROID_LOG_UNKNOWN;
95-
if (level == 'D') {
96-
android_log_level = ANDROID_LOG_DEBUG;
97-
} else if (level == 'I') {
98-
android_log_level = ANDROID_LOG_INFO;
99-
} else if (level == 'E') {
100-
android_log_level = ANDROID_LOG_ERROR;
101-
} else if (level == 'F') {
102-
android_log_level = ANDROID_LOG_FATAL;
103-
}
104-
105-
__android_log_print(android_log_level, "ExecuTorch", "%s", message);
106-
}
107-
#endif
108-
10940
namespace executorch::extension {
11041
class TensorHybrid : public facebook::jni::HybridClass<TensorHybrid> {
11142
public:
@@ -437,24 +368,26 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
437368
facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>>
438369
readLogBuffer() {
439370
#ifdef __ANDROID__
440-
std::lock_guard<std::mutex> guard(log_buffer_mutex_);
441-
442-
const auto size = log_buffer_.size();
443-
facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret =
444-
facebook::jni::JArrayClass<jstring>::newArray(size);
445-
446-
for (auto i = 0u; i < size; i++) {
447-
const auto& entry = log_buffer_[i];
448-
// Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL MESSAGE".
449-
std::stringstream ss;
450-
ss << "[" << entry.timestamp << " " << entry.function << " "
451-
<< entry.filename << ":" << entry.line << "] "
452-
<< static_cast<char>(entry.level) << " " << entry.message;
453-
454-
facebook::jni::local_ref<facebook::jni::JString> jstr_message =
455-
facebook::jni::make_jstring(ss.str().c_str());
456-
(*ret)[i] = jstr_message;
457-
}
371+
372+
facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret;
373+
374+
access_log_buffer([&](std::vector<log_entry>& buffer) {
375+
const auto size = buffer.size();
376+
ret = facebook::jni::JArrayClass<jstring>::newArray(size);
377+
for (auto i = 0u; i < size; i++) {
378+
const auto& entry = buffer[i];
379+
// Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL
380+
// MESSAGE".
381+
std::stringstream ss;
382+
ss << "[" << entry.timestamp << " " << entry.function << " "
383+
<< entry.filename << ":" << entry.line << "] "
384+
<< static_cast<char>(entry.level) << " " << entry.message;
385+
386+
facebook::jni::local_ref<facebook::jni::JString> jstr_message =
387+
facebook::jni::make_jstring(ss.str().c_str());
388+
(*ret)[i] = jstr_message;
389+
}
390+
});
458391

459392
return ret;
460393
#else
@@ -468,10 +401,7 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
468401
makeNativeMethod("forward", ExecuTorchJni::forward),
469402
makeNativeMethod("execute", ExecuTorchJni::execute),
470403
makeNativeMethod("loadMethod", ExecuTorchJni::load_method),
471-
472-
#ifdef __ANDROID__
473404
makeNativeMethod("readLogBuffer", ExecuTorchJni::readLogBuffer),
474-
#endif
475405
});
476406
}
477407
};

‎extension/android/jni/log.cpp‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree.
7+
*/
8+
9+
#include "log.h"
10+
11+
#ifdef __ANDROID__
12+
13+
#include <android/log.h>
14+
#include <functional>
15+
#include <mutex>
16+
#include <sstream>
17+
18+
using executorch::extension::log_entry;
19+
20+
// Number of entries to store in the in-memory log buffer.
21+
const size_t log_buffer_length = 16;
22+
23+
namespace {
24+
std::vector<log_entry> log_buffer_;
25+
std::mutex log_buffer_mutex_;
26+
} // namespace
27+
28+
// For Android, write to logcat
29+
void et_pal_emit_log_message(
30+
et_timestamp_t timestamp,
31+
et_pal_log_level_t level,
32+
const char* filename,
33+
const char* function,
34+
size_t line,
35+
const char* message,
36+
size_t length) {
37+
std::lock_guard<std::mutex> guard(log_buffer_mutex_);
38+
39+
while (log_buffer_.size() >= log_buffer_length) {
40+
log_buffer_.erase(log_buffer_.begin());
41+
}
42+
43+
log_buffer_.emplace_back(
44+
timestamp, level, filename, function, line, message, length);
45+
46+
int android_log_level = ANDROID_LOG_UNKNOWN;
47+
if (level == 'D') {
48+
android_log_level = ANDROID_LOG_DEBUG;
49+
} else if (level == 'I') {
50+
android_log_level = ANDROID_LOG_INFO;
51+
} else if (level == 'E') {
52+
android_log_level = ANDROID_LOG_ERROR;
53+
} else if (level == 'F') {
54+
android_log_level = ANDROID_LOG_FATAL;
55+
}
56+
57+
__android_log_print(android_log_level, "ExecuTorch", "%s", message);
58+
}
59+
60+
namespace executorch::extension {
61+
62+
void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor) {
63+
std::lock_guard<std::mutex> guard(log_buffer_mutex_);
64+
accessor(log_buffer_);
65+
}
66+
67+
} // namespace executorch::extension
68+
69+
#endif

‎extension/android/jni/log.h‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
/*
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree.
7+
*/
8+
9+
#include <functional>
10+
#include <string>
11+
#include <vector>
12+
13+
#include <executorch/runtime/platform/log.h>
14+
#include <executorch/runtime/platform/platform.h>
15+
#include <executorch/runtime/platform/runtime.h>
16+
17+
namespace executorch::extension {
18+
struct log_entry {
19+
et_timestamp_t timestamp;
20+
et_pal_log_level_t level;
21+
std::string filename;
22+
std::string function;
23+
size_t line;
24+
std::string message;
25+
26+
log_entry(
27+
et_timestamp_t timestamp,
28+
et_pal_log_level_t level,
29+
const char* filename,
30+
const char* function,
31+
size_t line,
32+
const char* message,
33+
size_t length)
34+
: timestamp(timestamp),
35+
level(level),
36+
filename(filename),
37+
function(function),
38+
line(line),
39+
message(message, length) {}
40+
};
41+
42+
void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor);
43+
} // namespace executorch::extension

0 commit comments

Comments
 (0)