<?xml version="1.0" encoding="ISO-8859-1"?>

<!DOCTYPE message PUBLIC
  "-//MLarc//DTD MLarc output files//EN"
  "../../mlarc.dtd"[
  <!ATTLIST message
    listname CDATA #REQUIRED
    title CDATA #REQUIRED
  >
]>

  <?xml-stylesheet href="../../mlarc.xsl" type="text/xsl"?>


<message 
  url="2003/07/c3abb130a34e05c89945e77f613ee37a"
  from="Xavier Leroy &lt;xavier.leroy@i...&gt;"
  author="Xavier Leroy"
  date="2003-07-17T20:27:43"
  subject="Re: [Caml-list] Two questions about using the CamlIDL"
  prev="2003/07/0b7f43c027ae0ddfa89dde1ef71f3a84"
  next="2003/07/e9c6124bdfecdfc3581bcce8c957f2ca"
  prev-in-thread="2003/07/348514c77483a81afd734d23858d5f77"
  next-in-thread="2003/07/dab979091d49d8282ce0ef1bf019d413"
  prev-thread="2003/07/ccd92eb3783074eb7e12bf2b325ce13c"
  next-thread="2003/07/342f857b4e404c7db28559ad8cefffb0"
  root="../../"
  period="month"
  listname="caml-list"
  title="Archives of the Caml mailing list">

<thread subject="[Caml-list] Two questions about using the CamlIDL">
<msg 
  url="2003/07/348514c77483a81afd734d23858d5f77"
  from="Mary Fernandez &lt;mff@r...&gt;"
  author="Mary Fernandez"
  date="2003-07-17T15:25:28"
  subject="[Caml-list] Two questions about using the CamlIDL">
<msg 
  url="2003/07/c3abb130a34e05c89945e77f613ee37a"
  from="Xavier Leroy &lt;xavier.leroy@i...&gt;"
  author="Xavier Leroy"
  date="2003-07-17T20:27:43"
  subject="Re: [Caml-list] Two questions about using the CamlIDL">
<msg 
  url="2003/07/dab979091d49d8282ce0ef1bf019d413"
  from="Mary Fernandez &lt;mff@r...&gt;"
  author="Mary Fernandez"
  date="2003-07-18T16:49:44"
  subject="Re: [Caml-list] Two questions about using the CamlIDL">
</msg>
</msg>
</msg>
</thread>

<contents>
&gt; Our Caml application is unusual in that the Caml
&gt; app calls C functions, which in turn may call
&gt; Caml functions that return Caml objects to C, 
&gt; which in turn return those Caml objects back to the 
&gt; Caml app.  
&gt; 
&gt; 1. It is not clear how to use the CamlIDL type syntax 
&gt; to define the type of a Caml value that will be returned from C.

Here is a simplistic solution:

  quote(c, "#include "camlobj.h")

  typedef [mltype(string), c2ml(long_to_camlobj), ml2c(camlobj_to_long)]
    long camlobj;

  camlobj f(camlobj v);

where camlobj.h contains:

  typedef long camlobj;
  #define long_to_camlobj(c) (*(c))
  #define camlobj_to_long(v,c) (*(c) = (v))

Basically, a "camlobj" is a long integer whose coercions to and from
the Caml "value" type are the identity function.  

You didn't say what Caml type the Caml objects should have.  I put
"string" here, but any closed type will do.  

The problem with this solution is that the Caml values that transit
through the C code under the type "camlobj" are not known to the GC.
Hence, if a GC occurs (e.g. because your C functions call several Caml
functions in turn), the "camlobj" values will become wrong.

A way to avoid this is to wrap the Caml values in a malloced block that
is registered with the Caml GC:

  quote(c, "#include &lt;camlobj.h&gt;)

  typedef [mltype(string), c2ml(unpack_camlobj), ml2c(pack_camlobj)]
    struct packed_camlobj * camlobj;

  camlobj f(camlobj v);

where camlobj.h is

  typedef struct packed_camlobj { value v; } * camlobj;
  extern void pack_camlobj(value v, camlobj * c);
  extern value unpack_camlobj(camlobj * c);

and camlobj.c contains

  void pack_camlobj(value v, camlobj * c)
  {
    camlobj p = malloc(sizeof(struct packed_camlobj));
    p-&gt;v = v;
    register_global_root(&amp;(p-&gt;v));
    *c = p;
  }

  value unpack_camlobj(camlobj * c)
  {
    camlobj p = *c;
    value v = p-&gt;v;
    remove_global_root(&amp;(p-&gt;v));
    free(p);
    return v;
  }

Notice that unpack_camlobj removes the GC root and destroys the
block allocated by malloc().  This is adequate (I hope :-) if your C
code never stores a camlobj in a global data structure, but simply
passes them around.  In more complex situations, you'd need to add a
reference count to the struct packed_camlobj and make sure that the C
code maintains this refcount properly.

&gt; 2. Assuming we can specify the above type, the c_function 
&gt; that calls back into Caml will look something like this:
&gt; 
&gt;   CamlObj c_function() { 
&gt;     CAMLparam0();
&gt;     CAMLlocal2(caml_obj, args);
&gt; 
&gt;     ... Usual set up to get pointer to Caml function 
&gt;     and allocate space for args ...
&gt;     
&gt;     caml_obj = callbackN(*caml_function_closure, 0, args)
&gt; 
&gt;     CAMLreturn(caml_obj);
&gt;   }
&gt; 
&gt; Because c_function will be called from the IDL stub functions,
&gt; do we have to modify the stub functions to follow the same
&gt; function-call protocol as above?

I'm not sure I completely understand your question.  If you're asking
about GC registration of memory roots, I think the "packed_camlobj"
approach above addresses the issue in a way that does not need
modifying the stub functions nor the intermediate C functions themselves.

One last word: in cases of complex C/Caml interactions, as in your
example, it's often easier to work out the (GC) issues first by
writing by hand the stubs for a few functions.  Using CamlIDL from the
beginning makes things even more obscure :-)

Hope this helps,

- Xavier Leroy

-------------------
To unsubscribe, mail caml-list-request@inria.fr Archives: http://caml.inria.fr
Bug reports: http://caml.inria.fr/bin/caml-bugs FAQ: http://caml.inria.fr/FAQ/
Beginner's list: http://groups.yahoo.com/group/ocaml_beginners

</contents>

</message>

