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

Last change on this file since 504 was 485, checked in by viala@…, 6 years ago

[kern] Add void type to function prototypes with no parameter
File size: 16.1 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_kernel_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 sets of process descriptors:
64 *
65 * 1) pref_tbl[] is an array indexed by lpid. There is one entry per owned process.
66 *    Each entry contains an extended pointer on the reference process descriptor.
67 *
68 * 2) The local_root is the root of the local list of all process descriptors in cluster K.
69 *    A process descriptor P is present in K, as soon as P has a thread in cluster K.
70 *
71 * 3) The copies_root[] array is indexed by lpid. There is one entry per owned process,
72 *    and each each entry contains the root of the xlist of copies for this process.
73 ******************************************************************************************/
74
75typedef struct process_manager_s
76{
77        xptr_t            pref_tbl[CONFIG_MAX_PROCESS_PER_CLUSTER];  /*! reference  process   */
78        spinlock_t        pref_lock;              /*! lock protecting lpid allocation/release */
79    uint32_t          pref_nr;                /*! number of processes owned by cluster    */
80
81    xlist_entry_t     local_root;             /*! root of list of process in cluster      */
82    remote_spinlock_t local_lock;             /*! lock protecting access to local list    */
83    uint32_t          local_nr;               /*! number of process in cluster            */
84
85    xlist_entry_t     copies_root[CONFIG_MAX_PROCESS_PER_CLUSTER];  /*! roots of lists    */
86    remote_spinlock_t copies_lock[CONFIG_MAX_PROCESS_PER_CLUSTER];  /*! one lock per list */
87    uint32_t          copies_nr[CONFIG_MAX_PROCESS_PER_CLUSTER];    /*! number of copies  */
88}
89pmgr_t;
90
91/*******************************************************************************************
92 * This structure defines a cluster manager.
93 * It contains both global platform information, and cluster specific resources
94 * controled by the local kernel instance.
95 ******************************************************************************************/
96
97typedef struct cluster_s
98{
99        spinlock_t      kcm_lock;          /*! local, protect creation of KCM allocators      */
100
101    // global parameters
102        uint32_t        paddr_width;       /*! numer of bits in physical address              */
103    uint32_t        x_width;           /*! number of bits to code x_size  (can be 0)      */
104    uint32_t        y_width;           /*! number of bits to code y_size  (can be 0)      */
105        uint32_t        x_size;            /*! number of clusters in a row    (can be 1)      */
106        uint32_t        y_size;            /*! number of clusters in a column (can be 1)      */
107        cxy_t           io_cxy;            /*! io cluster identifier                          */
108    uint32_t        dqdt_root_level;   /*! index of root node in dqdt_tbl[]               */
109    uint32_t        nb_txt_channels;   /*! number of TXT channels                         */
110    uint32_t        nb_nic_channels;   /*! number of NIC channels                         */
111    uint32_t        nb_ioc_channels;   /*! number of IOC channels                         */
112    uint32_t        nb_fbf_channels;   /*! number of FBF channels                         */
113
114    // local parameters
115        uint32_t        cores_nr;          /*! actual number of cores in cluster              */
116    uint32_t        ram_size;          /*! physical memory size                           */
117    uint32_t        ram_base;          /*! physical memory base (local address)           */
118
119        core_t          core_tbl[CONFIG_MAX_LOCAL_CORES];    /*! embedded cores               */
120
121        list_entry_t    dev_root;          /*! root of list of devices in cluster             */
122
123    // memory allocators
124        ppm_t           ppm;               /*! embedded kernel page manager                   */
125        khm_t           khm;               /*! embedded kernel heap manager                   */
126        kcm_t           kcm;               /*! embedded kernel KCMs manager                   */
127
128    kcm_t         * kcm_tbl[KMEM_TYPES_NR];              /*! pointers on allocated KCMs   */
129
130    // RPC
131        remote_fifo_t   rpc_fifo[CONFIG_MAX_LOCAL_CORES];    /*! one RPC FIFO per core        */
132    uint32_t        rpc_threads[CONFIG_MAX_LOCAL_CORES]; /*! RPC threads per core         */
133
134    // DQDT
135        dqdt_node_t     dqdt_tbl[CONFIG_DQDT_LEVELS_NR];     /*! embedded DQDT nodes          */
136
137    // Local process manager
138    pmgr_t          pmgr;              /*! embedded process manager                       */
139
140    void          * pic_extend;        /*! PIC implementation specific extension          */
141}
142cluster_t;
143
144/******************************************************************************************
145 * This global variable is allocated in the kernel_init.c file.
146 * There is one cluster_manager per cluster, with the same local address,
147 * but different content, in all clusters containing a kernel instance.
148 *****************************************************************************************/
149
150extern cluster_t cluster_manager;
151
152/******************************************************************************************
153 * This macro returns a local pointer on the local cluster manager.
154 *****************************************************************************************/
155
156#define LOCAL_CLUSTER    (&cluster_manager)
157
158/******************************************************************************************
159 * This generic function initialises the local cluster manager from information found
160 * in the local boot-info structure. It initializes the following local resources:
161 * - the global platform parameters,
162 * - the specific cluster parameters,
163 * - the lock protecting KCM creation,
164 * - the local DQDT nodes,
165 * - the PPM, KHM, and KCM allocators,
166 * - the local core descriptors,
167 * - the local RPC FIFO,
168 * - the process manager.
169 * It does NOT initialise the local device descriptors.
170 ******************************************************************************************
171 * @ info : pointer on the local boot_info_t structure build by the bootloader.
172 *****************************************************************************************/
173error_t cluster_init( boot_info_t * info );
174
175/******************************************************************************************
176 * This function checks the validity of a cluster identifier.
177 ******************************************************************************************
178 * @ cxy    : cluster identifier to be checked.
179 * @ returns true if the identified cluster does not exist.
180 *****************************************************************************************/
181bool_t cluster_is_undefined( cxy_t cxy );
182
183
184/*****************************************************************************************/
185/***************   Process Management Operations   ***************************************/
186/*****************************************************************************************/
187
188/******************************************************************************************
189 * This function returns an extended pointer on the process descriptor in owner cluster
190 * from the process <pid>. This PID can be be different from the calling process PID.
191 * It can be called by any thread running in any cluster,
192 ******************************************************************************************
193 * @ pid  : process identifier.
194 * @ return extended pointer on owner process if found / XPTR_NULL if not found.
195 *****************************************************************************************/
196xptr_t cluster_get_owner_process_from_pid( pid_t pid );
197
198/******************************************************************************************
199 * This function returns an extended pointer on the reference process descriptor
200 * from the process <pid>. This PID can be be different from the calling process PID.
201 * It can be called by any thread running in any cluster,
202 ******************************************************************************************
203 * @ pid  : process identifier.
204 * @ return extended pointer on reference process if found / XPTR_NULL if not found.
205 *****************************************************************************************/
206xptr_t cluster_get_reference_process_from_pid( pid_t pid );
207
208/******************************************************************************************
209 * This function returns an extended pointer on the process descriptor copy for the
210 * process identified by <pid> in cluster defined by <cxy> argument.
211 * This PID can be be different from the calling process PID.
212 * It can be called by any thread running in any cluster,
213 ******************************************************************************************
214 * @ cxy  : target cluster identifier.
215 * @ pid  : process identifier.
216 * @ return extended pointer on reference process if found / XPTR_NULL if not found.
217 *****************************************************************************************/
218xptr_t cluster_get_process_from_pid_in_cxy( cxy_t cxy,
219                                            pid_t pid );
220
221/******************************************************************************************
222 * This function allocates a new PID in local cluster, that becomes the process owner.
223 * It registers the process descriptor extended pointer in the local processs manager
224 * pref_tbl[] array. The process descriptor itself is not modified.
225 * This function is called by the process_make_fork() function,
226 * by the process_make_exec() function, and by the process_init_create() function.
227 ******************************************************************************************
228 * @ process    : pointer on process descriptor.
229 * @ pid        : [out] allocated PID.
230 * @ return 0 if success / return -1 if no PID slot available.
231 *****************************************************************************************/
232error_t cluster_pid_alloc( struct process_s * process,
233                           pid_t            * pid );
234
235/******************************************************************************************
236 * This function removes a PID from the local process manager pref_tbl[] array.
237 * It checks that removed process is owned by the local cluster and the lpid is legal.
238 * No memory is released by this function.
239 ******************************************************************************************
240 * @ pid        : allocated PID.
241 *****************************************************************************************/
242void cluster_pid_release( pid_t  pid );
243
244/******************************************************************************************
245 * This function returns a pointer on the local process descriptor from the PID.
246 * It uses the RPC
247 * to create a local process descriptor copy if it does not exist yet.
248 ******************************************************************************************
249 * @ pid     : searched process identifier.
250 * @ returns process descriptor pointer if found / returns NULL if not found.
251 *****************************************************************************************/
252struct process_s * cluster_get_local_process_from_pid( pid_t pid );
253
254/******************************************************************************************
255 * This function registers a local process descriptor in the process manager local_list.
256 ******************************************************************************************
257 * @ process     : pointer on local process descriptor.
258 *****************************************************************************************/
259void cluster_process_local_link( struct process_s * process );
260
261/******************************************************************************************
262 * This function removes a local process descriptor from the process manager local_list.
263 ******************************************************************************************
264 * @ process     : pointer on local process descriptor.
265 *****************************************************************************************/
266void cluster_process_local_unlink( struct process_s * process );
267
268/******************************************************************************************
269 * This function registers a local process descriptor in the owner process manager
270 * copies_list, that can be in a remote cluster.
271 ******************************************************************************************
272 * @ process     : pointer on local process descriptor.
273 *****************************************************************************************/
274void cluster_process_copies_link( struct process_s * process );
275
276/******************************************************************************************
277 * This function removes a local process descriptor from the owner process manager
278 * copies_list, that can be in a remote cluster.
279 ******************************************************************************************
280 * @ process     : pointer on local process descriptor.
281 *****************************************************************************************/
282void cluster_process_copies_unlink( struct process_s * process );
283
284/*********************************************************************************************
285 * This function displays on the kernel terminal TXT0 all user processes registered
286 * in the cluster defined by the <cxy> argument.
287 * It can be called by a thread running in any cluster, because is use remote accesses
288 * to scan the xlist of registered processes.
289 *********************************************************************************************
290 * @ cxy   : cluster identifier.
291 ********************************************************************************************/
292void cluster_processes_display( cxy_t cxy );
293
294
295
296/*****************************************************************************************/
297/***************   Cores Management Operations   *****************************************/
298/*****************************************************************************************/
299
300/******************************************************************************************
301 * This function returns the core local index that has the lowest usage in local cluster.
302 *****************************************************************************************/
303lid_t cluster_select_local_core( void );
304
305#endif  /* _CLUSTER_H_ */
Note: See TracBrowser for help on using the repository browser.