package ocaml_intrinsics

  1. Overview
  2. Docs

Source file prefetch_expert.ml

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
(* Prefetch any ocaml value *)

(* The same native C stubs can be used for value and unboxed native pointer
   inputs: the C type of the formal argument is value and
   intnat, respectively, and value is defined as intnat. *)

(* Prefetching hints are meant for highly-optimized code, the bytecode stubs do nothing,
   so they all call the same C stub [caml_prefetch_ignore]. *)

(* Prefetching primitives should not be annotated with [@@no_effects].
   Otherwise, the compiler can eliminate them, because they have no result. *)

external prefetch_write_high
  :  'a
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_high"
  [@@noalloc] [@@builtin]

external prefetch_write_moderate
  :  'a
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_moderate"
  [@@noalloc] [@@builtin]

external prefetch_write_low
  :  'a
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_low"
  [@@noalloc] [@@builtin]

external prefetch_write_none
  :  'a
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_none"
  [@@noalloc] [@@builtin]

external prefetch_read_none
  :  'a
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_none"
  [@@noalloc] [@@builtin]

external prefetch_read_low : 'a -> unit = "caml_prefetch_ignore" "caml_prefetch_read_low"
  [@@noalloc] [@@builtin]

external prefetch_read_moderate
  :  'a
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_moderate"
  [@@noalloc] [@@builtin]

external prefetch_read_high
  :  'a
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_high"
  [@@noalloc] [@@builtin]

(* Prefetch at the given byte offset from an OCaml value. *)

external prefetch_write_high_val_offset
  :  'a
  -> byte_offset:(int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_write_high_val_offset_untagged"
  [@@noalloc] [@@builtin]

external prefetch_write_moderate_val_offset
  :  'a
  -> byte_offset:(int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_write_moderate_val_offset_untagged"
  [@@noalloc] [@@builtin]

external prefetch_write_low_val_offset
  :  'a
  -> byte_offset:(int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_write_low_val_offset_untagged"
  [@@noalloc] [@@builtin]

external prefetch_write_none_val_offset
  :  'a
  -> byte_offset:(int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_write_none_val_offset_untagged"
  [@@noalloc] [@@builtin]

external prefetch_read_none_val_offset
  :  'a
  -> byte_offset:(int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_read_none_val_offset_untagged"
  [@@noalloc] [@@builtin]

external prefetch_read_low_val_offset
  :  'a
  -> byte_offset:(int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_read_low_val_offset_untagged"
  [@@noalloc] [@@builtin]

external prefetch_read_moderate_val_offset
  :  'a
  -> byte_offset:(int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_read_moderate_val_offset_untagged"
  [@@noalloc] [@@builtin]

external prefetch_read_high_val_offset
  :  'a
  -> byte_offset:(int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_read_high_val_offset_untagged"
  [@@noalloc] [@@builtin]

(* Native_pointer *)

external prefetch_write_high_native_pointer
  :  (Native_pointer.t[@unboxed])
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_high"
  [@@noalloc] [@@builtin]

external prefetch_write_moderate_native_pointer
  :  (Native_pointer.t[@unboxed])
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_moderate"
  [@@noalloc] [@@builtin]

external prefetch_write_low_native_pointer
  :  (Native_pointer.t[@unboxed])
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_low"
  [@@noalloc] [@@builtin]

external prefetch_write_none_native_pointer
  :  (Native_pointer.t[@unboxed])
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_none"
  [@@noalloc] [@@builtin]

external prefetch_read_none_native_pointer
  :  (Native_pointer.t[@unboxed])
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_none"
  [@@noalloc] [@@builtin]

external prefetch_read_low_native_pointer
  :  (Native_pointer.t[@unboxed])
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_low"
  [@@noalloc] [@@builtin]

external prefetch_read_moderate_native_pointer
  :  (Native_pointer.t[@unboxed])
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_moderate"
  [@@noalloc] [@@builtin]

external prefetch_read_high_native_pointer
  :  (Native_pointer.t[@unboxed])
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_high"
  [@@noalloc] [@@builtin]

(* Ext_pointer *)

external prefetch_write_high_ext_pointer
  :  Ext_pointer.t
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_high_ext_pointer"
  [@@noalloc] [@@builtin]

external prefetch_write_moderate_ext_pointer
  :  Ext_pointer.t
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_moderate_ext_pointer"
  [@@noalloc] [@@builtin]

external prefetch_write_low_ext_pointer
  :  Ext_pointer.t
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_low_ext_pointer"
  [@@noalloc] [@@builtin]

external prefetch_write_none_ext_pointer
  :  Ext_pointer.t
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_write_none_ext_pointer"
  [@@noalloc] [@@builtin]

external prefetch_read_none_ext_pointer
  :  Ext_pointer.t
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_none_ext_pointer"
  [@@noalloc] [@@builtin]

external prefetch_read_low_ext_pointer
  :  Ext_pointer.t
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_low_ext_pointer"
  [@@noalloc] [@@builtin]

external prefetch_read_moderate_ext_pointer
  :  Ext_pointer.t
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_moderate_ext_pointer"
  [@@noalloc] [@@builtin]

external prefetch_read_high_ext_pointer
  :  Ext_pointer.t
  -> unit
  = "caml_prefetch_ignore" "caml_prefetch_read_high_ext_pointer"
  [@@noalloc] [@@builtin]

(* Bigstring *)

external prefetch_write_high_bigstring
  :  Bigstring_intf.t
  -> (int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_write_high_bigstring_untagged"
  [@@noalloc] [@@builtin]

external prefetch_write_moderate_bigstring
  :  Bigstring_intf.t
  -> (int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_write_moderate_bigstring_untagged"
  [@@noalloc] [@@builtin]

external prefetch_write_low_bigstring
  :  Bigstring_intf.t
  -> (int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_write_low_bigstring_untagged"
  [@@noalloc] [@@builtin]

external prefetch_write_none_bigstring
  :  Bigstring_intf.t
  -> (int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_write_none_bigstring_untagged"
  [@@noalloc] [@@builtin]

external prefetch_read_none_bigstring
  :  Bigstring_intf.t
  -> (int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_read_none_bigstring_untagged"
  [@@noalloc] [@@builtin]

external prefetch_read_low_bigstring
  :  Bigstring_intf.t
  -> (int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_read_low_bigstring_untagged"
  [@@noalloc] [@@builtin]

external prefetch_read_moderate_bigstring
  :  Bigstring_intf.t
  -> (int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_read_moderate_bigstring_untagged"
  [@@noalloc] [@@builtin]

external prefetch_read_high_bigstring
  :  Bigstring_intf.t
  -> (int[@untagged])
  -> unit
  = "caml_prefetch_ignore2" "caml_prefetch_read_high_bigstring_untagged"
  [@@noalloc] [@@builtin]