source: trunk/kernel/kern/printk.h @ 374

Last change on this file since 374 was 374, checked in by max@…, 8 years ago

Use panic().
File size: 9.0 KB
Line 
1/*
2 * printk.h - Kernel Log & debug messages API definition.
3 *
4 * authors  Alain Greiner (2016)
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///////////////////////////////////////////////////////////////////////////////////
25// The printk.c and printk.h files define the functions used by the kernel
26// to display messages on a text terminal.
27// Two access modes are supported:
28// - The printk() function displays kernel messages on the kernel terminal TXT0,
29//   using a busy waiting policy: It calls directly the relevant TXT driver,
30//   after taking the TXT0 chdev lock for exclusive access to the TXT0 terminal.
31// - The user_printk() function displays messages on the calling thread private
32//   terminal, using a descheduling policy: it register the request in the selected
33//   TXT chdev waiting queue and deschedule. The calling thread is reactivated by
34//   the IRQ signalling completion.
35// Both functions use the generic TXT device to call the proper implementation
36// dependant TXT driver.
37// Finally these files define a set of conditional trace <***_dmsg> for debug.
38///////////////////////////////////////////////////////////////////////////////////
39
40#ifndef _PRINTK_H
41#define _PRINTK_H
42
43#include <hal_types.h>
44#include <stdarg.h>
45
46
47/**********************************************************************************
48 * This function build a formatted string.
49 * The supported formats are defined below :
50 *   %c : single character
51 *   %d : signed decimal 32 bits integer
52 *   %u : unsigned decimal 32 bits integer
53 *   %x : hexadecimal 32 bits integer
54 *   %l : hexadecimal 64 bits integer
55 *   %s : NUL terminated character string
56 **********************************************************************************
57 * @ string     : pointer on target buffer (allocated by caller).
58 * @ length     : target buffer length (number of bytes).
59 * @ format     : format respecting the printf syntax.
60 * @ returns the string length (including NUL) if success / return -1 if error.
61 *********************************************************************************/
62uint32_t snprintf( char     * string,
63                   uint32_t   length,
64                   char     * format, ... );
65
66/**********************************************************************************
67 * This function displays a formatted string on the kernel terminal TXT0,
68 * using a busy waiting policy: It calls directly the relevant TXT driver,
69 * after taking the TXT0 lock.
70 **********************************************************************************
71 * @ format     : formatted string.
72 *********************************************************************************/
73void printk( char* format, ... );
74
75/**********************************************************************************
76 * This function displays a formatted string on the kernel terminal TXT0,
77 * using a busy waiting policy: It calls directly the relevant TXT driver,
78 * without taking the TXT0 lock.
79 **********************************************************************************
80 * @ format     : formatted string.
81 *********************************************************************************/
82void nolock_printk( char* format, ... );
83
84/**********************************************************************************
85 * This function displays a message and forces the calling core in sleeping mode.
86 **********************************************************************************
87 * @ format        : formatted string
88 *********************************************************************************/
89void _panic( char* format, ... );
90
91/**********************************************************************************
92 * This function displays a "PANIC" message and forces the calling core in
93 * sleeping mode if a Boolean condition is false.
94 * These functions are actually used to debug the kernel...
95 **********************************************************************************
96 * @ condition     : condition that must be true.
97 * @ function_name : name of the calling function.
98 * @ format        : formatted string
99 *********************************************************************************/
100void assert( bool_t       condition,
101             const char * function_name,
102             char       * format , ... );
103
104#define panic(fmt, ...)     _panic("[PANIC] %s(): " fmt "\n", __func__, ##__VA_ARGS__)
105
106///////////////////////////////////////////////////////////////////////////////////
107//       Conditional debug macros
108///////////////////////////////////////////////////////////////////////////////////
109
110#if CONFIG_CLUSTER_DEBUG
111#define cluster_dmsg(...)   printk(__VA_ARGS__)
112#else
113#define cluster_dmsg(...)
114#endif
115
116#if CONFIG_CONTEXT_DEBUG
117#define context_dmsg(...)   printk(__VA_ARGS__)
118#else
119#define context_dmsg(...)
120#endif
121
122#if CONFIG_CORE_DEBUG
123#define core_dmsg(...)   printk(__VA_ARGS__)
124#else
125#define core_dmsg(...)
126#endif
127
128#if CONFIG_DEVFS_DEBUG
129#define devfs_dmsg(...)   printk(__VA_ARGS__)
130#else
131#define devfs_dmsg(...)
132#endif
133
134#if CONFIG_DMA_DEBUG
135#define dma_dmsg(...)   printk(__VA_ARGS__)
136#else
137#define dma_dmsg(...)
138#endif
139
140#if CONFIG_DQDT_DEBUG
141#define dma_dmsg(...)   printk(__VA_ARGS__)
142#else
143#define dma_dmsg(...)
144#endif
145
146#if CONFIG_DQDT_DEBUG
147#define dqdt_dmsg(...)   printk(__VA_ARGS__)
148#else
149#define dqdt_dmsg(...)
150#endif
151
152#if CONFIG_ELF_DEBUG
153#define elf_dmsg(...)   printk(__VA_ARGS__)
154#else
155#define elf_dmsg(...)
156#endif
157
158#if CONFIG_EXEC_DEBUG
159#define exec_dmsg(...)   printk(__VA_ARGS__)
160#else
161#define exec_dmsg(...)
162#endif
163
164#if CONFIG_FATFS_DEBUG
165#define fatfs_dmsg(...)   printk(__VA_ARGS__)
166#else
167#define fatfs_dmsg(...)
168#endif
169
170#if CONFIG_FBF_DEBUG
171#define fbf_dmsg(...)   printk(__VA_ARGS__)
172#else
173#define fbf_dmsg(...)
174#endif
175
176#if CONFIG_FORK_DEBUG
177#define fork_dmsg(...)   printk(__VA_ARGS__)
178#else
179#define fork_dmsg(...)
180#endif
181
182#if CONFIG_IDLE_DEBUG
183#define idle_dmsg(...) printk(__VA_ARGS__)
184#else
185#define idle_dmsg(...)
186#endif
187
188#if CONFIG_IOC_DEBUG
189#define ioc_dmsg(...)   printk(__VA_ARGS__)
190#else
191#define ioc_dmsg(...)
192#endif
193
194#if CONFIG_IRQ_DEBUG
195#define irq_dmsg(...)   printk(__VA_ARGS__)
196#else
197#define irq_dmsg(...)
198#endif
199
200#if CONFIG_KCM_DEBUG
201#define kcm_dmsg(...) printk(__VA_ARGS__)
202#else
203#define kcm_dmsg(...)
204#endif
205
206#if CONFIG_KHM_DEBUG
207#define khm_dmsg(...) printk(__VA_ARGS__)
208#else
209#define khm_dmsg(...)
210#endif
211
212#if CONFIG_KINIT_DEBUG
213#define kinit_dmsg(...) printk(__VA_ARGS__)
214#else
215#define kinit_dmsg(...)
216#endif
217
218#if CONFIG_KMEM_DEBUG
219#define kmem_dmsg(...) printk(__VA_ARGS__)
220#else
221#define kmem_dmsg(...)
222#endif
223
224#if CONFIG_MAPPER_DEBUG
225#define mapper_dmsg(...)   printk(__VA_ARGS__)
226#else
227#define mapper_dmsg(...)
228#endif
229
230#if CONFIG_MMC_DEBUG
231#define mmc_dmsg(...)   printk(__VA_ARGS__)
232#else
233#define mmc_dmsg(...)
234#endif
235
236#if CONFIG_NIC_DEBUG
237#define nic_dmsg(...)   printk(__VA_ARGS__)
238#else
239#define nic_dmsg(...)
240#endif
241
242#if CONFIG_PIC_DEBUG
243#define pic_dmsg(...)   printk(__VA_ARGS__)
244#else
245#define pic_dmsg(...)
246#endif
247
248#if CONFIG_PPM_DEBUG
249#define ppm_dmsg(...)   printk(__VA_ARGS__)
250#else
251#define ppm_dmsg(...)
252#endif
253
254#if CONFIG_PROCESS_DEBUG
255#define process_dmsg(...)   printk(__VA_ARGS__)
256#else
257#define process_dmsg(...)
258#endif
259
260#if CONFIG_RPC_DEBUG
261#define rpc_dmsg(...)   if(hal_time_stamp() > CONFIG_RPC_DEBUG) printk(__VA_ARGS__)
262#else
263#define rpc_dmsg(...)
264#endif
265
266#if CONFIG_RPCG_DEBUG
267#define rpcg_dmsg(...)   printk(__VA_ARGS__)
268#else
269#define rpcg_dmsg(...)
270#endif
271
272#if CONFIG_SCHED_DEBUG
273#define sched_dmsg(...)   printk(__VA_ARGS__)
274#else
275#define sched_dmsg(...)
276#endif
277
278#if CONFIG_SIGNAL_DEBUG
279#define signal_dmsg(...)   printk(__VA_ARGS__)
280#else
281#define signal_dmsg(...)
282#endif
283
284#if CONFIG_SYSCALL_DEBUG
285#define syscall_dmsg(...)   printk(__VA_ARGS__)
286#else
287#define syscall_dmsg(...)
288#endif
289
290#if CONFIG_THREAD_DEBUG
291#define thread_dmsg(...)   printk(__VA_ARGS__)
292#else
293#define thread_dmsg(...)
294#endif
295
296#if CONFIG_TXT_DEBUG
297#define txt_dmsg(...)   printk(__VA_ARGS__)
298#else
299#define txt_dmsg(...)
300#endif
301
302#if CONFIG_VFS_DEBUG
303#define vfs_dmsg(...)   if(hal_time_stamp() > CONFIG_VFS_DEBUG) printk(__VA_ARGS__)
304#else
305#define vfs_dmsg(...)
306#endif
307
308#if CONFIG_VMM_DEBUG
309#define vmm_dmsg(...)   printk(__VA_ARGS__)
310#else
311#define vmm_dmsg(...)
312#endif
313
314
315#endif  // _PRINTK_H
316
317// Local Variables:
318// tab-width: 4
319// c-basic-offset: 4
320// c-file-offsets:((innamespace . 0)(inline-open . 0))
321// indent-tabs-mode: nil
322// End:
323// vim: filetype=c:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
324
Note: See TracBrowser for help on using the repository browser.