AMD64 alien-indirect support; document alien-indirect

doc/handbook/alien.facts

@@ -30,6 +30,8 @@ ARTICLE: "alien-invoke" "Calling C from Factor"
 $terpri
 "The above parsing words create word definitions which call a lower-level word; you can use it directly, too:"
 { $subsection alien-invoke }
+"Sometimes it is necessary to invoke a C function pointer, rather than a named C function:"
+{ $subsection alien-indirect }
 "There are some details concerning the conversion of Factor objects to C values, and vice versa. See " { $link "c-types" } "." ;
 
 ARTICLE: "alien-callback" "Calling Factor from C"

library/compiler/alien/alien-callback.facts

@@ -21,4 +21,4 @@ HELP: alien-callback
     }
 }
 { $errors "Throws an " { $link alien-callback-error } " if the word calling " { $link alien-callback } " is not compiled." }
-{ $see-also alien-invoke } ;
+{ $see-also alien-invoke alien-indirect } ;

library/compiler/alien/alien-indirect.facts

@@ -0,0 +1,13 @@
+IN: alien
+USING: errors help ;
+
+HELP: alien-indirect-error
+{ $error-description "Thrown when " { $link alien-indirect } " is called in the interpreter.  Words using " { $link alien-indirect } " must be compiled first, and all three inputs to " { $link alien-indirect } " must be literals." } ;
+
+HELP: alien-indirect
+{ $values { "funcptr" "a C function pointer" } { "return" "a C return type" } { "parameters" "a sequence of C parameter types" } { "abi" "one of " { $snippet "\"cdecl\"" } " or " { $snippet "\"stdcall\"" } } }
+{ $description
+    "Invokes a C function pointer passed on the data stack. Input parameters are taken from the data stack following the function pointer, and the return value is pushed on the data stack after the function returns. A return type of " { $snippet "\"void\"" } " indicates that no value is to be expected."
+}
+{ $errors "Throws an " { $link alien-indirect-error } " if the word calling " { $link alien-indirect } " is not compiled." }
+{ $see-also alien-invoke alien-callback } ;

library/compiler/alien/alien-invoke.facts

@@ -8,7 +8,7 @@ HELP: alien-invoke
 { $values { "return" "a C return type" } { "library" "a logical library name" } { "function" "a C function name" } { "parameters" "a sequence of C parameter types" } }
 { $description "Calls a C library function with the given name. Input parameters are taken from the data stack, and the return value is pushed on the data stack after the function returns. A return type of " { $snippet "\"void\"" } " indicates that no value is to be expected." }
 { $errors "Throws an " { $link alien-invoke-error } " if the word calling " { $link alien-invoke } " is not compiled." }
-{ $see-also alien-callback } ;
+{ $see-also alien-indirect alien-callback } ;
 
 HELP: define-c-word
 { $values { "return" "a C return type" } { "library" "a logical library name" } { "function" "a C function name" } { "parameters" "a sequence of C parameter types" } }

library/compiler/amd64/alien.factor

@@ -48,8 +48,12 @@ M: stack-params %freg>stack
 : %alien-invoke ( symbol dll -- )
     reset-sse compile-c-call ;
 
+: alien-temp ( quot -- )
+    0 R11 MOV "alien_temp" f rel-absolute-cell rel-dlsym
+    R11 swap call ; inline
+
 : %alien-indirect ( -- )
-    "unbox_alien" f %alien-invoke  RAX CALL ;
+    reset-sse [ CALL ] alien-temp ;
 
 : %alien-callback ( quot -- )
     RDI load-indirect "run_callback" f compile-c-call ;

library/compiler/load.factor

@@ -33,6 +33,7 @@ PROVIDE: library/compiler {
     "alien/syntax.factor"
 
     "alien/alien-callback.facts"
+    "alien/alien-indirect.facts"
     "alien/alien-invoke.facts"
     "alien/aliens.facts"
     "alien/c-types.facts"

library/compiler/x86/architecture.factor

@@ -30,10 +30,11 @@ M: cs-loc v>operand cs-loc-n cs-reg reg-stack ;
 
 : alien-temp ( quot -- )
     0 [] swap call "alien_temp" f rel-absolute rel-dlsym ;
+    inline
 
 : %prepare-alien-indirect ( -- )
     "unbox_alien" f %alien-invoke
-    [ EAX MOV ] alien-temp ;
+    [ T{ int-regs } return-reg MOV ] alien-temp ;
 
 : %alien-indirect ( -- )
     [ CALL ] alien-temp ;