Navigation
- Accueil
- Présentation :
- FAQ
- Bugs et errata
- Contributions de lecteurs
- Téléchargements
- LXR (référencement des sources)
- Mailing-list
- Liens et Projets reliés
Site hébergé par :
Site hébergé par :
|
[ source navigation ] [ diff markup ] [ identifier search ] [ general search ] |
|||
|
||||
001 /* Copyright (C) 2000-2004, The KOS team !! 001 /* Copyright (C) 2005 David Decotigny 002 Copyright (C) 1999 Free Software Foundatio !! 002 Copyright (C) 2000-2004, The KOS team 003 003 004 This program is free software; you can redi 004 This program is free software; you can redistribute it and/or 005 modify it under the terms of the GNU Genera 005 modify it under the terms of the GNU General Public License 006 as published by the Free Software Foundatio 006 as published by the Free Software Foundation; either version 2 007 of the License, or (at your option) any lat 007 of the License, or (at your option) any later version. 008 008 009 This program is distributed in the hope tha 009 This program is distributed in the hope that it will be useful, 010 but WITHOUT ANY WARRANTY; without even the 010 but WITHOUT ANY WARRANTY; without even the implied warranty of 011 MERCHANTABILITY or FITNESS FOR A PARTICULAR 011 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 012 GNU General Public License for more details 012 GNU General Public License for more details. 013 013 014 You should have received a copy of the GNU 014 You should have received a copy of the GNU General Public License 015 along with this program; if not, write to t 015 along with this program; if not, write to the Free Software 016 Foundation, Inc., 59 Temple Place - Suite 3 016 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 017 USA. 017 USA. 018 */ 018 */ 019 #ifndef _SOS_CPUCTXT_H_ 019 #ifndef _SOS_CPUCTXT_H_ 020 #define _SOS_CPUCTXT_H_ 020 #define _SOS_CPUCTXT_H_ 021 021 022 022 023 /** 023 /** 024 * @file cpu_context.h 024 * @file cpu_context.h 025 * 025 * 026 * Low level API to manage kernel and user thr 026 * Low level API to manage kernel and user thread CPU contexts. Should 027 * be some kind of architecture-independent. 027 * be some kind of architecture-independent. 028 */ 028 */ 029 029 030 #include <sos/types.h> 030 #include <sos/types.h> 031 #include <sos/errno.h> 031 #include <sos/errno.h> 032 032 033 033 034 /** 034 /** 035 * Opaque structure storing the CPU context of !! 035 * Opaque structure storing the CPU context of an inactive kernel or 036 * thread, as saved by the low level primitive !! 036 * user thread, as saved by the low level primitives below or by the 037 * interrupt/exception handlers. 037 * interrupt/exception handlers. 038 * 038 * 039 * @note This is an (architecture-independent) 039 * @note This is an (architecture-independent) forward declaration: 040 * see cpu_context.c and the *.S files for its 040 * see cpu_context.c and the *.S files for its 041 * (architecture-dependent) definition. 041 * (architecture-dependent) definition. 042 */ 042 */ 043 struct sos_cpu_kstate; !! 043 struct sos_cpu_state; 044 044 045 045 046 /** 046 /** 047 * The type of the functions passed as argumen !! 047 * The type of the functions passed as arguments to the Kernel thread >> 048 * related functions. 048 */ 049 */ 049 typedef void (sos_cpu_kstate_function_arg1_t(s 050 typedef void (sos_cpu_kstate_function_arg1_t(sos_ui32_t arg1)); 050 051 051 052 052 /** 053 /** 053 * Function to create an initial context for a 054 * Function to create an initial context for a kernel thread starting 054 * its execution at function start_func with t 055 * its execution at function start_func with the argument initial_arg, 055 * and having the stack defined by stack_botto 056 * and having the stack defined by stack_bottom/stack_size. When the 056 * start_func function returns, the function e 057 * start_func function returns, the function exit_func is called with 057 * argument exit_arg. 058 * argument exit_arg. 058 * 059 * 059 * @param ctxt The kernel thread CPU context t !! 060 * @param kctxt The kernel thread CPU context to initialize. The 060 * address of the newly-initialized struct sos !! 061 * address of the newly-initialized struct sos_cpu_state will be 061 * stored in this variable. The contents of th !! 062 * stored in this variable. The contents of this struct sos_cpu_state 062 * are actually located /inside/ the stack. 063 * are actually located /inside/ the stack. 063 * 064 * 064 * @param start_func The address of the first 065 * @param start_func The address of the first instruction that will be 065 * executed when this context will be first tr 066 * executed when this context will be first transferred on 066 * CPU. Practically speaking, this is the addr 067 * CPU. Practically speaking, this is the address of a function that 067 * is assumed to take 1 argument. 068 * is assumed to take 1 argument. 068 * 069 * 069 * @param start_arg The value that will be pas 070 * @param start_arg The value that will be passed as the argument to 070 * start_func when the thread starts. The stac 071 * start_func when the thread starts. The stack will be setup 071 * accordingly to simulate a real call to the 072 * accordingly to simulate a real call to the function and really 072 * passing this arguement. 073 * passing this arguement. 073 * 074 * 074 * @param stack_bottom The lowest address of t 075 * @param stack_bottom The lowest address of the stack. 075 * 076 * 076 * @param stack_size The size of the stack. 077 * @param stack_size The size of the stack. 077 * 078 * 078 * @param exit_func The address of the instruc 079 * @param exit_func The address of the instruction executed after the 079 * function start_func has returned. This func 080 * function start_func has returned. This function takes 1 parameter 080 * as argument: exit_arg. 081 * as argument: exit_arg. 081 * 082 * 082 * @param exit_arg The argument passed to the 083 * @param exit_arg The argument passed to the function exit_func. 083 * 084 * 084 * @note the newly created context is INTERRUP 085 * @note the newly created context is INTERRUPTIBLE by default ! 085 */ 086 */ 086 sos_ret_t sos_cpu_kstate_init(struct sos_cpu_k !! 087 sos_ret_t sos_cpu_kstate_init(struct sos_cpu_state **kctxt, 087 sos_cpu_kstate_f 088 sos_cpu_kstate_function_arg1_t *start_func, 088 sos_ui32_t star 089 sos_ui32_t start_arg, 089 sos_vaddr_t stac 090 sos_vaddr_t stack_bottom, 090 sos_size_t stac 091 sos_size_t stack_size, 091 sos_cpu_kstate_f 092 sos_cpu_kstate_function_arg1_t *exit_func, 092 sos_ui32_t exit 093 sos_ui32_t exit_arg); 093 094 094 095 095 /** 096 /** 096 * Function that performs an immediate context !! 097 * Function that performs an immediate context-switch from one 097 * thread to another one. It stores the curren !! 098 * kernel/user thread to another one. It stores the current executing 098 * from_ctxt, and restores to_context on CPU. !! 099 * context in from_ctxt, and restores to_context on CPU. 099 * 100 * 100 * @param from_ctxt The address of the struct !! 101 * @param from_ctxt The address of the struct sos_cpu_state will be 101 * stored in this variable. Must NOT be NULL. 102 * stored in this variable. Must NOT be NULL. 102 * 103 * 103 * @param to_ctxt The CPU will resume its exec 104 * @param to_ctxt The CPU will resume its execution with the struct 104 * sos_cpu_kstate located at this address. Mus !! 105 * sos_cpu_state located at this address. Must NOT be NULL. 105 */ 106 */ 106 void sos_cpu_kstate_switch(struct sos_cpu_ksta !! 107 void sos_cpu_context_switch(struct sos_cpu_state **from_ctxt, 107 struct sos_cpu_ksta !! 108 struct sos_cpu_state *to_ctxt); 108 109 109 110 110 /* 111 /* 111 * Switch to the new given context (of a kerne !! 112 * Switch to the new given context (of a kernel/user thread) without 112 * the old context (of another kernel thread), !! 113 * saving the old context (of another kernel/user thread), and call 113 * reclaiming_func passing it the recalining_a !! 114 * the function reclaiming_func passing it the recalining_arg 114 * reclaining function is called from within t !! 115 * argument. The reclaining function is called from within the stack 115 * context, so that it can (among other things !! 116 * of the new context, so that it can (among other things) safely 116 * stack of the former context. !! 117 * destroy the stack of the former context. 117 * 118 * 118 * @param switch_to_ctxt The context that will 119 * @param switch_to_ctxt The context that will be restored on the CPU 119 * 120 * 120 * @param reclaiming_func The address of the f 121 * @param reclaiming_func The address of the function that will be 121 * called after having changed the stack, but 122 * called after having changed the stack, but before restoring the CPU 122 * context to switch_to_ctxt. 123 * context to switch_to_ctxt. 123 */ 124 */ 124 void 125 void 125 sos_cpu_kstate_exit_to(struct sos_cpu_kstate * !! 126 sos_cpu_context_exit_to(struct sos_cpu_state *switch_to_ctxt, 126 sos_cpu_kstate_function !! 127 sos_cpu_kstate_function_arg1_t *reclaiming_func, 127 sos_ui32_t reclaiming_a !! 128 sos_ui32_t reclaiming_arg) __attribute__((noreturn)); 128 << 129 129 130 /* =========================================== 130 /* ======================================================================= 131 * Public Accessor functions 131 * Public Accessor functions 132 */ 132 */ 133 133 >> 134 134 /** 135 /** 135 * Return Program Counter stored in the saved !! 136 * Return Program Counter stored in the saved kernel/user context 136 */ 137 */ 137 sos_vaddr_t sos_cpu_kstate_get_PC(const struct !! 138 sos_vaddr_t sos_cpu_context_get_PC(const struct sos_cpu_state *ctxt); 138 139 139 140 140 /** 141 /** 141 * Return Stack Pointer stored in the saved co !! 142 * Return Stack Pointer stored in the saved kernel/user context 142 */ 143 */ 143 sos_vaddr_t sos_cpu_kstate_get_SP(const struct !! 144 sos_vaddr_t sos_cpu_context_get_SP(const struct sos_cpu_state *ctxt); 144 145 145 146 146 /** 147 /** 147 * Dump the contents of the CPU context (bochs 148 * Dump the contents of the CPU context (bochs + x86_videomem) 148 */ 149 */ 149 void sos_cpu_kstate_dump(const struct sos_cpu_ !! 150 void sos_cpu_context_dump(const struct sos_cpu_state *ctxt); 150 151 151 152 152 /* =========================================== 153 /* ======================================================================= 153 * Public Accessor functions TO BE USED ONLY B 154 * Public Accessor functions TO BE USED ONLY BY Exception handlers 154 */ 155 */ 155 156 156 157 157 /** 158 /** 158 * Return the argument passed by the CPU upon 159 * Return the argument passed by the CPU upon exception, as stored in the 159 * saved context 160 * saved context 160 */ 161 */ 161 sos_ui32_t sos_cpu_kstate_get_EX_info(const st !! 162 sos_ui32_t sos_cpu_context_get_EX_info(const struct sos_cpu_state *ctxt); 162 163 163 164 164 /** 165 /** 165 * Return the faulting address of the exceptio 166 * Return the faulting address of the exception 166 */ 167 */ 167 sos_vaddr_t 168 sos_vaddr_t 168 sos_cpu_kstate_get_EX_faulting_vaddr(const str !! 169 sos_cpu_context_get_EX_faulting_vaddr(const struct sos_cpu_state *ctxt); 169 170 170 171 171 /* =========================================== 172 /* ======================================================================= 172 * Macros controlling stack poisoning. 173 * Macros controlling stack poisoning. 173 * Stack poisoning can be used to detect: 174 * Stack poisoning can be used to detect: 174 * - unitialized local variables 175 * - unitialized local variables 175 * - when the thread might have gone too deep 176 * - when the thread might have gone too deep in the stack 176 */ 177 */ 177 /** The signature of the poison */ 178 /** The signature of the poison */ 178 #define SOS_CPU_KSTATE_STACK_POISON 0xa5 !! 179 #define SOS_CPU_STATE_STACK_POISON 0xa5 179 180 180 /** 181 /** 181 * When set, mean that the whole stack is pois 182 * When set, mean that the whole stack is poisoned to detect use of 182 * unititialized variables 183 * unititialized variables 183 */ 184 */ 184 #define SOS_CPU_KSTATE_DETECT_UNINIT_VARS !! 185 #define SOS_CPU_STATE_DETECT_UNINIT_KERNEL_VARS 185 /* #undef SOS_CPU_KSTATE_DETECT_UNINIT_VARS */ !! 186 /* #undef SOS_CPU_STATE_DETECT_UNINIT_KERNEL_VARS */ 186 187 187 /** 188 /** 188 * When set, mean that the bottom of the stack 189 * When set, mean that the bottom of the stack is poisoned to detect 189 * probable stack overflow. Its value indicate 190 * probable stack overflow. Its value indicates the number of bytes 190 * used for this detection. 191 * used for this detection. 191 */ 192 */ 192 #define SOS_CPU_KSTATE_DETECT_STACK_OVERFLOW !! 193 #define SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW 64 193 /* #undef SOS_CPU_KSTATE_DETECT_STACK_OVERFLOW !! 194 /* #undef SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW */ 194 195 195 #if defined(SOS_CPU_KSTATE_DETECT_STACK_OVERFL !! 196 #if defined(SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW) 196 void 197 void 197 sos_cpu_kstate_prepare_detect_stack_overflow(c !! 198 sos_cpu_state_prepare_detect_kernel_stack_overflow(const struct sos_cpu_state *ctxt, 198 s !! 199 sos_vaddr_t kernel_stack_bottom, 199 s !! 200 sos_size_t kernel_stack_size); 200 void sos_cpu_kstate_detect_stack_overflow(cons !! 201 void sos_cpu_state_detect_kernel_stack_overflow(const struct sos_cpu_state *ctxt, 201 sos_ !! 202 sos_vaddr_t kernel_stack_bottom, 202 sos_ !! 203 sos_size_t kernel_stack_size); 203 #else 204 #else 204 # define sos_cpu_kstate_prepare_detect_stack_o !! 205 # define sos_cpu_state_prepare_detect_kernel_stack_overflow(ctxt,stkbottom,stksize) \ 205 ({ /* nop */ }) 206 ({ /* nop */ }) 206 # define sos_cpu_kstate_detect_stack_overflow( !! 207 # define sos_cpu_state_detect_kernel_stack_overflow(ctxt,stkbottom,stksize) \ 207 ({ /* nop */ }) 208 ({ /* nop */ }) 208 #endif 209 #endif 209 210 210 211 211 /* =========================================== 212 /* ======================================================================= 212 * Backtrace facility. To be used for DEBUGgin 213 * Backtrace facility. To be used for DEBUGging purpose ONLY. 213 */ 214 */ 214 215 215 216 216 /** 217 /** 217 * The function called at each step of the bac 218 * The function called at each step of the backtrace iterations 218 * 219 * 219 * @param PC The address of the next instructi 220 * @param PC The address of the next instruction of the function that 220 * will be executed 221 * will be executed 221 * 222 * 222 * @param params The address of the array of t 223 * @param params The address of the array of the parameteres that have 223 * been passed to the function considered 224 * been passed to the function considered 224 * 225 * 225 * @param depth The index of the iteration (ie 226 * @param depth The index of the iteration (ie the depth of the 226 * current frame into the stack) 227 * current frame into the stack) 227 * 228 * 228 * @param custom_arg Whatever you want: this i 229 * @param custom_arg Whatever you want: this is the argument passed as 229 * custom_arg to sos_backtrace() 230 * custom_arg to sos_backtrace() 230 */ 231 */ 231 typedef void (sos_backtrace_callback_t)(sos_va 232 typedef void (sos_backtrace_callback_t)(sos_vaddr_t PC, 232 sos_va 233 sos_vaddr_t params, 233 sos_ui 234 sos_ui32_t depth, 234 void * 235 void *custom_arg); 235 236 236 237 237 /** 238 /** 238 * Call the backtracer callback on each frame !! 239 * Call the backtracer callback on each frame stored in the cpu_state 239 * 240 * 240 * @param cpu_kstate The CPU context we want t !! 241 * @param cpu_state The CPU context we want to explore. MUST be the 241 * backtrace the current CPU context. !! 242 * context of a thread in Kernel mode, or NULL. When NULL: backtrace >> 243 * the current CPU context. 242 * 244 * 243 * @param max_depth The maximum number of fram 245 * @param max_depth The maximum number of frames to explore 244 * 246 * 245 * @param stack_bottom The lower boundary of t 247 * @param stack_bottom The lower boundary of the stack. This is used 246 * to make sure that the frame addresses fit i 248 * to make sure that the frame addresses fit inside the stack 247 * boudaries (ie are potentially correct). 249 * boudaries (ie are potentially correct). 248 * 250 * 249 * @param stack_size The size of the stack. Sa 251 * @param stack_size The size of the stack. Same comment. 250 * 252 * 251 * @param backtracer The function to call to h 253 * @param backtracer The function to call to handle the frame for each 252 * iteration 254 * iteration 253 * 255 * 254 * @param custom_arg The arg passed as custom_ 256 * @param custom_arg The arg passed as custom_arg to the backtracer 255 * 257 * 256 * @return The number of frames explored. 258 * @return The number of frames explored. 257 * 259 * 258 * @note Might be inaccurate when gcc's -fomit 260 * @note Might be inaccurate when gcc's -fomit-frame-pointer has been 259 * used. 261 * used. 260 */ 262 */ 261 sos_ui32_t sos_backtrace(const struct sos_cpu_ !! 263 sos_ui32_t sos_backtrace(const struct sos_cpu_state *cpu_state, 262 sos_ui32_t max_depth, 264 sos_ui32_t max_depth, 263 sos_vaddr_t stack_bot 265 sos_vaddr_t stack_bottom, 264 sos_size_t stack_size 266 sos_size_t stack_size, 265 sos_backtrace_callbac 267 sos_backtrace_callback_t * backtracer, 266 void *custom_arg); 268 void *custom_arg); 267 269 268 #endif /* _SOS_CPUCTXT_H_ */ 270 #endif /* _SOS_CPUCTXT_H_ */
| [ source navigation ] | [ diff markup ] | [ identifier search ] | [ general search ] |