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 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
|
(* Generator for library stubs
For examples, see nettls-gnutls and netgss-system.
----------------------------------------------------------------------
Declaration of functions:
----------------------------------------------------------------------
let functions = [ decl1; decl2; ... ]
Every declaration is a triple (name, parameters, directives).
Parameters: a list of triples (name, kind, type).
Parameter kinds: Input parameters appear in the argument list of the
OCaml binding. Output parameter appear in the result tuple.
- `In: the parameter is an input
- `In_ptr: same, but passed as pointer
- `In_ignore: the parameter is an input. The OCaml interface omits it.
- `Out: the parameter is an output. The C function gets only a pointer
to a value of [type], and needs to initialize it.
- `Out_ignore: the parameter is an output, but is omitted in the OCaml
interface.
- `Out_noptr: the parameter is an output. In this variant, the C function
gets the value of [type] directly (no pointer), and modifies its
contents.
- `In_out: the parameter is an input and an output. The C function gets
a pointer to a value of [type]
- `In_out_noptr: the parameter is an input and an output. No pointer
here.
- `Return: the return value of the C function. Appears in the result
tuple of the OCaml binding.
- `Return_ignore: the return value of the C function, omitted in the
OCaml binding.
The type may be one of the following:
type C mapping OCaml mapping
------------------------------------------------------------
void void unit
int int int
uint unsigned int int
int32 int32_t int32
uint32 int32_t int32
bool int bool
ubool unsigned int bool
double double float
file_descr int Unix.file_descr
ztstr char * string
(zero-terminated string)
t ztlist map(t) * map(t) list
(zero-terminated list of pointers; t may be any type)
t array map(t) * map(t) array
(array of pointers; t may be any type)
pname array_size size_t int
(must be used in conjuction with a "t array" parameter, and the name
of this other parameter must be specified as pname)
pname array_size_uint unsigned int int
(must be used in conjuction with a "t array" parameter, and the name
of this other parameter must be specified as paramname)
id bigarray void * Netsys_mem.memory
(the id is an arbitrary identifier)
id bigarray_size size_t int
(must be used in conjunction with "bigarray", same id)
id stringbuf void * bytes
(the id is an arbitrary identifier)
id stringbuf_size size_t int
(must be used in conjunction with "stringbuf", same id)
id ztstringbuf void * bytes
(zero-terminated; the id is an arbitrary identifier)
id ztstringbuf_size size_t int
(must be used in conjunction with "stringbuf", same id)
Also, you can use the special notation
t1/t2
meaning that t1 is used on the C side, but it has the same properties
as t2, and t2 is also used for the OCaml mapping.
All other type names: It is expected that a type wrapper is defined
for the type. See next section.
DIRECTIVES:
- `Optional: the function is only optionally available. A macro
HAVE_FUN_<name> is tested.
- `Declare "decl": This C declaration is added to the declarations
in the generated stub function.
- `Pre "stm": This C statement is emitted just before the wrapped
function is called.
- `Post "stm": This C statement is emitted after the wrapped
function is called.
- `GNUTLS_ask_for_size: special feature for GNUTLS
----------------------------------------------------------------------
Declaration of type wrappers:
----------------------------------------------------------------------
let types = [ (name1, decl1); (name2, decl2); ... ]
Possible declarations:
- `Manual "type name = something"
just add the type definition to the ml code. Do nothing on the C side.
The user has to manually write the wrapper helpers (when t is the type
name):
static t unwrap_t(value);
static value wrap_t(t);
- abstract_ptr "free_function"
Generates wrapper helpers for a pointer-like type. The user must write
a C function that releases memory:
static void free_function(t);
- tagged_abstract_ptr "free_function2"
Generates wrapper helpers for a pointer-like type. The user must write
a C function that releases memory:
static void free_function2(long,t);
In this variant, the free function gets a long as first argument, the
tag. The tag will be 0 for all values that are wrapped by wrap_t, i.e.
for all wrapped values returned by C code. Other tag values can be
defined by the user. The generator also emits code for
static value twrap_t(long,t);
which sets the tag to the passed long. The idea is to memoize in the tag
how the value was once allocated, and use the right method for
deallocation.
- `Abstract_enum
XXX
- `Enum cases
This is for an enumerator type (either an "enum", or a simulated enum
declared as integer where the cases are available as macros). The
cases are given as a list [ "value1"; "value2"; ... ].
A few special notations are understood:
VERTICAL BAR: "PREFIX|SUFFIX". In C the value is known as "PREFIXSUFFIX".
The OCaml version uses only "SUFFIX".
QUESTION MARK: "?VALUE". The value is only optionally available.
(Dependent on a macro HAVE_ENUM_ plus the value name)
- `Flags flags
Flags that are bitwise OR-ed. The flags are given as list
[ "value1"; "value2"; ... ].
Works very much like `Enum.
- `Same_as "other_type"
Treat this type as an alias for another type.
----------------------------------------------------------------------
Generating
----------------------------------------------------------------------
Call the generator as
generate
~c_file:"helpers.c"
~ml_file:"helpers.ml"
~mli_file:"helpers.mli"
~optional_functions: [ "fun1"; "fun2"; ... ]
~optional_types: [ "t1"; "t2"; ... ]
~enum_of_string: [ "t1"; "t2"; ... ]
~modname:"modulename"
~types (* type wrappers, see above *)
~functions (* functions, see above *)
~free: [ "t1"; "t2"; ... ]
~init: [ "t1"; "t2"; ... ]
~hashes: [ "h1"; "h2"; ... ]
()
The generated code will go into:
- modulename.ml
- modulename.mli
- modulename_stubs.c
Also, a shell script config_checks.sh is generated: For every optional
function, optional type, or optional value a shell function is called.
The user is expected to define this shell function.
optional_functions: Additional functions to check for.
optional_types: additional types to check for.
enum_of_string: For `Enum types, additional functions are generated
that map the enum values to and from strings.
free: If a type is listed here, and there is an input or in/out parameter
of this type, the generator will emit the code
free_<t>(value)
after calling the wrapped function.
init: If a type is listed here, and there is an output-only parameter of this
type (i.e. not in/out), the generator will emit the code
init_<t>(&variable)
before calling the wrapped function.
*)
#directory "+compiler-libs"
(* only for Btype.hash_variant *)
#load "str.cma"
#load "ocamlcommon.cma"
open Printf
let p1_re = Str.regexp "^\\(.*\\)(\\(.*\\))"
let p2_re = Str.regexp "[ \t]*,[ \t]*"
let p3_re = Str.regexp "[ \t]+"
let parse decl =
(* Parsing helper, optional *)
try
if Str.string_match p1_re decl 0 then (
let part1 = Str.matched_group 1 decl in
let part2 = Str.matched_group 2 decl in
let result_name = Str.split p3_re part1 in
let params =
List.map
(fun param_s ->
let l = Str.split p3_re param_s in
let tag, l1 =
match l with
| "IN" :: l1 -> (`In, l1)
| "IN_PTR" :: l1 -> (`In_ptr, l1)
| "IN_IGNORE" :: l1 -> (`In_ignore, l1)
| "IN_OUT" :: l1 -> (`In_out, l1)
| "OUT" :: l1 -> (`Out, l1)
| "OUT_IGNORE" :: l1 -> (`Out_ignore, l1)
| "OUT_NOPTR" :: l1 -> (`Out_noptr, l1)
| _ -> (`In, l) in
let n = List.hd (List.rev l1) in
let ty = List.rev (List.tl (List.rev l1)) in
(n, tag, String.concat " " ty)
)
(Str.split p2_re part2) in
let name = List.hd (List.rev result_name) in
let result = List.rev (List.tl (List.rev result_name)) in
(name, String.concat " " result, params)
)
else raise Not_found
with
| Not_found ->
failwith ("Parse error: " ^ decl)
let has_prefix ~prefix s =
let l1 = String.length s in
let l2 = String.length prefix in
l2 <= l1 && String.sub s 0 l2 = prefix
type abs_ptr =
{ abs_free_fn : [`Untagged of string | `Tagged of string ];
abs_nullok : bool;
abs_gen_set : bool;
}
let abstract_ptr ?(nullok=false) ?(gen_set=false) abs_free_fn =
`Abstract_ptr { abs_free_fn = `Untagged abs_free_fn;
abs_nullok = nullok;
abs_gen_set = gen_set }
let tagged_abstract_ptr ?(nullok=false) ?(gen_set=false) abs_free_fn =
`Abstract_ptr { abs_free_fn = `Tagged abs_free_fn;
abs_nullok = nullok;
abs_gen_set = gen_set }
(**********************************************************************)
(* Abstract_enum *)
(**********************************************************************)
let gen_abstract_enum c mli ml tyname ~optional =
fprintf mli "type %s\n" tyname;
fprintf ml "type %s\n" tyname;
fprintf c "/************** %s *************/\n\n" tyname;
if optional then
fprintf c "#ifdef HAVE_TY_%s\n" tyname;
fprintf c "struct enumstruct_%s { %s value; long oid; };\n\n" tyname tyname;
fprintf c "#define enumstructptr_%s_val(v) \
((struct enumstruct_%s *) (Data_custom_val(v)))\n" tyname tyname;
fprintf c "#define enum_%s_unwrap(v) \
(enumstructptr_%s_val(v)->value)\n" tyname tyname;
fprintf c "long enum_%s_oid = 0;\n" tyname;
fprintf c "\n";
fprintf c "static int enum_%s_compare(value v1, value v2) {\n" tyname;
fprintf c " struct enumstruct_%s *p1;\n" tyname;
fprintf c " struct enumstruct_%s *p2;\n" tyname;
fprintf c " p1 = enumstructptr_%s_val(v1);\n" tyname;
fprintf c " p2 = enumstructptr_%s_val(v2);\n" tyname;
fprintf c " return p1->oid - p2->oid;\n";
fprintf c "}\n\n";
fprintf c "static struct custom_operations enum_%s_ops = {\n" tyname;
fprintf c " \"\",\n";
fprintf c " custom_finalize_default,\n";
fprintf c " enum_%s_compare,\n" tyname;
fprintf c " custom_hash_default,\n";
fprintf c " custom_serialize_default,\n";
fprintf c " custom_deserialize_default\n";
fprintf c "};\n\n";
fprintf c "static %s unwrap_%s(value v) {\n" tyname tyname;
fprintf c " return enum_%s_unwrap(v);\n" tyname;
fprintf c "}\n\n";
fprintf c "static value wrap_%s(%s x) {\n" tyname tyname;
fprintf c " value v;\n";
fprintf c " v = caml_alloc_custom(&enum_%s_ops, \
sizeof(struct enumstruct_%s), 0, 1);\n"
tyname tyname;
fprintf c " enumstructptr_%s_val(v)->value = x;\n" tyname;
fprintf c " enumstructptr_%s_val(v)->oid = enum_%s_oid++;\n" tyname tyname;
fprintf c " return v;\n";
fprintf c "}\n";
if optional then
fprintf c "#endif\n";
fprintf c "\n";
()
(**********************************************************************)
(* Abstract_ptr *)
(**********************************************************************)
(* Here we allocate a pair
(tag, custom, list)
where custom is the custom block, and list is a list of
auxiliary values whose lifetime must exceed the custom block.
tag is an optional integer, usually 0. Especially, this allow to
deallocate the custom in different ways.
*)
let gen_abstract_ptr c mli ml tyname abs ~optional =
fprintf mli "type %s\n" tyname;
fprintf ml "type %s\n" tyname;
fprintf c "/************** %s *************/\n\n" tyname;
if optional then
fprintf c "#ifdef HAVE_TY_%s\n" tyname;
fprintf c "struct absstruct_%s { %s value; long tag; long oid; };\n\n"
tyname tyname;
fprintf c "#define absstructptr_%s_val(v) \
((struct absstruct_%s *) (Data_custom_val(v)))\n" tyname tyname;
fprintf c "#define abs_%s_unwrap(v) \
(absstructptr_%s_val(v)->value)\n" tyname tyname;
fprintf c "#define abs_%s_tag(v) \
(absstructptr_%s_val(v)->tag)\n" tyname tyname;
fprintf c "long abs_%s_oid = 0;\n" tyname;
fprintf c "\n";
fprintf c "static int abs_%s_compare(value v1, value v2) {\n" tyname;
fprintf c " struct absstruct_%s *p1;\n" tyname;
fprintf c " struct absstruct_%s *p2;\n" tyname;
fprintf c " p1 = absstructptr_%s_val(v1);\n" tyname;
fprintf c " p2 = absstructptr_%s_val(v2);\n" tyname;
fprintf c " return p1->oid - p2->oid;\n";
fprintf c "}\n\n";
fprintf c "static void abs_%s_finalize(value v1) {\n" tyname;
fprintf c " struct absstruct_%s *p1;\n" tyname;
fprintf c " p1 = absstructptr_%s_val(v1);\n" tyname;
( match abs.abs_free_fn with
| `Untagged free ->
fprintf c " %s(p1->value);\n" free
| `Tagged free ->
fprintf c " %s(p1->tag, p1->value);\n" free
);
fprintf c "}\n\n";
fprintf c "static struct custom_operations abs_%s_ops = {\n" tyname;
fprintf c " \"\",\n";
fprintf c " abs_%s_finalize,\n" tyname;
fprintf c " abs_%s_compare,\n" tyname;
fprintf c " custom_hash_default,\n";
fprintf c " custom_serialize_default,\n";
fprintf c " custom_deserialize_default\n";
fprintf c "};\n\n";
fprintf c "static %s unwrap_%s(value v) {\n" tyname tyname;
fprintf c " %s r;\n" tyname;
fprintf c " r = abs_%s_unwrap(Field(v,0));\n" tyname;
if not abs.abs_nullok then
fprintf c " if (r == NULL) raise_null_pointer();\n";
fprintf c " return r;\n";
fprintf c "}\n\n";
fprintf c "static long tag_%s(value v) {\n" tyname;
fprintf c " return abs_%s_tag(Field(v,0));\n" tyname;
fprintf c "}\n\n";
fprintf c "static value twrap_%s(long tag, %s x) {\n" tyname tyname;
fprintf c " CAMLparam0();\n";
fprintf c " CAMLlocal2(v,r);\n";
if not abs.abs_nullok then
fprintf c " if (x == NULL) caml_failwith(\"wrap_%s: NULL pointer\");\n" tyname;
fprintf c " v = caml_alloc_custom(&abs_%s_ops, \
sizeof(struct absstruct_%s), 0, 1);\n"
tyname tyname;
fprintf c " absstructptr_%s_val(v)->tag = tag;\n" tyname;
fprintf c " absstructptr_%s_val(v)->value = x;\n" tyname;
fprintf c " absstructptr_%s_val(v)->oid = abs_%s_oid++;\n" tyname tyname;
fprintf c " r = caml_alloc(2,0);\n";
fprintf c " Field(r,0) = v;\n";
fprintf c " Field(r,1) = Val_int(0);\n";
fprintf c " CAMLreturn(r);\n";
fprintf c "}\n\n";
fprintf c "static value wrap_%s(%s x) {\n" tyname tyname;
fprintf c " return twrap_%s(0, x);\n" tyname;
fprintf c "}\n\n";
if abs.abs_gen_set then (
fprintf c "static void set_%s(value v, %s x) {\n" tyname tyname;
fprintf c " absstructptr_%s_val(v)->value = x;\n" tyname;
fprintf c "}\n\n";
);
fprintf c "static void attach_%s(value v, value aux) {\n" tyname;
fprintf c " CAMLparam2(v,aux);\n";
fprintf c " CAMLlocal1(h);\n";
fprintf c " h = caml_alloc(2,0);\n";
fprintf c " Field(h,0) = aux;\n";
fprintf c " Field(h,1) = Field(v,1);\n";
fprintf c " Store_field(v,1,h);\n";
fprintf c " CAMLreturn0;\n";
fprintf c "}\n";
if optional then
fprintf c "#endif\n";
fprintf c "\n";
()
(**********************************************************************)
(* Enum *)
(**********************************************************************)
let vert_re = Str.regexp "[|]"
let qmark_re = Str.regexp "[?]"
let c_name_of_enum n =
Str.replace_first qmark_re ""
(Str.replace_first vert_re "" n)
let ml_name_of_enum n0 =
let n = Str.replace_first qmark_re "" n0 in
try
let l = String.length n in
let p = String.index n '|' in
String.capitalize_ascii (String.lowercase_ascii (String.sub n (p+1) (l-p-1)))
with
| Not_found ->
String.capitalize_ascii (String.lowercase_ascii n)
let is_opt_case n =
n.[0] = '?'
let gen_enum c mli ml tyname cases ~optional =
List.iter
(fun f ->
fprintf f "type %s =\n" tyname;
fprintf f " [ ";
let first = ref true in
List.iter
(fun case ->
if not !first then fprintf f " | ";
first := false;
fprintf f "`%s\n" (ml_name_of_enum case)
)
cases;
fprintf f " ]\n";
)
[ mli; ml ];
fprintf c "/************** %s *************/\n\n" tyname;
if optional then
fprintf c "#ifdef HAVE_TY_%s\n" tyname;
fprintf c "static value wrap_%s(%s x) {\n" tyname tyname;
fprintf c " switch (x) {\n";
List.iter
(fun case ->
let opt = is_opt_case case in
let n1 = c_name_of_enum case in
let n2 = ml_name_of_enum case in
let h = Btype.hash_variant n2 in
if opt then
fprintf c "#ifdef HAVE_ENUM_%s\n" n1;
fprintf c " case %s: return Val_long(%d);\n" n1 h;
if opt then
fprintf c "#endif\n"
)
cases;
fprintf c " default: break;\n";
fprintf c " };\n";
fprintf c " caml_failwith(\"wrap_%s: unexpected value\");\n" tyname;
fprintf c "}\n\n";
fprintf c "static %s unwrap_%s(value v) {\n" tyname tyname;
fprintf c " switch (Long_val(v)) {\n";
List.iter
(fun case ->
let opt = is_opt_case case in
let n1 = c_name_of_enum case in
let n2 = ml_name_of_enum case in
let h = Btype.hash_variant n2 in
if opt then
fprintf c "#ifdef HAVE_ENUM_%s\n" n1;
fprintf c " case %d: return %s;\n" h n1;
if opt then
fprintf c "#endif\n"
)
cases;
fprintf c " default: caml_invalid_argument(\"unwrap_%s\");\n" tyname;
fprintf c " };\n";
fprintf c " caml_failwith(\"unwrap_%s: unexpected value\");\n" tyname;
fprintf c "}\n";
if optional then
fprintf c "#endif\n";
fprintf c "\n";
()
let gen_enum_of_string mli ml fun_name type_name cases =
fprintf ml "let %s name =\n" fun_name;
fprintf ml " match name with\n";
List.iter
(fun case ->
let n1 = c_name_of_enum case in
let n2 = ml_name_of_enum case in
fprintf ml " | %S -> `%s\n" n1 n2
)
cases;
fprintf ml " | any -> failwith(\"%s: unknown error code\" ^ any)\n" fun_name;
fprintf ml "\n";
fprintf mli "val %s : string -> %s\n" fun_name type_name;
()
(**********************************************************************)
(* Flags *)
(**********************************************************************)
let gen_flags c mli ml tyname cases ~optional =
List.iter
(fun f ->
fprintf f "type %s_flag =\n" tyname;
fprintf f " [ ";
let first = ref true in
List.iter
(fun case ->
if not !first then fprintf f " | ";
first := false;
fprintf f "`%s\n" (ml_name_of_enum case)
)
cases;
fprintf f " ]\n";
fprintf f "type %s = %s_flag list\n" tyname tyname;
)
[ mli; ml ];
fprintf c "/************** %s *************/\n\n" tyname;
if optional then
fprintf c "#ifdef HAVE_TY_%s\n" tyname;
fprintf c "static value wrap_%s(%s x) {\n" tyname tyname;
fprintf c " CAMLparam0();\n";
fprintf c " CAMLlocal2(v,u);\n";
fprintf c " v = Val_long(0);\n";
List.iter
(fun case ->
let opt = is_opt_case case in
let n1 = c_name_of_enum case in
let n2 = ml_name_of_enum case in
let h = Btype.hash_variant n2 in
if opt then
fprintf c "#ifdef HAVE_ENUM_%s\n" n1;
fprintf c " if (x & %s) {\n" n1;
fprintf c " u = caml_alloc(2,0);\n";
fprintf c " Field(u, 0) = Val_long(%d);\n" h;
fprintf c " Field(u, 1) = v;\n";
fprintf c " v = u;\n";
fprintf c " };\n";
if opt then
fprintf c "#endif\n";
)
cases;
fprintf c " CAMLreturn(v);\n";
fprintf c "}\n\n";
fprintf c "static %s unwrap_%s(value v) {\n" tyname tyname;
fprintf c " %s x = 0;\n" tyname;
fprintf c " while (Is_block(v)) {\n";
fprintf c " switch (Long_val(Field(v,0))) {\n";
List.iter
(fun case ->
let opt = is_opt_case case in
let n1 = c_name_of_enum case in
let n2 = ml_name_of_enum case in
let h = Btype.hash_variant n2 in
if opt then
fprintf c "#ifdef HAVE_ENUM_%s\n" n1;
fprintf c " case %d: x |= %s; break;\n"
h n1;
if opt then
fprintf c "#endif\n";
)
cases;
fprintf c " };\n";
fprintf c " v = Field(v,1);\n";
fprintf c " };\n";
fprintf c " return x;\n";
fprintf c "}\n";
if optional then
fprintf c "#endif\n";
fprintf c "\n";
()
(**********************************************************************)
(* Same_as *)
(**********************************************************************)
let gen_same_as c mli ml old_tyname tyname =
fprintf mli "type %s = %s\n" tyname old_tyname;
fprintf ml "type %s = %s\n" tyname old_tyname;
(* (* this generates gcc warnings: *)
fprintf c "#define wrap_%s wrap_%s\n" tyname old_tyname;
fprintf c "#define unwrap_%s unwrap_%s\n" tyname old_tyname
*)
fprintf c "/************** %s *************/\n\n" tyname;
fprintf c "static value wrap_%s(%s x) {\n" tyname tyname;
fprintf c " %s y;\n" old_tyname;
fprintf c " y = (%s) x;\n" old_tyname;
fprintf c " return wrap_%s(y);\n" old_tyname;
fprintf c "}\n\n";
fprintf c "static %s unwrap_%s(value v) {\n" tyname tyname;
fprintf c " %s y;\n" old_tyname;
fprintf c " y = unwrap_%s(v);\n" old_tyname;
fprintf c " return (%s) y;\n" tyname;
fprintf c "}\n\n"
(**********************************************************************)
(* Functions *)
(**********************************************************************)
let ws_re = Str.regexp "[ \t]+"
let split_type ty =
let l = Str.split ws_re ty in
match l with
| "const" :: l' -> true, l'
| _ -> false, l
let rec translate_type_to_ml name ty =
let (is_const, ty_list) = split_type ty in
match ty_list with
| [ "void" ] -> "unit"
| [ "int" ] -> "int"
| [ "uint" ] -> "int"
| [ "int32" ] -> "int32"
| [ "uint32" ] -> "int32"
| [ "bool" ] -> "bool"
| [ "ubool" ] -> "bool"
| [ "double" ] -> "float"
| [ "ztstr" ] -> "string"
| [ elt; "ztlist" ] -> translate_type_to_ml name elt ^ " list"
| [ elt; "array" ] -> translate_type_to_ml name elt ^ " array"
| [ aname; "array_size" ] -> "int"
| [ id; "bigarray" ] -> "Netsys_mem.memory"
| [ id; "bigarray_size" ] -> "int"
| [ id; "stringbuf" ] -> "Bytes.t"
| [ id; "stringbuf_size" ] -> "int"
| [ id; "ztstringbuf" ] -> "Bytes.t"
| [ id; "ztstringbuf_size" ] -> "int"
| [ "bigarray_datum" ] -> "Netsys_mem.memory"
| [ "str_datum" ] -> "string"
| [ "file_descr" ] -> "Unix.file_descr"
| [ tyname ] ->
( try
let p = String.index tyname '/' in
let tyname2 =
String.sub tyname (p+1) (String.length tyname -p - 1) in
translate_type_to_ml name tyname2
with Not_found ->
tyname
)
| _ -> failwith ("Bad type in function " ^ name ^ ": " ^ ty)
let rec translate_type_to_c name ty =
let (is_const, ty_list) = split_type ty in
let c_ty, tag =
match ty_list with
| [ "void" ] ->
"void", `Ignore
| [ "int" ] ->
"int", `Plain("Int_val", "Val_int")
| [ "uint" ] ->
"unsigned int", `Plain("uint_val", "Val_int")
| [ "int32" ] ->
"int32_t", `Plain("Int32_val", "caml_copy_int32")
| [ "uint32" ] ->
"uint32_t", `Plain("Int32_val", "caml_copy_int32")
| [ "bool" ] ->
"int", `Plain("Bool_val", "Val_bool")
| [ "ubool" ] ->
"unsigned int", `Plain("Bool_val", "Val_bool")
| [ "double" ] ->
"double", `Plain("Double_val", "caml_copy_double")
| [ "ztstr" ] ->
"char *", `Plain("String_val", "protected_copy_string")
| [ "file_descr" ] -> (* FIXME: win32 *)
"int", `Plain("Int_val", "Val_int")
| [ elt; "ztlist" ] ->
let el_cty, el_tag =
translate_type_to_c name elt in
el_cty ^ " *", `ZTList el_tag
| [ elt; "array" ] ->
let el_cty, el_tag =
translate_type_to_c name elt in
el_cty ^ " *", `Array(el_cty, el_tag)
| [ aname; "array_size" ] ->
"size_t", `Array_size(aname, "size_t")
| [ aname; "array_size_uint" ] ->
"unsigned int", `Array_size(aname, "unsigned int")
| [ id; "bigarray" ] ->
"void *", `Bigarray id
| [ id; "bigarray_size" ] ->
"size_t", `Bigarray_size id
| [ id; "stringbuf" ] ->
"void *", `Stringbuf id
| [ id; "stringbuf_size" ] ->
"size_t", `Stringbuf_size id
| [ id; "ztstringbuf" ] ->
"void *", `ZTStringbuf id
| [ id; "ztstringbuf_size" ] ->
"size_t", `ZTStringbuf_size id
(*
| [ "bigarray_datum" ] ->
"gnutls_datum_t", `Bigarray_datum
| [ "bigarray_datum_p" ] ->
"gnutls_datum_t *", `Bigarray_datum
*)
| [ tyname ] ->
( try
let p = String.index tyname '/' in
let tyname1 =
String.sub tyname 0 p in
let tyname2 =
String.sub tyname (p+1) (String.length tyname - p - 1) in
let (_, tag) = translate_type_to_c name tyname2 in
(tyname1, tag)
with Not_found ->
tyname, `Plain("unwrap_" ^ tyname, "wrap_" ^ tyname)
)
| _ ->
ty, `Unsupported in
let c_ty1 =
if is_const && tag <> `Unsupported then "const " ^ c_ty else c_ty in
(c_ty1, tag)
let is_size ty =
let (is_const, ty_list) = split_type ty in
match ty_list with
| [ id; "bigarray_size" ] -> true
| [ id; "array_size" ] -> true
| [ id; "stringbuf_size" ] -> true
| [ id; "ztstringbuf_size" ] -> true
| _ -> false
let rec first n l =
if n=0 then
[]
else
match l with
| x :: l' -> x :: first (n-1) l'
| [] -> []
let rec after_first n l =
if n=0 then
l
else
match l with
| x :: l' -> after_first (n-1) l'
| [] -> []
let result_re = Str.regexp "RESULT"
let input_kinds = [ `In; `In_ptr; `In_ignore; `In_out; `In_out_noptr ]
let outonly_kinds = [ `Out; `Out_ignore; `Out_noptr ]
let inout_kinds = [ `In_out; `In_out_noptr ]
let output_kinds = outonly_kinds @ inout_kinds
let gen_fun c mli ml name args directives free init =
let optional = List.mem `Optional directives in
let blocking = List.mem `Blocking directives in
let input_args =
List.filter
(fun (n,kind,ty) -> List.mem kind input_kinds)
args in
let input_ml_args0 =
List.filter
(fun (n,kind,ty) ->
List.mem kind inout_kinds ||
((kind = `In || kind = `In_ptr) && not(is_size ty))
)
input_args in
let input_ml_args =
if input_ml_args0 = [] then [ "dummy", `In, "void" ] else input_ml_args0 in
let output_args =
List.filter
(fun (n,kind,ty) -> List.mem kind output_kinds)
args in
let output_ml_args0 =
List.filter
(fun (n,kind,ty) -> kind = `Out || kind = `Out_noptr ||
List.mem kind inout_kinds)
output_args in
let return_args =
List.filter
(fun (n,kind,ty) -> kind = `Return || kind = `Return_ignore)
args in
let return_arg =
match return_args with
| [] -> ("", `Return_ignore, "void")
| [ return_arg ] -> return_arg
| _ -> failwith ("More than one return value: " ^ name) in
let ignore_return_arg =
let (_, kind, _) = return_arg in
kind = `Return_ignore in
let output_ml_args =
if ignore_return_arg then (
if output_ml_args0 = [] then
["", `Out_ignore, "void" ]
else
output_ml_args0
)
else
return_arg :: output_ml_args0 in
let trans_input_ml_args =
List.map
(fun (_,_,ty) -> translate_type_to_ml name ty)
input_ml_args in
let trans_output_ml_args =
List.map
(fun (_,_,ty) -> translate_type_to_ml name ty)
output_ml_args in
fprintf mli "val %s : %s -> %s\n"
name
(String.concat " -> " trans_input_ml_args)
(String.concat " * " trans_output_ml_args);
fprintf ml "external %s : %s -> %s\n"
name
(String.concat " -> " trans_input_ml_args)
(String.concat " * " trans_output_ml_args);
fprintf ml " = %S %S\n"
(if List.length trans_input_ml_args > 5 then
("net_" ^ name ^ "__byte")
else
("net_" ^ name)
)
("net_" ^ name);
let c_args =
List.map
(fun (n,kind,ty) ->
let (c_ty, tag) = translate_type_to_c name ty in
(n, kind, ty, c_ty, tag)
)
args in
let c_decls = ref [] in
let ml_locals = ref [] in
let c_code_pre = ref [] in
let c_code_post = ref [] in
let c_code_post_prio = ref [] in
let c_act_args = ref [] in
let c_act_ret = ref None in
let n = ref 0 in
let new_local() = let k = !n in incr n; sprintf "local_%d" k in
(*
if not ignore_return_arg then (
let (n,_,_) = return_arg in
ml_locals := n :: !ml_locals
);
*)
let n_return = ref 0 in
let return_names = ref [] in
List.iter
(fun (n, kind, ty, c_ty, tag) ->
if kind <> `Return_ignore || ty <> "void" then (
let n1 = sprintf "%s__c" n in
c_decls := sprintf "%s %s;" c_ty n1 :: !c_decls;
if List.mem kind output_kinds && List.mem c_ty init then (
c_code_pre := sprintf "init_%s(&%s);" c_ty n1 :: !c_code_pre
);
if kind <> `In_ignore && List.mem kind input_kinds then (
match tag with
| `Plain(to_c,to_ml) ->
let need_free = List.mem c_ty free in
let unwrap =
sprintf "%s = %s(%s);" n1 to_c n in
c_code_pre := unwrap :: !c_code_pre;
if need_free then (
let free_call =
sprintf "free_%s(%s);" c_ty n1 in
c_code_post_prio := free_call :: !c_code_post_prio
)
| `Array(el_c_ty, `Plain(to_c,to_ml)) ->
let i1 = new_local() in
c_decls := sprintf "long %s;" i1 :: !c_decls;
let code1 =
[ sprintf "%s = (%s) caml_stat_alloc(Wosize_val(%s)*sizeof(%s));"
n1 c_ty n el_c_ty;
sprintf "for (%s=0; %s < Wosize_val(%s); %s++) {"
i1 i1 n i1;
sprintf " %s[%s] = %s(Field(%s,%s));" n1 i1 to_c n i1;
sprintf "};";
] in
c_code_pre := List.rev code1 @ !c_code_pre;
let el_need_free = List.mem el_c_ty free in
let code2 =
(if el_need_free then
[ sprintf "for (%s=0; %s < Wosize_val(%s); %s++) {"
i1 i1 n i1;
sprintf " free_%s(%s[%s]);" el_c_ty n1 i1;
sprintf "};"
]
else []) @
[ sprintf "caml_stat_free(%s);" n1 ] in
c_code_post_prio := List.rev code2 @ !c_code_post_prio;
| `Array_size(n_array, ty) ->
let code =
sprintf "%s = (%s) Wosize_val(%s);" n1 ty n_array in
c_code_pre := code :: !c_code_pre
| `Bigarray id ->
let code1 =
[ sprintf "%s = Caml_ba_data_val(%s);" n1 n ] in
c_code_pre := List.rev code1 @ !c_code_pre;
| `Bigarray_size id ->
let (n_array,_,_,_,_) =
try
List.find
(fun (_,_,_,_,tag) ->
tag = `Bigarray id
)
c_args
with
| Not_found ->
failwith ("bigarray_size needs bigarray, fn: " ^
name) in
let code1 =
[ sprintf "%s = caml_ba_byte_size(Caml_ba_array_val(%s));"
n1 n_array ] in
c_code_pre := List.rev code1 @ !c_code_pre;
| `Stringbuf id ->
let code1 =
[ sprintf "%s = String_val(%s);" n1 n ] in
c_code_pre := List.rev code1 @ !c_code_pre;
| `Stringbuf_size id ->
let (n_array,_,_,_,_) =
try
List.find
(fun (_,_,_,_,tag) ->
tag = `Stringbuf id
)
c_args
with
| Not_found ->
failwith ("stringbuf_size needs stringbuf, fn: " ^
name) in
let code1 =
[ sprintf "%s = caml_string_length(%s);"
n1 n_array ] in
c_code_pre := List.rev code1 @ !c_code_pre;
| `ZTStringbuf id ->
let code1 =
[ sprintf "%s = String_val(%s);" n1 n ] in
c_code_pre := List.rev code1 @ !c_code_pre;
| `ZTStringbuf_size id ->
(* sole difference to Stringbuf_size: the length includes
the trailing null byte
*)
let (n_array,_,_,_,_) =
try
List.find
(fun (_,_,_,_,tag) ->
tag = `ZTStringbuf id
)
c_args
with
| Not_found ->
failwith ("ztstringbuf_size needs ztstringbuf, fn: "
^ name) in
let code1 =
[ sprintf "%s = caml_string_length(%s)+1;"
n1 n_array ] in
c_code_pre := List.rev code1 @ !c_code_pre;
| _ ->
failwith ("Unsupported arg: " ^ n ^ ", fn " ^ name)
);
if (kind <> `Out_ignore && List.mem kind outonly_kinds)
|| kind = `Return
then (
ml_locals := n :: !ml_locals;
);
if (kind <> `Out_ignore && List.mem kind output_kinds)
|| kind = `Return
then (
incr n_return;
return_names := n :: !return_names;
match tag with
| `Plain(to_c,to_ml) ->
let wrap =
sprintf "%s = %s(%s);" n to_ml n1 in
c_code_post := wrap :: !c_code_post
| `ZTList(`Plain(to_c,to_ml)) ->
let i1 = new_local() in
let h1 = new_local() in
c_decls := sprintf "long %s;" i1 :: !c_decls;
ml_locals := h1 :: !ml_locals;
let code =
[ sprintf "%s = 0;" i1;
sprintf "while (%s[%s] != 0) %s++;" n1 i1 i1;
sprintf "%s = Val_int(0);" n;
sprintf "while (%s > 0) {" i1;
sprintf " %s--;" i1;
sprintf " %s = caml_alloc(2,0);" h1;
sprintf " Field(%s,0) = %s(%s[%s]);" h1 to_ml n1 i1;
sprintf " Field(%s,1) = %s;" h1 n;
sprintf " %s = %s;" n h1;
sprintf "};"
] in
c_code_post := List.rev code @ !c_code_post;
| `Array(el_c_ty, `Plain(to_c,to_ml)) ->
let (n_size,_,_,_,_) =
try
List.find
(fun (_,_,_,_,tag) ->
match tag with
| `Array_size(n_size,_) -> n_size = n
| _ -> false
)
c_args
with
| Not_found ->
failwith ("array needs array_size, fn: " ^ name) in
let i1 = new_local() in
c_decls := sprintf "long %s;" i1 :: !c_decls;
(* for simplicity we return an empty error in case of a
NULL pointer. Let's hope this is right.
*)
let code =
[ (* sprintf "if (%s == NULL) failwith(\"%s: NULL pointer\");"
n1 name;
*)
sprintf "if (%s == NULL)" n1;
sprintf " %s = caml_alloc(0,0);" n;
sprintf "else {";
sprintf " %s = caml_alloc(%s__c,0);" n n_size;
sprintf " for (%s = 0; %s < %s__c; %s++) {"
i1 i1 n_size i1;
sprintf " Store_field(%s, %s, %s(%s[%s]));"
n i1 to_ml n1 i1;
sprintf " };";
sprintf "};"
] in
c_code_post := List.rev code @ !c_code_post;
| `Array_size(aname,ty) ->
let code =
[ sprintf "%s = Val_long(%s);" n n1 ] in
c_code_post := List.rev code @ !c_code_post;
| `Bigarray _ ->
failwith ("Bigarray unsupported as `Out: " ^ name)
| `Bigarray_size id ->
let code1 =
[ sprintf "%s = Val_long(%s);" n n1 ] in
c_code_post := List.rev code1 @ !c_code_post;
| `Stringbuf id ->
if kind = `In_out then
failwith ("Stringbuf unsupported as `In_out: " ^ name);
if not (List.mem `GNUTLS_ask_for_size directives) then
failwith ("Stringbuf needs GNUTLS_ask_for_size: " ^ name);
()
| `Stringbuf_size id ->
let code1 =
[ sprintf "%s = Val_long(%s);" n n1 ] in
c_code_post := List.rev code1 @ !c_code_post;
| `ZTStringbuf id ->
if kind = `In_out then
failwith ("ZTStringbuf unsupported as `In_out: " ^ name);
if not (List.mem `GNUTLS_ask_for_size directives) then
failwith ("ZTStringbuf needs GNUTLS_ask_for_size: " ^ name);
()
| `ZTStringbuf_size id ->
let code1 =
[ sprintf "%s = Val_long(%s);" n n1 ] in
c_code_post := List.rev code1 @ !c_code_post;
| _ ->
failwith ("Unsupported arg: " ^ n ^ ", fn " ^ name)
);
let noref =
(* don't put a "&" before the arg even if it is an output *)
match tag with
| `Stringbuf _ -> true
| `ZTStringbuf _ -> true
| `Bigarray _ -> true
| _ -> false in
( match kind with
| `In | `In_ignore ->
c_act_args := n1 :: !c_act_args
| `In_ptr ->
c_act_args := ("&" ^ n1) :: !c_act_args
| `In_out | `Out | `Out_ignore ->
if noref then
c_act_args := n1 :: !c_act_args
else
c_act_args := ("&" ^ n1) :: !c_act_args
| `Out_noptr | `In_out_noptr ->
c_act_args := n1 :: !c_act_args
| `Return | `Return_ignore ->
c_act_ret := Some n1
)
)
)
c_args;
let n_compare =
List.length output_ml_args0 + (if ignore_return_arg then 0 else 1) in
if !n_return <> n_compare then
failwith(sprintf "Problem 1: %s (n_return=%d n_compare=%d)"
name
!n_return
n_compare);
let caml_return = ref None in
if !n_return = 1 then
caml_return := Some(List.hd !return_names)
else
if !n_return > 1 then (
let n1 = new_local() in
ml_locals := n1 :: !ml_locals;
c_code_post :=
sprintf "%s = caml_alloc(%d,0);" n1 !n_return :: !c_code_post;
let k = ref 0 in
List.iter
(fun (n,_,_) ->
if not (List.mem n !return_names) then
failwith ("Output name not found: " ^ n);
c_code_post :=
sprintf "Field(%s, %d) = %s;" n1 !k n :: !c_code_post;
incr k
)
output_ml_args;
caml_return := Some n1
);
let input_ml_args_as_c =
String.concat ","
(List.map (fun (n,_,_) -> "value " ^ n) input_ml_args) in
let l = ref input_ml_args in
let maybe_x = ref "" in
if !l = [] then
c_decls := "CAMLparam0();" :: !c_decls;
while !l <> [] do
let hd5 = first 5 !l in
let s = String.concat "," (List.map (fun (n,_,_) -> n) hd5) in
let d = sprintf "CAML%sparam%d(%s);" !maybe_x (List.length hd5) s in
c_decls := d :: !c_decls;
l := after_first 5 !l;
maybe_x := "x"
done;
let l = ref (List.rev !ml_locals) in
while !l <> [] do
let hd5 = first 5 !l in
let s = String.concat "," hd5 in
let d = sprintf "CAMLlocal%d(%s);" (List.length hd5) s in
c_decls := d :: !c_decls;
l := after_first 5 !l;
done;
fprintf c "value net_%s(%s) {\n" name input_ml_args_as_c;
if optional then
fprintf c "#ifdef HAVE_FUN_%s\n" name;
List.iter
(fun d -> fprintf c " %s\n" d)
(List.rev !c_decls);
List.iter
(function
| `Declare stmt -> fprintf c " %s\n" stmt
| _ -> ()
)
directives;
List.iter
(fun stmt -> fprintf c " %s\n" stmt)
(List.rev !c_code_pre);
List.iter
(function
| `Pre stmt -> fprintf c " %s\n" stmt
| _ -> ()
)
directives;
let emit_call() =
if blocking then
fprintf c "caml_enter_blocking_section();\n ";
( match !c_act_ret with
| None -> ()
| Some var -> fprintf c "%s = " var
);
fprintf c "%s(%s);\n" name (String.concat "," (List.rev !c_act_args));
if blocking then
fprintf c " caml_leave_blocking_section();\n" in
if List.mem `GNUTLS_ask_for_size directives then (
(* Call the function twice: once to get the size of the string buffer,
and a second time to fill the buffer
*)
let (n_strbuf,_,_,_,tag) =
try
List.find
(fun (_,_,_,_,tag) ->
tag = `Stringbuf "1" || tag = `ZTStringbuf "1"
)
c_args
with
| Not_found ->
failwith ("GNUTLS_ask_for_size needs '1 stringbuf', fn: " ^
name) in
let (n_strbuf_size,_,_,_,tag_size) =
try
List.find
(fun (_,_,_,_,tag_size) ->
tag_size = `Stringbuf_size "1" || tag_size = `ZTStringbuf_size "1"
)
c_args
with
| Not_found ->
failwith ("GNUTLS_ask_for_size needs '1 stringbuf_size', fn: " ^
name) in
let zt =
match tag, tag_size with
| `ZTStringbuf _, `ZTStringbuf_size _ -> true
| `Stringbuf _, `Stringbuf_size _ -> false
| _ ->
failwith ("Mixed use of Stringbuf/ZTStringbuf, fn: " ^ name) in
fprintf c " %s__c = NULL;\n" n_strbuf;
fprintf c " %s__c = 0;\n" n_strbuf_size;
fprintf c " %s = caml_alloc_string(0);\n" n_strbuf;
(* "pre call" *)
fprintf c " ";
let ret_var =
match !c_act_ret with
| None -> assert false
| Some var -> var in
fprintf c "%s = " ret_var;
fprintf c "%s(%s);\n" name (String.concat "," (List.rev !c_act_args));
if zt then (
(* Be very conservative: allocate one more byte for the terminating
null. The returned ocaml string will not include any null bytes
*)
fprintf c " if (%s == 0 || %s == GNUTLS_E_SHORT_MEMORY_BUFFER) {\n"
ret_var ret_var;
fprintf c " long n__stub;\n";
fprintf c " %s__c++;\n" n_strbuf_size;
fprintf c " n__stub = %s__c;\n" n_strbuf_size;
fprintf c " %s__c = caml_stat_alloc(%s__c+1);\n" n_strbuf n_strbuf_size;
fprintf c " ";
emit_call();
fprintf c " if (%s == 0) {\n" ret_var;
fprintf c " ((char *) %s__c)[n__stub] = 0;\n" n_strbuf;
fprintf c " %s = caml_copy_string(%s__c);\n" n_strbuf n_strbuf;
fprintf c " };\n";
fprintf c " caml_stat_free(%s__c);\n" n_strbuf;
fprintf c " };\n";
)
else (
fprintf c " if (%s == 0 || %s == GNUTLS_E_SHORT_MEMORY_BUFFER) {\n"
ret_var ret_var;
fprintf c " %s = caml_alloc_string(%s__c);\n"
n_strbuf n_strbuf_size;
fprintf c " %s__c = String_val(%s);\n" n_strbuf n_strbuf;
fprintf c " ";
emit_call();
fprintf c " };\n";
)
)
else (
fprintf c " ";
emit_call();
);
List.iter
(fun stmt -> fprintf c " %s\n" stmt)
(List.rev !c_code_post_prio);
List.iter
(function
| `Post stmt ->
let stmt1 =
match !c_act_ret with
| None -> stmt
| Some r ->
Str.global_replace result_re r stmt in
fprintf c " %s\n" stmt1
| _ -> ()
)
directives;
List.iter
(fun stmt -> fprintf c " %s\n" stmt)
(List.rev !c_code_post);
( match !caml_return with
| None ->
fprintf c " CAMLreturn(Val_unit);\n"
| Some r ->
fprintf c " CAMLreturn(%s);\n" r;
);
if optional then (
fprintf c "#else\n";
fprintf c " caml_invalid_argument(\"%s\");\n" name;
fprintf c "#endif\n";
);
fprintf c "}\n\n";
if List.length trans_input_ml_args > 5 then (
fprintf c "value net_%s__byte(value * argv, int argn) {\n" name;
fprintf c " return net_%s(%s);\n"
name
(String.concat ","
(Array.to_list
(Array.init
(List.length trans_input_ml_args)
(fun i -> sprintf "argv[%d]" i)
)
)
);
fprintf c "}\n\n";
);
()
(**********************************************************************)
let cfg_cases cfg cases =
List.iter
(fun case ->
if is_opt_case case then (
let cname = c_name_of_enum case in
fprintf cfg "check_enum HAVE_ENUM_%s %s\n" cname cname
)
)
cases
let cfg_fun cfg name =
fprintf cfg "check_fun HAVE_FUN_%s %s\n" name name
let cfg_type cfg name =
fprintf cfg "check_type HAVE_TY_%s %s\n" name name
(**********************************************************************)
let gen_c_head c =
fprintf c "#include <stdlib.h>\n\
#include <stdio.h>\n\
#include <string.h>\n\
\n\
#include \"caml/mlvalues.h\"\n\
#include \"caml/alloc.h\"\n\
#include \"caml/memory.h\"\n\
#include \"caml/misc.h\"\n\
#include \"caml/custom.h\"\n\
#include \"caml/fail.h\"\n\
#include \"caml/unixsupport.h\"\n\
#include \"caml/callback.h\"\n\
#include \"caml/bigarray.h\"\n\
#include \"caml/threads.h\"\n\
\n\
static unsigned int uint_val(value v);\n\
static value protected_copy_string(const char *s);\n\
\n"
let gen_c_head2 c =
fprintf c "static unsigned int uint_val(value v) {\n\
\032 if (Int_val(v) < 0) caml_invalid_argument(\"negative integer\");\n\
\032 return (unsigned int) Int_val(v);\n\
}\n\
\n\
static value protected_copy_string(const char *s) {\n\
\032 if (s==NULL) raise_null_pointer();\n\
\032 return caml_copy_string(s);\n\
}\n\
\n"
let generate ?c_file ?ml_file ?mli_file
?(optional_functions = [])
?(optional_types = [])
?(enum_of_string = [])
~modname ~types ~functions ~free ~init
~hashes
() =
let c_name = modname ^ "_stubs.c" in
let ml_name = modname ^ ".ml" in
let mli_name = modname ^ ".mli" in
let cfg_name = "config_checks.sh" in
let to_close = ref [] in
try
let c = open_out c_name in
to_close := (fun () -> close_out_noerr c) :: !to_close;
let ml = open_out ml_name in
to_close := (fun () -> close_out_noerr ml) :: !to_close;
let mli = open_out mli_name in
to_close := (fun () -> close_out_noerr mli) :: !to_close;
let cfg =
open_out_gen
[Open_wronly;Open_append;Open_creat;Open_text] 0o666 cfg_name in
to_close := (fun () -> close_out_noerr cfg) :: !to_close;
fprintf mli "(** Bindings of a C library *)";
List.iter
(fun h ->
fprintf c "#define H_%s %d\n" h (Btype.hash_variant h)
)
hashes;
let copy out file =
match file with
| Some fn ->
let f = open_in fn in
( try
while true do
let line = input_line f in
fprintf out "%s\n" line
done;
assert false
with End_of_file ->
close_in f
);
| None -> () in
gen_c_head c;
copy c c_file;
gen_c_head2 c;
List.iter
(fun name -> cfg_type cfg name)
optional_types;
List.iter
(fun (tyname,tydecl) ->
let optional = List.mem tyname optional_types in
match tydecl with
| `Abstract_enum ->
gen_abstract_enum c mli ml tyname ~optional
| `Abstract_ptr abs ->
gen_abstract_ptr c mli ml tyname abs ~optional
| `Enum cases ->
cfg_cases cfg cases;
gen_enum c mli ml tyname cases ~optional
| `Flags cases ->
cfg_cases cfg cases;
gen_flags c mli ml tyname cases ~optional
| `Same_as old_tyname ->
gen_same_as c mli ml old_tyname tyname
| `Manual(ocaml_decl ) ->
fprintf ml "%s\n" ocaml_decl;
fprintf mli "%s\n" ocaml_decl;
)
types;
List.iter
(fun (name,args,directives) ->
if List.mem `Optional directives then
cfg_fun cfg name;
gen_fun c mli ml name args directives free init
)
functions;
List.iter
(fun name -> cfg_fun cfg name)
optional_functions;
List.iter
(fun (fun_name, type_name) ->
let tydef =
try List.assoc type_name types
with Not_found ->
failwith ("enum_of_string: type not found: " ^ type_name) in
match tydef with
| `Enum cases ->
gen_enum_of_string mli ml fun_name type_name cases
| _ ->
failwith ("enum_of_string: not an enum: " ^ type_name)
)
enum_of_string;
copy ml ml_file;
copy mli mli_file;
close_out c;
close_out ml;
close_out mli;
close_out cfg
with
| error ->
List.iter
(fun f -> f())
!to_close;
List.iter
(fun n -> try Sys.remove n with _ -> ())
[ c_name; ml_name; mli_name ];
raise error
|