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

Last change on this file since 273 was 188, checked in by alain, 7 years ago

Redefine the PIC device API.
File size: 7.8 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;
38enum   pic_impl_e;
39
40/****************************************************************************************
41 * This structure defines the core descriptor.
42 * Besides the core identifiers (gid,lid), it contains an embedded private scheduler.
43 * It contains an architecture specific extension to store the interrupt vector(s).
44 * The core_init()function must allocate memory for this extension, depending on the
45 * PIC device implementation type.
46 ***************************************************************************************/
47
48typedef struct core_s
49{
50        lid_t               lid;            /*! core local index in cluster                */
51        gid_t               gid;            /*! core global identifier (hardware index)    */
52        uint64_t            cycles;         /*! total number of cycles (from hard reset)   */
53        uint32_t            time_stamp;     /*! previous time stamp (read from register)   */
54        uint32_t            ticks_nr;       /*! number of elapsed ticks                    */
55        uint32_t            ticks_period;   /*! number of cycles between two ticks         */
56        uint32_t            usage;          /*! cumulated busy_percent (idle / total)      */
57        uint32_t            spurious_irqs;  /*! for instrumentation...                     */
58    uint32_t            rpc_threads;    /*! current RPC threads number for this core   */
59        struct thread_s   * thread_rpc;     /*! pointer on current RPC thread descriptor   */
60        struct thread_s   * thread_idle;    /*! pointer on idle thread descriptor          */
61        struct thread_s   * fpu_owner;      /*! pointer on current FPU owner thread        */
62    uint32_t            rand_last;      /*! last computed random value                 */
63        scheduler_t         scheduler;      /*! embedded private scheduler                 */
64
65    void              * pic_extend;     /*! PIC implementation specific extension      */
66}
67core_t;
68
69/****************************************************************************************
70 * This macro returns a pointer on the calling core descriptor.
71 ***************************************************************************************/
72
73#define CURRENT_CORE  (CURRENT_THREAD->core)
74
75/***************************************************************************************
76 * This function initializes a core descriptor.
77 * It makes the association [gid] <=> [lid], as defined in arch_info, via the
78 * boot_info_t structure build by the bootloader in each cluster.
79 * It allocates memory for the PIC infrastructure specific core extension.
80 * It does NOT initialize the <thread_idle> and the <pic_extend> fields,
81 * that must be completed later.
82 ***************************************************************************************
83 * @ core      : pointer on core descriptor to initialise.
84 * @ lid       : local core index in cluster.
85 * @ gid       : global core identifier (hardware index).
86 **************************************************************************************/
87void core_init( core_t          * core,
88                lid_t             lid,
89                gid_t             gid );
90
91/***************************************************************************************
92 * This function returns a pseudo random number from the core descriptor
93 * private random generator.
94 ***************************************************************************************
95 * @ core       : pointer on core descriptor.
96 * @ returns the pseudo random value.
97 **************************************************************************************/
98inline uint32_t core_get_rand( core_t * core );
99
100/***************************************************************************************
101 * This function returns the current date (seconds & micro-seconds) from
102 * the 64 bits calling core cycles counter.
103 ***************************************************************************************
104 * @ core      : pointer on core descriptor.
105 * @ tm_s      : number of seconds.
106 * @ tm_us     : number of micro-seconds.
107 **************************************************************************************/
108void core_get_time( core_t   * core,
109                    uint32_t * tm_s,
110                    uint32_t * tm_us );
111
112/***************************************************************************************
113 * This function must be called at each TICK.
114 * It updates the  cycles and ticks counter in the calling core descriptor.
115 * It handles all pending alarms depending on the ticks counter value.
116 * It handles the scheduling, depending on the ticks counter value.
117 * It handles the global DQDT update, depending on the ticks counter vakue.
118 ***************************************************************************************
119 * @ core       : pointer on core descriptor.
120 **************************************************************************************/
121void core_clock( core_t * core );
122
123/***************************************************************************************
124 * This function updates the usage statistics for the calling core descriptor,
125 * based on the ratio between the idle_ticks and total_ticks.
126 ***************************************************************************************
127 * @ core       : pointer on core descriptor.
128 **************************************************************************************/
129void core_compute_stats( core_t * core );
130
131/***************************************************************************************
132 * This function reset the usage statistics.
133 ***************************************************************************************
134 * @ core       : pointer on core descriptor.
135 **************************************************************************************/
136void core_reset_stats( core_t * core );
137
138/***************************************************************************************
139 * This function set/reset a selected entry in one interrupt vector for a remote core.
140 * The written value is an extended pointer on the "source" device (or the XPTR_NULL
141 * value in case of reset). As it uses remote access, this function can be called by
142 * any thread in any cluster.
143 ***************************************************************************************
144 * @ core       : local pointer on the core descriptor.
145 * @ irq_type   : type of IRQ (HWI/WTI/PTI).
146 * @ irq_id     : index in the IRQ vector.
147 * @ chdev      : local pointer on the "source" chdev descriptor.
148 **************************************************************************************/
149void core_set_irq_vector_entry( core_t          * core,
150                                uint32_t          irq_type,
151                                uint32_t          irq_id,
152                                struct chdev_s  * chdev );
153
154
155#endif  /* _CORE_H_ */
Note: See TracBrowser for help on using the repository browser.