timer interrupts enabled
[barrelfish] / include / barrelfish_kpi / syscalls.h
1 /**
2  * \file
3  * \brief System call numbers.
4  */
5
6 /*
7  * Copyright (c) 2007, 2008, 2009, 2010, ETH Zurich.
8  * All rights reserved.
9  *
10  * This file is distributed under the terms in the attached LICENSE file.
11  * If you do not find this file, copies can be found by writing to:
12  * ETH Zurich D-INFK, Haldeneggsteig 4, CH-8092 Zurich. Attn: Systems Group.
13  */
14
15 #ifndef BARRELFISH_SYSCALLS_H
16 #define BARRELFISH_SYSCALLS_H
17
18 #ifndef __ASSEMBLER__
19
20 /// return type from a system call: two words
21 struct sysret {
22     errval_t  error;
23     uintptr_t value;
24 };
25
26 /// Macro used for constructing return values from single-value syscalls
27 #define SYSRET(x) (struct sysret){ /*error*/ x, /*value*/ 0 }
28 #endif // __ASSEMBLER__
29
30 /*
31  * These are the system call ordinals. Please keep the space contiguous
32  * as far as possible and make sure SYSCALL_COUNT is the number of system
33  * calls. Lower layers may build direct-mapped syscall tables and so
34  * compactness is a virtue.
35  */
36
37 /* Proper Barrelfish system calls */
38 #define SYSCALL_INVOKE              0       ///< Invoke a cap
39 #define SYSCALL_YIELD               1       ///< Yield the CPU
40 #define SYSCALL_LRPC                2       ///< Fast LRPC
41
42 /* Debug/Benchmarking system calls */
43 #define SYSCALL_DEBUG               3     ///< Benchmarking and debug syscalls
44 #define SYSCALL_REBOOT              4     ///< Reboot the machine
45 #define SYSCALL_NOP                 5     ///< No operation
46 #define SYSCALL_PRINT               6     ///< Write to console
47
48 /* Architecture-specific syscalls 
49  * FIXME: shouldn't these be in an arch-specific header? -AB */
50 #ifdef __ARM_ARCH_7M__  //cortex-m3 on pandaboard
51 //overwrite unused syscall instead of creating yet another global one
52 #define SYSCALL_RESUME_CONTEXT      7     ///< Resume a context that the dispatcher can't
53 #else
54 #define SYSCALL_X86_FPU_TRAP_ON     7     ///< Turn FPU trap on (x86)
55 #endif  //__ARM_ARCH_7M__
56
57
58 #define SYSCALL_X86_RELOAD_LDT      8     ///< Reload the LDT register (x86_64)
59
60 #define SYSCALL_COUNT               9     ///< Number of syscalls [0..SYSCALL_COUNT - 1]
61
62 /*
63  * To understand system calls it might be helpful to know that there
64  * are four different levels of abstraction with multiplexing
65  * performed at three of them (compare with Tennenhouse: Layered
66  * Multiplexing Considered Harmful).
67  *
68  * At the bottom two levels of abstraction are the system call number
69  * as defined in this file.  This is one point of multiplexing and two
70  * levels of abstraction; the second one comes about because the
71  * system calls defined here use non primitive C types such as
72  * "struct sysret" which have to be converted and dealt with by a
73  * level of abstraction to deal with the encoding used over the
74  * protection boundary.  For example, on some architectures
75  * structures, including output structures, are passed by reference in
76  * the argument list.  Therefore below the C abstraction of the system
77  * call there must be a translation to an abstraction which can cross
78  * the protection boundary.
79  *
80  * Above this is the invoke system call.  It deals with two different
81  * ways of doing additional multiplexing, based on the type of the
82  * capability being invoked, and the command being invoked on the
83  * capability.  This defines which kernel system call implementation
84  * is to be run.  An aspect of this is that the arguments to the
85  * intended kernel code have to multiplexed up in user space onto the
86  * invoke system call and demultiplexed by the kernel, thus preventing
87  * direct dispatch to the intended implementation.
88  *
89  * Above this is the endpoint invocation in which the above system
90  * invocation system call is performed and demultiplexed, but the
91  * target capability is a special type in which the implementation
92  * code being called is not in the kernel; in this the arguments to
93  * the desired functionality must be marshalled in such a way that
94  * they can be delivered to the desired domain instead of the kernel.
95  *
96  * Knowing this will help the reader understand the various different
97  * marshalling and unmarshalling code found variously in
98  * monitor_invocations.h, invocations.h, syscalls.c, syscall_arch.h,
99  * syscall.c and related assembler.
100  */
101
102 #endif // BARRELFISH_SYSCALLS_H