source: mainline/kernel/generic/include/arch.h@ d16fc78

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since d16fc78 was eb239dc, checked in by Jakub Jermar <jakub@…>, 15 years ago

Add a descriptive comment for THE.

  • Property mode set to 100644
File size: 3.2 KB
Line 
1/*
2 * Copyright (c) 2001-2004 Jakub Jermar
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup generic
30 * @{
31 */
32/** @file
33 */
34
35#ifndef KERN_ARCH_H_
36#define KERN_ARCH_H_
37
38#include <arch/arch.h>
39#include <proc/thread.h>
40#include <proc/task.h>
41#include <mm/as.h>
42
43#define DEFAULT_CONTEXT 0
44
45#define CPU THE->cpu
46#define THREAD THE->thread
47#define TASK THE->task
48#define AS THE->as
49#define CONTEXT (THE->task ? THE->task->context : DEFAULT_CONTEXT)
50#define PREEMPTION_DISABLED THE->preemption_disabled
51
52#define context_check(ctx1, ctx2) ((ctx1) == (ctx2))
53
54/**
55 * For each possible kernel stack, structure
56 * of the following type will be placed at
57 * the base address of the stack.
58 */
59typedef struct {
60 size_t preemption_disabled; /**< Preemption disabled counter. */
61 thread_t *thread; /**< Current thread. */
62 task_t *task; /**< Current task. */
63 cpu_t *cpu; /**< Executing cpu. */
64 as_t *as; /**< Current address space. */
65} the_t;
66
67/*
68 * THE is not an abbreviation, but the English definite article written in
69 * capital letters. It means the current pointer to something, e.g. thread,
70 * processor or address space. Kind reader of this comment shall appreciate
71 * the wit of constructs like THE->thread and similar.
72 */
73#define THE ((the_t * )(get_stack_base()))
74
75extern void the_initialize(the_t *);
76extern void the_copy(the_t *, the_t *);
77
78extern void arch_pre_mm_init(void);
79extern void arch_post_mm_init(void);
80extern void arch_post_cpu_init(void);
81extern void arch_pre_smp_init(void);
82extern void arch_post_smp_init(void);
83
84extern void calibrate_delay_loop(void);
85
86extern void reboot(void);
87extern void arch_reboot(void);
88extern void *arch_construct_function(fncptr_t *, void *, void *);
89
90#endif
91
92/** @}
93 */
Note: See TracBrowser for help on using the repository browser.