score/src/coretodhookrun.c

0001 /**
0002  * @file
0003  *
0004  * @ingroup RTEMSScoreTODHooks
0005  *
0006  * @brief This source file contains the implementation of
0007  *   _TOD_Hook_Run().
0008  */
0009
0010 /*
0011  *  SPDX-License-Identifier: BSD-2-Clause
0012  *
0013  *  COPYRIGHT (c) 2019.
0014  *  On-Line Applications Research Corporation (OAR).
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifdef HAVE_CONFIG_H
0039 #include "config.h"
0040 #endif
0041
0042 #include <rtems/score/todimpl.h>
0043 #include <rtems/score/assert.h>
0044 #include <rtems/score/chainimpl.h>
0045
0046 Status_Control _TOD_Hook_Run(
0047   TOD_Action             action,
0048   const struct timespec *tod
0049 )
0050 {
0051   const Chain_Node *the_node;
0052   Status_Control    status;
0053
0054   status = STATUS_SUCCESSFUL;
0055
0056   /*
0057    * This is assumed to be called only from _TOD_Set() which is supposed
0058    * to be called only while holding the TOD lock.
0059    */
0060   _Assert( _TOD_Is_owner() );
0061
0062   for (
0063     the_node = _Chain_Immutable_first( &_TOD_Hooks );
0064     !_Chain_Is_tail( &_TOD_Hooks, the_node );
0065     the_node = _Chain_Immutable_next( the_node )
0066   ) {
0067     const TOD_Hook *the_hook;
0068
0069     the_hook = (const TOD_Hook *) the_node;
0070     status = ( *the_hook->handler )( action, tod );
0071     if ( status != STATUS_SUCCESSFUL ) {
0072       break;
0073     }
0074   }
0075
0076   return status;
0077 }