rtems/cpukit/libmisc/monitor/mon-task.c

/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @brief RTEMS Monitor task support
 */

/*
 * COPYRIGHT (c) 1989-2022. On-Line Applications Research Corporation (OAR).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <rtems.h>
#include <rtems/monitor.h>
#include <rtems/rtems/tasksdata.h>
#include <rtems/score/threadimpl.h>
#include <rtems/score/threadqimpl.h>

#include <inttypes.h>
#include <stdio.h>
#include <string.h>    /* memcpy() */

static void
rtems_monitor_task_wait_info(
    rtems_monitor_task_t *canonical_task,
    Thread_Control       *rtems_thread
)
{
    Thread_queue_Context      queue_context;
    const Thread_queue_Queue *queue;

    canonical_task->wait[0] = '\0';

    _Thread_queue_Context_initialize( &queue_context );
    _Thread_Wait_acquire( rtems_thread, &queue_context );

    queue = rtems_thread->Wait.queue;

    if ( queue != NULL ) {
      Objects_Id id;

      _Thread_queue_Queue_get_name_and_id(
        queue,
        canonical_task->wait,
        sizeof(canonical_task->wait),
        &id
      );

      if (id != 0) {
        snprintf(
          canonical_task->wait,
          sizeof(canonical_task->wait),
          "%08" PRIx32,
          id
        );
      }
    } else if (
      (rtems_thread->current_state & STATES_WAITING_FOR_BSD_WAKEUP) != 0
    ) {
      const char *wmesg;

      wmesg = rtems_thread->Wait.return_argument_second.immutable_object;

      if (wmesg != NULL) {
        strlcpy(
          canonical_task->wait,
          wmesg,
          sizeof(canonical_task->wait)
        );
      }
    }

    _Thread_Wait_release( rtems_thread, &queue_context );
}

void
rtems_monitor_task_canonical(
    rtems_monitor_task_t  *canonical_task,
    const void            *thread_void
)
{
    Thread_Control    *rtems_thread;
    RTEMS_API_Control *api;
    Objects_Name       name;

    rtems_thread =
      RTEMS_DECONST( Thread_Control *, (const Thread_Control *) thread_void );

    api = rtems_thread->API_Extensions[ THREAD_API_RTEMS ];

    _Objects_Name_to_string(
      rtems_thread->Object.name,
      false,
      canonical_task->short_name,
      sizeof( canonical_task->short_name )
    );

    _Thread_Get_name(
      rtems_thread,
      canonical_task->long_name,
      sizeof( canonical_task->long_name )
    );

    name.name_u32 = _Thread_Scheduler_get_home( rtems_thread )->name;
    _Objects_Name_to_string(
      name,
      false,
      canonical_task->scheduler_name,
      sizeof( canonical_task->scheduler_name )
    );

    rtems_monitor_task_wait_info( canonical_task, rtems_thread );

    canonical_task->state = rtems_thread->current_state;
    canonical_task->entry = rtems_thread->Start.Entry;
    canonical_task->stack = rtems_thread->Start.Initial_stack.area;
    canonical_task->stack_size = rtems_thread->Start.Initial_stack.size;
    canonical_task->priority = _Thread_Get_unmapped_priority( rtems_thread );
    canonical_task->events = api->Event.pending_events;
    /*
     * FIXME: make this optionally cpu_time_executed
     */
#if 0
    canonical_task->ticks = rtems_thread->cpu_time_executed;
#else
    canonical_task->ticks = 0;
#endif

/* XXX modes and attributes only exist in the RTEMS API .. */
/* XXX not directly in the core thread.. they will have to be derived */
/* XXX if they are important enough to include anymore.   */
    canonical_task->modes = 0; /* XXX FIX ME.... rtems_thread->current_modes; */
    canonical_task->attributes = 0 /* XXX FIX ME rtems_thread->API_Extensions[ THREAD_API_RTEMS ]->attribute_set */;
}


void
rtems_monitor_task_dump_header(
    bool verbose RTEMS_UNUSED
)
{
    fprintf(stdout,"\
ID       NAME                 SHED PRI STATE  MODES    EVENTS WAITINFO\n"); /*
0a010004 SHLL                 UPD  100 READY  P:T:nA   NONE   00000000 */

    rtems_monitor_separator();
}

/*
 */

void
rtems_monitor_task_dump(
    rtems_monitor_task_t *monitor_task,
    bool                  verbose RTEMS_UNUSED
)
{
    int length = 0;

    length += rtems_monitor_dump_id(monitor_task->id);
    length += rtems_monitor_pad(9, length);

    if (strcmp(monitor_task->short_name, monitor_task->long_name) == 0) {
        length += fprintf(stdout, "%s", monitor_task->short_name);
    } else {
        length += fprintf(
          stdout,
          "%s %s",
          monitor_task->short_name,
          monitor_task->long_name
        );
    }

    length += rtems_monitor_pad(30, length);
    length += fprintf(stdout, "%s", monitor_task->scheduler_name);
    length += rtems_monitor_pad(35, length);
    length += rtems_monitor_dump_priority(monitor_task->priority);
    length += rtems_monitor_pad(39, length);
    length += rtems_monitor_dump_state(monitor_task->state);
    length += rtems_monitor_pad(46, length);
    length += rtems_monitor_dump_modes(monitor_task->modes);
    length += rtems_monitor_pad(53, length);
    length += rtems_monitor_dump_events(monitor_task->events);
    length += rtems_monitor_pad(62, length);
    length += fprintf(stdout, "%s", monitor_task->wait);

    fprintf(stdout,"\n");
}