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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
/*
* %CopyrightBegin%
*
* Copyright Ericsson AB 2004-2014. All Rights Reserved.
*
* The contents of this file are subject to the Erlang Public License,
* Version 1.1, (the "License"); you may not use this file except in
* compliance with the License. You should have received a copy of the
* Erlang Public License along with this software. If not, it can be
* retrieved online at http://www.erlang.org/.
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* %CopyrightEnd%
*/
/*
*
* List all non architecture-specific BIFs and primops, and
* classify each as belonging to one of the classes below.
* This list is included in hipe_${ARCH}_bifs.m4, which is
* responsible for translating these classifications to the
* best possible native code wrappers.
*
* XXX: We should have a more detailed BIF classification
* with a number of orthogonal properties (e.g., UPDATES_HP,
* NEEDS_NSP, CAN_FAIL, CAN_GC, etc), from which we should
* generate appropriate interfaces.
*
* The classification is expressed in terms of the resources
* and BIF failure modes described below.
*
* Resources:
* - NSP: native stack pointer
* NSP is read by GC BIFs and primops, and hipe_handle_exception().
* NSP is updated at compiler-inserted calls to hipe_inc_nstack().
* No other BIF or primop may access NSP.
* - NSP_LIMIT: native stack limit
* NSP_LIMIT is only updated at compiler-inserted calls to inc_stack.
* Everywhere else, the cached value equals the value stored in P.
* - NRA: native return address
* NRA is read by GC BIFs and primops, and hipe_handle_exception().
* No BIF or primop may update NRA.
* - HP: heap pointer
* All BIFs can read and update HP.
* Primops with access to P that do not access HP are called "nocons".
* - HP_LIMIT: heap limit
* HP_LIMIT is only updated by GC BIFs and primops.
* Everywhere else, the cached value equals the value stored in P.
* - FCALLS: reduction counter
* All BIFs can read and update FCALLS (because BEAM abuses FCALLS
* to trigger GCs). XXX: can we avoid that overhead?
* All nocons primops do not access FCALLS.
* All other primops with access to P can read and update FCALLS.
* - P: pointer to the state record for the process
*
* BIF failure modes:
* - none: may not signal any exception
* The BIF wrapper needs no checks before returning.
* - standard: may signal any exception
* The BIF wrapper must check for an exception before returning.
* Zero-arity BIFs signal no exceptions, except in a small number
* of cases explicitly enumerated here.
*/
/****************************************************************
* BIF CLASS DESCRIPTIONS *
****************************************************************/
/*
* standard_bif_interface_0(nbif_name, cbif_name)
* standard_bif_interface_1(nbif_name, cbif_name)
* standard_bif_interface_2(nbif_name, cbif_name)
* standard_bif_interface_3(nbif_name, cbif_name)
*
* A BIF with implicit P parameter, 0-3 ordinary parameters,
* which may fail.
* HP and FCALLS may be read and updated.
* HP_LIMIT, NSP, NSP_LIMIT, and NRA may not be accessed.
*/
/*
* nofail_primop_interface_0(nbif_name, cbif_name)
* nofail_primop_interface_1(nbif_name, cbif_name)
* nofail_primop_interface_2(nbif_name, cbif_name)
* nofail_primop_interface_3(nbif_name, cbif_name)
*
* A primop or guard BIF with no failure mode, otherwise
* identical to standard_bif_interface_N.
*/
/*
* gc_bif_interface_0(nbif_name, cbif_name)
* gc_bif_interface_1(nbif_name, cbif_name)
* gc_bif_interface_2(nbif_name, cbif_name)
*
* A BIF which may do a GC or walk the native stack.
* May read NSP, NSP_LIMIT, NRA, HP, HP_LIMIT, and FCALLS.
* May update HP, HP_LIMIT, and FCALLS.
* May not update NSP, NSP_LIMIT, or NRA.
* Otherwise identical to standard_bif_interface_N.
*/
/*
* gc_nofail_primop_interface_1(nbif_name, cbif_name)
*
* A primop with implicit P parameter, 1 ordinary parameter,
* and no failure mode.
* May read NSP, NSP_LIMIT, NRA, HP, HP_LIMIT, and FCALLS.
* May update HP, HP_LIMIT, and FCALLS.
* May not update NSP, NSP_LIMIT, or NRA.
*/
/*
* nocons_nofail_primop_interface_0(nbif_name, cbif_name)
* nocons_nofail_primop_interface_1(nbif_name, cbif_name)
* nocons_nofail_primop_interface_2(nbif_name, cbif_name)
* nocons_nofail_primop_interface_3(nbif_name, cbif_name)
* nocons_nofail_primop_interface_5(nbif_name, cbif_name)
*
* A primop with implicit P parameter, 0-3 or 5 ordinary parameters,
* and no failure mode.
* HP, HP_LIMIT, FCALLS, NSP, NSP_LIMIT, and NRA may not be accessed.
*/
/*
* noproc_primop_interface_0(nbif_name, cbif_name)
* noproc_primop_interface_1(nbif_name, cbif_name)
* noproc_primop_interface_2(nbif_name, cbif_name)
* noproc_primop_interface_3(nbif_name, cbif_name)
* noproc_primop_interface_5(nbif_name, cbif_name)
*
* A primop with no P parameter, 0-3 or 5 ordinary parameters,
* and no failure mode.
* HP, HP_LIMIT, FCALLS, NSP, NSP_LIMIT, and NRA may not be accessed.
*/
/****************************************************************
* BIF CLASSIFICATION *
****************************************************************/
/*
* Zero-arity BIFs that can fail.
*/
standard_bif_interface_0(nbif_processes_0, processes_0)
standard_bif_interface_0(nbif_ports_0, ports_0)
/*
* BIFs and primops that may do a GC (change heap limit and walk the native stack).
* XXX: erase/1 and put/2 cannot fail
*/
gc_bif_interface_2(nbif_erts_internal_check_process_code_2, hipe_erts_internal_check_process_code_2)
gc_bif_interface_1(nbif_erase_1, erase_1)
gc_bif_interface_0(nbif_garbage_collect_0, garbage_collect_0)
gc_nofail_primop_interface_1(nbif_gc_1, hipe_gc)
gc_bif_interface_2(nbif_put_2, put_2)
/*
* Debug BIFs that need read access to the full state.
* hipe_bifs:nstack_used_size/0 only needs read access to NSP.
* They are classified as GC BIFs for simplicity.
*/
gc_bif_interface_1(nbif_hipe_bifs_show_nstack_1, hipe_show_nstack_1)
gc_bif_interface_1(nbif_hipe_bifs_show_pcb_1, hipe_bifs_show_pcb_1)
gc_bif_interface_0(nbif_hipe_bifs_nstack_used_size_0, hipe_bifs_nstack_used_size_0)
gc_bif_interface_2(nbif_hipe_bifs_debug_native_called, hipe_bifs_debug_native_called_2)
/*
* Arithmetic operators called indirectly by the HiPE compiler.
*/
standard_bif_interface_2(nbif_add_2, splus_2)
standard_bif_interface_2(nbif_sub_2, sminus_2)
standard_bif_interface_2(nbif_mul_2, stimes_2)
standard_bif_interface_2(nbif_div_2, div_2)
standard_bif_interface_2(nbif_intdiv_2, intdiv_2)
standard_bif_interface_2(nbif_rem_2, rem_2)
standard_bif_interface_2(nbif_bsl_2, bsl_2)
standard_bif_interface_2(nbif_bsr_2, bsr_2)
standard_bif_interface_2(nbif_band_2, band_2)
standard_bif_interface_2(nbif_bor_2, bor_2)
standard_bif_interface_2(nbif_bxor_2, bxor_2)
standard_bif_interface_1(nbif_bnot_1, bnot_1)
/*
* Miscellaneous primops.
*/
standard_bif_interface_1(nbif_set_timeout, hipe_set_timeout)
standard_bif_interface_1(nbif_conv_big_to_float, hipe_conv_big_to_float)
standard_bif_interface_2(nbif_rethrow, hipe_rethrow)
standard_bif_interface_3(nbif_find_na_or_make_stub, hipe_find_na_or_make_stub)
standard_bif_interface_2(nbif_nonclosure_address, hipe_nonclosure_address)
nocons_nofail_primop_interface_0(nbif_fclearerror_error, hipe_fclearerror_error)
/*
* Mbox primops with implicit P parameter.
*/
nocons_nofail_primop_interface_0(nbif_select_msg, hipe_select_msg)
/*
* Primops without any P parameter.
* These cannot CONS or gc.
*/
noproc_primop_interface_2(nbif_cmp_2, cmp)
noproc_primop_interface_2(nbif_eq_2, eq)
/*
* Bit-syntax primops with implicit P parameter.
* XXX: all of the _2 versions cons on the ordinary heap
* XXX: all of them can cons and thus update FCALLS
*/
nofail_primop_interface_3(nbif_bs_get_integer_2, erts_bs_get_integer_2)
nofail_primop_interface_3(nbif_bs_get_binary_2, erts_bs_get_binary_2)
nofail_primop_interface_3(nbif_bs_get_float_2, erts_bs_get_float_2)
standard_bif_interface_3(nbif_bs_put_utf8, hipe_bs_put_utf8)
standard_bif_interface_3(nbif_bs_put_utf16be, hipe_bs_put_utf16be)
standard_bif_interface_3(nbif_bs_put_utf16le, hipe_bs_put_utf16le)
standard_bif_interface_1(nbif_bs_validate_unicode, hipe_bs_validate_unicode)
/*
* Bit-syntax primops without any P parameter.
* These cannot CONS or gc.
*/
noproc_primop_interface_1(nbif_bs_allocate, hipe_bs_allocate)
noproc_primop_interface_2(nbif_bs_reallocate, hipe_bs_reallocate)
noproc_primop_interface_1(nbif_bs_utf8_size, hipe_bs_utf8_size)
noproc_primop_interface_1(nbif_bs_get_utf8, erts_bs_get_utf8)
noproc_primop_interface_1(nbif_bs_utf16_size, hipe_bs_utf16_size)
noproc_primop_interface_2(nbif_bs_get_utf16, erts_bs_get_utf16)
noproc_primop_interface_2(nbif_bs_validate_unicode_retract, hipe_bs_validate_unicode_retract)
/*
* Bit-syntax primops. The ERTS_SMP runtime system requires P,
* hence the use of nocons_nofail_primop_interface_N().
* When ERTS_SMP is disabled, noproc_primop_interface_N()
* should be used instead.
*/
nocons_nofail_primop_interface_5(nbif_bs_put_small_float, hipe_bs_put_small_float)
noproc_primop_interface_5(nbif_bs_put_bits, hipe_bs_put_bits)
ifelse(ERTS_SMP,1,`
nocons_nofail_primop_interface_5(nbif_bs_put_big_integer, hipe_bs_put_big_integer)
',`
noproc_primop_interface_5(nbif_bs_put_big_integer, hipe_bs_put_big_integer)
')dnl
gc_bif_interface_0(nbif_check_get_msg, hipe_check_get_msg)
#`ifdef' NO_FPE_SIGNALS
nocons_nofail_primop_interface_0(nbif_emulate_fpe, hipe_emulate_fpe)
#endif
/*
* SMP-specific stuff
*/
ifelse(ERTS_SMP,1,`
nocons_nofail_primop_interface_0(nbif_clear_timeout, hipe_clear_timeout)
noproc_primop_interface_1(nbif_atomic_inc, hipe_atomic_inc)
',)dnl
/*
* Standard BIFs.
* BIF_LIST(ModuleAtom,FunctionAtom,Arity,CFun,Index)
*/
/* BIFs that disable GC while trapping are called via a wrapper
* to reserve stack space for the "trap frame".
*/
define(CFUN,`ifelse($1,term_to_binary_1,hipe_wrapper_term_to_binary_1,
ifelse($1,term_to_binary_2,hipe_wrapper_term_to_binary_2,
ifelse($1,binary_to_term_1,hipe_wrapper_binary_to_term_1,
ifelse($1,binary_to_term_2,hipe_wrapper_binary_to_term_2,
ifelse($1,binary_to_list_1,hipe_wrapper_binary_to_list_1,
ifelse($1,binary_to_list_3,hipe_wrapper_binary_to_list_3,
ifelse($1,bitstring_to_list_1,hipe_wrapper_bitstring_to_list_1,
ifelse($1,list_to_binary_1,hipe_wrapper_list_to_binary_1,
ifelse($1,iolist_to_binary_1,hipe_wrapper_iolist_to_binary_1,
ifelse($1,binary_list_to_bin_1,hipe_wrapper_binary_list_to_bin_1,
ifelse($1,list_to_bitstring_1,hipe_wrapper_list_to_bitstring_1,
ifelse($1,send_2,hipe_wrapper_send_2,
ifelse($1,send_3,hipe_wrapper_send_3,
ifelse($1,ebif_bang_2,hipe_wrapper_ebif_bang_2,
$1))))))))))))))')
define(BIF_LIST,`standard_bif_interface_$3(nbif_$4, CFUN($4))')
include(TARGET/`erl_bif_list.h')
/*
* Guard BIFs.
* GBIF_LIST(FunctionAtom,Arity,CFun)
*/
define(GBIF_LIST,`nofail_primop_interface_$2(gbif_$3, $3)')
include(`hipe/hipe_gbif_list.h')
|
