source: trunk/libs/libalmosmkh/almosmkh.h @ 580

Last change on this file since 580 was 580, checked in by alain, 3 years ago

1) Register the kernel process in the cluster manager local list.
2) Introduce a new service in idbg : display the set of busylocks taken by a given thread.

File size: 19.7 KB
Line 
1/*
2 * almosmkh.h - User level ALMOS-MKH specific library definition.
3 *
4 * Author     Alain Greiner (2016,2017,2018)
5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MKH.
9 *
10 * ALMOS-MKH is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2.0 of the License.
13 *
14 * ALMOS-MKH is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#ifndef _LIBALMOSMKH_H_
25#define _LIBALMOSMKH_H_
26
27/***************************************************************************************
28 * This file defines an user level, ALMOS-MKH specific library, containing:
29 * - non standard system calls.
30 * - debug functions.
31 * - remote malloc extensions.
32 **************************************************************************************/
33
34#include <pthread.h>
35#include <shared_almos.h>
36
37/****************** Non standard (ALMOS_MKH specific) system calls ********************/
38
39
40/***************************************************************************************
41 * This function is used to give the process identified by the <pid> argument the
42 * exclusive ownership of its TXT terminal.
43 ***************************************************************************************
44 * @ pid        : process identifier.
45 * @ returns O if success / returns -1 if process not found.
46 **************************************************************************************/
47int fg( unsigned int pid );
48
49/***************************************************************************************
50 * This function stores in the buffer identified by the <owner> argument a non zero
51 * value when the process identified by the <pid> argument is currently the exclusive
52 * owner of its TXT terminal.
53 ***************************************************************************************
54 * @ pid        : [in]  process identifier.
55 * @ owner      : [out] pointer on buffer to store the
56 * @ returns O if success / returns -1 if process not found.
57 **************************************************************************************/
58int is_fg( unsigned int pid,
59           unsigned int * owner );
60
61/***************************************************************************************
62 * This function returns the hardware platform parameters.
63 ***************************************************************************************
64 * @ x_size   : [out] number of clusters in a row.
65 * @ y_size   : [out] number of clusters in a column.
66 * @ ncores   : [out] number of cores per cluster.
67 * @ return always 0.
68 **************************************************************************************/
69int get_config( unsigned int * x_size,
70                unsigned int * y_size,
71                unsigned int * ncores );
72
73/***************************************************************************************
74 * This function returns the cluster an local index for the calling core.
75 ***************************************************************************************
76 * @ cxy      : [out] cluster identifier.
77 * @ lid      : [out] core local index in cluster.
78 * @ return always 0.
79 **************************************************************************************/
80int get_core( unsigned int * cxy,
81              unsigned int * lid );
82
83/***************************************************************************************
84 * This function returns the calling core cycles counter,
85 * taking into account a possible overflow on 32 bits architectures.
86 ***************************************************************************************
87 * @ cycle    : [out] current cycle value.
88 * @ return always 0.
89 **************************************************************************************/
90int get_cycle( unsigned long long * cycle );
91
92/***************************************************************************************
93 * This function implement the operations related to User Thread Local Storage.
94 ***************************************************************************************
95 * @ operation  : UTLS operation type as defined in "shared_sycalls.h" file.
96 * @ value      : argument value for the UTLS_SET operation.
97 * @ return value for the UTLS_GET and UTLS_GET_ERRNO / return -1 if failure.
98 **************************************************************************************/
99int utls( unsigned int operation,
100          unsigned int value );
101
102/***************************************************************************************
103 * This function returns an unsigned 32 bits integer from the standard "stdin" stream.
104 * Both decimal numbers and hexadecimal numbers (prefixed by 0x) are supported.
105 ***************************************************************************************
106 * returns the integer value if success / returns -1 if failure.
107 **************************************************************************************/
108unsigned int getint32( void );
109
110
111/***************** Non standard (ALMOS-MKH specific) debug functions ******************/
112
113
114/***************************************************************************************
115 * This debug function displays on the kernel terminal TXT0
116 * the thread / process / core identifiers, the current cycle, plus a user defined
117 * message as specified by the <string> argument.
118 ***************************************************************************************
119 * @ string    : [in] user defined message.
120 **************************************************************************************/
121void display_string( char * string );
122
123/***************************************************************************************
124 * This debug function displays on the kernel terminal TXT0
125 * the state of the  VMM for the process <pid>, in cluster <cxy>.
126 * It can be called by any thread running in any cluster.
127 ***************************************************************************************
128 * @ pid      : [in] process identifier.
129 * @ return 0 if success / return -1 if illegal argument.
130 **************************************************************************************/
131int display_vmm(unsigned int cxy, unsigned int  pid );
132
133/***************************************************************************************
134 * This debug function displays on the kernel terminal TXT0
135 * the state of the core scheduler identified by the <cxy> and <lid> arguments.
136 * It can be called by any thread running in any cluster.
137 ***************************************************************************************
138 * @ cxy      : [in] target cluster identifier.
139 * @ lid      : [in] target core local index.
140 * @ return 0 if success / return -1 if illegal arguments.
141 **************************************************************************************/
142int display_sched( unsigned int  cxy,
143                   unsigned int  lid );
144
145/***************************************************************************************
146 * This debug function displays on the kernel terminal TXT0
147 * the list of process registered in a given cluster identified by the <cxy> argument.
148 * It can be called by any thread running in any cluster.
149 ***************************************************************************************
150 * @ cxy      : [in] target cluster identifier.
151 * @ return 0 if success / return -1 if illegal argument.
152 **************************************************************************************/
153int display_cluster_processes( unsigned int  cxy );
154
155/***************************************************************************************
156 * This debug function displays on the kernel terminal TXT0
157 * the list of processes attached to a given TXT channel.
158 * It can be called by any thread running in any cluster.
159 ***************************************************************************************
160 * @ txt_id   : [in] TXT terminal indes.
161 * @ return 0 if success / return -1 if illegal argument.
162 **************************************************************************************/
163int display_txt_processes( unsigned int txt_id );
164
165/***************************************************************************************
166 * This debug function displays on the kernel terminal TXT0
167 * the list of channel devices available in the architecture.
168 * It can be called by any thread running in any cluster.
169 ***************************************************************************************
170 * @ return always 0.
171 **************************************************************************************/
172int display_chdev( void );
173
174/***************************************************************************************
175 * This debug function displays on the kernel terminal TXT0
176 * the list of channel device or pseudo-files registered in the VFS cache.
177 * It can be called by any thread running in any cluster.
178 ***************************************************************************************
179 * @ return always 0.
180 **************************************************************************************/
181int display_vfs( void );
182
183/***************************************************************************************
184 * This debug function displays on the kernel terminal TXT0 the current DQDT state.
185 * It can be called by any thread running in any cluster.
186 ***************************************************************************************
187 * @ return always 0.
188 **************************************************************************************/
189int display_dqdt( void );
190
191/*****************************************************************************************
192* This debug function is used to activate / desactivate the context switches trace
193* for a core identified by the <cxy> and <lid> arguments.
194* It can be called by any thread running in any cluster.
195*****************************************************************************************
196* @ active     : activate trace if non zero / desactivate if zero.
197* @ cxy        : cluster identifier.
198* @ lid        : core local index.
199* @ returns O if success / returns -1 if illegal arguments.
200****************************************************************************************/
201int trace( unsigned int active,
202           unsigned int cxy, 
203           unsigned int lid );
204
205/****************************************************************************************
206 * This blocking function implements an user-level interactive debugger that can be
207 * introduced in any user application to display various kernel distributed structures.
208 * The supported commands are:
209 * - p (cxy)     : display all processes descriptors in a given cluster.
210 * - s (cxy,lid) : display all threads attached to a given core in a given cluster.
211 * - v (cxy)     : display the calling process VMM in a given cluster.
212 * - t (tid)     : display all owner process descriptors attached to a TXT terminal.
213 * - x           : force the calling process to exit.
214 * - c           : continue calling process execution.
215 * - h           : list the supported commands
216 ***************************************************************************************/
217void idbg( void );
218
219
220/****************** Non standard (ALMOS-MKH specific) malloc operations  ***************/
221
222/////////////////////////////////////////////////////////////////////////////////////////
223// General principles:
224// - In user space the HEAP zone spread between the ELF zone and the STACK zone,
225//   as defined in the kernel_config.h file.
226// - The malloc library uses the mmap() syscall to create - on demand -
227//   one vseg in a given cluster. The size of this vseg is defined below
228//   by the MALLOC_LOCAL_STORE_SIZE parameter.
229// - For a standard malloc(), the target cluster is the cluster containing
230//   the core running the client thread.
231// - For a remote_malloc(), the target cluster is explicitely defined
232//   by the argument.
233// - In each cluster, the available storage in virtual space is handled by a
234//   local allocator using the buddy algorithm.
235//
236// TODO : In this first implementation one single - fixed size - vseg
237//        is allocated on demand in each cluster.
238//        We should introduce the possibility to dynamically allocate
239//        several vsegs in each cluster, using several mmap when required.
240/////////////////////////////////////////////////////////////////////////////////////////
241// Free blocks organisation in each cluster :
242// - All free blocks have a size that is a power of 2, larger or equal
243//   to MALLOC_MIN_BLOCK_SIZE (typically 64 bytes).
244// - All free blocks are aligned.
245// - They are pre-classed in an array of linked lists, where all blocks in a
246//   given list have the same size.
247// - The NEXT pointer implementing those linked lists is written
248//   in the first bytes of the block itself, using the unsigned int type.
249// - The pointers on the first free block for each size are stored in an
250//   array of pointers free[32] in the storage(x,y) descriptor.
251/////////////////////////////////////////////////////////////////////////////////////////
252// Allocation policy:
253// - The block size required by the user can be any value, but the allocated
254//   block size can be larger than the requested size:
255// - The allocator computes actual_size, that is the smallest power of 2
256//   value larger or equal to the requested size AND larger or equal to
257//   MALLOC_MIN_BLOCK_SIZE.
258// - It pop the linked list of free blocks corresponding to actual_size,
259//   and returns the block B if the list[actual_size] is not empty.
260// - If the list[actual_size] is empty, it pop the list[actual_size * 2].
261//   If a block B' is found, it breaks this block in 2 B/2 blocks, returns
262//   the first B/2 block and push the other B/2 block into list[actual_size].
263// - If the list[actual_size * 2] is empty, it pop the list[actual_size * 4].
264//   If a block B is found, it break this block in 3 blocks B/4, B/4 and B/2,
265//   returns the first B/4 block, push the other blocks B/4 and B/2 into
266//   the proper lists. etc...
267// - If no block satisfying the request is available it returns a failure
268//   (NULL pointer).
269// - This allocation policy has the nice following property:
270//   If the vseg is aligned (the vseg base is a multiple of the
271//   vseg size), all allocated blocks are aligned on the actual_size.
272/////////////////////////////////////////////////////////////////////////////////////////
273// Free policy:
274// - Each allocated block is registered in an alloc[] array of unsigned char.
275// - This registration is required by the free() operation, because the size
276//   of the allocated block must be obtained from the base address of the block. 
277// - The number of entries in this array is equal to the max number
278//   of allocated block : MALLOC_LOCAL_STORE_SIZE / MALLOC_MIN_BLOCK_SIZE.
279// - For each allocated block, the value registered in the alloc[] array
280//   is log2( size_of_allocated_block ).
281// - The index in this array is computed from the allocated block base address:
282//      index = (block_base - vseg_base) / MALLOC_MIN_BLOCK_SIZE
283// - The alloc[] array is stored at the end of heap segment. This consume
284//   (1 / MALLOC_MIN_BLOCK_SIZE) of the total storage capacity.
285/////////////////////////////////////////////////////////////////////////////////////////
286
287
288#define MALLOC_INITIALIZED         0xBABEF00D   // magic number when initialised
289#define MALLOC_MIN_BLOCK_SIZE      0x40         // 64 bytes
290#define MALLOC_LOCAL_STORE_SIZE    0x800000     // 8 Mbytes     
291#define MALLOC_MAX_CLUSTERS        0x100        // 256 clusters
292
293/////////////////////////////////////////////////////////////////////////////////////////
294//               store(x,y) descriptor (one per cluster)
295/////////////////////////////////////////////////////////////////////////////////////////
296
297typedef struct malloc_store_s
298{
299    pthread_mutex_t mutex;           // lock protecting exclusive access to local heap
300    unsigned int    initialized;     // initialised when value == MALLOC_INITIALIZED
301    unsigned int    cxy;             // cluster identifier 
302    unsigned int    store_base;      // store base address
303    unsigned int    store_size;      // store size (bytes)
304    unsigned int    alloc_base;      // alloc[] array base address
305    unsigned int    alloc_size;      // alloc[] array size (bytes)
306    unsigned int    free[32];        // array of addresses of first free block
307} 
308malloc_store_t;
309
310/*****************************************************************************************
311 * This function allocates <size> bytes of memory in user space, and returns a pointer
312 * to the allocated buffer. The pysical memory is allocated from store located in
313 * cluster identified by the <cxy> argument.
314 *****************************************************************************************
315 * @ size    : number of requested bytes.
316 * @ cxy     : target cluster identifier.
317 * @ returns a pointer on the allocated buffer if success / returns NULL if failure
318 ****************************************************************************************/
319void * remote_malloc( unsigned int size, 
320                      unsigned int cxy );
321
322/*****************************************************************************************
323 * This function releases the memory buffer identified by the <ptr> argument,
324 * to the store identified by the <cxy> argument.
325 * It displays an error message, but does nothing if the ptr is illegal.
326 *****************************************************************************************
327 * @ ptr   : pointer on the released buffer.
328 * @ cxy   : target cluster identifier.
329 ****************************************************************************************/
330void remote_free( void        * ptr,
331                  unsigned int  cxy );
332
333/*****************************************************************************************
334 * This function releases the memory buffer identified by the <ptr> argument,
335 * to the store located in cluster identified by the <cxy> argument, and allocates
336 * a new buffer containing <size> bytes from this store.
337 * The content of the old buffer is copied to the new buffer, up to <size> bytes.
338 * It displays an error message, but does nothing if the ptr is illegal.
339 *****************************************************************************************
340 * @ ptr     : pointer on the released buffer.
341 * @ size    : new buffer requested size (bytes).
342 * @ cxy     : target cluster identifier.
343 * @ return a pointer on allocated buffer if success / return NULL if failure
344 ****************************************************************************************/
345void * remote_realloc( void        * ptr,
346                       unsigned int  size,
347                       unsigned int  cxy );
348
349/*****************************************************************************************
350 * This function allocates enough space for <count> objects that are <size> bytes
351 * of memory each from the store located in cluster identied by the <cxy> argument.
352 * The allocated memory is filled with bytes of value zero.
353 *****************************************************************************************
354 * @ count   : number of requested objects.
355 * @ size    : number of bytes per object.
356 * @ cxy     : target cluster identifier.
357 * @ returns a pointer on allocated buffer if success / returns NULL if failure
358 ****************************************************************************************/
359void * remote_calloc( unsigned int count,
360                      unsigned int size,
361                      unsigned int cxy );
362
363#endif /* _LIBALMOSMKH_H_ */
364
Note: See TracBrowser for help on using the repository browser.