forked from SDL-Hercules-390/hyperion
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_archdep_templ.c
251 lines (201 loc) · 10.8 KB
/
_archdep_templ.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
/* XXXXXXX.C (C) Copyright Your name or company, YYYY */
/* Short module description goes here */
/* */
/* Released under "The Q Public License Version 1" */
/* (http://www.hercules-390.org/herclic.html) as modifications to */
/* Hercules. */
/*-------------------------------------------------------------------*/
/* This module implements blah, blah, blah... */
/* ... described in the manual XXnn-nnnn-vv "Name of Manual"... */
/* Basically a short description of this module's purpose. */
/*-------------------------------------------------------------------*/
/*-------------------------------------------------------------------*/
/* Optional Additional credits section: */
/* Name of other people who have contributed to this module */
/* and possibly a description of what they contributed, */
/* as well as any people who helped or inspired you... */
/*-------------------------------------------------------------------*/
#if 0 // ** REMOVE ME! ** REMOVE ME! ** REMOVE ME! ** REMOVE ME! **
#include "hstdinc.h" // (MUST ALWAYS BE FIRST)
#define _XXXXXXX_C_ // (ALWAYS) (see hexterns.h)
#define _XXXXX_DLL_ // (ALWAYS) (usually _HENGINE_DLL_)
#include "hercules.h" // (ALWAYS) (needed by most modules)
//#include "xxxxxx.h" // (other needed includes go here)
//#include "xxxxxx.h" // (other needed includes go here)
//#include "xxxxxx.h" // (other needed includes go here)
/*-------------------------------------------------------------------*/
/* ARCH_DEP section: compiled multiple times, once for each arch. */
/*-------------------------------------------------------------------*/
// Note: non-arch-dep static functions should ideally be at the end
// but you can put them here by using an ifdef similar to the below
#if !defined( COMPILE_THIS_ONLY_ONCE )
#define COMPILE_THIS_ONLY_ONCE
/*-------------------------------------------------------------------*/
/* non_arch_dep_static_helper_one */
/*-------------------------------------------------------------------*/
static int non_arch_dep_static_helper_two( xxx... ); // (fwd ref)
static int non_arch_dep_static_helper_one( xxx... )
{
//------------------------------------------------------------
// IMPORTANT
// You MUST NOT use any feature.h macros in your non-arch_dep
// functions. See the IMPORTANT PROGRAMMING NOTE at the end.
//------------------------------------------------------------
return 0;
}
#endif // COMPILE_THIS_ONLY_ONCE
//-------------------------------------------------------------------
// ARCH_DEP() code
//-------------------------------------------------------------------
// ARCH_DEP (build-architecture / FEATURE-dependent) functions here.
// All BUILD architecture dependent (ARCH_DEP) function are compiled
// multiple times (once for each defined build architecture) and each
// time they are compiled with a different set of FEATURE_XXX defines
// appropriate for that architecture. Use #ifdef FEATURE_XXX guards
// to check whether the current BUILD architecture has that given
// feature #defined for it or not. WARNING: Do NOT use _FEATURE_XXX.
// The underscore feature #defines mean something else entirely. Only
// test for FEATURE_XXX. (WITHOUT the underscore)
//-------------------------------------------------------------------
/*-------------------------------------------------------------------*/
/* arch_dep_helper_func */
/*-------------------------------------------------------------------*/
static int ARCH_DEP( arch_dep_helper_func )( function arguments... )
{
return 0;
}
/*-------------------------------------------------------------------*/
/* Advanced function description including purpose... */
/* */
/* Input: */
/* aaaaa Some input parameter */
/* bbbbb Another input parameter */
/* */
/* Output: */
/* ccccc Updated parameter */
/* */
/* Returns: */
/* Description of return code if any */
/* */
/* Detailed description of functionality... Detailed description */
/* of functionality... Detailed description of functionality... */
/* Detailed description of functionality... Detailed description */
/* of functionality... Detailed description of functionality... */
/* */
/*-------------------------------------------------------------------*/
int ARCH_DEP( foobar_func )( REGS* regs, xxx... )
{
RADR raddr;
VADR vaddr;
int rc;
/* call non-archdep helper function */
foo();
/* call another arch-dep function */
ARCH_DEP( some_other_func )( regs, &raddr, &vaddr );
#if defined( FEATURE_nnn_XXXX_FACILITY )
if (FACILITY_ENABLED( nnn_XXXX, regs ))
{
rc = 0;
}
else
rc = -1;
#endif // defined( FEATURE_nnn_XXXX_FACILITY )
#if defined( FEATURE_XXX )
/* Code to handle this feature... */
#endif // defined( FEATURE_XXX )
return rc;
} /* end function foobar_func */
/*-------------------------------------------------------------------*/
/* (delineates ARCH_DEP from non-arch_dep) */
/*-------------------------------------------------------------------*/
#if !defined( _GEN_ARCH )
#if defined( _ARCH_NUM_1 )
#define _GEN_ARCH _ARCH_NUM_1
#include "ourselves.c"
#endif
#if defined( _ARCH_NUM_2 )
#undef _GEN_ARCH
#define _GEN_ARCH _ARCH_NUM_2
#include "ourselves.c"
#endif
/*-------------------------------------------------------------------*/
/* (delineates ARCH_DEP from non-arch_dep) */
/*-------------------------------------------------------------------*/
/*-------------------------------------------------------------------*/
/* non-ARCH_DEP section: compiled only ONCE after last arch built */
/*-------------------------------------------------------------------*/
/* Note: the last architecture has been built so the normal non- */
/* underscore FEATURE values are now #defined according to the */
/* LAST built architecture just built (usually zarch = 900). This */
/* means from this point onward (to the end of file) you should */
/* ONLY be testing the underscore _FEATURE values to see if the */
/* given feature was defined for *ANY* of the build architectures. */
/*-------------------------------------------------------------------*/
/*-------------------------------------------------------------------*/
/* non_arch_dep_static_helper_two */
/*-------------------------------------------------------------------*/
static int non_arch_dep_static_helper_two( xxx... )
{
//------------------------------------------------------------
// IMPORTANT
// You MUST NOT use any feature.h macros in your non-arch_dep
// functions. See the IMPORTANT PROGRAMMING NOTE just below.
//------------------------------------------------------------
return 0;
}
//-------------------------------------------------------------------
// _FEATURE_XXX code
//-------------------------------------------------------------------
// Place any _FEATURE_XXX depdendent functions (WITH the underscore)
// here. You may need to define such functions whenever one or more
// build architectures has a given FEATURE_XXX (WITHOUT underscore)
// defined for it. The underscore means AT LEAST ONE of the build
// architectures #defined that feature. (See featchk.h) You must NOT
// use any #ifdef FEATURE_XXX here. Test for ONLY for _FEATURE_XXX.
// The functions in this area are compiled ONCE (only ONE time) and
// ONLY one time but are always compiled LAST after everything else.
//-------------------------------------------------------------------
/*********************************************************************/
/* IMPORTANT PROGRAMMING NOTE */
/*********************************************************************/
/* */
/* It is CRITICALLY IMPORTANT to not use any architecture dependent */
/* macros anywhere in any of your non-arch_dep functions. This means */
/* you CANNOT use GREG, RADR, VADR, etc. anywhere in your function, */
/* nor can you call "ARCH_DEP(func)(args)" anywhere in your code! */
/* */
/* Basically you MUST NOT use any architecture dependent macro that */
/* is #defined in the "feature.h" header. If you you need to use */
/* any of them, then your function MUST be an "ARCH_DEP" function */
/* that is placed within the ARCH_DEP section at the beginning of */
/* this module where it can be compiled multiple times, once for */
/* each of the supported architectures so the macro gets #defined */
/* to its proper value for the architecture. YOU HAVE BEEN WARNED. */
/* */
/*********************************************************************/
#if defined( _FEATURE_XXX ) // (is FEATURE_XXX code needed?)
/*-------------------------------------------------------------------*/
/* This function is needed to support FEATURE_XXX. */
/* This is an example of a RUN-TIME-ARCHITECTURE dependent function */
/*-------------------------------------------------------------------*/
int feature_xxx_func( REGS* regs )
{
int rc;
switch( regs->arch_mode ) // (switch based on RUN-TIME archmode)
{
#if defined( _370 )
case ARCH_370_IDX: rc = s370_foobar_func( regs, ... ); break;
#endif
#if defined( _390 )
case ARCH_390_IDX: rc = s390_foobar_func( regs, ... ); break;
#endif
#if defined( _900 )
case ARCH_900_IDX: rc = z900_foobar_func( regs, ... ); break;
#endif
default: CRASH();
}
return rc;
}
#endif // _FEATURE_XXX
#endif // !defined(_GEN_ARCH)
#endif // ** REMOVE ME! ** REMOVE ME! ** REMOVE ME! ** REMOVE ME! **