libmisc/monitor/mon-queue.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @brief Monitor Support for Message Queues
0007  */
0008
0009 /*
0010  * COPYRIGHT (c) 1989-2022. On-Line Applications Research Corporation (OAR).
0011  *
0012  * Redistribution and use in source and binary forms, with or without
0013  * modification, are permitted provided that the following conditions
0014  * are met:
0015  * 1. Redistributions of source code must retain the above copyright
0016  *    notice, this list of conditions and the following disclaimer.
0017  * 2. Redistributions in binary form must reproduce the above copyright
0018  *    notice, this list of conditions and the following disclaimer in the
0019  *    documentation and/or other materials provided with the distribution.
0020  *
0021  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0022  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0024  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0025  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0026  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0027  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0030  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0031  * POSSIBILITY OF SUCH DAMAGE.
0032  */
0033
0034 #ifdef HAVE_CONFIG_H
0035 #include "config.h"
0036 #endif
0037
0038 #include <rtems.h>
0039 #include <rtems/monitor.h>
0040 #include <rtems/rtems/messageimpl.h>
0041
0042 #include <stdio.h>
0043
0044 void
0045 rtems_monitor_queue_canonical(
0046     rtems_monitor_queue_t *canonical_queue,
0047     const void            *queue_void
0048 )
0049 {
0050     const Message_queue_Control *rtems_queue = (const Message_queue_Control *) queue_void;
0051
0052     canonical_queue->attributes = 0;
0053
0054     if (
0055       rtems_queue->message_queue.operations
0056         == &_Thread_queue_Operations_priority
0057     ) {
0058       canonical_queue->attributes |= RTEMS_PRIORITY;
0059     }
0060
0061 #if defined(RTEMS_MULTIPROCESSING)
0062     if ( rtems_queue->is_global ) {
0063       canonical_queue->attributes |= RTEMS_GLOBAL;
0064     }
0065 #endif
0066
0067     canonical_queue->maximum_message_size = rtems_queue->message_queue.maximum_message_size;
0068     canonical_queue->maximum_pending_messages = rtems_queue->message_queue.maximum_pending_messages;
0069     canonical_queue->number_of_pending_messages = rtems_queue->message_queue.number_of_pending_messages;
0070 }
0071
0072 void
0073 rtems_monitor_queue_dump_header(
0074     bool verbose RTEMS_UNUSED
0075 )
0076 {
0077     fprintf(stdout,"\
0078   ID       NAME   ATTRIBUTES   PEND   MAXPEND  MAXSIZE\n");
0079 /*23456789 123456789 123456789 123456789 123456789 123456789 123456789 123456789
0080 0         1         2         3         4         5         6         7       */
0081     rtems_monitor_separator();
0082 }
0083
0084
0085 /*
0086  * Dump out the "next" queue indicated by 'id'.
0087  * Returns next one to check.
0088  * Returns RTEMS_OBJECT_ID_FINAL when all done
0089  */
0090
0091 void
0092 rtems_monitor_queue_dump(
0093     rtems_monitor_queue_t *monitor_queue,
0094     bool  verbose RTEMS_UNUSED
0095 )
0096 {
0097     uint32_t              length = 0;
0098
0099     length += rtems_monitor_dump_id(monitor_queue->id);
0100     length += rtems_monitor_pad(11, length);
0101     length += rtems_monitor_dump_name(monitor_queue->id);
0102     length += rtems_monitor_pad(19, length);
0103     length += rtems_monitor_dump_attributes(monitor_queue->attributes);
0104     length += rtems_monitor_pad(31, length);
0105     length += rtems_monitor_dump_decimal(monitor_queue->number_of_pending_messages);
0106     length += rtems_monitor_pad(39, length);
0107     length += rtems_monitor_dump_decimal(monitor_queue->maximum_pending_messages);
0108     length += rtems_monitor_pad(48, length);
0109     length += rtems_monitor_dump_decimal(monitor_queue->maximum_message_size);
0110
0111     fprintf(stdout,"\n");
0112 }