1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Compiles extern code within a module to a static library, as needed
16 module on_demand_compiler
22 import naive_interpreter
25 redef class ToolContext
28 var opt_compile_dir
= new OptionString("Directory used to generate temporary files", "--compile-dir")
30 init do option_context
.add_option opt_compile_dir
33 redef class AMethPropdef
34 # Does this method definition use the FFI and is it supported by the interpreter?
36 # * Must use the nested foreign code block of the FFI.
37 # * Must not have callbacks.
38 # * Must be implemented in C.
39 # * Must not have a parameter or return typed with a Nit standard class.
40 fun supported_by_dynamic_ffi
: Bool
42 # If the user specfied `is light_ffi`, it must be supported
43 var nats
= get_annotations
("light_ffi")
44 if nats
.not_empty
then return true
46 var n_extern_code_block
= n_extern_code_block
47 if not (n_extern_calls
== null and n_extern_code_block
!= null and
48 n_extern_code_block
.is_c
) then return false
50 for mparam
in mpropdef
.msignature
.mparameters
do
51 if not mparam
.mtype
.is_cprimitive
then
56 var return_mtype
= mpropdef
.msignature
.return_mtype
57 if return_mtype
!= null and not return_mtype
.is_cprimitive
then
65 redef class NaiveInterpreter
66 redef fun start
(mainmodule
)
70 # Delete temporary files
71 var compile_dir
= compile_dir
72 if compile_dir
.file_exists
then compile_dir
.rmdir
75 # Where to store generated C and extracted code
76 private var compile_dir
: String is lazy
do
77 # Prioritize the user supplied directory
78 var opt
= modelbuilder
.toolcontext
.opt_compile_dir
.value
79 if opt
!= null then return opt
80 return "/tmp/niti_ffi_{process_id}"
83 # Identifier for this process, unique between running interpreters
84 private fun process_id
: Int `{ return getpid(); `}
86 # Path of the compiled foreign code library
88 # TODO change the ".so" extension per platform.
89 fun foreign_code_lib_path(mmodule: MModule): String
91 return compile_dir / mmodule.c_name + ".so"
94 # External compiler used to generate the foreign code library
95 private var c_compiler = "cc"
100 # Compile user FFI code and a standardized API into a `.so
` file
102 # Returns `true` on success.
103 fun compile_foreign_lib(v: NaiveInterpreter): Bool
105 var mmodule = mmodule
106 assert mmodule != null
108 var compile_dir = v.compile_dir
109 var foreign_code_lib_path = v.foreign_code_lib_path(mmodule)
111 if not compile_dir.file_exists then compile_dir.mkdir(0o700)
113 # Compile the common FFI part
114 ensure_compile_ffi_wrapper
115 for mclassdef in mmodule.mclassdefs do for mpropdef in mclassdef.mpropdefs do
116 var anode = v.modelbuilder.mpropdef2node(mpropdef)
117 if mpropdef isa MMethodDef and anode isa AMethPropdef and anode.supported_by_dynamic_ffi then
118 anode.compile_ffi_method(mmodule)
121 mmodule.finalize_ffi_wrapper(compile_dir, mmodule)
123 # Compile the standard API and its implementation for the .so file
124 var ccu = compile_foreign_lib_api(compile_dir)
126 var srcs = [for file in ccu.files do new ExternCFile(file, ""): ExternFile]
127 srcs.add_all mmodule.ffi_files
129 # Compiler options specific to this module
130 var ldflags_array = mmodule.ldflags[""]
131 if ldflags_array.has("-lrt") and system("sh -c 'uname -s 2>/dev/null || echo not' | grep Darwin >/dev/null") == 0 then
132 # Remove -lrt on OS X
133 ldflags_array.remove "-lrt"
135 var ldflags = ldflags_array.join(" ")
138 var pkgconfigs = mmodule.pkgconfigs
140 if not pkgconfigs.is_empty then
141 var cmd = "which pkg-config >/dev/null"
142 if system(cmd) != 0 then
143 v.fatal "FFI Error: Command `pkg-config
` not found. Please install it"
147 for p in pkgconfigs do
148 cmd = "pkg-config --exists '{p}'"
149 if system(cmd) != 0 then
150 v.fatal "FFI Error: package {p} is not found by `pkg-config
`. Please install it."
155 pkg_cflags = "`pkg-config
--cflags
{pkgconfigs.join(" ")}`"
156 ldflags += " `pkg-config
--libs
{pkgconfigs.join(" ")}`"
159 # Compile each source file to an object file (or equivalent)
160 var object_files = new Array[String]
162 f.compile(v, mmodule, object_files, pkg_cflags)
165 # Link everything in a shared library
166 var cmd = "{v.c_compiler} -Wall -shared -o {foreign_code_lib_path} {object_files.join(" ")} {ldflags}"
167 if system(cmd) != 0 then
168 v.fatal "FFI Error: Failed to link native code using `{cmd}`"
175 # Compile the standard API of the `.so
` file
177 # * The shared structure `nit_call_arg
`.
178 # * Standardized implementation functions entrypoints that relay calls
179 # to the FFI implementation functions.
180 private fun compile_foreign_lib_api(compdir: String): CCompilationUnit
182 var mmodule = mmodule
183 assert mmodule != null
185 # ready extern code compiler
186 var ecc = new CCompilationUnit
188 ecc.body_decl.add """
192 #include <inttypes.h>
194 // C structure behind `CallArg` from the interpreter
195 typedef union nit_call_arg {
202 uint16_t value_UInt16;
204 uint32_t value_UInt32;
212 var used_types = collect_mtypes
213 for t in used_types do
214 if not t.is_cprimitive then
215 ecc.header_c_types.add "typedef void* {t.cname};\n"
219 # TODO callbacks & casts
221 for nclassdef in n_classdefs do for npropdef in nclassdef.n_propdefs do
222 if npropdef isa AMethPropdef and npropdef.supported_by_dynamic_ffi then
223 npropdef.mpropdef.compile_foreign_code_entry ecc
227 ecc.write_as_foreign_lib_api(mmodule, compdir)
232 # Collect all `MType` use in extern methods within this module
233 private fun collect_mtypes: Set[MType]
235 var used_types = new HashSet[MType]
238 for nclassdef in n_classdefs do for npropdef in nclassdef.n_propdefs do
239 if npropdef isa AMethPropdef and npropdef.supported_by_dynamic_ffi then
240 var fcs = npropdef.foreign_callbacks
241 used_types.add_all fcs.types
249 redef class CCompilationUnit
250 # Write this compilation unit as the API of a foreign code library
251 private fun write_as_foreign_lib_api(mmodule: MModule, compdir: String)
253 # The FFI expects the support header to end with `._nitni
.h
`
254 var base_name = mmodule.c_name + "._nitni"
255 var guard = mmodule.c_name.to_s.to_upper + "_API_H"
256 var header_comment = """
258 Public API to foreign code of the Nit module {{{mmodule.name}}}
263 var h_file = base_name+".h"
264 var stream = new FileWriter.open(compdir/h_file)
265 stream.write header_comment
270 compile_header_core stream
278 var c_file = base_name+".c"
279 stream = new FileWriter.open(compdir/c_file)
280 stream.write header_comment
282 #include "{{{h_file}}}"
284 compile_body_core stream
287 # Only the C files needs compiling
288 files.add compdir / c_file
292 redef class MMethodDef
293 # Name of the entry point to the implementation function in the foreign lib
294 fun foreign_lib_entry_cname: String do return "entry__{cname}"
296 # Compile the standardized entry point as part of the foreign lib API
297 private fun compile_foreign_code_entry(ecc: CCompilationUnit)
299 var msignature = msignature
300 if msignature == null then return
303 var return_mtype = msignature.return_mtype
304 if mproperty.is_init then return_mtype = mclassdef.mclass.mclass_type
307 if return_mtype != null then
308 c_return_type = return_mtype.cname_blind
309 else c_return_type = "void"
311 var is_init = mproperty.is_init
314 var params = new Array[String]
315 if not is_init then params.add mclassdef.mclass.mclass_type.cname_blind
316 for param in msignature.mparameters do params.add param.mtype.cname_blind
318 # Declare the implementation function as extern
319 var impl_cname = mproperty.build_cname(mclassdef.bound_mtype,
320 mclassdef.mmodule, "___impl", long_signature)
321 ecc.body_decl.add "extern {c_return_type} {impl_cname}({params.join(", ")});\n"
323 # Declare the entry function
324 var foreign_lib_entry_cname = "int {foreign_lib_entry_cname}(int argc, nit_call_arg *argv, nit_call_arg *result)"
325 var fc = new CFunction(foreign_lib_entry_cname)
327 # Check argument count on the library side
329 # This may detect inconsistencies between the interpreter and the generated code.
330 var expected_argc = msignature.arity
331 if not is_init then expected_argc += 1
334 if (argc != {{{expected_argc}}}) {
335 printf("Invalid argument count in `{{{mproperty.full_name}}}`, expected %d, got %d.\\n",
336 argc, {{{expected_argc}}});
341 # Unpack and prepare args for the user code
343 var args_for_call = new Array[String]
345 var mtype = mclassdef.mclass.mclass_type
346 var arg_name = "arg___self"
348 fc.decls.add " {mtype.cname_blind} {arg_name};\n"
349 fc.exprs.add " {arg_name} = argv[{k}].{mtype.call_arg_field};\n"
350 args_for_call.add arg_name
354 for param in msignature.mparameters do
355 var mtype = param.mtype
356 var arg_name = "arg__"+param.name
358 fc.decls.add " {mtype.cname_blind} {arg_name};\n"
359 fc.exprs.add " {arg_name} = argv[{k}].{mtype.call_arg_field};\n"
360 args_for_call.add arg_name
365 # Call implementation function
366 var args_compressed = args_for_call.join(", ")
367 var method_call = "{impl_cname}({args_compressed})"
368 if return_mtype != null then
370 {{{return_mtype.cname_blind}}} return_value;
373 return_value = {{{method_call}}};
374 result->{{{return_mtype.call_arg_field}}} = return_value;
377 fc.exprs.add " {method_call};\n"
380 fc.exprs.add " return 0;\n"
382 ecc.add_exported_function fc
387 # The interpreter FFI use `void
*` to represent intern data types
388 redef fun cname_blind do return "void*"
390 # Field to store this type in the C structure `nit_call_arg
`
391 private fun call_arg_field: String do return "value_Pointer"
394 redef class MClassType
395 redef fun call_arg_field
397 if is_cprimitive and mclass.kind != extern_kind then
398 return "value_{name}"
403 redef class ExternFile
404 # Compile this source file
405 private fun compile(v: NaiveInterpreter, mmodule: MModule,
406 object_files: Array[String], pkg_cflags: String): Bool is abstract
409 redef class ExternCFile
410 redef fun compile(v, mmodule, object_files, pkg_cflags)
412 var compile_dir = v.compile_dir
413 var cflags = mmodule.cflags[""].join(" ") + " " + pkg_cflags
414 var obj = compile_dir / filename.basename(".c") + ".o"
416 var cmd = "{v.c_compiler} -Wall -c -fPIC -I {compile_dir} -g -o {obj} {filename} {cflags}"
417 if sys.system(cmd) != 0 then
418 v.fatal "FFI Error: Failed to compile C code using `{cmd}`"