Skip to content
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

log: refine log function for Android #2071

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

log: refine log function for Android #2071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bc37ad
log: refine log function for Android
zhouwg Apr 17, 2024
0362365
fix build issue which reported by github CI system
zhouwg Apr 17, 2024
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: 4 additions & 0 deletions ggml.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,13 +206,17 @@
# define GGML_DEPRECATED(func, hint) func
#endif

#if (defined __ANDROID__) || (defined ANDROID)
# define GGML_ATTRIBUTE_FORMAT(...)
#else
#ifndef __GNUC__
# define GGML_ATTRIBUTE_FORMAT(...)
#elif defined(__MINGW32__)
# define GGML_ATTRIBUTE_FORMAT(...) __attribute__((format(gnu_printf, __VA_ARGS__)))
#else
# define GGML_ATTRIBUTE_FORMAT(...) __attribute__((format(printf, __VA_ARGS__)))
#endif
#endif

#include <stdbool.h>
#include <stddef.h>
Expand Down
33 changes: 23 additions & 10 deletions whisper.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,9 @@ static void byteswap_tensor(ggml_tensor * tensor) {
#define BYTESWAP_TENSOR(t) do {} while (0)
#endif

#if (defined __ANDROID__) || (defined ANDROID)
#define WHISPER_ATTRIBUTE_FORMAT(...)
#else
#ifdef __GNUC__
#ifdef __MINGW32__
#define WHISPER_ATTRIBUTE_FORMAT(...) __attribute__((format(gnu_printf, __VA_ARGS__)))
Expand All @@ -117,24 +120,29 @@ static void byteswap_tensor(ggml_tensor * tensor) {
#else
#define WHISPER_ATTRIBUTE_FORMAT(...)
#endif
#endif

//
// logging
//
#if (defined __ANDROID__) || (defined ANDROID)
extern "C" int __android_log_print(int prio, const char * tag, const char * fmt, ...)
__attribute__((__format__(printf, 3, 4)));
#endif

WHISPER_ATTRIBUTE_FORMAT(2, 3)
static void whisper_log_internal (ggml_log_level level, const char * format, ...);
WHISPER_ATTRIBUTE_FORMAT(5, 6)
static void whisper_log_internal (ggml_log_level level, const char * file, const char * func, int line, const char * format, ...);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why add these three parameters at such a low level?

static void whisper_log_callback_default(ggml_log_level level, const char * text, void * user_data);

#define WHISPER_LOG_ERROR(...) whisper_log_internal(GGML_LOG_LEVEL_ERROR, __VA_ARGS__)
#define WHISPER_LOG_WARN(...) whisper_log_internal(GGML_LOG_LEVEL_WARN , __VA_ARGS__)
#define WHISPER_LOG_INFO(...) whisper_log_internal(GGML_LOG_LEVEL_INFO , __VA_ARGS__)
#define WHISPER_LOG_ERROR(...) whisper_log_internal(GGML_LOG_LEVEL_ERROR, __FILE__, __FUNCTION__, __LINE__, __VA_ARGS__)
#define WHISPER_LOG_WARN(...) whisper_log_internal(GGML_LOG_LEVEL_WARN , __FILE__, __FUNCTION__, __LINE__, __VA_ARGS__)
#define WHISPER_LOG_INFO(...) whisper_log_internal(GGML_LOG_LEVEL_INFO , __FILE__, __FUNCTION__, __LINE__, __VA_ARGS__)

// define this to enable verbose trace logging - useful for debugging purposes
//#define WHISPER_DEBUG

#if defined(WHISPER_DEBUG)
#define WHISPER_LOG_DEBUG(...) whisper_log_internal(GGML_LOG_LEVEL_DEBUG, __VA_ARGS__)
#define WHISPER_LOG_DEBUG(...) whisper_log_internal(GGML_LOG_LEVEL_DEBUG, __FILE__, __FUNCTION__, __LINE__, __VA_ARGS__)
#else
#define WHISPER_LOG_DEBUG(...)
#endif
Expand Down Expand Up @@ -7196,14 +7204,19 @@ void whisper_log_set(ggml_log_callback log_callback, void * user_data) {
g_state.log_callback_user_data = user_data;
}

GGML_ATTRIBUTE_FORMAT(2, 3)
static void whisper_log_internal(ggml_log_level level, const char * format, ...) {
GGML_ATTRIBUTE_FORMAT(5, 6)
static void whisper_log_internal(ggml_log_level level, const char * file, const char * func, int line, const char * format, ...) {
va_list args;
va_start(args, format);
char buffer[1024];
int len = vsnprintf(buffer, 1024, format, args);
if (len < 1024) {
int len_prefix = snprintf(buffer, 1024, "[%s, %d]: ", func, line); // param file not used in this file
int len = vsnprintf(buffer + len_prefix, 1024 - len_prefix, format, args);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if snprintf fails due to an output error then this will write to an address before the buffer's start.

if (len < (1024 - len_prefix)) {
#if (defined __ANDROID__) || (defined ANDROID)
__android_log_print(level, "whisper.cpp", "%s", buffer);
#else
g_state.log_callback(level, buffer, g_state.log_callback_user_data);
#endif
} else {
char* buffer2 = new char[len+1];
vsnprintf(buffer2, len+1, format, args);
Expand Down
Loading