rtems/src/ratemongetstatus.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSImplClassicRateMonotonic
0007  *
0008  * @brief This source file contains the implementation of
0009  *   rtems_rate_monotonic_get_status().
0010  */
0011
0012 /*
0013  *  COPYRIGHT (c) 1989-2009.
0014  *  On-Line Applications Research Corporation (OAR).
0015  *  Copyright (c) 2016 embedded brains GmbH & Co. KG
0016  *  Copyright (c) 2017 Kuan-Hsun Chen.
0017  *
0018  * Redistribution and use in source and binary forms, with or without
0019  * modification, are permitted provided that the following conditions
0020  * are met:
0021  * 1. Redistributions of source code must retain the above copyright
0022  *    notice, this list of conditions and the following disclaimer.
0023  * 2. Redistributions in binary form must reproduce the above copyright
0024  *    notice, this list of conditions and the following disclaimer in the
0025  *    documentation and/or other materials provided with the distribution.
0026  *
0027  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0028  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0029  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0030  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0031  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0032  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0033  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0034  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0035  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0036  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0037  * POSSIBILITY OF SUCH DAMAGE.
0038  */
0039
0040 #ifdef HAVE_CONFIG_H
0041 #include "config.h"
0042 #endif
0043
0044 #include <rtems/rtems/ratemonimpl.h>
0045
0046 rtems_status_code rtems_rate_monotonic_get_status(
0047   rtems_id                            id,
0048   rtems_rate_monotonic_period_status *period_status
0049 )
0050 {
0051   Rate_monotonic_Control *the_period;
0052   ISR_lock_Context        lock_context;
0053
0054   if ( period_status == NULL ) {
0055     return RTEMS_INVALID_ADDRESS;
0056   }
0057
0058   the_period = _Rate_monotonic_Get( id, &lock_context );
0059   if ( the_period == NULL ) {
0060     return RTEMS_INVALID_ID;
0061   }
0062
0063   _Rate_monotonic_Acquire_critical( the_period, &lock_context );
0064
0065   period_status->owner = the_period->owner->Object.id;
0066   period_status->state = the_period->state;
0067   period_status->postponed_jobs_count = the_period->postponed_jobs;
0068
0069   if ( the_period->state == RATE_MONOTONIC_INACTIVE ) {
0070     /*
0071      *  If the period is inactive, there is no information.
0072      */
0073     _Timespec_Set_to_zero( &period_status->since_last_period );
0074     _Timespec_Set_to_zero( &period_status->executed_since_last_period );
0075   } else {
0076     Timestamp_Control wall_since_last_period;
0077     Timestamp_Control cpu_since_last_period;
0078
0079     /*
0080      *  Grab the current status.
0081      */
0082     _Rate_monotonic_Get_status(
0083       the_period,
0084       &wall_since_last_period,
0085       &cpu_since_last_period
0086     );
0087     _Timestamp_To_timespec(
0088       &wall_since_last_period,
0089       &period_status->since_last_period
0090     );
0091     _Timestamp_To_timespec(
0092       &cpu_since_last_period,
0093       &period_status->executed_since_last_period
0094     );
0095   }
0096
0097   _Rate_monotonic_Release( the_period, &lock_context );
0098   return RTEMS_SUCCESSFUL;
0099 }