Import of the watch repository from Pebble

This commit is contained in:
Matthieu Jeanson 2024-12-12 16:43:03 -08:00 committed by Katharine Berry
commit 3b92768480
10334 changed files with 2564465 additions and 0 deletions

407
src/fw/system/logging.h Normal file
View file

@ -0,0 +1,407 @@
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include "console/dbgserial.h"
#include "system/die.h"
#include "system/reboot_reason.h"
#include "system/status_codes.h"
#include <stdarg.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <stdbool.h>
#ifndef __FILE_NAME__
#define __FILE_NAME__ __FILE__
#endif
#define SPLIT_64_BIT_ARG(x) (uint32_t)((x >> 32) & 0xFFFFFFFF), (uint32_t)(x & 0xFFFFFFFF)
#define LOG_BUFFER_LENGTH 128
// Minimum amount of stack space required for vsniprintf
#define LOGGING_MIN_STACK_FOR_SPRINTF 240
#define LOGGING_STACK_FULL_MSG ((const char *)" [STK FULL]")
void pbl_log_hashed_async(const uint32_t packed_loghash, ...);
void pbl_log_hashed_sync(const uint32_t packed_loghash, ...);
// Core Number must be shifted to the correct position.
void pbl_log_hashed_core(const uint32_t core_number, const uint32_t packed_loghash, ...);
// Core Number must be shifted to the correct position.
void pbl_log_hashed_vargs(const bool async, const uint32_t core_number,
const uint32_t packed_loghash, va_list fmt_args);
void pbl_log_vargs(uint8_t log_level, const char *src_filename, int src_line_number,
const char *fmt, va_list args);
void pbl_log(uint8_t log_level, const char* src_filename, int src_line_number, const char* fmt, ...)
FORMAT_PRINTF(4, 5);
void pbl_log_sync(uint8_t log_level, const char* src_filename, int src_line_number, const char* fmt, ...)
FORMAT_PRINTF(4, 5);
int pbl_log_binary_format(char* buffer, int buffer_len, const uint8_t log_level,
const char* src_filename_path, int src_line_number, const char* fmt, va_list args);
int pbl_log_get_bin_format(char* buffer, int buffer_len, const uint8_t log_level,
const char* src_filename_path, int src_line_number, const char* fmt, ...);
#define LOG_LEVEL_ALWAYS 0
#define LOG_LEVEL_ERROR 1
#define LOG_LEVEL_WARNING 50
#define LOG_LEVEL_INFO 100
#define LOG_LEVEL_DEBUG 200
#define LOG_LEVEL_DEBUG_VERBOSE 255
#ifdef PBL_LOGS_HASHED
#include <logging/log_hashing.h>
#endif
#define LOG_COLOR_BLACK "BLACK" // Not so useful in general
#define LOG_COLOR_RED "RED"
#define LOG_COLOR_GREEN "GREEN"
#define LOG_COLOR_YELLOW "YELLOW"
#define LOG_COLOR_BLUE "BLUE"
#define LOG_COLOR_MAGENTA "MAGENTA"
#define LOG_COLOR_CYAN "CYAN"
#define LOG_COLOR_GREY "GREY"
// Reserved for bold. Use sparingly
#define LOG_COLOR_LIGHT_GREY "LIGHT_GREY"
#define LOG_COLOR_LIGHT_RED "LIGHT_RED"
#define LOG_COLOR_LIGHT_GREEN "LIGHT_GREEN"
#define LOG_COLOR_LIGHT_YELLOW "LIGHT_YELLOW"
#define LOG_COLOR_LIGHT_BLUE "LIGHT_BLUE"
#define LOG_COLOR_LIGHT_MAGENTA "LIGHT_MAGENTA"
#define LOG_COLOR_LIGHT_CYAN "LIGHT_CYAN"
#define LOG_COLOR_WHITE "WHITE"
// Allow the default color for a src file to be set by defining FILE_LOG_COLOR
// Can be called directly with PBL_LOG_COLOR
#ifdef FILE_LOG_COLOR
#define DEFAULT_LOG_COLOR FILE_LOG_COLOR
#else
#define DEFAULT_LOG_COLOR LOG_COLOR_GREY
#endif
#define LOG_DOMAIN_MISC 1
#define LOG_DOMAIN_BT_CORE 1
#define LOG_DOMAIN_FS 1
#define LOG_DOMAIN_COMM 1
#define LOG_DOMAIN_ACCEL 0
#define LOG_DOMAIN_TEXT 0
#define LOG_DOMAIN_QEMU_COMM 0
#define LOG_DOMAIN_ANIMATION 0
#define LOG_DOMAIN_ANALYTICS 0
#define LOG_DOMAIN_ACTIVITY 0
#define LOG_DOMAIN_ACTIVITY_INSIGHTS 0
#define LOG_DOMAIN_PROTOBUF 0
#if defined(VOICE_DEBUG)
#define LOG_DOMAIN_VOICE 1
#else
#define LOG_DOMAIN_VOICE 0
#endif
#define LOG_DOMAIN_BLOBDB 0
#ifndef LOG_DOMAIN_BT_ISPP
#define LOG_DOMAIN_BT_ISPP 0
#endif
#ifndef LOG_DOMAIN_BT_SDP
#define LOG_DOMAIN_BT_SDP 0
#endif
#ifndef LOG_DOMAIN_BT_GAP
#define LOG_DOMAIN_BT_GAP 0
#endif
#ifndef LOG_DOMAIN_BT_PROFILES
#define LOG_DOMAIN_BT_PROFILES 0
#endif
#ifndef LOG_DOMAIN_BT_PAIRING_INFO
#if !RELEASE
#define LOG_DOMAIN_BT_PAIRING_INFO 1
#else
#define LOG_DOMAIN_BT_PAIRING_INFO 0
#endif
#endif
#ifndef LOG_DOMAIN_BT_SNIFF
#define LOG_DOMAIN_BT_SNIFF 0
#endif
#ifndef LOG_DOMAIN_BT_HCI
#define LOG_DOMAIN_BT_HCI 0
#endif
#ifndef LOG_DOMAIN_BLE // Not grouped with BT classic
#define LOG_DOMAIN_BLE 0
#endif
#ifndef LOG_DOMAIN_DATA_LOGGING
#define LOG_DOMAIN_DATA_LOGGING 0
#endif
#ifndef LOG_DOMAIN_BLE_CORE // Not included with BLE
#define LOG_DOMAIN_BLE_CORE 0
#endif
#ifndef LOG_DOMAIN_BLE_GAP // Not included with BLE
#define LOG_DOMAIN_BLE_GAP 0
#endif
#ifndef LOG_DOMAIN_BLE_SM // Not included with BLE
#define LOG_DOMAIN_BLE_SM 0
#endif
#ifdef LOG_DOMAIN_ALL // Turn on all domains that are off by default
#define LOG_DOMAIN_BT
#endif
#ifdef LOG_DOMAIN_BT
#define LOG_DOMAIN_BT_PROFILES 1
#define LOG_DOMAIN_BT_HCI 1
#define LOG_DOMAIN_BT_SNIFF 1
#else
#define LOG_DOMAIN_BT 0
#endif
#if LOG_DOMAIN_BT_PROFILES
#define LOG_DOMAIN_BT_ISPP 1
#define LOG_DOMAIN_BT_SDP 1
#define LOG_DOMAIN_BT_GAP 1
#endif
#ifndef LOG_DOMAIN_TOUCH
#define LOG_DOMAIN_TOUCH 0
#endif
#ifndef LOG_DOMAIN_I2C
#define LOG_DOMAIN_I2C 0
#endif
#ifndef STRINGIFY
#define STRINGIFY_NX(a) #a
#define STRINGIFY(a) STRINGIFY_NX(a)
#endif // STRINGIFY
#define STATUS_STRING(s) STRINGIFY(s)
#ifndef DEFAULT_LOG_DOMAIN
#define DEFAULT_LOG_DOMAIN LOG_DOMAIN_MISC
#endif // DEFAULT_LOG_DOMAIN
#if defined(PLATFORM_TINTIN) && !defined(TARGET_QEMU)
#define PBL_SHOULD_LOG(level) ((level) < LOG_LEVEL_DEBUG)
#else
#define PBL_SHOULD_LOG(level) (true)
#endif
#ifdef PBL_LOG_ENABLED
#ifdef PBL_LOGS_HASHED
#define PBL_LOG_D(domain, level, fmt, ...) \
do { \
if (PBL_SHOULD_LOG(level)) { \
if (domain) { \
NEW_LOG_HASH(pbl_log_hashed_async, level, DEFAULT_LOG_COLOR, fmt, ## __VA_ARGS__); \
} \
} \
} while (0)
#define PBL_LOG_D_SYNC(domain, level, fmt, ...) \
do { \
if (PBL_SHOULD_LOG(level)) { \
if (domain) { \
NEW_LOG_HASH(pbl_log_hashed_sync, level, DEFAULT_LOG_COLOR, fmt, ## __VA_ARGS__); \
} \
} \
} while (0)
#define PBL_LOG_COLOR_D(domain, level, color, fmt, ...) \
do { \
if (PBL_SHOULD_LOG(level)) { \
if (domain) { \
NEW_LOG_HASH(pbl_log_hashed_async, level, color, fmt, ## __VA_ARGS__); \
} \
} \
} while (0)
#define PBL_LOG_COLOR_D_SYNC(domain, level, color, fmt, ...) \
do { \
if (PBL_SHOULD_LOG(level)) { \
if (domain) { \
NEW_LOG_HASH(pbl_log_hashed_sync, level, color, fmt, ## __VA_ARGS__); \
} \
} \
} while (0)
#else
#define PBL_LOG_D(domain, level, fmt, ...) \
do { \
if (domain) { \
pbl_log(level, __FILE__, __LINE__, fmt, ## __VA_ARGS__); \
} \
} while (0)
#define PBL_LOG_D_SYNC(domain, level, fmt, ...) \
do { \
if (domain) { \
pbl_log_sync(level, __FILE__, __LINE__, fmt, ## __VA_ARGS__); \
} \
} while (0)
#define PBL_LOG_COLOR_D(domain, level, color, fmt, ...) \
do { \
if (domain) { \
pbl_log(level, __FILE__, __LINE__, fmt, ## __VA_ARGS__); \
} \
} while (0)
#define PBL_LOG_COLOR_D_SYNC(domain, level, color, fmt, ...) \
do { \
if (domain) { \
pbl_log_sync(level, __FILE__, __LINE__, fmt, ## __VA_ARGS__); \
} \
} while (0)
#endif
#define PBL_LOG(level, fmt, ...) \
PBL_LOG_D(DEFAULT_LOG_DOMAIN, level, fmt, ## __VA_ARGS__)
#define PBL_LOG_COLOR(level, color, fmt, ...) \
PBL_LOG_COLOR_D(DEFAULT_LOG_DOMAIN, level, color, fmt, ## __VA_ARGS__)
#define PBL_LOG_SYNC(level, fmt, ...) \
PBL_LOG_D_SYNC(DEFAULT_LOG_DOMAIN, level, fmt, ## __VA_ARGS__)
#define PBL_LOG_COLOR_SYNC(level, color, fmt, ...) \
PBL_LOG_COLOR_D_SYNC(DEFAULT_LOG_DOMAIN, level, color, fmt, ## __VA_ARGS__)
#ifdef VERBOSE_LOGGING
#define PBL_LOG_VERBOSE(fmt, ...) \
PBL_LOG_D(DEFAULT_LOG_DOMAIN, LOG_LEVEL_DEBUG, fmt, ## __VA_ARGS__)
#define PBL_LOG_D_VERBOSE(domain, fmt, ...) \
PBL_LOG_D(domain, LOG_LEVEL_DEBUG, fmt, ## __VA_ARGS__)
#define PBL_LOG_COLOR_D_VERBOSE(domain, color, fmt, ...) \
PBL_LOG_COLOR_D(domain, LOG_LEVEL_DEBUG, color, fmt, ## __VA_ARGS__)
#define PBL_LOG_COLOR_VERBOSE(color, fmt, ...) \
PBL_LOG_COLOR_D(DEFAULT_LOG_DOMAIN, LOG_LEVEL_DEBUG, color, fmt, ## __VA_ARGS__)
#define RETURN_STATUS_D(d, st) \
do { \
if (PASSED(st)) \
PBL_LOG_D(d, LOG_LEVEL_INFO, "%d", (int)(st)); \
else \
PBL_LOG_D(d, LOG_LEVEL_WARNING, "%d", (int)(st)); \
return st; \
} while (0)
#define RETURN_STATUS_COLOR_D(d, color, st) \
do { \
if (PASSED(st)) \
PBL_LOG_COLOR_D(d, LOG_LEVEL_INFO, color, "%d", (int)(st)); \
else \
PBL_LOG_COLOR_D(d, LOG_LEVEL_WARNING, color, "%d", (int)(st)); \
return st; \
} while (0)
#define RETURN_STATUS_UP_D(d, st) \
do { \
if ((st) == E_INVALID_ARGUMENT) { \
PBL_LOG_D(d, LOG_LEVEL_ERROR, "%d", (int)(st)); \
return E_INTERNAL; \
} \
else { \
return (st); \
} \
} while (0)
#define RETURN_STATUS_UP_COLOR_D(d, color, st) \
do { \
if ((st) == E_INVALID_ARGUMENT) { \
PBL_LOG_COLOR_D(d, LOG_LEVEL_ERROR, color, "%d", (int)(st)); \
return E_INTERNAL; \
} \
else { \
return (st); \
} \
} while (0)
#else // VERBOSE_LOGGING
#define PBL_LOG_VERBOSE(fmt, ...)
#define PBL_LOG_COLOR_VERBOSE(color, fmt, ...)
#define PBL_LOG_D_VERBOSE(domain, fmt, ...)
#define PBL_LOG_COLOR_D_VERBOSE(domain, color, fmt, ...)
#define RETURN_STATUS_D(d, st) \
do { \
if (FAILED(st)) { \
PBL_LOG_D(d, LOG_LEVEL_WARNING, "%d", (int)(st)); \
} \
return st; \
} while (0)
#define RETURN_STATUS_COLOR_D(d, color, st) \
do { \
if (FAILED(st)) { \
PBL_LOG_COLOR_D(d, LOG_LEVEL_WARNING, color, "%d", (int)(st)); \
} \
return st; \
} while (0)
#define RETURN_STATUS_UP_D(d, st) \
return ((st) != E_INVALID_ARGUMENT ? (st) : E_INTERNAL)
#define RETURN_STATUS_UP_COLOR_D(d, color, st) \
return ((st) != E_INVALID_ARGUMENT ? (st) : E_INTERNAL)
#endif // VERBOSE_LOGGING
#else // PBL_LOG_ENABLED
#define PBL_LOG(level, fmt, ...)
#define PBL_LOG_COLOR(level, color, fmt, ...)
#define PBL_LOG_SYNC(level, fmt, ...)
#define PBL_LOG_COLOR_SYNC(level, color, fmt, ...)
#define PBL_LOG_D(domain, level, fmt, ...)
#define PBL_LOG_COLOR_D(domain, level, color, fmt, ...)
#define PBL_LOG_D_SYNC(domain, level, fmt, ...)
#define PBL_LOG_COLOR_D_SYNC(domain, level, color, fmt, ...)
#define PBL_LOG_VERBOSE(fmt, ...)
#define PBL_LOG_COLOR_VERBOSE(color, fmt, ...)
#define PBL_LOG_D_VERBOSE(domain, fmt, ...)
#define PBL_LOG_COLOR_D_VERBOSE(domain, color, fmt, ...)
#define RETURN_STATUS_D(d, st) return (st)
#define RETURN_STATUS_COLOR_D(d, color, st) return (st)
#define RETURN_STATUS_UP_D(d, st) \
return ((st) == E_INVALID_ARGUMENT ? E_INTERNAL : (st))
#define RETURN_STATUS_UP_COLOR_D(d, color, st) \
return ((st) == E_INVALID_ARGUMENT ? E_INTERNAL : (st))
#endif // PBL_LOG_ENABLED
#define RETURN_STATUS(s) RETURN_STATUS_D(DEFAULT_LOG_DOMAIN, s)
#define RETURN_STATUS_UP(s) RETURN_STATUS_UP_D(DEFAULT_LOG_DOMAIN, s)