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

Last change on this file since 676 was 669, checked in by alain, 4 years ago

1) Introduce up to 4 command lines arguments in the KSH "load" command.
These arguments are transfered to the user process through the
argc/argv mechanism, using the user space "args" vseg.

2) Introduce the named and anonymous "pipes", for inter-process communication
through the pipe() and mkfifo() syscalls.

3) Introduce the "chat" application to validate the two above mechanisms.

4) Improve printk() and assert() fonctions in printk.c.
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,2018)
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_kernel_types.h>
30#include <busylock.h>
31#include <list.h>
32#include <rpc.h>
33#include <scheduler.h>
34
35/****  Forward declarations  ****/
36
37struct thread_s;
38struct chdev_s;
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
53        uint64_t            cycles;         /*! total number of cycles (from hard reset)   */
54        uint32_t            time_stamp;     /*! previous time stamp (read from register)   */
55
56    list_entry_t        alarms_root;    /*! root of list of attached alarms            */
57    busylock_t          alarms_lock;    /*! lock protecting the list of alarms         */
58
59        uint32_t            ticks_nr;       /*! number of elapsed ticks                    */
60        uint32_t            usage;          /*! cumulated busy_percent (idle / total)      */
61        uint32_t            spurious_irqs;  /*! for instrumentation...                     */
62        struct thread_s   * fpu_owner;      /*! pointer on current FPU owner thread        */
63    uint32_t            rand_last;      /*! last computed random value                 */
64
65        scheduler_t         scheduler;      /*! embedded private scheduler                 */
66
67    void              * pic_extend;     /*! PIC implementation specific extension      */
68}
69core_t;
70
71/***************************************************************************************
72 * This function initializes a core descriptor.
73 * It makes the association [gid] <=> [lid], as defined in arch_info, via the
74 * boot_info_t structure build by the bootloader in each cluster.
75 * It initializes the core scheduler structures, and the alarms list and lock.
76 * It allocates memory for the PIC infrastructure specific core extension,
77 * but it does NOT initialize the <pic_extend> fields, that must be completed later.
78 ***************************************************************************************
79 * @ core      : pointer on core descriptor to initialise.
80 * @ lid       : local core index in cluster.
81 * @ gid       : global core identifier (hardware index).
82 **************************************************************************************/
83void core_init( core_t          * core,
84                lid_t             lid,
85                gid_t             gid );
86
87/***************************************************************************************
88 * This function returns the calling core local index (lid), making an associative
89 * search in the local core_tbl[] array, based on the hardwired (gid).
90 ***************************************************************************************
91 * @ returns always the lid value.
92 **************************************************************************************/
93lid_t core_lid( void );
94
95/***************************************************************************************
96 * This function returns a pseudo random number from the core descriptor
97 * private random generator.
98 ***************************************************************************************
99 * @ core       : pointer on core descriptor.
100 * @ returns the pseudo random value.
101 **************************************************************************************/
102inline uint32_t core_get_rand( core_t * core );
103
104/***************************************************************************************
105 * This function returns the current date (seconds & micro-seconds) from
106 * the 64 bits calling core cycles counter.
107 ***************************************************************************************
108 * @ core      : pointer on core descriptor.
109 * @ tm_s      : number of seconds.
110 * @ tm_us     : number of micro-seconds.
111 **************************************************************************************/
112void core_get_time( core_t   * core,
113                    uint32_t * tm_s,
114                    uint32_t * tm_us );
115
116/***************************************************************************************
117 * This function must be called at each TICK.
118 * - it updates the ticks counter in the calling core descriptor.
119 * - it checks the registered alarms depending on the ticks counter value.
120 * - it calls the scheduler, depending on the ticks counter value.
121 ***************************************************************************************
122 * @ core       : pointer on core descriptor.
123 **************************************************************************************/
124void core_clock( core_t * core );
125
126/***************************************************************************************
127 * This function updates the usage statistics for the calling core descriptor,
128 * based on the ratio between the idle_ticks and total_ticks.
129 ***************************************************************************************
130 * @ core       : pointer on core descriptor.
131 **************************************************************************************/
132void core_compute_stats( core_t * core );
133
134/***************************************************************************************
135 * This function reset the usage statistics.
136 ***************************************************************************************
137 * @ core       : pointer on core descriptor.
138 **************************************************************************************/
139void core_reset_stats( core_t * core );
140
141/***************************************************************************************
142 * This function set/reset a selected entry in one interrupt vector for a remote core.
143 * The written value is an extended pointer on the "source" device (or the XPTR_NULL
144 * value in case of reset). As it uses remote access, this function can be called by
145 * any thread in any cluster.
146 ***************************************************************************************
147 * @ core       : local pointer on the core descriptor.
148 * @ irq_type   : type of IRQ (HWI/WTI/PTI).
149 * @ irq_id     : index in the IRQ vector.
150 * @ chdev      : local pointer on the "source" chdev descriptor.
151 **************************************************************************************/
152void core_set_irq_vector_entry( core_t          * core,
153                                uint32_t          irq_type,
154                                uint32_t          irq_id,
155                                struct chdev_s  * chdev );
156
157
158#endif  /* _CORE_H_ */
Note: See TracBrowser for help on using the repository browser.