Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | /* |
2 | * ========== Copyright Header Begin ========================================== | |
3 | * | |
4 | * Hypervisor Software File: hcall.h | |
5 | * | |
6 | * Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved. | |
7 | * | |
8 | * - Do no alter or remove copyright notices | |
9 | * | |
10 | * - Redistribution and use of this software in source and binary forms, with | |
11 | * or without modification, are permitted provided that the following | |
12 | * conditions are met: | |
13 | * | |
14 | * - Redistribution of source code must retain the above copyright notice, | |
15 | * this list of conditions and the following disclaimer. | |
16 | * | |
17 | * - Redistribution in binary form must reproduce the above copyright notice, | |
18 | * this list of conditions and the following disclaimer in the | |
19 | * documentation and/or other materials provided with the distribution. | |
20 | * | |
21 | * Neither the name of Sun Microsystems, Inc. or the names of contributors | |
22 | * may be used to endorse or promote products derived from this software | |
23 | * without specific prior written permission. | |
24 | * | |
25 | * This software is provided "AS IS," without a warranty of any kind. | |
26 | * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, | |
27 | * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A | |
28 | * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN | |
29 | * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR | |
30 | * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR | |
31 | * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN | |
32 | * OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR | |
33 | * FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE | |
34 | * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, | |
35 | * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF | |
36 | * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. | |
37 | * | |
38 | * You acknowledge that this software is not designed, licensed or | |
39 | * intended for use in the design, construction, operation or maintenance of | |
40 | * any nuclear facility. | |
41 | * | |
42 | * ========== Copyright Header End ============================================ | |
43 | */ | |
44 | /* | |
45 | * Copyright 2007 Sun Microsystems, Inc. All rights reserved. | |
46 | * Use is subject to license terms. | |
47 | */ | |
48 | ||
49 | #ifndef _HCALL_H | |
50 | #define _HCALL_H | |
51 | ||
52 | #pragma ident "@(#)hcall.h 1.2 07/05/03 SMI" | |
53 | ||
54 | #ifdef __cplusplus | |
55 | extern "C" { | |
56 | #endif | |
57 | ||
58 | #include <guest.h> | |
59 | ||
60 | /* | |
61 | * Macros for creating the table mapping api_group and version | |
62 | * numbers to specific sets of HV API calls. The structure is meant | |
63 | * to be self-explanatory, but you might still do well to understand | |
64 | * hcall_api_set_version before you do anything beyond trivial to the | |
65 | * table. | |
66 | * | |
67 | * Rules for structuring the GROUP_* macros (this is a regular | |
68 | * language, if you really care about theory...): | |
69 | * | |
70 | * GROUP_BEGIN -- start of one API group | |
71 | * { | |
72 | * GROUP_MAJOR_ENTRY -- one major number in the API group | |
73 | * { GROUP_MINOR_ENTRY } + -- all the minor number call tables | |
74 | * GROUP_MINOR_END -- end of minor number call tables | |
75 | * } + | |
76 | * GROUP_MAJOR_END -- end of the major number entries | |
77 | * | |
78 | * { | |
79 | * { | |
80 | * GROUP_HCALL_TABLE -- one label for a minor number call table | |
81 | * { GROUP_HCALL_ENTRY } + -- one call table entry | |
82 | * } + | |
83 | * GROUP_HCALL_END -- end of call table for this major number | |
84 | * } + | |
85 | * GROUP_END -- end of this API group | |
86 | */ | |
87 | /* BEGIN CSTYLED */ | |
88 | ||
89 | #define GROUP_BEGIN(name, number) \ | |
90 | hcall_api_group_/**/name: ;\ | |
91 | .word number ;\ | |
92 | .word hcall_api_group_/**/name/**/_end - hcall_api_group_/**/name | |
93 | ||
94 | #define GROUP_END(name) \ | |
95 | hcall_api_group_/**/name/**/_end: | |
96 | ||
97 | #define GROUP_MAJOR_ENTRY(name, major, max_minor) \ | |
98 | /* name not used in this case */ ;\ | |
99 | .xword MAKE_VERSION(major, max_minor) | |
100 | ||
101 | #define GROUP_MAJOR_END(name) \ | |
102 | GROUP_MAJOR_ENTRY(name, 0, 0) | |
103 | ||
104 | #define GROUP_MINOR_ENTRY(name) \ | |
105 | .xword hcall_table_/**/name | |
106 | ||
107 | #define GROUP_MINOR_END(name) \ | |
108 | .xword hcall_table_/**/name | |
109 | ||
110 | #define GROUP_HCALL_TABLE(name) \ | |
111 | hcall_table_/**/name: | |
112 | ||
113 | #define GROUP_HCALL_ENTRY(number, function) \ | |
114 | .xword number, function | |
115 | ||
116 | #define GROUP_HCALL_END(name) \ | |
117 | hcall_table_/**/name: | |
118 | ||
119 | /* END CSTYLED */ | |
120 | ||
121 | /* | |
122 | * Constants below relate to the entries defined by | |
123 | * GROUP_HCALL_ENTRY. Each entry contains a function number and an | |
124 | * unrelocated function label. | |
125 | * | |
126 | * HCALL_ENTRY_INDEX - | |
127 | * Offset of the function number within the entry. | |
128 | * | |
129 | * HCALL_ENTRY_LABEL - | |
130 | * Offset of the function address within the entry. | |
131 | * | |
132 | * HCALL_ENTRY_SIZE - | |
133 | * Size of one function entry in bytes. | |
134 | */ | |
135 | #define HCALL_ENTRY_INDEX 0 | |
136 | #define HCALL_ENTRY_LABEL 8 | |
137 | #define HCALL_ENTRY_SIZE 16 | |
138 | ||
139 | /* | |
140 | * UPDATE_HCALL_TARGET - update the branch target for an API call | |
141 | * | |
142 | * tbl - address of the fast_trap branch table in memory | |
143 | * fn - fast_trap function# (clobbered) | |
144 | * tgt - target address for the selected branch table entry | |
145 | */ | |
146 | /* BEGIN CSTYLED */ | |
147 | ||
148 | #define UPDATE_HCALL_TARGET(tbl, fn, tgt) \ | |
149 | sllx fn, API_ENTRY_SIZE_SHIFT, fn ;\ | |
150 | stx tgt, [tbl + fn] | |
151 | ||
152 | /* END CSTYLED */ | |
153 | ||
154 | #ifdef __cplusplus | |
155 | } | |
156 | #endif | |
157 | ||
158 | #endif /* _HCALL_H */ |