forked from cxreg/zavolaj
-
Notifications
You must be signed in to change notification settings - Fork 0
/
NativeCall.pm6
278 lines (250 loc) · 9.5 KB
/
NativeCall.pm6
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
module NativeCall;
# Throwaway type just to get us some way to get at the NativeCall
# representation.
my class native_callsite is repr('NativeCall') { }
# Maps a chosen string encoding to a type recognized by the native call engine.
sub string_encoding_to_nci_type($enc) {
given $enc {
when 'utf8' { 'utf8str' }
when 'utf16' { 'utf16str' }
when 'ascii' { 'asciistr' }
default { die "Unknown string encoding for native call: $enc"; }
}
}
# Builds a hash of type information for the specified parameter.
sub param_hash_for(Parameter $p, :$with-typeobj) {
my Mu $result := nqp::hash();
my $type := $p.type();
nqp::bindkey($result, 'typeobj', $type) if $with-typeobj;
if $type ~~ Str {
my $enc := $p.?native_call_encoded() || 'utf8';
nqp::bindkey($result, 'type', nqp::unbox_s(string_encoding_to_nci_type($enc)));
nqp::bindkey($result, 'free_str', nqp::unbox_i(1));
}
elsif $type ~~ Callable {
nqp::bindkey($result, 'type', nqp::unbox_s(type_code_for($p.type)));
my $info := param_list_for($p.sub_signature, :with-typeobj);
nqp::unshift($info, return_hash_for($p.sub_signature));
nqp::bindkey($result, 'callback_args', $info);
}
else {
nqp::bindkey($result, 'type', nqp::unbox_s(type_code_for($p.type)));
}
$result
}
# Builds the list of parameter information for a callback argument.
sub param_list_for(Signature $sig, :$with-typeobj) {
my Mu $arg_info := nqp::list();
for $sig.params -> $p {
nqp::push($arg_info, param_hash_for($p, :with-typeobj($with-typeobj)))
}
$arg_info;
}
# Builds a hash of type information for the specified return type.
sub return_hash_for(Signature $s) {
my Mu $result := nqp::hash();
my $returns := $s.returns;
if $returns ~~ Str {
my $enc := &r.?native_call_encoded() || 'utf8';
nqp::bindkey($result, 'type', nqp::unbox_s(string_encoding_to_nci_type($enc)));
nqp::bindkey($result, 'free_str', nqp::unbox_i(0));
}
# TODO: If we ever want to handle function pointers returned from C, this
# bit of code needs to handle that.
else {
nqp::bindkey($result, 'type',
$returns =:= Mu ?? 'void' !! nqp::unbox_s(type_code_for($returns)));
}
$result
}
# Gets the NCI type code to use based on a given Perl 6 type.
my %type_map =
'int8' => 'char',
'int16' => 'short',
'int32' => 'int',
'int' => 'long',
'Int' => 'longlong',
'num32' => 'float',
'num64' => 'double',
'num' => 'double',
'Num' => 'double',
'Callable' => 'callback';
sub type_code_for(Mu ::T) {
return %type_map{T.^name}
if %type_map.exists(T.^name);
return 'cstruct'
if T.REPR eq 'CStruct';
return 'cpointer'
if T.REPR eq 'CPointer';
return 'carray'
if T.REPR eq 'CArray';
die "Unknown type {T.^name} used in native call.\n" ~
"If you want to pass a struct, be sure to use the CStruct representation.\n" ~
"If you want to pass an array, be sure to use the CArray type.";
}
multi sub map_return_type(Mu $type) { Mu }
multi sub map_return_type($type) {
$type === int8 || $type === int16 || $type === int32 || $type === int ?? Int !!
$type === num32 || $type === num64 || $type === num ?? Num !!
$type
}
my role NativeCallSymbol[Str $name] {
method native_symbol() { $name }
}
# This role is mixed in to any routine that is marked as being a
# native call.
my role Native[Routine $r, Str $libname] {
has int $!setup;
has native_callsite $!call is box_target;
method postcircumfix:<( )>($args) {
unless $!setup {
my Mu $arg_info := param_list_for($r.signature);
my str $conv = self.?native_call_convention || '';
my $realname =
!$libname.DEFINITE ?? "" !!
$libname ~~ /\.\w+$/ ?? $libname !!
"$libname$*VM<config><load_ext>";
nqp::buildnativecall(self,
nqp::unbox_s($realname), # library name
nqp::unbox_s(self.?native_symbol // $r.name), # symbol to call
nqp::unbox_s($conv), # calling convention
$arg_info,
return_hash_for($r.signature));
$!setup = 1;
}
nqp::nativecall(nqp::p6decont(map_return_type($r.returns)), self,
nqp::getattr(nqp::p6decont($args), Capture, '$!list'))
}
}
# Role for carrying extra calling convention information.
my role NativeCallingConvention[$name] {
method native_call_convention() { $name };
}
# Role for carrying extra string encoding information.
my role NativeCallEncoded[$name] {
method native_call_encoded() { $name };
}
# Expose an OpaquePointer class for working with raw pointers.
my class OpaquePointer is export(:types, :DEFAULT) is repr('CPointer') { }
# CArray class, used to represent C arrays.
my class CArray is export(:types, :DEFAULT) is repr('CArray') {
method at_pos(CArray:D: $pos) { die "CArray cannot be used without a type" }
my role IntTypedCArray[::TValue] does Positional[TValue] {
multi method at_pos(::?CLASS:D \$arr: $pos) is rw {
Proxy.new:
FETCH => method () {
nqp::p6box_i(nqp::r_atpos_i($arr, nqp::unbox_i($pos.Int)))
},
STORE => method (int $v) {
nqp::r_bindpos_i($arr, nqp::unbox_i($pos.Int), $v);
self
}
}
multi method at_pos(::?CLASS:D \$arr: int $pos) is rw {
Proxy.new:
FETCH => method () {
nqp::p6box_i(nqp::r_atpos_i($arr, $pos))
},
STORE => method (int $v) {
nqp::r_bindpos_i($arr, $pos, $v);
self
}
}
}
multi method PARAMETERIZE_TYPE(Int:U $t) {
self but IntTypedCArray[$t.WHAT]
}
my role NumTypedCArray[::TValue] does Positional[TValue] {
multi method at_pos(::?CLASS:D \$arr: $pos) is rw {
Proxy.new:
FETCH => method () {
nqp::p6box_n(nqp::r_atpos_n($arr, nqp::unbox_i($pos.Int)))
},
STORE => method (num $v) {
nqp::r_bindpos_n($arr, nqp::unbox_i($pos.Int), $v);
self
}
}
multi method at_pos(::?CLASS:D \$arr: int $pos) is rw {
Proxy.new:
FETCH => method () {
nqp::p6box_n(nqp::r_atpos_n($arr, $pos))
},
STORE => method (num $v) {
nqp::r_bindpos_n($arr, $pos, $v);
self
}
}
}
multi method PARAMETERIZE_TYPE(Num:U $t) {
self but NumTypedCArray[$t.WHAT]
}
my role TypedCArray[::TValue] does Positional[TValue] {
multi method at_pos(::?CLASS:D \$arr: $pos) is rw {
Proxy.new:
FETCH => method () {
nqp::r_atpos($arr, nqp::unbox_i($pos.Int))
},
STORE => method ($v) {
nqp::r_bindpos($arr, nqp::unbox_i($pos.Int), nqp::p6decont($v));
self
}
}
multi method at_pos(::?CLASS:D \$arr: int $pos) is rw {
Proxy.new:
FETCH => method () {
nqp::r_atpos($arr, $pos)
},
STORE => method ($v) {
nqp::r_bindpos($arr, $pos, nqp::p6decont($v));
self
}
}
}
multi method PARAMETERIZE_TYPE(Mu:U $t) {
die "A C array can only hold integers, numbers, strings, CStructs, CPointers or CArrays (not $t.perl())"
unless $t === Str || $t.REPR eq 'CStruct' | 'CPointer' | 'CArray';
self but TypedCArray[$t.WHAT]
}
}
multi trait_mod:<is>(Routine $r, :$symbol!) is export(:DEFAULT, :traits) {
$r does NativeCallSymbol[$symbol];
}
# Specifies that the routine is actually a native call, into the
# current executable (platform specific) or into a named library
multi trait_mod:<is>(Routine $r, :$native!) is export(:DEFAULT, :traits) {
$r does Native[$r, $native === True ?? Str !! $native];
}
# Specifies the calling convention to use for a native call.
multi trait_mod:<is>(Routine $r, :$nativeconv!) is export(:DEFAULT, :traits) {
$r does NativeCallingConvention[$nativeconv];
}
# Ways to specify how to marshall strings.
multi trait_mod:<is>(Parameter $p, :$encoded!) is export(:DEFAULT, :traits) {
$p does NativeCallEncoded[$encoded];
}
multi trait_mod:<is>(Routine $p, :$encoded!) is export(:DEFAULT, :traits) {
$p does NativeCallEncoded[$encoded];
}
class CStr is repr('CStr') {
my role Encoding[$encoding] {
method encoding() { $encoding }
}
multi method PARAMETERIZE_TYPE(Str:D $encoding) {
die "Unknown string encoding for native call: $encoding" if not $encoding eq any('utf8', 'utf16', 'ascii');
self but Encoding[$encoding];
}
}
role ExplicitlyManagedString {
has CStr $.cstr is rw;
}
multi explicitly-manage(Str $x is rw, :$encoding = 'utf8') is export(:DEFAULT,
:utils) {
$x does ExplicitlyManagedString;
$x.cstr = pir::repr_box_str__PsP(nqp::unbox_s($x), CStr[$encoding]);
}
multi refresh($obj) is export(:DEFAULT, :utils) {
nqp::nativecallrefresh($obj);
1;
}
# vim:ft=perl6