source: trunk/kernel/kern/cluster.h @ 441

Last change on this file since 441 was 440, checked in by alain, 7 years ago

1/ Fix a bug in the Multithreaded "sort" applicationr:
The pthread_create() arguments must be declared as global variables.
2/ The exit syscall can be called by any thread of a process..
File size: 15.3 KB
Line 
1/*
2 * cluster.h - Cluster-Manager definition
3 *
4 * authors  Ghassan Almaless (2008,2009,2010,2011,2012)
5 *          Mohamed Lamine Karaoui (2015)
6 *          Alain Greiner (2016,2017,2018)
7 *
8 * Copyright (c) UPMC Sorbonne Universites
9 *
10 * This file is part of ALMOS-MKH.
11 *
12 * ALMOS-MKH is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; version 2.0 of the License.
15 *
16 * ALMOS-MKH is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 */
25
26#ifndef _CLUSTER_H_
27#define _CLUSTER_H_
28
29#include <kernel_config.h>
30#include <hal_types.h>
31#include <bits.h>
32#include <spinlock.h>
33#include <readlock.h>
34#include <remote_barrier.h>
35#include <list.h>
36#include <xlist.h>
37#include <dqdt.h>
38#include <kmem.h>
39#include <hal_atomic.h>
40#include <ppm.h>
41#include <kcm.h>
42#include <khm.h>
43#include <rpc.h>
44#include <core.h>
45#include <process.h>
46
47/**** Forward declarations  ****/
48
49struct core_s;
50struct process_s;
51
52
53/*******************************************************************************************
54 * This structure defines the process manager, that is part of the cluster manager.
55 * For any process P, the process descriptor is replicated in all clusters containing
56 * at least one thread of process P, but only the "reference" cluster descriptor contains
57 * the reference (complete) GPT, VSL, and FDT structures.
58 * The "owner" cluster K is in charge to allocate a lpid (local process index),
59 * to the owned processes, and to register the "reference" cluster for these processes.
60 *
61 * Warning : the "owner" cluster, and the "reference" cluster can be different clusters.
62 *
63 * The process manager of a cluster K maintains three structures:
64 * 1) The pref_tbl[] is an array indexed by lpid. There is one entry per owned process.
65 *    Each entry contains an extended pointer on the reference process descriptor.
66 *
67 * 2) The local_root is the root of the local list of process descriptors in cluster K.
68 *    A process descriptor P is present in K, as soon as P has a thread in cluster K.
69 *
70 * 3) The copies_root[] array is indexed by lpid. There is one entry per owned process,
71 *    and each each entry contains the root of the xlist of copies for this process.
72 ******************************************************************************************/
73
74typedef struct process_manager_s
75{
76        xptr_t            pref_tbl[CONFIG_MAX_PROCESS_PER_CLUSTER];  /*! reference  process   */
77        spinlock_t        pref_lock;              /*! lock protecting lpid allocation/release */
78    uint32_t          pref_nr;                /*! number of processes owned by cluster    */
79
80    xlist_entry_t     local_root;             /*! root of list of process in cluster      */
81    remote_spinlock_t local_lock;             /*! lock protecting access to local list    */
82    uint32_t          local_nr;               /*! number of process in cluster            */
83
84    xlist_entry_t     copies_root[CONFIG_MAX_PROCESS_PER_CLUSTER];  /*! roots of lists    */
85    remote_spinlock_t copies_lock[CONFIG_MAX_PROCESS_PER_CLUSTER];  /*! one lock per list */
86    uint32_t          copies_nr[CONFIG_MAX_PROCESS_PER_CLUSTER];    /*! number of copies  */
87}
88pmgr_t;
89
90/*******************************************************************************************
91 * This structure defines a cluster manager.
92 * It contains both global platform information, and cluster specific resources
93 * controled by the local kernel instance.
94 ******************************************************************************************/
95
96typedef struct cluster_s
97{
98        spinlock_t      kcm_lock;          /*! local, protect creation of KCM allocators      */
99
100    // global parameters
101        uint32_t        paddr_width;       /*! numer of bits in physical address              */
102    uint32_t        x_width;           /*! number of bits to code x_size  (can be 0)      */
103    uint32_t        y_width;           /*! number of bits to code y_size  (can be 0)      */
104        uint32_t        x_size;            /*! number of clusters in a row    (can be 1)      */
105        uint32_t        y_size;            /*! number of clusters in a column (can be 1)      */
106        cxy_t           io_cxy;            /*! io cluster identifier                          */
107    uint32_t        dqdt_root_level;   /*! index of root node in dqdt_tbl[]               */
108    uint32_t        nb_txt_channels;   /*! number of TXT channels                         */
109    uint32_t        nb_nic_channels;   /*! number of NIC channels                         */
110    uint32_t        nb_ioc_channels;   /*! number of IOC channels                         */
111    uint32_t        nb_fbf_channels;   /*! number of FBF channels                         */
112
113    // local parameters
114        uint32_t        cores_nr;          /*! actual number of cores in cluster              */
115    uint32_t        ram_size;          /*! physical memory size                           */
116    uint32_t        ram_base;          /*! physical memory base (local address)           */
117
118        core_t          core_tbl[CONFIG_MAX_LOCAL_CORES];    /*! embedded cores               */
119
120        list_entry_t    dev_root;          /*! root of list of devices in cluster             */
121
122    // memory allocators
123        ppm_t           ppm;               /*! embedded kernel page manager                   */
124        khm_t           khm;               /*! embedded kernel heap manager                   */
125        kcm_t           kcm;               /*! embedded kernel KCMs manager                   */
126
127    kcm_t         * kcm_tbl[KMEM_TYPES_NR];              /*! pointers on allocated KCMs   */
128
129    // RPC
130        remote_fifo_t   rpc_fifo[CONFIG_MAX_LOCAL_CORES];    /*! one RPC FIFO per core        */
131    uint32_t        rpc_threads[CONFIG_MAX_LOCAL_CORES]; /*! RPC threads per core         */
132
133    // DQDT
134        dqdt_node_t     dqdt_tbl[CONFIG_DQDT_LEVELS_NR];     /*! embedded DQDT nodes          */
135
136    // Local process manager
137    pmgr_t          pmgr;              /*! embedded process manager                       */
138
139    void          * pic_extend;        /*! PIC implementation specific extension          */
140}
141cluster_t;
142
143/******************************************************************************************
144 * This global variable is allocated in the kernel_init.c file.
145 * There is one cluster_manager per cluster, with the same local address,
146 * but different content, in all clusters containing a kernel instance.
147 *****************************************************************************************/
148
149extern cluster_t cluster_manager;
150
151/******************************************************************************************
152 * This macro returns a local pointer on the local cluster manager.
153 *****************************************************************************************/
154
155#define LOCAL_CLUSTER    (&cluster_manager)
156
157/******************************************************************************************
158 * This generic function initialises the local cluster manager from information found
159 * in the local boot-info structure. It initializes the following local resources:
160 * - the global platform parameters,
161 * - the specific cluster parameters,
162 * - the lock protecting KCM creation,
163 * - the local DQDT nodes,
164 * - the PPM, KHM, and KCM allocators,
165 * - the local core descriptors,
166 * - the local RPC FIFO,
167 * - the process manager.
168 * It does NOT initialise the local device descriptors.
169 ******************************************************************************************
170 * @ info : pointer on the local boot_info_t structure build by the bootloader.
171 *****************************************************************************************/
172error_t cluster_init( boot_info_t * info );
173
174/******************************************************************************************
175 * This function checks the validity of a cluster identifier.
176 ******************************************************************************************
177 * @ cxy    : cluster identifier to be checked.
178 * @ returns true if the identified cluster does not exist.
179 *****************************************************************************************/
180bool_t cluster_is_undefined( cxy_t cxy );
181
182
183/*****************************************************************************************/
184/***************   Process Management Operations   ***************************************/
185/*****************************************************************************************/
186
187/******************************************************************************************
188 * This function returns an extended pointer on the process descriptor in owner cluster
189 * from the process PID. This PID can be be different from the calling process PID.
190 * It can be called by any thread running in any cluster,
191 ******************************************************************************************
192 * @ pid  : process identifier.
193 * @ return extended pointer on owner process if found / XPTR_NULL if not found.
194 *****************************************************************************************/
195xptr_t cluster_get_owner_process_from_pid( pid_t pid );
196
197/******************************************************************************************
198 * This function returns an extended pointer on the reference process descriptor
199 * from the process PID. This PID can be be different from the calling process PID.
200 * It can be called by any thread running in any cluster,
201 ******************************************************************************************
202 * @ pid  : process identifier.
203 * @ return extended pointer on reference process if found / XPTR_NULL if not found.
204 *****************************************************************************************/
205xptr_t cluster_get_reference_process_from_pid( pid_t pid );
206
207/******************************************************************************************
208 * This function allocates a new PID in local cluster, that becomes the process owner.
209 * It registers the process descriptor extended pointer in the local processs manager
210 * pref_tbl[] array. The process descriptor itself is not modified.
211 * This function is called by the process_make_fork() function,
212 * by the process_make_exec() function, and by the process_init_create() function.
213 ******************************************************************************************
214 * @ process    : pointer on process descriptor.
215 * @ pid        : [out] allocated PID.
216 * @ return 0 if success / return -1 if no PID slot available.
217 *****************************************************************************************/
218error_t cluster_pid_alloc( struct process_s * process,
219                           pid_t            * pid );
220
221/******************************************************************************************
222 * This function removes a PID from the local process manager pref_tbl[] array.
223 * It checks that removed process is owned by the local cluster and the lpid is legal.
224 * No memory is released by this function.
225 ******************************************************************************************
226 * @ pid        : allocated PID.
227 *****************************************************************************************/
228void cluster_pid_release( pid_t  pid );
229
230/******************************************************************************************
231 * This function returns a pointer on the local process descriptor from the PID.
232 * It uses the RPC
233 * to create a local process descriptor copy if it does not exist yet.
234 ******************************************************************************************
235 * @ pid     : searched process identifier.
236 * @ returns process descriptor pointer if found / returns NULL if not found.
237 *****************************************************************************************/
238struct process_s * cluster_get_local_process_from_pid( pid_t pid );
239
240/******************************************************************************************
241 * This function registers a local process descriptor in the process manager local_list.
242 ******************************************************************************************
243 * @ process     : pointer on local process descriptor.
244 *****************************************************************************************/
245void cluster_process_local_link( struct process_s * process );
246
247/******************************************************************************************
248 * This function removes a local process descriptor from the process manager local_list.
249 ******************************************************************************************
250 * @ process     : pointer on local process descriptor.
251 *****************************************************************************************/
252void cluster_process_local_unlink( struct process_s * process );
253
254/******************************************************************************************
255 * This function registers a local process descriptor in the owner process manager
256 * copies_list, that can be in a remote cluster.
257 ******************************************************************************************
258 * @ process     : pointer on local process descriptor.
259 *****************************************************************************************/
260void cluster_process_copies_link( struct process_s * process );
261
262/******************************************************************************************
263 * This function removes a local process descriptor from the owner process manager
264 * copies_list, that can be in a remote cluster.
265 ******************************************************************************************
266 * @ process     : pointer on local process descriptor.
267 *****************************************************************************************/
268void cluster_process_copies_unlink( struct process_s * process );
269
270/*********************************************************************************************
271 * This function displays on the kernel terminal TXT0 all user processes registered
272 * in the cluster defined by the <cxy> argument.
273 * It can be called by a thread running in any cluster, because is use remote accesses
274 * to scan the xlist of registered processes.
275 *********************************************************************************************
276 * @ cxy   : cluster identifier.
277 ********************************************************************************************/
278void cluster_processes_display( cxy_t cxy );
279
280
281
282/*****************************************************************************************/
283/***************   Cores Management Operations   *****************************************/
284/*****************************************************************************************/
285
286/******************************************************************************************
287 * This function returns the core local index that has the lowest usage in local cluster.
288 *****************************************************************************************/
289lid_t cluster_select_local_core();
290
291#endif  /* _CLUSTER_H_ */
Note: See TracBrowser for help on using the repository browser.