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

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

First import

File size: 14.9 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)
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 <almos_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;
51struct device_s;
52
53
54/*******************************************************************************************
55 * This structure defines the process manager, that is part of the cluster manager.
56 * For any process P, the process descriptor is replicated in all clusters containing
57 * at least one thread of process P, but only the "reference" cluster descriptor contains
58 * the reference (complete) structures such as the GPT, the VSL, or the FDT.
59 * The "owner" cluster is in charge to allocate a lpid (local process index),
60 * for all process owned by a cluster K, and to register the "reference" cluster for
61 * all process owned by K.
62 *
63 * Warning : the "owner" cluster, and the "reference" cluster can be different clusters.
64 *
65 * The process manager of a cluster K maintains three structures:
66 * 1) The pref_tbl[] is an array indexed by lpid, for all processes owned by cluster K.
67 *    Each entry contains an extended pointer on the reference process descriptor.
68 * 2) The local_root is the root of the local list of 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 * 3) The copies_root[] array is indexed by lpid. Each entry contains the root of
71 *    the xlist of copies for a given process owned by cluster K.   
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    list_entry_t      local_root;             /*! root of list of process in cluster      */
81    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 informations, and cluster specific ressources
93 * managed by the local kernel instance.
94 ******************************************************************************************/
95
96typedef struct cluster_s
97{
98        spinlock_t        kcm_lock;           /*! local, protect creation of KCM allocators   */
99    remote_barrier_t  barrier;            /*! used to synchronize kernel parallel init    */
100    remote_spinlock_t txt0_lock;          /*! global, only cluster_io lock is used        */
101
102    // global parameters
103
104        uint32_t          paddr_width;        /*! numer of bits in physical address           */
105    uint32_t          x_width;            /*! number of bits to code x_size  (can be 0)   */
106    uint32_t          y_width;            /*! number of bits to code y_size  (can be 0)   */
107        uint32_t          x_size;             /*! number of clusters in a row    (can be 1)   */
108        uint32_t          y_size;             /*! number of clusters in a column (can be 1)   */
109        cxy_t             io_cxy;             /*! io cluster identifier                       */
110    uint32_t          dqdt_root_level;    /*! index of root node in dqdt_tbl[]            */
111
112    // local parameters
113
114        uint32_t          cores_nr;           /*! number of cores in cluster                  */
115    uint32_t          cores_in_kernel;    /*! number of cores currently in kernel mode    */
116
117        core_t            core_tbl[CONFIG_MAX_CORES_PER_CLUSTER];         /*! embedded cores  */
118
119        ppm_t             ppm;                /*! embedded kernel page manager                */
120        khm_t             khm;                /*! embedded kernel heap manager                */
121        kcm_t             kcm;                /*! embedded kernel cache manager (for KCMs)    */
122
123    kcm_t           * kcm_tbl[KMEM_TYPES_NR];         /*! pointers on allocated KCMs      */
124
125    uint32_t          ram_size;           /*! physical memory size                        */
126    uint32_t          ram_base;           /*! physical memory base (local address)        */
127
128        rpc_fifo_t        rpc_fifo;           /*! cluster RPC fifo (shared)                   */
129        list_entry_t      devlist;            /*! root of list of devices in cluster          */
130    struct device_s * icu;                /*! pointer on local XCU device                 */
131
132    int32_t           pages_var;          /*! pages number increment from last update     */
133    int32_t           threads_var;        /*! threads number increment from last update   */
134
135        dqdt_node_t       dqdt_tbl[CONFIG_MAX_DQDT_DEPTH];     /*! embedded DQDT nodes        */
136
137    pmgr_t            pmgr;               /*! embedded process manager                    */
138
139        char              name[CONFIG_SYSFS_NAME_LEN]; 
140        sysfs_entry_t     node;
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 value, 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 informations 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 cheks the validity of a cluster identifier. TODO useful ??? [AG]
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 * This function register sysfs information in cluster TODO ???  [AG]
185 *****************************************************************************************/
186void cluster_sysfs_register();
187
188
189/*****************************************************************************************/
190/***************   Process Management Operations   ***************************************/
191/*****************************************************************************************/
192
193/******************************************************************************************
194 * This function returns an extended pointer on the reference process descriptor
195 * from the process PID.  It can be called by any thread running in any cluster,
196 * as it uses a RPC to the owner cluster if the current cluster is not the owner.
197 ******************************************************************************************
198 * @ pid  : process identifier.
199 * @ return extended pointer on the reference process descriptor.
200 *****************************************************************************************/
201xptr_t cluster_get_reference_process_from_pid( pid_t pid );
202
203/******************************************************************************************
204 * This function allocates a new PID in local cluster, that becomes the process owner.
205 * It register the process descriptor extended pointer in the local processs manager
206 * pref_tbl[] array. This function is called by the rpc_process_alloc_pid() function for
207 * remote registration, or by the process_init_create() function for local registration.
208 ******************************************************************************************
209 * @ process    : [in]  extended pointer on the process descriptor.
210 * @ pid        : [out] allocated PID.
211 * @ return 0 if success / return EAGAIN if no PID slot available
212 *****************************************************************************************/
213error_t cluster_pid_alloc( xptr_t    process_xp,
214                           pid_t   * pid );
215
216/******************************************************************************************
217 * This function removes a PID from the local process manager pref_tbl[] array.
218 * It checks that removed process is owned by the local cluster and the lpid is legal.
219 * No memory is released by this function.
220 ******************************************************************************************
221 * @ pid        : allocated PID.
222 *****************************************************************************************/
223void cluster_pid_release( pid_t  pid );
224
225/******************************************************************************************
226 * This function returns a pointer on the local process descriptor from the PID.
227 * It uses the RPC
228 * to create a local process descriptor copy if it does not exist yet.
229 ******************************************************************************************
230 * @ pid     : searched process identifier.
231 * @ returns process descriptor pointer if found / returns NULL if not found.
232 *****************************************************************************************/
233struct process_s * cluster_get_local_process_from_pid( pid_t pid );
234
235/******************************************************************************************
236 * This function registers a local process descriptor in the process manager local_list.
237 ******************************************************************************************
238 * @ process     : pointer on local process descriptor.
239 *****************************************************************************************/
240void cluster_process_local_link( struct process_s * process ); 
241
242/******************************************************************************************
243 * This function removes a local process descriptor from the process manager local_list.
244 ******************************************************************************************
245 * @ process     : pointer on local process descriptor.
246 *****************************************************************************************/
247void cluster_process_local_unlink( struct process_s * process ); 
248
249/******************************************************************************************
250 * This function registers a local process descriptor in the owner process manager
251 * copies_list, that can be in a remote cluster.
252 ******************************************************************************************
253 * @ process     : pointer on local process descriptor.
254 *****************************************************************************************/
255void cluster_process_copies_link( struct process_s * process ); 
256
257/******************************************************************************************
258 * This function removes a local process descriptor from the owner process manager
259 * copies_list, that can be in a remote cluster.
260 ******************************************************************************************
261 * @ process     : pointer on local process descriptor.
262 *****************************************************************************************/
263void cluster_process_copies_unlink( struct process_s * process ); 
264
265
266
267/*****************************************************************************************/
268/***************   Cores Management Operations   *****************************************/
269/*****************************************************************************************/
270
271/******************************************************************************************
272 * This function increments the "cores_in_kernel" variable in cluster descriptor.
273 *****************************************************************************************/
274void cluster_core_kernel_enter();
275
276/******************************************************************************************
277 * This function decrements the "cores_in_kernel" variable in cluster descriptor.
278 *****************************************************************************************/
279void cluster_core_kernel_exit();
280
281/******************************************************************************************
282 * This function returns the core local index that has the lowest usage in local cluster.
283 *****************************************************************************************/
284lid_t cluster_select_local_core();
285
286#endif  /* _CLUSTER_H_ */
Note: See TracBrowser for help on using the repository browser.