Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 | /*
* Copyright (c) 2020 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* @brief Additional test case for log core
*
*/
#include <tc_util.h>
#include <stdbool.h>
#include <zephyr.h>
#include <ztest.h>
#include <logging/log_backend.h>
#include <logging/log_backend_std.h>
#include <logging/log_ctrl.h>
#include <logging/log.h>
#include <logging/log_output.h>
#define LOG_MODULE_NAME log_test
LOG_MODULE_REGISTER(LOG_MODULE_NAME, LOG_LEVEL_INF);
static K_SEM_DEFINE(log_sem, 0, 1);
#define TIMESTAMP_FREC (2000000)
ZTEST_BMEM uint32_t source_id;
/* used when log_msg2 create in user space */
ZTEST_BMEM uint8_t domain, level;
ZTEST_DMEM uint32_t msg_data = 0x1234;
ZTEST_DMEM char *test_msg_usr = "test msg";
static uint8_t buf;
static int char_out(uint8_t *data, size_t length, void *ctx)
{
ARG_UNUSED(data);
ARG_UNUSED(ctx);
return length;
}
LOG_OUTPUT_DEFINE(log_output, char_out, &buf, 1);
struct backend_cb {
/* count log messages handled by this backend */
size_t counter;
/* count log messages handled immediately by this backend */
size_t sync;
/* inform put() to check timestamp of message against exp_timestamps */
bool check_timestamp;
uint32_t exp_timestamps[16];
/* inform put() to check severity of message against exp_severity */
bool check_severity;
uint16_t exp_severity[4];
/* inform put() to check domain_id of message */
bool check_domain_id;
/* How many messages have been logged.
* used in async mode, to make sure all logs have been handled by compare
* counter with total_logs
*/
size_t total_logs;
};
static void process(const struct log_backend *const backend,
union log_msg2_generic *msg)
{
uint32_t flags;
struct backend_cb *cb = (struct backend_cb *)backend->cb->ctx;
if (cb->check_domain_id) {
zassert_equal(log_msg2_get_domain(&(msg->log)), CONFIG_LOG_DOMAIN_ID,
"Unexpected domain id");
}
if (cb->check_timestamp) {
uint32_t exp_timestamp = cb->exp_timestamps[cb->counter];
zassert_equal(log_msg2_get_timestamp(&(msg->log)), exp_timestamp,
"Unexpected message index");
}
if (cb->check_severity) {
zassert_equal(log_msg2_get_level(&(msg->log)),
cb->exp_severity[cb->counter],
"Unexpected log severity");
}
cb->counter++;
if (IS_ENABLED(CONFIG_LOG_PROCESS_THREAD)) {
if (cb->counter == cb->total_logs) {
k_sem_give(&log_sem);
}
}
if (k_is_user_context()) {
zassert_equal(log_msg2_get_domain(&(msg->log)), domain,
"Unexpected domain id");
zassert_equal(log_msg2_get_level(&(msg->log)), level,
"Unexpected log severity");
}
flags = log_backend_std_get_flags();
log_output_msg2_process(&log_output, &msg->log, flags);
}
static void put(struct log_backend const *const backend, struct log_msg *msg)
{
log_msg_get(msg);
struct backend_cb *cb = (struct backend_cb *)backend->cb->ctx;
if (cb->check_domain_id) {
zassert_equal(log_msg_domain_id_get(msg), CONFIG_LOG_DOMAIN_ID,
"Unexpected domain id");
}
if (cb->check_timestamp) {
uint32_t exp_timestamp = cb->exp_timestamps[cb->counter];
zassert_equal(log_msg_timestamp_get(msg), exp_timestamp,
"Unexpected message index");
}
if (cb->check_severity) {
zassert_equal(log_msg_level_get(msg),
cb->exp_severity[cb->counter],
"Unexpected log severity");
}
cb->counter++;
if (IS_ENABLED(CONFIG_LOG_PROCESS_THREAD)) {
if (cb->counter == cb->total_logs) {
k_sem_give(&log_sem);
}
}
log_msg_put(msg);
}
static void sync_string(const struct log_backend *const backend,
struct log_msg_ids src_level, uint32_t timestamp,
const char *fmt, va_list ap)
{
struct backend_cb *cb = (struct backend_cb *)backend->cb->ctx;
cb->counter++;
cb->sync++;
}
static void sync_hexdump(const struct log_backend *const backend,
struct log_msg_ids src_level, uint32_t timestamp,
const char *metadata, const uint8_t *data,
uint32_t length)
{
struct backend_cb *cb = (struct backend_cb *)backend->cb->ctx;
cb->counter++;
cb->sync++;
}
static void panic(const struct log_backend *const backend)
{
ARG_UNUSED(backend);
}
const struct log_backend_api log_backend_test_api = {
.process = IS_ENABLED(CONFIG_LOG2) ? process : NULL,
.put = IS_ENABLED(CONFIG_LOG_MODE_DEFERRED) ? put : NULL,
.put_sync_string = IS_ENABLED(CONFIG_LOG_IMMEDIATE) ?
sync_string : NULL,
.put_sync_hexdump = IS_ENABLED(CONFIG_LOG_IMMEDIATE) ?
sync_hexdump : NULL,
.panic = panic,
};
LOG_BACKEND_DEFINE(backend1, log_backend_test_api, false);
struct backend_cb backend1_cb;
LOG_BACKEND_DEFINE(backend2, log_backend_test_api, false);
struct backend_cb backend2_cb;
/* The logging system support user customize timestamping in log messages
* by register a timestamp function, in timestamp_get() below, just return
* a counter as timestamp for different messages.
* when install this timestamp function, timestamping frequence is set to
* 2000000, means 2 timestamp/us
*/
static uint32_t stamp;
static uint32_t timestamp_get(void)
{
stamp++;
return log_output_timestamp_to_us(stamp * 2);
}
static void log_setup(bool backend2_enable)
{
stamp = 0U;
log_init();
#ifndef CONFIG_LOG_PROCESS_THREAD
log_thread_set(k_current_get());
#endif
memset(&backend1_cb, 0, sizeof(backend1_cb));
log_backend_enable(&backend1, &backend1_cb, LOG_LEVEL_DBG);
if (backend2_enable) {
memset(&backend2_cb, 0, sizeof(backend2_cb));
log_backend_enable(&backend2, &backend2_cb, LOG_LEVEL_DBG);
} else {
log_backend_disable(&backend2);
}
}
static bool log_test_process(bool bypass)
{
if (IS_ENABLED(CONFIG_LOG_PROCESS_THREAD)) {
/* waiting for all logs have been handled */
k_sem_take(&log_sem, K_FOREVER);
return false;
} else {
return log_process(bypass);
}
}
/**
* @brief Support multi-processor systems
*
* @details Logging system identify domain/processor by domain_id which is now
* statically configured by CONFIG_LOG_DOMAIN_ID
*
* @addtogroup logging
*/
static void test_log_domain_id(void)
{
log_setup(false);
backend1_cb.check_domain_id = true;
backend1_cb.total_logs = 1;
LOG_INF("info message for domain id test");
while (log_test_process(false)) {
}
zassert_equal(backend1_cb.total_logs, backend1_cb.counter,
"Unexpected amount of messages received by the backend");
}
/**
* @brief Synchronous processing of logging messages.
*
* @details if CONFIG_LOG_IMMEDIATE is enabled, log message is
* handled immediately
*
* @addtogroup logging
*/
static void test_log_sync(void)
{
TC_PRINT("Logging synchronousely\n");
if (IS_ENABLED(CONFIG_LOG_IMMEDIATE)) {
log_setup(false);
LOG_INF("Log immediately");
LOG_INF("Log immediately");
/* log immediately, no log_process needed */
zassert_equal(2, backend1_cb.sync,
"Unexpected amount of messages received by the backend.");
} else {
ztest_test_skip();
}
}
/**
* @brief Early logging
* @details Handle log message attempts as well as creating new log contexts
* instance, before the backend are active
*
* @addtogroup logging
*/
static void test_log_early_logging(void)
{
if (IS_ENABLED(CONFIG_LOG_IMMEDIATE)) {
ztest_test_skip();
} else {
log_init();
/* deactivate other backends */
const struct log_backend *backend;
for (int i = 0; i < log_backend_count_get(); i++) {
backend = log_backend_get(i);
if (strcmp(backend->name, "test")) {
log_backend_deactivate(backend);
}
}
TC_PRINT("Create log message before backend active\n");
LOG_INF("log info before backend active");
LOG_WRN("log warn before backend active");
LOG_ERR("log error before backend active");
TC_PRINT("Activate backend with context");
memset(&backend1_cb, 0, sizeof(backend1_cb));
backend1_cb.total_logs = 3;
log_backend_enable(&backend1, &backend1_cb, LOG_LEVEL_DBG);
while (log_test_process(false)) {
}
zassert_equal(backend1_cb.total_logs, backend1_cb.counter,
"Unexpected amount of messages received. %d",
backend1_cb.counter);
}
}
/**
* @brief Log severity
*
* @details This module is registered with LOG_LEVEL_INF, LOG_LEVEL_DBG will be
* filtered out at compile time, only 3 message handled
*
* @addtogroup logging
*/
static void test_log_severity(void)
{
log_setup(false);
backend1_cb.check_severity = true;
backend1_cb.exp_severity[0] = LOG_LEVEL_INF;
backend1_cb.exp_severity[1] = LOG_LEVEL_WRN;
backend1_cb.exp_severity[2] = LOG_LEVEL_ERR;
LOG_INF("info message");
LOG_WRN("warning message");
LOG_ERR("error message");
backend1_cb.total_logs = 3;
while (log_test_process(false)) {
}
zassert_equal(backend1_cb.total_logs, backend1_cb.counter,
"Unexpected amount of messages received by the backend.");
}
/**
* @brief Customizable timestamping in log messages
*
* @details Log core permit user to register customized timestamp function
*
* @addtogroup logging
*/
static void test_log_timestamping(void)
{
stamp = 0U;
log_init();
/* deactivate all other backend */
const struct log_backend *backend;
for (int i = 0; i < log_backend_count_get(); i++) {
backend = log_backend_get(i);
log_backend_deactivate(backend);
}
TC_PRINT("Register timestamp function\n");
zassert_equal(-EINVAL, log_set_timestamp_func(NULL, 0),
"Expects successful timestamp function setting.");
zassert_equal(0, log_set_timestamp_func(timestamp_get, TIMESTAMP_FREC),
"Expects successful timestamp function setting.");
memset(&backend1_cb, 0, sizeof(backend1_cb));
log_backend_enable(&backend1, &backend1_cb, LOG_LEVEL_DBG);
backend1_cb.check_timestamp = true;
backend1_cb.exp_timestamps[0] = 1U;
backend1_cb.exp_timestamps[1] = 2U;
backend1_cb.exp_timestamps[2] = 3U;
LOG_INF("test timestamp");
LOG_INF("test timestamp");
LOG_WRN("test timestamp");
backend1_cb.total_logs = 3;
while (log_test_process(false)) {
}
zassert_equal(backend1_cb.total_logs,
backend1_cb.counter,
"Unexpected amount of messages received by the backend.");
}
/**
* @brief Multiple logging backends
*
* @details Enable two backends in this module and enable UART backend
* by CONFIG_LOG_BACKEND_UART, there are three backends at least.
*
* @addtogroup logging
*/
#define UART_BACKEND "log_backend_uart"
static void test_multiple_backends(void)
{
TC_PRINT("Test multiple backends");
/* enable both backend1 and backend2 */
log_setup(true);
zassert_true((log_backend_count_get() >= 2),
"There is no multi backends");
if (IS_ENABLED(CONFIG_LOG_BACKEND_UART)) {
bool have_uart = false;
struct log_backend const *backend;
for (int i = 0; i < log_backend_count_get(); i++) {
backend = log_backend_get(i);
if (strcmp(backend->name, UART_BACKEND) == 0) {
have_uart = true;
}
}
zassert_true(have_uart, "There is no UART log backend found");
}
}
/**
* @brief Process all logging activities using a dedicated thread
*
* @addtogroup logging
*/
#ifdef CONFIG_LOG_PROCESS_THREAD
static void test_log_thread(void)
{
uint32_t slabs_free, used, max;
TC_PRINT("Logging buffer is configured to %d bytes\n",
CONFIG_LOG_BUFFER_SIZE);
TC_PRINT("Stack size of logging thread is configured by ");
TC_PRINT("CONFIG_LOG_PROCESS_THREAD_STACK_SIZE: %d bytes\n",
CONFIG_LOG_PROCESS_THREAD_STACK_SIZE);
log_setup(false);
slabs_free = log_msg_mem_get_free();
used = log_msg_mem_get_used();
max = log_msg_mem_get_max_used();
zassert_equal(used, 0, NULL);
LOG_INF("log info to log thread");
LOG_WRN("log warning to log thread");
LOG_ERR("log error to log thread");
zassert_equal(log_msg_mem_get_used(), 3, NULL);
zassert_equal(log_msg_mem_get_free(), slabs_free - 3, NULL);
zassert_equal(log_msg_mem_get_max_used(), max, NULL);
TC_PRINT("after log, free: %d, used: %d, max: %d\n", slabs_free, used, max);
/* wait 2 seconds for logging thread to handle this log message*/
k_sleep(K_MSEC(2000));
zassert_equal(3, backend1_cb.counter,
"Unexpected amount of messages received by the backend.");
zassert_equal(log_msg_mem_get_used(), 0, NULL);
}
#else
static void test_log_thread(void)
{
ztest_test_skip();
}
#endif
static void call_log_generic(uint32_t source_id, const char *fmt, ...)
{
struct log_msg_ids src_level = {
.level = LOG_LEVEL_INF,
.domain_id = CONFIG_LOG_DOMAIN_ID,
.source_id = source_id,
};
va_list ap;
va_start(ap, fmt);
log_generic(src_level, fmt, ap, LOG_STRDUP_EXEC);
va_end(ap);
}
void test_log_generic(void)
{
source_id = LOG_CURRENT_MODULE_ID();
char *log_msg = "log user space";
log_setup(false);
backend1_cb.total_logs = 4;
call_log_generic(source_id, "log generic");
call_log_generic(source_id, "log generic: %s", log_msg);
call_log_generic(source_id, "log generic %d\n", source_id);
call_log_generic(source_id, "log generic %d, %d\n", source_id, 1);
while (log_test_process(false)) {
}
}
void test_log_msg2_create(void)
{
log_setup(false);
if (IS_ENABLED(CONFIG_LOG2)) {
int mode;
domain = 3;
level = 2;
z_log_msg2_runtime_create(domain, __log_current_const_data,
level, &msg_data,
sizeof(msg_data), NULL);
/* try z_log_msg2_static_create() */
Z_LOG_MSG2_STACK_CREATE(domain, __log_current_const_data,
level, &msg_data,
sizeof(msg_data), NULL);
Z_LOG_MSG2_CREATE(!IS_ENABLED(CONFIG_USERSPACE), mode,
CONFIG_LOG_DOMAIN_ID, NULL,
LOG_LEVEL_INTERNAL_RAW_STRING, NULL, 0, test_msg_usr);
while (log_test_process(false)) {
}
}
}
void test_log_msg2_create_user(void)
{
if (IS_ENABLED(CONFIG_LOG2)) {
int mode;
domain = 3;
level = 2;
z_log_msg2_runtime_create(domain, NULL,
level, &msg_data,
sizeof(msg_data), test_msg_usr);
/* try z_log_msg2_static_create() */
Z_LOG_MSG2_STACK_CREATE(domain, NULL,
level, &msg_data,
sizeof(msg_data), test_msg_usr);
Z_LOG_MSG2_CREATE(!IS_ENABLED(CONFIG_USERSPACE), mode,
CONFIG_LOG_DOMAIN_ID, NULL,
LOG_LEVEL_INTERNAL_RAW_STRING, NULL, 0, test_msg_usr);
while (log_test_process(false)) {
}
}
}
/* The log process thread has the K_LOWEST_APPLICATION_THREAD_PRIO, adjust it
* to a higher priority to increase the chances of being scheduled to handle
* log message as soon as possible
*/
void promote_log_thread(const struct k_thread *thread, void *user_data)
{
if (!(strcmp(thread->name, "logging"))) {
k_thread_priority_set((k_tid_t)thread, -1);
}
}
/*test case main entry*/
void test_main(void)
{
#ifdef CONFIG_LOG_PROCESS_THREAD
k_thread_foreach(promote_log_thread, NULL);
#endif
ztest_test_suite(test_log_list,
ztest_unit_test(test_multiple_backends),
ztest_unit_test(test_log_generic),
ztest_unit_test(test_log_domain_id),
ztest_unit_test(test_log_severity),
ztest_unit_test(test_log_timestamping),
ztest_unit_test(test_log_early_logging),
ztest_unit_test(test_log_sync),
ztest_unit_test(test_log_thread),
ztest_unit_test(test_log_msg2_create),
ztest_user_unit_test(test_log_msg2_create_user)
);
ztest_run_test_suite(test_log_list);
}
|