source: trunk/kernel/kern/core.h @ 68

Last change on this file since 68 was 68, checked in by alain, 5 years ago

Fix bug in kernel_init, and reduce size of remote_fifo.

File size: 8.6 KB
Line 
1/*
2 * core.h - core descriptor and associated access functions définition
3 *
4 * Authors  Ghassan Almaless (2008,2009,2010,2011,2012)
5 *          Alain Greiner (2016,2017)
6 *
7 * Copyright (c) UPMC Sorbonne Universites
8 *
9 * This file is part of ALMOS-MKH.
10 *
11 * ALMOS-MKH is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; version 2.0 of the License.
14 *
15 * ALMOS-MKH is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 */
24
25#ifndef _CORE_H_
26#define _CORE_H_
27
28#include <kernel_config.h>
29#include <hal_types.h>
30#include <list.h>
31#include <rpc.h>
32#include <scheduler.h>
33
34/****  Forward declarations  ****/
35
36struct thread_s;
37struct chdev_s;
38
39
40/****************************************************************************************
41 * This structure defines the core descriptor.
42 * - It contains an embedded private scheduler.
43 * - It contains the three interrupt vectors, implemented as three arrays of pointers
44 *   on the source channel devices, for all IRQs allocated to the core.
45 ***************************************************************************************/
46
47typedef struct core_s
48{
49        lid_t               lid;            /*! core local index in cluster                */
50        gid_t               gid;            /*! core global identifier (hardware index)    */
51        uint64_t            cycles;         /*! total number of cycles (from hard reset)   */
52        uint32_t            time_stamp;     /*! previous time stamp (read from register)   */
53        uint32_t            ticks_nr;       /*! number of elapsed ticks                    */
54        uint32_t            ticks_period;   /*! number of cycles between two ticks         */
55        uint32_t            usage;          /*! cumulated busy_percent (idle / total)      */
56        uint32_t            spurious_irqs;  /*! for instrumentation...                     */
57        struct thread_s   * thread_rpc;     /*! pointer on current RPC thread descriptor   */
58        struct thread_s   * thread_idle;    /*! pointer on idle thread descriptor          */
59        struct thread_s   * fpu_owner;      /*! pointer on current FPU owner thread        */
60    uint32_t            rand_last;      /*! last computed random value                 */
61        uint32_t            rpc_threads;    /*! total number of RPC threads for this core  */
62        list_entry_t        rpc_free_list;  /*! root of the list of free RPC threads       */
63
64        scheduler_t         scheduler;      /*! embedded private scheduler                 */
65
66    struct chdev_s    * hwi_vector[CONFIG_MAX_HWIS_PER_ICU];     /*! on source device  */
67    struct chdev_s    * pti_vector[CONFIG_MAX_PTIS_PER_ICU];     /*! on source device  */
68    struct chdev_s    * wti_vector[CONFIG_MAX_WTIS_PER_ICU];     /*! on source device  */
69}
70core_t;
71
72/***************************************************************************************
73 * This macro returns a pointer on the calling core descriptor.
74 **************************************************************************************/
75
76#define CURRENT_CORE  (CURRENT_THREAD->core)
77
78/***************************************************************************************
79 * TODO this initialisation must be completed for the thread_idle field... [AG]
80 * This function initializes a core descriptor from information found in arch_info.
81 * It makes the association [gid] <=> [lid], as defined in arch_info, via the
82 * boot_info_t structure build by the bootloader in each cluster.
83 ***************************************************************************************
84 * @ core      : pointer on core descriptor to initialise.
85 * @ lid       : local core index
86 * @ gid       : global core identifier (hardware index)
87 **************************************************************************************/
88void core_init( core_t   * core,
89                lid_t      lid,
90                gid_t      gid );
91
92/***************************************************************************************
93 * This function returns a pseudo random number from the core descriptor
94 * private random generator.
95 ***************************************************************************************
96 * @ core       : pointer on core descriptor.
97 * @ returns the pseudo random value.
98 **************************************************************************************/
99inline uint32_t core_get_rand( core_t * core );
100
101/***************************************************************************************
102 * This function returns the current date (cycles) from both
103 * the hardware 32 bits cycles counter and the core descriptor cycles counter,
104 * taking into account the 32 bits hardware register overflow.
105 * The core descriptor time is updated.
106 ***************************************************************************************
107 * @ core       : pointer on core descriptor.
108 * @ returns the number of cycles.
109 **************************************************************************************/
110inline uint64_t core_get_cycles( core_t * core );
111
112/***************************************************************************************
113 * This function returns the current date (seconds & micro-seconds) from both
114 * the hardware 32 bits cycles counter and the core descriptor cycles counter,
115 * taking into account the 32 bits hardware register overflow.
116 * The core descriptor time is updated.
117 ***************************************************************************************
118 * @ core      : pointer on core descriptor.
119 * @ tm_s      : number of seconds.
120 * @ tm_us     : number of micro-seconds.
121 **************************************************************************************/
122void core_get_time( core_t   * core,
123                    uint32_t * tm_s,
124                    uint32_t * tm_us );
125
126/***************************************************************************************
127 * This function must be called at each TICK.
128 * It updates the  cycles and ticks counter in the calling core descriptor.
129 * It handles all pending alarms depending on the ticks counter value.
130 * It handles the scheduling, depending on the ticks counter value.
131 * It handles the global DQDT update, depending on the ticks counter vakue.
132 ***************************************************************************************
133 * @ core       : pointer on core descriptor.
134 **************************************************************************************/
135void core_clock( core_t * core );
136
137/***************************************************************************************
138 * This function updates the usage statistics for the calling core descriptor,
139 * based on the ratio between the idle_ticks and total_ticks.
140 ***************************************************************************************
141 * @ core       : pointer on core descriptor.
142 **************************************************************************************/
143void core_compute_stats( core_t * core );
144
145/***************************************************************************************
146 * This function reset the usage statistics.
147 ***************************************************************************************
148 * @ core       : pointer on core descriptor.
149 **************************************************************************************/
150void core_reset_stats( core_t * core );
151
152/***************************************************************************************
153 * This function set/reset a selected entry in one interrupt vector for a remote core.
154 * The written value is an extended pointer on the "source" device (or the XPTR_NULL
155 * value in case of reset). As it uses remote access, this function can be called by
156 * any thread in any cluster.
157 ***************************************************************************************
158 * @ core       : local pointer on the core descriptor.
159 * @ irq_type   : type of IRQ (HWI/WTI/PTI).
160 * @ irq_id     : index in the IRQ vector.
161 * @ chdev      : local pointer on the "source" chdev descriptor.
162 **************************************************************************************/
163void core_set_irq_vector_entry( core_t          * core,
164                                uint32_t          irq_type,
165                                uint32_t          irq_id,
166                                struct chdev_s  * chdev );
167
168
169#endif  /* _CORE_H_ */
Note: See TracBrowser for help on using the repository browser.