src/lib/support/logging/CHIPLogging.cpp

/*
 *
 *    Copyright (c) 2020 Project CHIP Authors
 *    Copyright (c) 2013-2017 Nest Labs, Inc.
 *
 *    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.
 */

/**
 *    @file
 *      This file implements macros, constants, and interfaces for a
 *      platform-independent logging interface for the chip SDK.
 *
 */

#include "CHIPLogging.h"

#include <lib/core/CHIPCore.h>
#include <lib/support/CHIPMem.h>
#include <lib/support/CodeUtils.h>
#include <lib/support/DLLUtil.h>
#include <lib/support/Span.h>

#include <stdarg.h>
#include <stdio.h>
#include <string.h>

#include <atomic>

#if CHIP_PW_TOKENIZER_LOGGING

extern "C" void pw_tokenizer_HandleEncodedMessageWithPayload(uintptr_t levels, const uint8_t encoded_message[], size_t size_bytes)
{
    uint8_t log_category = levels >> 8 & 0xFF;
    uint8_t log_module   = levels & 0xFF;
    char * buffer        = (char *) chip::Platform::MemoryAlloc(2 * size_bytes + 1);

    if (buffer)
    {
        for (int i = 0; i < size_bytes; i++)
        {
            sprintf(buffer + 2 * i, "%02x", encoded_message[i]);
        }
        buffer[2 * size_bytes] = '\0';
        chip::Logging::Log(log_module, log_category, "%s", buffer);
        chip::Platform::MemoryFree(buffer);
    }
}

#endif

