forked from Imagelibrary/rtems
e4cc56a792
This code did not have any copyrights or licenses and a bit of archeology was needed to determine authorship. This code was in the initial import into the RTEMS CVS repository when it was established in May 1995. There was very little, if any, code not written by OAR Corporation in that initial import. After discussion with Chris Johns, it was determined that this code was from OAR Corporation and that he had added a few features later. Both Chris Johns and OAR Corporation have given permission to relicense. Updates #3053.
454 lines
14 KiB
C
454 lines
14 KiB
C
/* SPDX-License-Identifier: BSD-2-Clause */
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* @brief RTEMS Monitor "object" support.
|
|
*
|
|
* Used to traverse object lists and print them out.
|
|
* An object can be an RTEMS object (chain based stuff) or
|
|
* a "misc" object such as a device driver.
|
|
*
|
|
* Each object has its own file in this directory (eg: extension.c)
|
|
* That file provides routines to convert a "native" structure
|
|
* to its canonical form, print a canonical structure, etc.
|
|
*
|
|
* TODO:
|
|
* should allow for non-numeric id's???
|
|
*/
|
|
|
|
/*
|
|
* 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/extensionimpl.h>
|
|
#include <rtems/rtems/messageimpl.h>
|
|
#include <rtems/rtems/partimpl.h>
|
|
#include <rtems/rtems/regionimpl.h>
|
|
#include <rtems/rtems/semimpl.h>
|
|
#include <rtems/rtems/tasksimpl.h>
|
|
#include <rtems/posix/pthreadimpl.h>
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h> /* strtoul() */
|
|
#include <string.h> /* memcpy() */
|
|
|
|
#define NUMELEMS(arr) (sizeof(arr) / sizeof(arr[0]))
|
|
|
|
/*
|
|
* add:
|
|
* next
|
|
*/
|
|
|
|
static const rtems_monitor_object_info_t rtems_monitor_object_info[] =
|
|
{
|
|
{ RTEMS_MONITOR_OBJECT_CONFIG,
|
|
(void *) 0,
|
|
sizeof(rtems_monitor_config_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_config_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_config_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_config_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_config_dump,
|
|
},
|
|
{ RTEMS_MONITOR_OBJECT_MPCI,
|
|
(void *) 0,
|
|
#if defined(RTEMS_MULTIPROCESSING)
|
|
sizeof(rtems_monitor_mpci_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_mpci_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_mpci_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_mpci_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_mpci_dump,
|
|
#else
|
|
0,
|
|
(rtems_monitor_object_next_fn) 0,
|
|
(rtems_monitor_object_canonical_fn) 0,
|
|
(rtems_monitor_object_dump_header_fn) 0,
|
|
(rtems_monitor_object_dump_fn) 0,
|
|
#endif
|
|
},
|
|
{ RTEMS_MONITOR_OBJECT_INIT_TASK,
|
|
(void *) 0,
|
|
sizeof(rtems_monitor_init_task_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_init_task_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_init_task_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_init_task_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_init_task_dump,
|
|
},
|
|
{ RTEMS_MONITOR_OBJECT_TASK,
|
|
(void *) &_RTEMS_tasks_Information.Objects,
|
|
sizeof(rtems_monitor_task_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_manager_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_task_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_task_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_task_dump,
|
|
},
|
|
{ RTEMS_MONITOR_OBJECT_QUEUE,
|
|
(void *) &_Message_queue_Information,
|
|
sizeof(rtems_monitor_queue_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_manager_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_queue_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_queue_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_queue_dump,
|
|
},
|
|
{ RTEMS_MONITOR_OBJECT_SEMAPHORE,
|
|
(void *) &_Semaphore_Information,
|
|
sizeof(rtems_monitor_sema_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_manager_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_sema_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_sema_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_sema_dump,
|
|
},
|
|
{ RTEMS_MONITOR_OBJECT_REGION,
|
|
(void *) &_Region_Information,
|
|
sizeof(rtems_monitor_region_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_manager_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_region_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_region_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_region_dump,
|
|
},
|
|
{ RTEMS_MONITOR_OBJECT_PARTITION,
|
|
(void *) &_Partition_Information,
|
|
sizeof(rtems_monitor_part_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_manager_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_part_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_part_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_part_dump,
|
|
},
|
|
{ RTEMS_MONITOR_OBJECT_EXTENSION,
|
|
(void *) &_Extension_Information,
|
|
sizeof(rtems_monitor_extension_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_manager_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_extension_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_extension_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_extension_dump,
|
|
},
|
|
{ RTEMS_MONITOR_OBJECT_DRIVER,
|
|
(void *) 0,
|
|
sizeof(rtems_monitor_driver_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_driver_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_driver_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_driver_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_driver_dump,
|
|
},
|
|
{ RTEMS_MONITOR_OBJECT_PTHREAD,
|
|
(void *) &_POSIX_Threads_Information.Objects,
|
|
sizeof(rtems_monitor_task_t),
|
|
(rtems_monitor_object_next_fn) rtems_monitor_manager_next,
|
|
(rtems_monitor_object_canonical_fn) rtems_monitor_task_canonical,
|
|
(rtems_monitor_object_dump_header_fn) rtems_monitor_task_dump_header,
|
|
(rtems_monitor_object_dump_fn) rtems_monitor_task_dump,
|
|
}
|
|
};
|
|
|
|
/*
|
|
* Allow id's to be specified without the node number or
|
|
* type for convenience.
|
|
*/
|
|
|
|
rtems_id
|
|
rtems_monitor_id_fixup(
|
|
rtems_id id,
|
|
uint32_t default_node,
|
|
rtems_monitor_object_type_t type
|
|
)
|
|
{
|
|
uint32_t node;
|
|
|
|
node = rtems_object_id_get_node(id);
|
|
if (node == 0)
|
|
{
|
|
if (rtems_object_id_get_class(id) != OBJECTS_CLASSIC_NO_CLASS)
|
|
type = rtems_object_id_get_class(id);
|
|
|
|
id = rtems_build_id(
|
|
OBJECTS_CLASSIC_API,
|
|
type,
|
|
default_node,
|
|
rtems_object_id_get_index(id)
|
|
);
|
|
}
|
|
return id;
|
|
}
|
|
|
|
|
|
const rtems_monitor_object_info_t *
|
|
rtems_monitor_object_lookup(
|
|
rtems_monitor_object_type_t type
|
|
)
|
|
{
|
|
const rtems_monitor_object_info_t *p;
|
|
for (p = &rtems_monitor_object_info[0];
|
|
p < &rtems_monitor_object_info[NUMELEMS(rtems_monitor_object_info)];
|
|
p++)
|
|
{
|
|
if (p->type == type)
|
|
return p;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
#if defined(RTEMS_MULTIPROCESSING)
|
|
static rtems_id
|
|
rtems_monitor_object_canonical_next_remote(
|
|
rtems_monitor_object_type_t type,
|
|
rtems_id id,
|
|
void *canonical
|
|
)
|
|
{
|
|
rtems_id next_id;
|
|
rtems_status_code status;
|
|
rtems_monitor_server_request_t request;
|
|
rtems_monitor_server_response_t response;
|
|
|
|
/*
|
|
* Send request
|
|
*/
|
|
|
|
request.command = RTEMS_MONITOR_SERVER_CANONICAL;
|
|
request.argument0 = (uint32_t) type;
|
|
request.argument1 = (uint32_t) id;
|
|
|
|
status = rtems_monitor_server_request(
|
|
rtems_object_id_get_node(id), &request, &response);
|
|
if (status != RTEMS_SUCCESSFUL)
|
|
goto failed;
|
|
|
|
/*
|
|
* process response
|
|
*/
|
|
|
|
next_id = (rtems_id) response.result0;
|
|
if (next_id != RTEMS_OBJECT_ID_FINAL)
|
|
(void) memcpy(canonical, &response.payload, response.result1);
|
|
|
|
return next_id;
|
|
|
|
failed:
|
|
return RTEMS_OBJECT_ID_FINAL;
|
|
|
|
}
|
|
#endif
|
|
|
|
|
|
rtems_id
|
|
rtems_monitor_object_canonical_next(
|
|
const rtems_monitor_object_info_t *info,
|
|
rtems_id id,
|
|
void *canonical
|
|
)
|
|
{
|
|
rtems_id next_id;
|
|
const void *raw_item;
|
|
|
|
#if defined(RTEMS_MULTIPROCESSING)
|
|
if ( ! _Objects_Is_local_id(id) ) {
|
|
next_id = rtems_monitor_object_canonical_next_remote(
|
|
info->type,
|
|
id,
|
|
canonical
|
|
);
|
|
} else
|
|
#endif
|
|
{
|
|
next_id = id;
|
|
|
|
raw_item = info->next(
|
|
info->object_information,
|
|
canonical,
|
|
&next_id
|
|
);
|
|
|
|
if (raw_item) {
|
|
info->canonical(canonical, raw_item);
|
|
_Objects_Allocator_unlock();
|
|
}
|
|
}
|
|
return next_id;
|
|
}
|
|
|
|
|
|
/*
|
|
* this is routine server invokes locally to get the type
|
|
*/
|
|
|
|
rtems_id
|
|
rtems_monitor_object_canonical_get(
|
|
rtems_monitor_object_type_t type,
|
|
rtems_id id,
|
|
void *canonical,
|
|
size_t *size_p
|
|
)
|
|
{
|
|
const rtems_monitor_object_info_t *info;
|
|
rtems_id next_id;
|
|
|
|
*size_p = 0;
|
|
|
|
info = rtems_monitor_object_lookup(type);
|
|
|
|
if (info == 0)
|
|
return RTEMS_OBJECT_ID_FINAL;
|
|
|
|
next_id = rtems_monitor_object_canonical_next(info, id, canonical);
|
|
*size_p = info->size;
|
|
|
|
return next_id;
|
|
}
|
|
|
|
|
|
static void
|
|
rtems_monitor_object_dump_1(
|
|
const rtems_monitor_object_info_t *info,
|
|
rtems_id id,
|
|
bool verbose
|
|
)
|
|
{
|
|
rtems_id next_id;
|
|
rtems_monitor_union_t canonical;
|
|
|
|
if ((next_id = rtems_monitor_object_canonical_next(
|
|
info,
|
|
id,
|
|
&canonical)) != RTEMS_OBJECT_ID_FINAL)
|
|
{
|
|
/*
|
|
* If the one we actually got is the one we wanted, then
|
|
* print it out.
|
|
* For ones that have an id field, this works fine,
|
|
* for all others, always dump it out.
|
|
*
|
|
* HACK: the way we determine whether there is an id is a hack.
|
|
*
|
|
* by the way: the reason we try to not have an id, is that some
|
|
* of the canonical structures are almost too big for shared
|
|
* memory driver (eg: mpci)
|
|
*/
|
|
|
|
if ((info->next != rtems_monitor_manager_next) ||
|
|
(id == canonical.generic.id))
|
|
info->dump(&canonical, verbose);
|
|
}
|
|
}
|
|
|
|
static void
|
|
rtems_monitor_object_dump_all(
|
|
const rtems_monitor_object_info_t *info,
|
|
bool verbose
|
|
)
|
|
{
|
|
rtems_id next_id;
|
|
rtems_monitor_union_t canonical;
|
|
|
|
next_id = RTEMS_OBJECT_ID_INITIAL(OBJECTS_CLASSIC_API, info->type, rtems_monitor_default_node);
|
|
|
|
while ((next_id = rtems_monitor_object_canonical_next(
|
|
info,
|
|
next_id,
|
|
&canonical)) != RTEMS_OBJECT_ID_FINAL)
|
|
{
|
|
info->dump(&canonical, verbose);
|
|
}
|
|
}
|
|
|
|
void
|
|
rtems_monitor_object_cmd(
|
|
int argc,
|
|
char **argv,
|
|
const rtems_monitor_command_arg_t *command_arg,
|
|
bool verbose
|
|
)
|
|
{
|
|
int arg;
|
|
const rtems_monitor_object_info_t *info = 0;
|
|
rtems_monitor_object_type_t type;
|
|
|
|
/* what is the default type? */
|
|
type = command_arg->monitor_object;
|
|
|
|
if (argc == 1)
|
|
{
|
|
if (type == RTEMS_MONITOR_OBJECT_INVALID)
|
|
{
|
|
fprintf(stdout,"A type must be specified to \"dump all\"\n");
|
|
goto done;
|
|
}
|
|
|
|
info = rtems_monitor_object_lookup(type);
|
|
if (info == 0)
|
|
goto not_found;
|
|
|
|
if (info->dump_header)
|
|
info->dump_header(verbose);
|
|
rtems_monitor_object_dump_all(info, verbose);
|
|
}
|
|
else
|
|
{
|
|
uint32_t default_node = rtems_monitor_default_node;
|
|
rtems_monitor_object_type_t last_type = RTEMS_MONITOR_OBJECT_INVALID;
|
|
rtems_id id;
|
|
|
|
for (arg=1; argv[arg]; arg++)
|
|
{
|
|
id = (rtems_id) strtoul(argv[arg], 0, 16);
|
|
id = rtems_monitor_id_fixup(id, default_node, type);
|
|
type = (rtems_monitor_object_type_t) rtems_object_id_get_class(id);
|
|
|
|
/*
|
|
* Allow the item type to change in the middle
|
|
* of the command. If the type changes, then
|
|
* just dump out a new header and keep on going.
|
|
*/
|
|
if (type != last_type)
|
|
{
|
|
info = rtems_monitor_object_lookup(type);
|
|
if (info == 0)
|
|
goto not_found;
|
|
|
|
if (info->dump_header)
|
|
info->dump_header(verbose);
|
|
}
|
|
|
|
if (info == 0)
|
|
{
|
|
not_found: fprintf(stdout,"Invalid or unsupported type %d\n", type);
|
|
goto done;
|
|
}
|
|
|
|
rtems_monitor_object_dump_1(info, id, verbose);
|
|
|
|
default_node = rtems_object_id_get_node(id);
|
|
|
|
last_type = type;
|
|
}
|
|
}
|
|
done:
|
|
return;
|
|
}
|