source: trunk/kernel/kernel_config.h@ 607

Last change on this file since 607 was 607, checked in by alain, 8 years ago

Introduce new debug facilities.

File size: 20.9 KB
Line 
1/*
2 * kernel_config.h - global kernel configuration arguments
3 *
4 * Authors Mohamed Lamine Karaoui (2015)
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 _KERNEL_CONFIG_H_
26#define _KERNEL_CONFIG_H_
27
28#define CONFIG_ALMOS_VERSION "Version 1.1 / October 2018"
29
30////////////////////////////////////////////////////////////////////////////////////////////
31// KERNEL DEBUG
32// Each debug variable control one kernel function, or one small group of functions.
33// - trace is generated only when cycle > debug_value.
34// - detailed trace is enabled when (debug_value & Ox1) is non zero.
35////////////////////////////////////////////////////////////////////////////////////////////
36
37#define DEBUG_BARRIER 0
38
39#define DEBUG_BUSYLOCK 1
40#define DEBUG_BUSYLOCK_THREAD_XP 0x0000000000ULL // selected thread xptr
41
42#define DEBUG_CHDEV_CMD_RX 0
43#define DEBUG_CHDEV_CMD_TX 0
44#define DEBUG_CHDEV_SERVER_RX 0
45#define DEBUG_CHDEV_SERVER_TX 0
46
47#define DEBUG_CLUSTER_INIT 0
48#define DEBUG_CLUSTER_PID_ALLOC 0
49#define DEBUG_CLUSTER_PID_RELEASE 0
50#define DEBUG_CLUSTER_PROCESS_COPIES 0
51
52#define DEBUG_DEV_TXT_RX 0
53#define DEBUG_DEV_TXT_TX 0
54#define DEBUG_DEV_IOC_RX 0
55#define DEBUG_DEV_IOC_TX 0
56#define DEBUG_DEV_NIC_RX 0
57#define DEBUG_DEV_NIC_RX 0
58#define DEBUG_DEV_FBF_RX 0
59#define DEBUG_DEV_FBF_TX 0
60#define DEBUG_DEV_DMA 0
61#define DEBUG_DEV_MMC 0
62#define DEBUG_DEV_PIC 0
63
64#define DEBUG_DEVFS_INIT 0
65#define DEBUG_DEVFS_MOVE 0
66
67#define DEBUG_ELF_LOAD 0
68
69#define DEBUG_DQDT_INIT 0
70#define DEBUG_DQDT_UPDATE_THREADS 0
71#define DEBUG_DQDT_SELECT_FOR_PROCESS 0
72#define DEBUG_DQDT_UPDATE_PAGES 0
73#define DEBUG_DQDT_SELECT_FOR_MEMORY 0
74
75#define DEBUG_FATFS_ADD_DENTRY 0
76#define DEBUG_FATFS_CHILD_INIT 0
77#define DEBUG_FATFS_CLUSTER_ALLOC 0
78#define DEBUG_FATFS_CTX_INIT 0
79#define DEBUG_FATFS_FREE_CLUSTERS 0
80#define DEBUG_FATFS_GET_CLUSTER 0
81#define DEBUG_FATFS_MOVE_PAGE 0
82#define DEBUG_FATFS_RELEASE_INODE 0
83#define DEBUG_FATFS_REMOVE_DENTRY 1
84#define DEBUG_FATFS_SYNC_FAT 0
85#define DEBUG_FATFS_SYNC_FSINFO 0
86#define DEBUG_FATFS_SYNC_INODE 0
87
88#define DEBUG_HAL_GPT_SET_PTE 0
89#define DEBUG_HAL_GPT_COPY 0
90#define DEBUG_HAL_GPT_CREATE 0
91#define DEBUG_HAL_GPT_DESTROY 0
92
93#define DEBUG_HAL_KENTRY 0
94#define DEBUG_HAL_EXCEPTIONS 0
95#define DEBUG_HAL_IRQS 0
96#define DEBUG_HAL_TXT_RX 0
97#define DEBUG_HAL_TXT_TX 0
98#define DEBUG_HAL_IOC_RX 0
99#define DEBUG_HAL_IOC_TX 0
100
101#define DEBUG_KCM 0
102#define DEBUG_KMEM 0
103
104#define DEBUG_KERNEL_INIT 0
105
106#define DEBUG_MAPPER_GET_PAGE 1
107#define DEBUG_MAPPER_HANDLE_MISS 0
108#define DEBUG_MAPPER_MOVE_USER 0
109#define DEBUG_MAPPER_MOVE_KERNEL 0
110
111#define DEBUG_MUTEX 0
112
113#define DEBUG_PPM_ALLOC_PAGES 0
114#define DEBUG_PPM_FREE_PAGES 0
115
116#define DEBUG_PROCESS_COPY_INIT 0
117#define DEBUG_PROCESS_DESTROY 0
118#define DEBUG_PROCESS_GET_LOCAL_COPY 0
119#define DEBUG_PROCESS_INIT_CREATE 0
120#define DEBUG_PROCESS_MAKE_EXEC 0
121#define DEBUG_PROCESS_MAKE_FORK 0
122#define DEBUG_PROCESS_REFERENCE_INIT 0
123#define DEBUG_PROCESS_SIGACTION 0
124#define DEBUG_PROCESS_TXT 0
125#define DEBUG_PROCESS_ZERO_CREATE 0
126
127#define DEBUG_QUEUELOCK 0
128
129#define DEBUG_RPC_CLIENT_GENERIC 0
130#define DEBUG_RPC_SERVER_GENERIC 0
131
132#define DEBUG_RPC_KCM_ALLOC 0
133#define DEBUG_RPC_KCM_FREE 0
134#define DEBUG_RPC_MAPPER_rGT_PAGE 0
135#define DEBUG_RPC_MAPPER_MOVE_USER 0
136#define DEBUG_RPC_PMEM_GET_PAGES 0
137#define DEBUG_RPC_PMEM_RELEASE_PAGES 0
138#define DEBUG_RPC_PROCESS_MAKE_FORK 0
139#define DEBUG_RPC_PROCESS_SIGACTION 0
140#define DEBUG_RPC_THREAD_USER_CREATE 0
141#define DEBUG_RPC_THREAD_KERNEL_CREATE 0
142#define DEBUG_RPC_VFS_INODE_CREATE 0
143#define DEBUG_RPC_VFS_INODE_DESTROY 0
144#define DEBUG_RPC_VFS_DENTRY_CREATE 0
145#define DEBUG_RPC_VFS_DENTRY_DESTROY 0
146#define DEBUG_RPC_VFS_FILE_CREATE 0
147#define DEBUG_RPC_VFS_FILE_DESTROY 0
148#define DEBUG_RPC_VFS_DEVICE_GET_DENTRY 0
149#define DEBUG_RPC_VMM_GET_PTE 0
150#define DEBUG_RPC_VMM_GET_VSEG 0
151
152#define DEBUG_RWLOCK 0
153
154#define DEBUG_SCHED_HANDLE_SIGNALS 2
155#define DEBUG_SCHED_YIELD 2 // must be activated by the trace() syscall
156#define DEBUG_SCHED_RPC_ACTIVATE 0
157
158#define DEBUG_SEM 0
159
160#define DEBUG_SYSCALLS_ERROR 2
161
162#define DEBUG_SYS_BARRIER 0
163#define DEBUG_SYS_CLOSE 0
164#define DEBUG_SYS_CONDVAR 0
165#define DEBUG_SYS_DISPLAY 0
166#define DEBUG_SYS_EXEC 0
167#define DEBUG_SYS_EXIT 0
168#define DEBUG_SYS_FG 0
169#define DEBUG_SYS_FORK 0
170#define DEBUG_SYS_GET_CONFIG 0
171#define DEBUG_SYS_GETPID 0
172#define DEBUG_SYS_ISATTY 0
173#define DEBUG_SYS_IS_FG 0
174#define DEBUG_SYS_KILL 0
175#define DEBUG_SYS_OPEN 0
176#define DEBUG_SYS_MMAP 0
177#define DEBUG_SYS_MUNMAP 0
178#define DEBUG_SYS_MUTEX 0
179#define DEBUG_SYS_READ 0
180#define DEBUG_SYS_SEM 0
181#define DEBUG_SYS_STAT 0
182#define DEBUG_SYS_THREAD_CANCEL 0
183#define DEBUG_SYS_THREAD_CREATE 0
184#define DEBUG_SYS_THREAD_EXIT 0
185#define DEBUG_SYS_THREAD_JOIN 0
186#define DEBUG_SYS_THREAD_SLEEP 0
187#define DEBUG_SYS_THREAD_WAKEUP 0
188#define DEBUG_SYS_THREAD_YIELD 0
189#define DEBUG_SYS_TRACE 0
190#define DEBUG_SYS_UNLINK 0
191#define DEBUG_SYS_WAIT 0
192#define DEBUG_SYS_WRITE 0
193
194#define DEBUG_THREAD_BLOCK 0
195#define DEBUG_THREAD_DELETE 0
196#define DEBUG_THREAD_DESTROY 0
197#define DEBUG_THREAD_GET_XPTR 0
198#define DEBUG_THREAD_IDLE 0
199#define DEBUG_THREAD_INIT 0
200#define DEBUG_THREAD_KERNEL_CREATE 0
201#define DEBUG_THREAD_USER_CREATE 0
202#define DEBUG_THREAD_USER_FORK 0
203#define DEBUG_THREAD_USER_EXEC 0
204
205#define DEBUG_VFS_ADD_CHILD 0
206#define DEBUG_VFS_CLOSE 0
207#define DEBUG_VFS_DENTRY_CREATE 0
208#define DEBUG_VFS_INODE_CREATE 0
209#define DEBUG_VFS_INODE_LOAD_ALL 0
210#define DEBUG_VFS_LOOKUP 0
211#define DEBUG_VFS_LSEEK 0
212#define DEBUG_VFS_NEW_CHILD_INIT 0
213#define DEBUG_VFS_OPEN 0
214#define DEBUG_VFS_STAT 0
215#define DEBUG_VFS_UNLINK 1
216
217#define DEBUG_VMM_CREATE_VSEG 0
218#define DEBUG_VMM_DESTROY 0
219#define DEBUG_VMM_FORK_COPY 0
220#define DEBUG_VMM_GET_ONE_PPN 0
221#define DEBUG_VMM_GET_PTE 0
222#define DEBUG_VMM_HANDLE_PAGE_FAULT 0
223#define DEBUG_VMM_HANDLE_COW 0
224#define DEBUG_VMM_INIT 0
225#define DEBUG_VMM_PAGE_ALLOCATE 0
226#define DEBUG_VMM_SET_COW 0
227#define DEBUG_VMM_UNMAP_VSEG 0
228#define DEBUG_VMM_UPDATE_PTE 0
229
230#define DEBUG_XHTAB 0
231
232
233////////////////////////////////////////////////////////////////////////////////////////////
234// KERNEL LOCKS TYPES MNEMONICS (for debug)
235// It must be kept consistent with the lock_name[] array defined in kernel_init.c file.
236////////////////////////////////////////////////////////////////////////////////////////////
237
238#define LOCK_CLUSTER_KCM 1 // local (B) protect dynamic KCM creation in cluster
239#define LOCK_PPM_FREE 2 // local (B) protect PPM allocator free_pages lists
240#define LOCK_SCHED_STATE 3 // local (B) protect scheduler state for given core
241#define LOCK_VMM_STACK 4 // local (B) protect VMM stack vseg allocator
242#define LOCK_VMM_MMAP 5 // local (B) protect VMM mmap vseg allocator
243#define LOCK_VFS_CTX 6 // local (B) protect vfs context state
244#define LOCK_KCM_STATE 7 // local (B) protect KCM allocator state
245#define LOCK_KHM_STATE 8 // local (B) protect KHM allocator state
246#define LOCK_HTAB_STATE 9 // local (B) protect a local htab state
247
248#define LOCK_THREAD_JOIN 10 // remote (B) protect join/exit between two threads
249#define LOCK_VFS_MAIN 11 // remote (B) protect vfs traversal (one per inode)
250#define LOCK_CHDEV_QUEUE 12 // remote (B) protect chdev threads waiting queue
251#define LOCK_CHDEV_TXT0 13 // remote (B) protect access to kernel terminal TXT0
252#define LOCK_CHDEV_TXTLIST 14 // remote (B) protect xlist of processes using same TXT
253#define LOCK_PAGE_STATE 15 // remote (B) protect physical page descriptor state
254#define LOCK_MUTEX_STATE 16 // remote (B) protect user mutex state
255#define LOCK_CONDVAR_STATE 17 // remote (B) protect user condvar state
256#define LOCK_SEM_STATE 18 // remote (B) protect user semaphore state
257#define LOCK_XHTAB_STATE 19 // remote (B) protect a distributed xhatb state
258
259#define BUSYLOCK_TYPE_MAX 20
260
261#define LOCK_CLUSTER_PREFTBL 21 // local (Q) protect array of ref. processes in cluster
262
263#define LOCK_PPM_DIRTY 22 // remote (Q) protect PPM dirty_pages list
264#define LOCK_CLUSTER_LOCALS 23 // remote (Q) protect xlist of local processes in cluster
265#define LOCK_CLUSTER_COPIES 24 // remote (Q) protect xlist of process copies in cluster
266#define LOCK_PROCESS_CHILDREN 25 // remote (Q) protect xlist of chidren process in process
267#define LOCK_PROCESS_USERSYNC 26 // remote (Q) protect all lists of user synchros in process
268#define LOCK_PROCESS_FDARRAY 27 // remote (Q) protect array of open files in owner process
269#define LOCK_FATFS_FREE 28 // remote (Q) protect the FATFS context (free clusters)
270
271#define LOCK_PROCESS_THTBL 29 // local (RW) protect local array of threads in a process
272
273#define LOCK_MAPPER_STATE 30 // remote (RW) protect mapper state
274#define LOCK_PROCESS_CWD 31 // remote (RW) protect current working directory in process
275#define LOCK_VFS_INODE 32 // remote (RW) protect inode state and associated mapper
276#define LOCK_VFS_FILE 33 // remote (RW) protect file descriptor state
277#define LOCK_VMM_VSL 34 // remote (RW) protect VSL (local list of vsegs)
278#define LOCK_VMM_GPT 35 // remote (RW) protect GPT (local page table)
279
280
281////////////////////////////////////////////////////////////////////////////////////////////
282// HARDWARE CONFIGURATION
283////////////////////////////////////////////////////////////////////////////////////////////
284
285#define CONFIG_KERNEL_IDENTITY_MAP true // True for 32 bits cores
286#define CONFIG_MAX_CLUSTERS_X 16 // max number of clusters in row
287#define CONFIG_MAX_CLUSTERS_Y 16 // max number of clusters in column
288#define CONFIG_MAX_CLUSTERS (CONFIG_MAX_CLUSTERS_X * CONFIG_MAX_CLUSTERS_Y)
289#define CONFIG_MAX_LOCAL_CORES 4 // max number of cores per cluster
290#define CONFIG_MAX_INT_DEV 4 // max number of internal peripherals
291#define CONFIG_MAX_EXT_DEV 8 // max number of external peripherals
292#define CONFIG_MAX_INTERNAL_IRQS 32 // max number of internal IRQs
293#define CONFIG_MAX_EXTERNAL_IRQS 32 // max number of external IRQs
294#define CONFIG_IRQS_PER_CORE 4 // number of input IRQs per core
295#define CONFIG_CLUSTER_SPAN 32 // ln(phys. address space per cluster)
296#define CONFIG_CACHE_LINE_SIZE 64 // number of bytes in cache line
297
298#define CONFIG_CACHE_LINE_ALIGNED __attribute__((aligned(CONFIG_CACHE_LINE_SIZE)))
299
300#define CONFIG_MAX_IOC_CHANNELS 1 // max number of IOC device channels
301#define CONFIG_MAX_FBF_CHANNELS 1 // max number of FBF device channels
302#define CONFIG_MAX_TXT_CHANNELS 8 // max number of TXT device channels
303#define CONFIG_MAX_DMA_CHANNELS 4 // max number of DMA device channels
304#define CONFIG_MAX_NIC_CHANNELS 4 // max number of NIC device channels
305
306#define CONFIG_TXT_ECHO_MODE 1 // echo mode for TXT peripheral
307#define CONFIG_TXT_KBUF_SIZE 512 // kernel buffer for TXT write
308
309#define CONFIG_FBF_WIDTH 128
310#define CONFIG_FBF_HEIGHT 128
311
312#define CONFIG_CPU_CTX_SIZE 256 // up to 64 uint32_t registers
313#define CONFIG_FPU_CTX_SIZE 256 // up to 32 uint64_t registers
314#define CONFIG_NIC_CHBUF_DEPTH 1 // number of containers in NIC chbuf
315
316////////////////////////////////////////////////////////////////////////////////////////////
317// PROCESS MANAGEMENT
318////////////////////////////////////////////////////////////////////////////////////////////
319
320#define CONFIG_MAX_PROCESS_PER_CLUSTER 16 // max number of owned process
321#define CONFIG_PROCESS_FILE_MAX_NR 16 // max number of open files
322#define CONFIG_PROCESS_MAX_CHILDREN 1024 // max number of children process
323#define CONFIG_PROCESS_HEAP_MIN_SIZE 0x00010000 // user heap min size (bytes)
324#define CONFIG_PROCESS_HEAP_MAX_SIZE 0x30000000 // user heap max size (bytes)
325#define CONFIG_PROCESS_INIT_PATH "/bin/user/init.elf"
326
327////////////////////////////////////////////////////////////////////////////////////////////
328// VIRTUAL FILE SYSTEM
329////////////////////////////////////////////////////////////////////////////////////////////
330
331#define CONFIG_VFS_MAX_INODES 128 // max number of inodes per cluster
332#define CONFIG_VFS_MAX_NAME_LENGTH 32 // dentry name max length (bytes)
333#define CONFIG_VFS_MAX_PATH_LENGTH 256 // pathname max length (bytes)
334#define CONFIG_VFS_FREE_CLUSTERS_MIN 32 // min number of free clusters
335
336
337#define CONFIG_VFS_ROOT_IS_FATFS 1 // root FS is FATFS if non zero
338#define CONFIG_VFS_ROOT_IS_EX2FS 0 // root FS is EX2FS if non zero
339
340////////////////////////////////////////////////////////////////////////////////////////////
341// DQDT
342////////////////////////////////////////////////////////////////////////////////////////////
343
344#define CONFIG_DQDT_LEVELS_NR 5
345#define CONFIG_DQDT_TICKS_PER_QUANTUM 1 // number of ticks between updates
346
347////////////////////////////////////////////////////////////////////////////////////////////
348// RANDOM NUMBERS
349////////////////////////////////////////////////////////////////////////////////////////////
350
351#define CONFIG_RDNG_PARAM_A 65519
352#define CONFIG_RDNG_PARAM_C 64037
353
354////////////////////////////////////////////////////////////////////////////////////////////
355// SCHEDULING
356////////////////////////////////////////////////////////////////////////////////////////////
357
358#define CONFIG_SCHED_TICK_MS_PERIOD 10000 // number of milliseconds per period
359#define CONFIG_SCHED_TICKS_PER_QUANTUM 1 // number of ticks between scheduling
360#define CONFIG_SCHED_MAX_THREADS_NR 32 // max number of threads per core
361#define CONFIG_SCHED_IDLE_MODE_SLEEP 0 // idle thread use sleep mode if non 0
362
363////////////////////////////////////////////////////////////////////////////////////////////
364// THREADS
365////////////////////////////////////////////////////////////////////////////////////////////
366
367#define CONFIG_THREADS_MAX_PER_CLUSTER 32 // max threads per cluster per process
368#define CONFIG_THREAD_DESC_SIZE 0x4000 // thread desc size (with kernel stack)
369#define CONFIG_THREAD_DESC_ORDER 2 // ln( number of 4K pages )
370
371////////////////////////////////////////////////////////////////////////////////////////////
372// REMOTE PROCEDURE CALL
373////////////////////////////////////////////////////////////////////////////////////////////
374
375#define CONFIG_REMOTE_FIFO_SLOTS 16
376#define CONFIG_REMOTE_FIFO_MAX_ITERATIONS 1024
377#define CONFIG_RPC_THREADS_MAX 4 // max number of RPC threads per core
378
379////////////////////////////////////////////////////////////////////////////////////////////
380// MAPPER
381////////////////////////////////////////////////////////////////////////////////////////////
382
383#define CONFIG_MAPPER_MAX_FRAGMENTS 10 // max number of fragments moved
384#define CONFIG_MAPPER_MIN CONFIG_VFS_INODE_MIN
385#define CONFIG_MAPPER_MAX CONFIG_VFS_INODE_MAX
386#define CONFIG_MAPPER_GRDXT_W1 7 // number of bits for RADIX_TREE_IX1
387#define CONFIG_MAPPER_GRDXT_W2 7 // number of bits for RADIX_TREE_IX2
388#define CONFIG_MAPPER_GRDXT_W3 6 // number of bits for RADIX_TREE_IX3
389
390////////////////////////////////////////////////////////////////////////////////////////////
391// USER SPACE SEGMENTATION / all values are number of pages
392////////////////////////////////////////////////////////////////////////////////////////////
393
394#define CONFIG_VMM_VSPACE_SIZE 0x100000 // virtual space : 4 Gbytes
395
396#define CONFIG_VMM_KENTRY_BASE 0x000004 // UTILS zone base : 16 Kbytes
397#define CONFIG_VMM_ELF_BASE 0x000400 // ELF zone base : 4 Mbytes
398#define CONFIG_VMM_HEAP_BASE 0x002000 // HEAP zone base : 32 Mbytes
399#define CONFIG_VMM_STACK_BASE 0x0C0000 // STACK zone base : 3 Gbytes
400
401#define CONFIG_VMM_KENTRY_SIZE 0x000004 // kentry vseg size : 16 Kbytes
402#define CONFIG_VMM_ARGS_SIZE 0x000004 // args vseg size : 16 Kbytes
403#define CONFIG_VMM_ENVS_SIZE 0x000008 // envs vseg size : 32 Kbytes
404#define CONFIG_VMM_STACK_SIZE 0x000100 // single stack vseg size : 1 Mbytes
405
406////////////////////////////////////////////////////////////////////////////////////////////
407// PHYSICAL MEMORY MANAGEMENT (GENERIC)
408////////////////////////////////////////////////////////////////////////////////////////////
409
410#define CONFIG_PPM_PAGE_SIZE 4096 // physical page size (bytes)
411#define CONFIG_PPM_PAGE_SHIFT 12 // physical page shift (bits)
412#define CONFIG_PPM_PAGE_MASK 0x00000FFF // physical page mask
413#define CONFIG_PPM_MAX_ORDER 16 // ln(total number of pages per cluster)
414#define CONFIG_PPM_HEAP_ORDER 10 // ln(number of heap pages per cluster)
415#define CONFIG_PPM_MAX_RSVD 32 // max reserved zones on the machine
416
417#define CONFIG_KCM_SLOT_SIZE 64 // smallest allocated block (bytes)
418
419#define CONFIG_PPM_PAGE_ALIGNED __attribute__((aligned(CONFIG_PPM_PAGE_SIZE)))
420
421
422////////////////////////////////////////////////////////////////////////////////////////////
423// INSTRUMENTATION
424////////////////////////////////////////////////////////////////////////////////////////////
425
426#define CONFIG_INTRUMENTATION_SYSCALLS 0
427
428
429
430
431
432#endif /* _KERNEL_CONFIG_H_ */
Note: See TracBrowser for help on using the repository browser.