sw/device/lib/base/log.c

// Copyright lowRISC contributors.
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0

#include "sw/device/lib/base/log.h"

#include "sw/device/lib/arch/device.h"
#include "sw/device/lib/base/memory.h"
#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/base/print.h"

/**
 * Ensure that log_fields_t is always 20 bytes.
 *
 * The assertion below helps prevent inadvertant changes to the struct.
 * Please see the description of log_fields_t in log.h for more details.
 */
_Static_assert(sizeof(log_fields_t) == 20,
               "log_fields_t must always be 20 bytes.");

/**
 * Converts a severity to a static string.
 */
static const char *stringify_severity(log_severity_t severity) {
  switch (severity) {
    case kLogSeverityInfo:
      return "I";
    case kLogSeverityWarn:
      return "W";
    case kLogSeverityError:
      return "E";
    case kLogSeverityFatal:
      return "F";
    default:
      return "?";
  }
}

/**
 * Logs `format` and the values that following to stdout.
 *
 * @param severity the log severity.
 * @param file_name a constant string referring to the file in which the log
 * occured.
 * @param line a line number from `file_name`.
 * @param format a format string, as described in print.h. This must be a string
 * literal.
 * @param ... format parameters matching the format string.
 */
void base_log_internal_core(log_severity_t severity, const char *file_name,
                            uint32_t line, const char *format, ...) {
  size_t file_name_len =
      ((char *)memchr(file_name, '\0', PTRDIFF_MAX)) - file_name;
  const char *base_name = memrchr(file_name, '/', file_name_len);
  if (base_name == NULL) {
    base_name = file_name;
  } else {
    ++base_name;  // Remove the final '/'.
  }

  // A small global counter that increments with each log line. This can be
  // useful for seeing how many times this function has been called, even if
  // nothing was printed for some time.
  static uint16_t global_log_counter = 0;

  base_printf("%s%5d %s:%d] ", stringify_severity(severity), global_log_counter,
              base_name, line);
  ++global_log_counter;

  va_list args;
  va_start(args, format);
  base_vprintf(format, args);
  va_end(args);

  base_printf("\r\n");
}

/**
 * Logs `format` and the values that following in an efficient, DV-testbench
 * specific way.
 *
 * @param log the log_fields_t struct that holds the log fields.
 * @param nargs the number of arguments passed to the format string.
 * @param ... format parameters matching the format string.
 */

/**
 * Indicates the fixed location in RAM for SW logging for DV.
 * TODO: Figure aout a better place to put this.
 */
static const uintptr_t kSwLogDvAddr = 0x1000fffc;

void base_log_internal_dv(const log_fields_t *log, int nargs, ...) {
  mmio_region_t sw_log_dv_addr = mmio_region_from_addr(kSwLogDvAddr);
  mmio_region_write32(sw_log_dv_addr, 0x0, (uintptr_t)log);

  va_list args;
  va_start(args, nargs);
  for (int i = 0; i < nargs; ++i) {
    uint32_t value = va_arg(args, uint32_t);
    mmio_region_write32(sw_log_dv_addr, 0x0, value);
  }
  va_end(args);
}