namespace chip {
namespace Logging {

#if _CHIP_USE_LOGGING

namespace {

std::atomic<LogRedirectCallback_t> sLogRedirectCallback{ nullptr };

/*
 * Array of strings containing the names for each of the chip log
 * modules.
 *
 * NOTE: The names must be in the order defined in the LogModule
 *       enumeration. Each name must be a fixed number of characters
 *       long (chip::Logging::kMaxModuleNameLen) padded with nulls as
 *       necessary.
 *
 */
const char ModuleNames[] = "-\0\0" // None
                           "IN\0"  // Inet
                           "BLE"   // BLE
                           "ML\0"  // MessageLayer
                           "SM\0"  // SecurityManager
                           "EM\0"  // ExchangeManager
                           "TLV"   // TLV
                           "ASN"   // ASN1
                           "CR\0"  // Crypto
                           "CTL"   // Controller
                           "AL\0"  // Alarm
                           "SC\0"  // SecureChannel
                           "BDX"   // BulkDataTransfer
                           "DMG"   // DataManagement
                           "DC\0"  // DeviceControl
                           "DD\0"  // DeviceDescription
                           "ECH"   // Echo
                           "FP\0"  // FabricProvisioning
                           "NP\0"  // NetworkProvisioning
                           "SD\0"  // ServiceDirectory
                           "SP\0"  // ServiceProvisioning
                           "SWU"   // SoftwareUpdate
                           "FS\0"  // FailSafe
                           "TS\0"  // TimeService
                           "HB\0"  // Heartbeat
                           "CSL"   // chipSystemLayer
                           "EVL"   // Event Logging
                           "SPT"   // Support
                           "TOO"   // chipTool
                           "ZCL"   // Zcl
                           "SH\0"  // Shell
                           "DL\0"  // DeviceLayer
                           "SPL"   // SetupPayload
                           "SVR"   // AppServer
                           "DIS"   // Discovery
                           "IM\0"  // InteractionModel
                           "TST"   // Test
                           "OSS"   // OperationalSessionSetup
                           "ATM"   // Automation
                           "CSM"   // CASESessionManager
    ;

#define ModuleNamesCount ((sizeof(ModuleNames) - 1) / chip::Logging::kMaxModuleNameLen)

void GetModuleName(char (&buf)[chip::Logging::kMaxModuleNameLen + 1], uint8_t module)
{

    const char * module_name = ModuleNames;
    if (module < ModuleNamesCount)
    {
        module_name += module * chip::Logging::kMaxModuleNameLen;
    }

    memcpy(buf, module_name, chip::Logging::kMaxModuleNameLen);
    buf[chip::Logging::kMaxModuleNameLen] = 0; // ensure null termination
}

} // namespace

void SetLogRedirectCallback(LogRedirectCallback_t callback)
{
    sLogRedirectCallback.store(callback);
}

/**
 * Log, to the platform-specified mechanism, the specified log
 * message, @a msg, for the specified module, @a module, in the
 * provided category, @a category.
 *
 * @param[in] module    A LogModule enumeration indicating the
 *                      source of the chip package module that
 *                      generated the log message. This must be
 *                      translated within the function to a module
 *                      name for inclusion in the log message.
 * @param[in] category  A LogCategory enumeration indicating the
 *                      category of the log message. The category
 *                      may be filtered in or out if
 *                      CHIP_LOG_FILTERING was asserted.
 * @param[in] msg       A pointer to a NULL-terminated C string with
 *                      C Standard Library-style format specifiers
 *                      containing the log message to be formatted and
 *                      logged.
 * @param[in] ...       A variadic argument list whose elements should
 *                      correspond to the format specifiers in @a msg.
 *
 */
DLL_EXPORT void Log(uint8_t module, uint8_t category, const char * msg, ...)
{

    va_list v;
    va_start(v, msg);
    LogV(module, category, msg, v);
    va_end(v);
}

DLL_EXPORT void LogByteSpan(uint8_t module, uint8_t category, const chip::ByteSpan & span)
{
    // Maximum number of characters needed to print 8 byte buffer including formatting (0x)
    // 8 bytes * (2 nibbles per byte + 4 character for ", 0x") + null termination.
    // Rounding up to 50 bytes.
    char output[50];
    size_t offset = 0;
    for (unsigned int i = 0; i < span.size(); i++)
    {
        if (i % 8 == 0 && offset != 0)
        {
            Log(module, category, "%s", output);
            offset = 0;
        }
        int result = snprintf(&output[offset], sizeof(output) - offset, "0x%02x, ", (unsigned char) span.data()[i]);
        if (result > 0)
        {
            offset += static_cast<size_t>(result);
        }
        else
        {
            Log(module, chip::Logging::kLogCategory_Error, "Failed to print ByteSpan buffer");
            return;
        }
    }
    if (offset != 0)
    {
        Log(module, category, "%s", output);
    }
}

void LogV(uint8_t module, uint8_t category, const char * msg, va_list args)
{
    if (!IsCategoryEnabled(category))
    {
        return;
    }

    char moduleName[chip::Logging::kMaxModuleNameLen + 1];
    GetModuleName(moduleName, module);

    LogRedirectCallback_t redirect = sLogRedirectCallback.load();

    if (redirect != nullptr)
    {
        redirect(moduleName, category, msg, args);
    }
    else
    {
        Platform::LogV(moduleName, category, msg, args);
    }
}

#if CHIP_LOG_FILTERING
uint8_t gLogFilter = kLogCategory_Max;
DLL_EXPORT bool IsCategoryEnabled(uint8_t category)
{
    return (category <= gLogFilter);
}

DLL_EXPORT uint8_t GetLogFilter()
{
    return gLogFilter;
}

DLL_EXPORT void SetLogFilter(uint8_t category)
{
    gLogFilter = category;
}

#else  // CHIP_LOG_FILTERING

DLL_EXPORT bool IsCategoryEnabled(uint8_t category)
{
    (void) category;
    return true;
}

DLL_EXPORT uint8_t GetLogFilter()
{
    return kLogCategory_Max;
}

DLL_EXPORT void SetLogFilter(uint8_t category)
{
    (void) category;
}
#endif // CHIP_LOG_FILTERING

#endif /* _CHIP_USE_LOGGING */

} // namespace Logging
} // namespace chip