Add Android standalone log target#6590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
facebook-github-bot merged 1 commit into from
Nov 10, 2024
Merged

Add Android standalone log target #6590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions extension/android/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ set(executorch_DIR ${CMAKE_CURRENT_BINARY_DIR}/../../lib/cmake/ExecuTorch)
find_package(executorch CONFIG REQUIRED)
target_link_options_shared_lib(executorch)

add_library(executorch_jni SHARED jni/jni_layer.cpp)
add_library(executorch_jni SHARED jni/jni_layer.cpp jni/log.cpp)

set(link_libraries)
list(
Expand DownExpand Up@@ -146,7 +146,7 @@ if(EXECUTORCH_JNI_CUSTOM_LIBRARY)
endif()

if(EXECUTORCH_BUILD_LLAMA_JNI)
target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp)
target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp jni/log.cpp)
list(APPEND link_libraries llama_runner llava_runner)
target_compile_definitions(executorch_jni PUBLIC EXECUTORCH_BUILD_LLAMA_JNI=1)
add_subdirectory(
Expand Down
23 changes: 21 additions & 2 deletions extension/android/jni/BUCK
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
load("@fbsource//tools/build_defs/android:fb_android_cxx_library.bzl", "fb_android_cxx_library")
load("@fbsource//xplat/executorch/backends/xnnpack/third-party:third_party_libs.bzl", "third_party_dep")
load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
load("@fbsource//xplat/executorch/codegen:codegen.bzl", "executorch_generated_lib")

oncall("executorch")
Expand All@@ -25,7 +26,7 @@ executorch_generated_lib(

fb_android_cxx_library(
name = "executorch_jni",
srcs = ["jni_layer.cpp"],
srcs = ["jni_layer.cpp", "log.cpp"],
headers = ["jni_layer_constants.h"],
allow_jni_merging = False,
compiler_flags = [
Expand All@@ -36,6 +37,7 @@ fb_android_cxx_library(
soname = "libexecutorch.$(ext)",
visibility = ["PUBLIC"],
deps = [
":log_provider_static",
"//fbandroid/libraries/fbjni:fbjni",
"//fbandroid/native/fb:fb",
"//third-party/glog:glog",
Expand All@@ -49,7 +51,7 @@ fb_android_cxx_library(

fb_android_cxx_library(
name = "executorch_jni_full",
srcs = ["jni_layer.cpp"],
srcs = ["jni_layer.cpp", "log.cpp"],
headers = ["jni_layer_constants.h"],
allow_jni_merging = False,
compiler_flags = [
Expand All@@ -60,6 +62,7 @@ fb_android_cxx_library(
soname = "libexecutorch.$(ext)",
visibility = ["PUBLIC"],
deps = [
":log_provider_static",
":generated_op_lib_optimized_static",
"//fbandroid/libraries/fbjni:fbjni",
"//fbandroid/native/fb:fb",
Expand DownExpand Up@@ -88,6 +91,7 @@ fb_android_cxx_library(
soname = "libexecutorch.$(ext)",
visibility = ["PUBLIC"],
deps = [
":log_provider_static",
"//fbandroid/libraries/fbjni:fbjni",
"//fbandroid/native/fb:fb",
"//third-party/glog:glog",
Expand All@@ -101,3 +105,18 @@ fb_android_cxx_library(
"//xplat/executorch/extension/threadpool:threadpool_static",
],
)

runtime.cxx_library(
name = "log_provider",
srcs = ["log.cpp"],
exported_headers = ["log.h"],
compiler_flags = [
"-frtti",
"-fexceptions",
"-Wno-unused-variable",
],
deps = [
"//executorch/runtime/core:core",
],
visibility = ["@EXECUTORCH_CLIENTS"],
)
112 changes: 21 additions & 91 deletions extension/android/jni/jni_layer.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

#include "jni_layer_constants.h"

#include <executorch/extension/android/jni/log.h>
#include <executorch/extension/module/module.h>
#include <executorch/extension/runner_util/inputs.h>
#include <executorch/extension/tensor/tensor.h>
Expand All@@ -36,76 +37,6 @@
using namespace executorch::extension;
using namespace torch::executor;

#ifdef __ANDROID__
#include <android/log.h>
#include <mutex>
#include <sstream>

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

struct log_entry {
et_timestamp_t timestamp;
et_pal_log_level_t level;
std::string filename;
std::string function;
size_t line;
std::string message;

log_entry(
et_timestamp_t timestamp,
et_pal_log_level_t level,
const char* filename,
const char* function,
size_t line,
const char* message,
size_t length)
: timestamp(timestamp),
level(level),
filename(filename),
function(function),
line(line),
message(message, length) {}
};

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
et_timestamp_t timestamp,
et_pal_log_level_t level,
const char* filename,
const char* function,
size_t line,
const char* message,
size_t length) {
std::lock_guard<std::mutex> guard(log_buffer_mutex_);

while (log_buffer_.size() >= log_buffer_length) {
log_buffer_.erase(log_buffer_.begin());
}

log_buffer_.emplace_back(
timestamp, level, filename, function, line, message, length);

int android_log_level = ANDROID_LOG_UNKNOWN;
if (level == 'D') {
android_log_level = ANDROID_LOG_DEBUG;
} else if (level == 'I') {
android_log_level = ANDROID_LOG_INFO;
} else if (level == 'E') {
android_log_level = ANDROID_LOG_ERROR;
} else if (level == 'F') {
android_log_level = ANDROID_LOG_FATAL;
}

__android_log_print(android_log_level, "ExecuTorch", "%s", message);
}
#endif

namespace executorch::extension {
class TensorHybrid : public facebook::jni::HybridClass<TensorHybrid> {
public:
Expand DownExpand Up@@ -437,24 +368,26 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>>
readLogBuffer() {
#ifdef __ANDROID__
std::lock_guard<std::mutex> guard(log_buffer_mutex_);

const auto size = log_buffer_.size();
facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret =
facebook::jni::JArrayClass<jstring>::newArray(size);

for (auto i = 0u; i < size; i++) {
const auto& entry = log_buffer_[i];
// Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL MESSAGE".
std::stringstream ss;
ss << "[" << entry.timestamp << " " << entry.function << " "
<< entry.filename << ":" << entry.line << "] "
<< static_cast<char>(entry.level) << " " << entry.message;

facebook::jni::local_ref<facebook::jni::JString> jstr_message =
facebook::jni::make_jstring(ss.str().c_str());
(*ret)[i] = jstr_message;
}

facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret;

access_log_buffer([&](std::vector<log_entry>& buffer) {
const auto size = buffer.size();
ret = facebook::jni::JArrayClass<jstring>::newArray(size);
for (auto i = 0u; i < size; i++) {
const auto& entry = buffer[i];
// Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL
// MESSAGE".
std::stringstream ss;
ss << "[" << entry.timestamp << " " << entry.function << " "
<< entry.filename << ":" << entry.line << "] "
<< static_cast<char>(entry.level) << " " << entry.message;

facebook::jni::local_ref<facebook::jni::JString> jstr_message =
facebook::jni::make_jstring(ss.str().c_str());
(*ret)[i] = jstr_message;
}
});

return ret;
#else
Expand All@@ -468,10 +401,7 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
makeNativeMethod("forward", ExecuTorchJni::forward),
makeNativeMethod("execute", ExecuTorchJni::execute),
makeNativeMethod("loadMethod", ExecuTorchJni::load_method),

#ifdef __ANDROID__
makeNativeMethod("readLogBuffer", ExecuTorchJni::readLogBuffer),
#endif
});
}
};
Expand Down
69 changes: 69 additions & 0 deletions extension/android/jni/log.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/

#include "log.h"

#ifdef __ANDROID__

#include <android/log.h>
#include <functional>
#include <mutex>
#include <sstream>

using executorch::extension::log_entry;

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
et_timestamp_t timestamp,
et_pal_log_level_t level,
const char* filename,
const char* function,
size_t line,
const char* message,
size_t length) {
std::lock_guard<std::mutex> guard(log_buffer_mutex_);

while (log_buffer_.size() >= log_buffer_length) {
log_buffer_.erase(log_buffer_.begin());
}

log_buffer_.emplace_back(
timestamp, level, filename, function, line, message, length);

int android_log_level = ANDROID_LOG_UNKNOWN;
if (level == 'D') {
android_log_level = ANDROID_LOG_DEBUG;
} else if (level == 'I') {
android_log_level = ANDROID_LOG_INFO;
} else if (level == 'E') {
android_log_level = ANDROID_LOG_ERROR;
} else if (level == 'F') {
android_log_level = ANDROID_LOG_FATAL;
}

__android_log_print(android_log_level, "ExecuTorch", "%s", message);
}

namespace executorch::extension {

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor) {
std::lock_guard<std::mutex> guard(log_buffer_mutex_);
accessor(log_buffer_);
}

} // namespace executorch::extension

#endif
43 changes: 43 additions & 0 deletions extension/android/jni/log.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/

#include <functional>
#include <string>
#include <vector>

#include <executorch/runtime/platform/log.h>
#include <executorch/runtime/platform/platform.h>
#include <executorch/runtime/platform/runtime.h>

namespace executorch::extension {
struct log_entry {
et_timestamp_t timestamp;
et_pal_log_level_t level;
std::string filename;
std::string function;
size_t line;
std::string message;

log_entry(
et_timestamp_t timestamp,
et_pal_log_level_t level,
const char* filename,
const char* function,
size_t line,
const char* message,
size_t length)
: timestamp(timestamp),
level(level),
filename(filename),
function(function),
line(line),
message(message, length) {}
};

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor);
} // namespace executorch::extension
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add Android standalone log target#6590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

facebook-github-bot
merged 1 commit into

from

Nov 10, 2024
 Merged


Add Android standalone log target
#6590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
extension/android/CMakeLists.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ set(executorch_DIR ${CMAKE_CURRENT_BINARY_DIR}/../../lib/cmake/ExecuTorch)
find_package(executorch CONFIG REQUIRED)
target_link_options_shared_lib(executorch)

add_library(executorch_jni SHARED jni/jni_layer.cpp)
add_library(executorch_jni SHARED jni/jni_layer.cpp jni/log.cpp)

set(link_libraries)
list(
Expand DownExpand Up@@ -146,7 +146,7 @@ if(EXECUTORCH_JNI_CUSTOM_LIBRARY)
endif()

if(EXECUTORCH_BUILD_LLAMA_JNI)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp jni/log.cpp)
 list(APPEND link_libraries llama_runner llava_runner)
 target_compile_definitions(executorch_jni PUBLIC EXECUTORCH_BUILD_LLAMA_JNI=1)
 add_subdirectory(
Expand Down

23 changes: 21 additions & 2 deletions
extension/android/jni/BUCK

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
load("@fbsource//tools/build_defs/android:fb_android_cxx_library.bzl", "fb_android_cxx_library")
load("@fbsource//xplat/executorch/backends/xnnpack/third-party:third_party_libs.bzl", "third_party_dep")
load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
load("@fbsource//xplat/executorch/codegen:codegen.bzl", "executorch_generated_lib")

oncall("executorch")
Expand All@@ -25,7 +26,7 @@ executorch_generated_lib(

fb_android_cxx_library(
 name = "executorch_jni",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -36,6 +37,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -49,7 +51,7 @@ fb_android_cxx_library(

fb_android_cxx_library(
 name = "executorch_jni_full",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -60,6 +62,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 ":generated_op_lib_optimized_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
Expand DownExpand Up@@ -88,6 +91,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -101,3 +105,18 @@ fb_android_cxx_library(
 "//xplat/executorch/extension/threadpool:threadpool_static",
 ],
)

runtime.cxx_library(
 name = "log_provider",
 srcs = ["log.cpp"],
 exported_headers = ["log.h"],
 compiler_flags = [
 "-frtti",
 "-fexceptions",
 "-Wno-unused-variable",
 ],
 deps = [
 "//executorch/runtime/core:core",
 ],
 visibility = ["@EXECUTORCH_CLIENTS"],
)

112 changes: 21 additions & 91 deletions
extension/android/jni/jni_layer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

#include "jni_layer_constants.h"

#include <executorch/extension/android/jni/log.h>
#include <executorch/extension/module/module.h>
#include <executorch/extension/runner_util/inputs.h>
#include <executorch/extension/tensor/tensor.h>
Expand All@@ -36,76 +37,6 @@
using namespace executorch::extension;
using namespace torch::executor;

#ifdef __ANDROID__
#include <android/log.h>
#include <mutex>
#include <sstream>

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}
#endif

namespace executorch::extension {
class TensorHybrid : public facebook::jni::HybridClass<TensorHybrid> {
 public:
Expand DownExpand Up@@ -437,24 +368,26 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>>
 readLogBuffer() {
#ifdef __ANDROID__
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 const auto size = log_buffer_.size();
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret =
 facebook::jni::JArrayClass<jstring>::newArray(size);

 for (auto i = 0u; i < size; i++) {
 const auto& entry = log_buffer_[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }

 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret;

 access_log_buffer([&](std::vector<log_entry>& buffer) {
 const auto size = buffer.size();
 ret = facebook::jni::JArrayClass<jstring>::newArray(size);
 for (auto i = 0u; i < size; i++) {
 const auto& entry = buffer[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL
 // MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }
 });

 return ret;
#else
Expand All@@ -468,10 +401,7 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 makeNativeMethod("forward", ExecuTorchJni::forward),
 makeNativeMethod("execute", ExecuTorchJni::execute),
 makeNativeMethod("loadMethod", ExecuTorchJni::load_method),

#ifdef __ANDROID__
 makeNativeMethod("readLogBuffer", ExecuTorchJni::readLogBuffer),
#endif
 });
 }
};
Expand Down

69 changes: 69 additions & 0 deletions
extension/android/jni/log.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include "log.h"

#ifdef __ANDROID__

#include <android/log.h>
#include <functional>
#include <mutex>
#include <sstream>

using executorch::extension::log_entry;

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}

namespace executorch::extension {

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);
 accessor(log_buffer_);
}

} // namespace executorch::extension

#endif

43 changes: 43 additions & 0 deletions
extension/android/jni/log.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include <functional>
#include <string>
#include <vector>

#include <executorch/runtime/platform/log.h>
#include <executorch/runtime/platform/platform.h>
#include <executorch/runtime/platform/runtime.h>

namespace executorch::extension {
struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor);
} // namespace executorch::extension

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add Android standalone log target#6590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

facebook-github-bot
merged 1 commit into

from

Nov 10, 2024
 Merged


Add Android standalone log target
#6590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
extension/android/CMakeLists.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ set(executorch_DIR ${CMAKE_CURRENT_BINARY_DIR}/../../lib/cmake/ExecuTorch)
find_package(executorch CONFIG REQUIRED)
target_link_options_shared_lib(executorch)

add_library(executorch_jni SHARED jni/jni_layer.cpp)
add_library(executorch_jni SHARED jni/jni_layer.cpp jni/log.cpp)

set(link_libraries)
list(
Expand DownExpand Up@@ -146,7 +146,7 @@ if(EXECUTORCH_JNI_CUSTOM_LIBRARY)
endif()

if(EXECUTORCH_BUILD_LLAMA_JNI)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp jni/log.cpp)
 list(APPEND link_libraries llama_runner llava_runner)
 target_compile_definitions(executorch_jni PUBLIC EXECUTORCH_BUILD_LLAMA_JNI=1)
 add_subdirectory(
Expand Down

23 changes: 21 additions & 2 deletions
extension/android/jni/BUCK

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
load("@fbsource//tools/build_defs/android:fb_android_cxx_library.bzl", "fb_android_cxx_library")
load("@fbsource//xplat/executorch/backends/xnnpack/third-party:third_party_libs.bzl", "third_party_dep")
load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
load("@fbsource//xplat/executorch/codegen:codegen.bzl", "executorch_generated_lib")

oncall("executorch")
Expand All@@ -25,7 +26,7 @@ executorch_generated_lib(

fb_android_cxx_library(
 name = "executorch_jni",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -36,6 +37,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -49,7 +51,7 @@ fb_android_cxx_library(

fb_android_cxx_library(
 name = "executorch_jni_full",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -60,6 +62,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 ":generated_op_lib_optimized_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
Expand DownExpand Up@@ -88,6 +91,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -101,3 +105,18 @@ fb_android_cxx_library(
 "//xplat/executorch/extension/threadpool:threadpool_static",
 ],
)

runtime.cxx_library(
 name = "log_provider",
 srcs = ["log.cpp"],
 exported_headers = ["log.h"],
 compiler_flags = [
 "-frtti",
 "-fexceptions",
 "-Wno-unused-variable",
 ],
 deps = [
 "//executorch/runtime/core:core",
 ],
 visibility = ["@EXECUTORCH_CLIENTS"],
)

112 changes: 21 additions & 91 deletions
extension/android/jni/jni_layer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

#include "jni_layer_constants.h"

#include <executorch/extension/android/jni/log.h>
#include <executorch/extension/module/module.h>
#include <executorch/extension/runner_util/inputs.h>
#include <executorch/extension/tensor/tensor.h>
Expand All@@ -36,76 +37,6 @@
using namespace executorch::extension;
using namespace torch::executor;

#ifdef __ANDROID__
#include <android/log.h>
#include <mutex>
#include <sstream>

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}
#endif

namespace executorch::extension {
class TensorHybrid : public facebook::jni::HybridClass<TensorHybrid> {
 public:
Expand DownExpand Up@@ -437,24 +368,26 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>>
 readLogBuffer() {
#ifdef __ANDROID__
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 const auto size = log_buffer_.size();
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret =
 facebook::jni::JArrayClass<jstring>::newArray(size);

 for (auto i = 0u; i < size; i++) {
 const auto& entry = log_buffer_[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }

 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret;

 access_log_buffer([&](std::vector<log_entry>& buffer) {
 const auto size = buffer.size();
 ret = facebook::jni::JArrayClass<jstring>::newArray(size);
 for (auto i = 0u; i < size; i++) {
 const auto& entry = buffer[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL
 // MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }
 });

 return ret;
#else
Expand All@@ -468,10 +401,7 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 makeNativeMethod("forward", ExecuTorchJni::forward),
 makeNativeMethod("execute", ExecuTorchJni::execute),
 makeNativeMethod("loadMethod", ExecuTorchJni::load_method),

#ifdef __ANDROID__
 makeNativeMethod("readLogBuffer", ExecuTorchJni::readLogBuffer),
#endif
 });
 }
};
Expand Down

69 changes: 69 additions & 0 deletions
extension/android/jni/log.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include "log.h"

#ifdef __ANDROID__

#include <android/log.h>
#include <functional>
#include <mutex>
#include <sstream>

using executorch::extension::log_entry;

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}

namespace executorch::extension {

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);
 accessor(log_buffer_);
}

} // namespace executorch::extension

#endif

43 changes: 43 additions & 0 deletions
extension/android/jni/log.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include <functional>
#include <string>
#include <vector>

#include <executorch/runtime/platform/log.h>
#include <executorch/runtime/platform/platform.h>
#include <executorch/runtime/platform/runtime.h>

namespace executorch::extension {
struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor);
} // namespace executorch::extension

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add Android standalone log target#6590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

facebook-github-bot
merged 1 commit into

from

Nov 10, 2024
 Merged


Add Android standalone log target
#6590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
extension/android/CMakeLists.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ set(executorch_DIR ${CMAKE_CURRENT_BINARY_DIR}/../../lib/cmake/ExecuTorch)
find_package(executorch CONFIG REQUIRED)
target_link_options_shared_lib(executorch)

add_library(executorch_jni SHARED jni/jni_layer.cpp)
add_library(executorch_jni SHARED jni/jni_layer.cpp jni/log.cpp)

set(link_libraries)
list(
Expand DownExpand Up@@ -146,7 +146,7 @@ if(EXECUTORCH_JNI_CUSTOM_LIBRARY)
endif()

if(EXECUTORCH_BUILD_LLAMA_JNI)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp jni/log.cpp)
 list(APPEND link_libraries llama_runner llava_runner)
 target_compile_definitions(executorch_jni PUBLIC EXECUTORCH_BUILD_LLAMA_JNI=1)
 add_subdirectory(
Expand Down

23 changes: 21 additions & 2 deletions
extension/android/jni/BUCK

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
load("@fbsource//tools/build_defs/android:fb_android_cxx_library.bzl", "fb_android_cxx_library")
load("@fbsource//xplat/executorch/backends/xnnpack/third-party:third_party_libs.bzl", "third_party_dep")
load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
load("@fbsource//xplat/executorch/codegen:codegen.bzl", "executorch_generated_lib")

oncall("executorch")
Expand All@@ -25,7 +26,7 @@ executorch_generated_lib(

fb_android_cxx_library(
 name = "executorch_jni",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -36,6 +37,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -49,7 +51,7 @@ fb_android_cxx_library(

fb_android_cxx_library(
 name = "executorch_jni_full",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -60,6 +62,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 ":generated_op_lib_optimized_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
Expand DownExpand Up@@ -88,6 +91,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -101,3 +105,18 @@ fb_android_cxx_library(
 "//xplat/executorch/extension/threadpool:threadpool_static",
 ],
)

runtime.cxx_library(
 name = "log_provider",
 srcs = ["log.cpp"],
 exported_headers = ["log.h"],
 compiler_flags = [
 "-frtti",
 "-fexceptions",
 "-Wno-unused-variable",
 ],
 deps = [
 "//executorch/runtime/core:core",
 ],
 visibility = ["@EXECUTORCH_CLIENTS"],
)

112 changes: 21 additions & 91 deletions
extension/android/jni/jni_layer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

#include "jni_layer_constants.h"

#include <executorch/extension/android/jni/log.h>
#include <executorch/extension/module/module.h>
#include <executorch/extension/runner_util/inputs.h>
#include <executorch/extension/tensor/tensor.h>
Expand All@@ -36,76 +37,6 @@
using namespace executorch::extension;
using namespace torch::executor;

#ifdef __ANDROID__
#include <android/log.h>
#include <mutex>
#include <sstream>

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}
#endif

namespace executorch::extension {
class TensorHybrid : public facebook::jni::HybridClass<TensorHybrid> {
 public:
Expand DownExpand Up@@ -437,24 +368,26 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>>
 readLogBuffer() {
#ifdef __ANDROID__
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 const auto size = log_buffer_.size();
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret =
 facebook::jni::JArrayClass<jstring>::newArray(size);

 for (auto i = 0u; i < size; i++) {
 const auto& entry = log_buffer_[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }

 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret;

 access_log_buffer([&](std::vector<log_entry>& buffer) {
 const auto size = buffer.size();
 ret = facebook::jni::JArrayClass<jstring>::newArray(size);
 for (auto i = 0u; i < size; i++) {
 const auto& entry = buffer[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL
 // MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }
 });

 return ret;
#else
Expand All@@ -468,10 +401,7 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 makeNativeMethod("forward", ExecuTorchJni::forward),
 makeNativeMethod("execute", ExecuTorchJni::execute),
 makeNativeMethod("loadMethod", ExecuTorchJni::load_method),

#ifdef __ANDROID__
 makeNativeMethod("readLogBuffer", ExecuTorchJni::readLogBuffer),
#endif
 });
 }
};
Expand Down

69 changes: 69 additions & 0 deletions
extension/android/jni/log.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include "log.h"

#ifdef __ANDROID__

#include <android/log.h>
#include <functional>
#include <mutex>
#include <sstream>

using executorch::extension::log_entry;

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}

namespace executorch::extension {

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);
 accessor(log_buffer_);
}

} // namespace executorch::extension

#endif

43 changes: 43 additions & 0 deletions
extension/android/jni/log.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include <functional>
#include <string>
#include <vector>

#include <executorch/runtime/platform/log.h>
#include <executorch/runtime/platform/platform.h>
#include <executorch/runtime/platform/runtime.h>

namespace executorch::extension {
struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor);
} // namespace executorch::extension

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add Android standalone log target#6590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

facebook-github-bot
merged 1 commit into

from

Nov 10, 2024
 Merged


Add Android standalone log target
#6590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
extension/android/CMakeLists.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ set(executorch_DIR ${CMAKE_CURRENT_BINARY_DIR}/../../lib/cmake/ExecuTorch)
find_package(executorch CONFIG REQUIRED)
target_link_options_shared_lib(executorch)

add_library(executorch_jni SHARED jni/jni_layer.cpp)
add_library(executorch_jni SHARED jni/jni_layer.cpp jni/log.cpp)

set(link_libraries)
list(
Expand DownExpand Up@@ -146,7 +146,7 @@ if(EXECUTORCH_JNI_CUSTOM_LIBRARY)
endif()

if(EXECUTORCH_BUILD_LLAMA_JNI)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp jni/log.cpp)
 list(APPEND link_libraries llama_runner llava_runner)
 target_compile_definitions(executorch_jni PUBLIC EXECUTORCH_BUILD_LLAMA_JNI=1)
 add_subdirectory(
Expand Down

23 changes: 21 additions & 2 deletions
extension/android/jni/BUCK

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
load("@fbsource//tools/build_defs/android:fb_android_cxx_library.bzl", "fb_android_cxx_library")
load("@fbsource//xplat/executorch/backends/xnnpack/third-party:third_party_libs.bzl", "third_party_dep")
load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
load("@fbsource//xplat/executorch/codegen:codegen.bzl", "executorch_generated_lib")

oncall("executorch")
Expand All@@ -25,7 +26,7 @@ executorch_generated_lib(

fb_android_cxx_library(
 name = "executorch_jni",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -36,6 +37,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -49,7 +51,7 @@ fb_android_cxx_library(

fb_android_cxx_library(
 name = "executorch_jni_full",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -60,6 +62,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 ":generated_op_lib_optimized_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
Expand DownExpand Up@@ -88,6 +91,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -101,3 +105,18 @@ fb_android_cxx_library(
 "//xplat/executorch/extension/threadpool:threadpool_static",
 ],
)

runtime.cxx_library(
 name = "log_provider",
 srcs = ["log.cpp"],
 exported_headers = ["log.h"],
 compiler_flags = [
 "-frtti",
 "-fexceptions",
 "-Wno-unused-variable",
 ],
 deps = [
 "//executorch/runtime/core:core",
 ],
 visibility = ["@EXECUTORCH_CLIENTS"],
)

112 changes: 21 additions & 91 deletions
extension/android/jni/jni_layer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

#include "jni_layer_constants.h"

#include <executorch/extension/android/jni/log.h>
#include <executorch/extension/module/module.h>
#include <executorch/extension/runner_util/inputs.h>
#include <executorch/extension/tensor/tensor.h>
Expand All@@ -36,76 +37,6 @@
using namespace executorch::extension;
using namespace torch::executor;

#ifdef __ANDROID__
#include <android/log.h>
#include <mutex>
#include <sstream>

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}
#endif

namespace executorch::extension {
class TensorHybrid : public facebook::jni::HybridClass<TensorHybrid> {
 public:
Expand DownExpand Up@@ -437,24 +368,26 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>>
 readLogBuffer() {
#ifdef __ANDROID__
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 const auto size = log_buffer_.size();
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret =
 facebook::jni::JArrayClass<jstring>::newArray(size);

 for (auto i = 0u; i < size; i++) {
 const auto& entry = log_buffer_[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }

 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret;

 access_log_buffer([&](std::vector<log_entry>& buffer) {
 const auto size = buffer.size();
 ret = facebook::jni::JArrayClass<jstring>::newArray(size);
 for (auto i = 0u; i < size; i++) {
 const auto& entry = buffer[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL
 // MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }
 });

 return ret;
#else
Expand All@@ -468,10 +401,7 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 makeNativeMethod("forward", ExecuTorchJni::forward),
 makeNativeMethod("execute", ExecuTorchJni::execute),
 makeNativeMethod("loadMethod", ExecuTorchJni::load_method),

#ifdef __ANDROID__
 makeNativeMethod("readLogBuffer", ExecuTorchJni::readLogBuffer),
#endif
 });
 }
};
Expand Down

69 changes: 69 additions & 0 deletions
extension/android/jni/log.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include "log.h"

#ifdef __ANDROID__

#include <android/log.h>
#include <functional>
#include <mutex>
#include <sstream>

using executorch::extension::log_entry;

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}

namespace executorch::extension {

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);
 accessor(log_buffer_);
}

} // namespace executorch::extension

#endif

43 changes: 43 additions & 0 deletions
extension/android/jni/log.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include <functional>
#include <string>
#include <vector>

#include <executorch/runtime/platform/log.h>
#include <executorch/runtime/platform/platform.h>
#include <executorch/runtime/platform/runtime.h>

namespace executorch::extension {
struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor);
} // namespace executorch::extension

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add Android standalone log target#6590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

facebook-github-bot
merged 1 commit into

from

Nov 10, 2024
 Merged


Add Android standalone log target
#6590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
extension/android/CMakeLists.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ set(executorch_DIR ${CMAKE_CURRENT_BINARY_DIR}/../../lib/cmake/ExecuTorch)
find_package(executorch CONFIG REQUIRED)
target_link_options_shared_lib(executorch)

add_library(executorch_jni SHARED jni/jni_layer.cpp)
add_library(executorch_jni SHARED jni/jni_layer.cpp jni/log.cpp)

set(link_libraries)
list(
Expand DownExpand Up@@ -146,7 +146,7 @@ if(EXECUTORCH_JNI_CUSTOM_LIBRARY)
endif()

if(EXECUTORCH_BUILD_LLAMA_JNI)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp jni/log.cpp)
 list(APPEND link_libraries llama_runner llava_runner)
 target_compile_definitions(executorch_jni PUBLIC EXECUTORCH_BUILD_LLAMA_JNI=1)
 add_subdirectory(
Expand Down

23 changes: 21 additions & 2 deletions
extension/android/jni/BUCK

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
load("@fbsource//tools/build_defs/android:fb_android_cxx_library.bzl", "fb_android_cxx_library")
load("@fbsource//xplat/executorch/backends/xnnpack/third-party:third_party_libs.bzl", "third_party_dep")
load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
load("@fbsource//xplat/executorch/codegen:codegen.bzl", "executorch_generated_lib")

oncall("executorch")
Expand All@@ -25,7 +26,7 @@ executorch_generated_lib(

fb_android_cxx_library(
 name = "executorch_jni",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -36,6 +37,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -49,7 +51,7 @@ fb_android_cxx_library(

fb_android_cxx_library(
 name = "executorch_jni_full",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -60,6 +62,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 ":generated_op_lib_optimized_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
Expand DownExpand Up@@ -88,6 +91,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -101,3 +105,18 @@ fb_android_cxx_library(
 "//xplat/executorch/extension/threadpool:threadpool_static",
 ],
)

runtime.cxx_library(
 name = "log_provider",
 srcs = ["log.cpp"],
 exported_headers = ["log.h"],
 compiler_flags = [
 "-frtti",
 "-fexceptions",
 "-Wno-unused-variable",
 ],
 deps = [
 "//executorch/runtime/core:core",
 ],
 visibility = ["@EXECUTORCH_CLIENTS"],
)

112 changes: 21 additions & 91 deletions
extension/android/jni/jni_layer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

#include "jni_layer_constants.h"

#include <executorch/extension/android/jni/log.h>
#include <executorch/extension/module/module.h>
#include <executorch/extension/runner_util/inputs.h>
#include <executorch/extension/tensor/tensor.h>
Expand All@@ -36,76 +37,6 @@
using namespace executorch::extension;
using namespace torch::executor;

#ifdef __ANDROID__
#include <android/log.h>
#include <mutex>
#include <sstream>

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}
#endif

namespace executorch::extension {
class TensorHybrid : public facebook::jni::HybridClass<TensorHybrid> {
 public:
Expand DownExpand Up@@ -437,24 +368,26 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>>
 readLogBuffer() {
#ifdef __ANDROID__
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 const auto size = log_buffer_.size();
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret =
 facebook::jni::JArrayClass<jstring>::newArray(size);

 for (auto i = 0u; i < size; i++) {
 const auto& entry = log_buffer_[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }

 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret;

 access_log_buffer([&](std::vector<log_entry>& buffer) {
 const auto size = buffer.size();
 ret = facebook::jni::JArrayClass<jstring>::newArray(size);
 for (auto i = 0u; i < size; i++) {
 const auto& entry = buffer[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL
 // MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }
 });

 return ret;
#else
Expand All@@ -468,10 +401,7 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 makeNativeMethod("forward", ExecuTorchJni::forward),
 makeNativeMethod("execute", ExecuTorchJni::execute),
 makeNativeMethod("loadMethod", ExecuTorchJni::load_method),

#ifdef __ANDROID__
 makeNativeMethod("readLogBuffer", ExecuTorchJni::readLogBuffer),
#endif
 });
 }
};
Expand Down

69 changes: 69 additions & 0 deletions
extension/android/jni/log.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include "log.h"

#ifdef __ANDROID__

#include <android/log.h>
#include <functional>
#include <mutex>
#include <sstream>

using executorch::extension::log_entry;

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}

namespace executorch::extension {

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);
 accessor(log_buffer_);
}

} // namespace executorch::extension

#endif

43 changes: 43 additions & 0 deletions
extension/android/jni/log.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include <functional>
#include <string>
#include <vector>

#include <executorch/runtime/platform/log.h>
#include <executorch/runtime/platform/platform.h>
#include <executorch/runtime/platform/runtime.h>

namespace executorch::extension {
struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor);
} // namespace executorch::extension

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add Android standalone log target#6590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

facebook-github-bot
merged 1 commit into

from

Nov 10, 2024
 Merged


Add Android standalone log target
#6590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
extension/android/CMakeLists.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ set(executorch_DIR ${CMAKE_CURRENT_BINARY_DIR}/../../lib/cmake/ExecuTorch)
find_package(executorch CONFIG REQUIRED)
target_link_options_shared_lib(executorch)

add_library(executorch_jni SHARED jni/jni_layer.cpp)
add_library(executorch_jni SHARED jni/jni_layer.cpp jni/log.cpp)

set(link_libraries)
list(
Expand DownExpand Up@@ -146,7 +146,7 @@ if(EXECUTORCH_JNI_CUSTOM_LIBRARY)
endif()

if(EXECUTORCH_BUILD_LLAMA_JNI)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp jni/log.cpp)
 list(APPEND link_libraries llama_runner llava_runner)
 target_compile_definitions(executorch_jni PUBLIC EXECUTORCH_BUILD_LLAMA_JNI=1)
 add_subdirectory(
Expand Down

23 changes: 21 additions & 2 deletions
extension/android/jni/BUCK

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
load("@fbsource//tools/build_defs/android:fb_android_cxx_library.bzl", "fb_android_cxx_library")
load("@fbsource//xplat/executorch/backends/xnnpack/third-party:third_party_libs.bzl", "third_party_dep")
load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
load("@fbsource//xplat/executorch/codegen:codegen.bzl", "executorch_generated_lib")

oncall("executorch")
Expand All@@ -25,7 +26,7 @@ executorch_generated_lib(

fb_android_cxx_library(
 name = "executorch_jni",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -36,6 +37,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -49,7 +51,7 @@ fb_android_cxx_library(

fb_android_cxx_library(
 name = "executorch_jni_full",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -60,6 +62,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 ":generated_op_lib_optimized_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
Expand DownExpand Up@@ -88,6 +91,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -101,3 +105,18 @@ fb_android_cxx_library(
 "//xplat/executorch/extension/threadpool:threadpool_static",
 ],
)

runtime.cxx_library(
 name = "log_provider",
 srcs = ["log.cpp"],
 exported_headers = ["log.h"],
 compiler_flags = [
 "-frtti",
 "-fexceptions",
 "-Wno-unused-variable",
 ],
 deps = [
 "//executorch/runtime/core:core",
 ],
 visibility = ["@EXECUTORCH_CLIENTS"],
)

112 changes: 21 additions & 91 deletions
extension/android/jni/jni_layer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

#include "jni_layer_constants.h"

#include <executorch/extension/android/jni/log.h>
#include <executorch/extension/module/module.h>
#include <executorch/extension/runner_util/inputs.h>
#include <executorch/extension/tensor/tensor.h>
Expand All@@ -36,76 +37,6 @@
using namespace executorch::extension;
using namespace torch::executor;

#ifdef __ANDROID__
#include <android/log.h>
#include <mutex>
#include <sstream>

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}
#endif

namespace executorch::extension {
class TensorHybrid : public facebook::jni::HybridClass<TensorHybrid> {
 public:
Expand DownExpand Up@@ -437,24 +368,26 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>>
 readLogBuffer() {
#ifdef __ANDROID__
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 const auto size = log_buffer_.size();
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret =
 facebook::jni::JArrayClass<jstring>::newArray(size);

 for (auto i = 0u; i < size; i++) {
 const auto& entry = log_buffer_[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }

 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret;

 access_log_buffer([&](std::vector<log_entry>& buffer) {
 const auto size = buffer.size();
 ret = facebook::jni::JArrayClass<jstring>::newArray(size);
 for (auto i = 0u; i < size; i++) {
 const auto& entry = buffer[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL
 // MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }
 });

 return ret;
#else
Expand All@@ -468,10 +401,7 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 makeNativeMethod("forward", ExecuTorchJni::forward),
 makeNativeMethod("execute", ExecuTorchJni::execute),
 makeNativeMethod("loadMethod", ExecuTorchJni::load_method),

#ifdef __ANDROID__
 makeNativeMethod("readLogBuffer", ExecuTorchJni::readLogBuffer),
#endif
 });
 }
};
Expand Down

69 changes: 69 additions & 0 deletions
extension/android/jni/log.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include "log.h"

#ifdef __ANDROID__

#include <android/log.h>
#include <functional>
#include <mutex>
#include <sstream>

using executorch::extension::log_entry;

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}

namespace executorch::extension {

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);
 accessor(log_buffer_);
}

} // namespace executorch::extension

#endif

43 changes: 43 additions & 0 deletions
extension/android/jni/log.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include <functional>
#include <string>
#include <vector>

#include <executorch/runtime/platform/log.h>
#include <executorch/runtime/platform/platform.h>
#include <executorch/runtime/platform/runtime.h>

namespace executorch::extension {
struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor);
} // namespace executorch::extension

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add Android standalone log target#6590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

facebook-github-bot
merged 1 commit into

from

Nov 10, 2024
 Merged


Add Android standalone log target
#6590
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
extension/android/CMakeLists.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -64,7 +64,7 @@ set(executorch_DIR ${CMAKE_CURRENT_BINARY_DIR}/../../lib/cmake/ExecuTorch)
find_package(executorch CONFIG REQUIRED)
target_link_options_shared_lib(executorch)

add_library(executorch_jni SHARED jni/jni_layer.cpp)
add_library(executorch_jni SHARED jni/jni_layer.cpp jni/log.cpp)

set(link_libraries)
list(
Expand DownExpand Up@@ -146,7 +146,7 @@ if(EXECUTORCH_JNI_CUSTOM_LIBRARY)
endif()

if(EXECUTORCH_BUILD_LLAMA_JNI)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp)
 target_sources(executorch_jni PRIVATE jni/jni_layer_llama.cpp jni/log.cpp)
 list(APPEND link_libraries llama_runner llava_runner)
 target_compile_definitions(executorch_jni PUBLIC EXECUTORCH_BUILD_LLAMA_JNI=1)
 add_subdirectory(
Expand Down

23 changes: 21 additions & 2 deletions
extension/android/jni/BUCK

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
load("@fbsource//tools/build_defs/android:fb_android_cxx_library.bzl", "fb_android_cxx_library")
load("@fbsource//xplat/executorch/backends/xnnpack/third-party:third_party_libs.bzl", "third_party_dep")
load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
load("@fbsource//xplat/executorch/codegen:codegen.bzl", "executorch_generated_lib")

oncall("executorch")
Expand All@@ -25,7 +26,7 @@ executorch_generated_lib(

fb_android_cxx_library(
 name = "executorch_jni",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -36,6 +37,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -49,7 +51,7 @@ fb_android_cxx_library(

fb_android_cxx_library(
 name = "executorch_jni_full",
 srcs = ["jni_layer.cpp"],
 srcs = ["jni_layer.cpp", "log.cpp"],
 headers = ["jni_layer_constants.h"],
 allow_jni_merging = False,
 compiler_flags = [
Expand All@@ -60,6 +62,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 ":generated_op_lib_optimized_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
Expand DownExpand Up@@ -88,6 +91,7 @@ fb_android_cxx_library(
 soname = "libexecutorch.$(ext)",
 visibility = ["PUBLIC"],
 deps = [
 ":log_provider_static",
 "//fbandroid/libraries/fbjni:fbjni",
 "//fbandroid/native/fb:fb",
 "//third-party/glog:glog",
Expand All@@ -101,3 +105,18 @@ fb_android_cxx_library(
 "//xplat/executorch/extension/threadpool:threadpool_static",
 ],
)

runtime.cxx_library(
 name = "log_provider",
 srcs = ["log.cpp"],
 exported_headers = ["log.h"],
 compiler_flags = [
 "-frtti",
 "-fexceptions",
 "-Wno-unused-variable",
 ],
 deps = [
 "//executorch/runtime/core:core",
 ],
 visibility = ["@EXECUTORCH_CLIENTS"],
)

112 changes: 21 additions & 91 deletions
extension/android/jni/jni_layer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

#include "jni_layer_constants.h"

#include <executorch/extension/android/jni/log.h>
#include <executorch/extension/module/module.h>
#include <executorch/extension/runner_util/inputs.h>
#include <executorch/extension/tensor/tensor.h>
Expand All@@ -36,76 +37,6 @@
using namespace executorch::extension;
using namespace torch::executor;

#ifdef __ANDROID__
#include <android/log.h>
#include <mutex>
#include <sstream>

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}
#endif

namespace executorch::extension {
class TensorHybrid : public facebook::jni::HybridClass<TensorHybrid> {
 public:
Expand DownExpand Up@@ -437,24 +368,26 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>>
 readLogBuffer() {
#ifdef __ANDROID__
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 const auto size = log_buffer_.size();
 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret =
 facebook::jni::JArrayClass<jstring>::newArray(size);

 for (auto i = 0u; i < size; i++) {
 const auto& entry = log_buffer_[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }

 facebook::jni::local_ref<facebook::jni::JArrayClass<jstring>> ret;

 access_log_buffer([&](std::vector<log_entry>& buffer) {
 const auto size = buffer.size();
 ret = facebook::jni::JArrayClass<jstring>::newArray(size);
 for (auto i = 0u; i < size; i++) {
 const auto& entry = buffer[i];
 // Format the log entry as "[TIMESTAMP FUNCTION FILE:LINE] LEVEL
 // MESSAGE".
 std::stringstream ss;
 ss << "[" << entry.timestamp << " " << entry.function << " "
 << entry.filename << ":" << entry.line << "] "
 << static_cast<char>(entry.level) << " " << entry.message;

 facebook::jni::local_ref<facebook::jni::JString> jstr_message =
 facebook::jni::make_jstring(ss.str().c_str());
 (*ret)[i] = jstr_message;
 }
 });

 return ret;
#else
Expand All@@ -468,10 +401,7 @@ class ExecuTorchJni : public facebook::jni::HybridClass<ExecuTorchJni> {
 makeNativeMethod("forward", ExecuTorchJni::forward),
 makeNativeMethod("execute", ExecuTorchJni::execute),
 makeNativeMethod("loadMethod", ExecuTorchJni::load_method),

#ifdef __ANDROID__
 makeNativeMethod("readLogBuffer", ExecuTorchJni::readLogBuffer),
#endif
 });
 }
};
Expand Down

69 changes: 69 additions & 0 deletions
extension/android/jni/log.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include "log.h"

#ifdef __ANDROID__

#include <android/log.h>
#include <functional>
#include <mutex>
#include <sstream>

using executorch::extension::log_entry;

// Number of entries to store in the in-memory log buffer.
const size_t log_buffer_length = 16;

namespace {
std::vector<log_entry> log_buffer_;
std::mutex log_buffer_mutex_;
} // namespace

// For Android, write to logcat
void et_pal_emit_log_message(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);

 while (log_buffer_.size() >= log_buffer_length) {
 log_buffer_.erase(log_buffer_.begin());
 }

 log_buffer_.emplace_back(
 timestamp, level, filename, function, line, message, length);

 int android_log_level = ANDROID_LOG_UNKNOWN;
 if (level == 'D') {
 android_log_level = ANDROID_LOG_DEBUG;
 } else if (level == 'I') {
 android_log_level = ANDROID_LOG_INFO;
 } else if (level == 'E') {
 android_log_level = ANDROID_LOG_ERROR;
 } else if (level == 'F') {
 android_log_level = ANDROID_LOG_FATAL;
 }

 __android_log_print(android_log_level, "ExecuTorch", "%s", message);
}

namespace executorch::extension {

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor) {
 std::lock_guard<std::mutex> guard(log_buffer_mutex_);
 accessor(log_buffer_);
}

} // namespace executorch::extension

#endif

43 changes: 43 additions & 0 deletions
extension/android/jni/log.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */

#include <functional>
#include <string>
#include <vector>

#include <executorch/runtime/platform/log.h>
#include <executorch/runtime/platform/platform.h>
#include <executorch/runtime/platform/runtime.h>

namespace executorch::extension {
struct log_entry {
 et_timestamp_t timestamp;
 et_pal_log_level_t level;
 std::string filename;
 std::string function;
 size_t line;
 std::string message;

 log_entry(
 et_timestamp_t timestamp,
 et_pal_log_level_t level,
 const char* filename,
 const char* function,
 size_t line,
 const char* message,
 size_t length)
 : timestamp(timestamp),
 level(level),
 filename(filename),
 function(function),
 line(line),
 message(message, length) {}
};

void access_log_buffer(std::function<void(std::vector<log_entry>&)> accessor);
} // namespace executorch::extension