Merge pull request #11 from avsm/master

Fix cstruct overflow, correct sequencing in cenum, add docs

Author: avsm

.travis-ci.sh

@@ -0,0 +1,30 @@
+OPAM_DEPENDS="ocplib-endian lwt async"
+
+case "$OCAML_VERSION,$OPAM_VERSION" in
+3.12.1,1.0.0) ppa=avsm/ocaml312+opam10 ;;
+3.12.1,1.1.0) ppa=avsm/ocaml312+opam11 ;;
+4.00.1,1.0.0) ppa=avsm/ocaml40+opam10 ;;
+4.00.1,1.1.0) ppa=avsm/ocaml40+opam11 ;;
+4.01.0,1.0.0) ppa=avsm/ocaml41+opam10 ;;
+4.01.0,1.1.0) ppa=avsm/ocaml41+opam11 ;;
+*) echo Unknown $OCAML_VERSION,$OPAM_VERSION; exit 1 ;;
+esac
+
+echo "yes" | sudo add-apt-repository ppa:$ppa
+sudo apt-get update -qq
+sudo apt-get install -qq ocaml ocaml-native-compilers camlp4-extra opam time
+
+export OPAMYES=1
+export OPAMVERBOSE=1
+echo OCaml version
+ocaml -version
+echo OPAM versions
+opam --version
+opam --git-version
+
+opam init
+opam install ${OPAM_DEPENDS}
+
+eval `opam config env`
+make
+./test.sh

.travis.yml

@@ -0,0 +1,9 @@
+language: c
+script: bash -ex .travis-ci.sh
+env:
+  - OCAML_VERSION=4.01.0 OPAM_VERSION=1.0.0
+  - OCAML_VERSION=4.01.0 OPAM_VERSION=1.1.0
+  - OCAML_VERSION=4.00.1 OPAM_VERSION=1.0.0
+  - OCAML_VERSION=4.00.1 OPAM_VERSION=1.1.0
+  - OCAML_VERSION=3.12.1 OPAM_VERSION=1.0.0
+  - OCAML_VERSION=3.12.1 OPAM_VERSION=1.1.0

CHANGES

@@ -1,3 +1,10 @@
+0.7.2 (trunk):
+* Improved ocamldoc for BE/LE modules.
+* Add Travis-CI test scripts and fix `test.sh` script compilation.
+* Check and raise error in case of negative offsets for blits (#4).
+* Correctly preserve the sequence after a constant constructor is set during a `cenum` definition.
+* Do not repeat the `sizeof_<field>` binding for every get/set field (should be no externally observable change).
+
 0.7.1 (06-Mar-2013):
 * Add `Async_cstruct.Pipe` to map pipes of `Cstruct` buffers to strings or `Bigsubstring`.
 

README.md

@@ -42,14 +42,91 @@ cstruct ipv4 {
 } as big_endian
 ```
 
+This auto-generates generates functions of the form below in the `ml` file:
+
+```
+let sizeof_pcap_packet = 16
+let get_pcap_packet_ts_sec v = Cstruct.LE.get_uint32 v 0
+let set_pcap_packet_ts_sec v x = Cstruct.LE.set_uint32 v 0 x
+let get_pcap_packet_ts_usec v = Cstruct.LE.get_uint32 v 4
+let set_pcap_packet_ts_usec v x = Cstruct.LE.set_uint32 v 4 x
+let get_pcap_packet_incl_len v = Cstruct.LE.get_uint32 v 8
+let set_pcap_packet_incl_len v x = Cstruct.LE.set_uint32 v 8 x
+let get_pcap_packet_orig_len v = Cstruct.LE.get_uint32 v 12
+let set_pcap_packet_orig_len v x = Cstruct.LE.set_uint32 v 12 x
+
+let sizeof_ethernet = 14
+let get_ethernet_dst src = Cstruct.sub src 0 6
+let copy_ethernet_dst src = Cstruct.copy src 0 6
+let set_ethernet_dst src srcoff dst =
+  Cstruct.blit_from_string src srcoff dst 0 6
+let blit_ethernet_dst src srcoff dst = Cstruct.blit src srcoff dst 0 6
+let get_ethernet_src src = Cstruct.sub src 6 6
+let copy_ethernet_src src = Cstruct.copy src 6 6
+let set_ethernet_src src srcoff dst =
+  Cstruct.blit_from_string src srcoff dst 6 6
+let blit_ethernet_src src srcoff dst = Cstruct.blit src srcoff dst 6 6
+let get_ethernet_ethertype v = Cstruct.BE.get_uint16 v 12
+let set_ethernet_ethertype v x = Cstruct.BE.set_uint16 v 12 x
+```
+
+The `mli` file will have signatures of this form:
+
+```
+val sizeof_pcap_packet : int
+val get_pcap_packet_ts_sec : Cstruct.t -> Cstruct.uint32
+val set_pcap_packet_ts_sec : Cstruct.t -> Cstruct.uint32 -> unit
+val get_pcap_packet_ts_usec : Cstruct.t -> Cstruct.uint32
+val set_pcap_packet_ts_usec : Cstruct.t -> Cstruct.uint32 -> unit
+val get_pcap_packet_incl_len : Cstruct.t -> Cstruct.uint32
+val set_pcap_packet_incl_len : Cstruct.t -> Cstruct.uint32 -> unit
+val get_pcap_packet_orig_len : Cstruct.t -> Cstruct.uint32
+val set_pcap_packet_orig_len : Cstruct.t -> Cstruct.uint32 -> unit
+
+val sizeof_ethernet : int
+val get_ethernet_dst : Cstruct.t -> Cstruct.t
+val copy_ethernet_dst : Cstruct.t -> string
+val set_ethernet_dst : string -> int -> Cstruct.t -> unit
+val blit_ethernet_dst : Cstruct.t -> int -> Cstruct.t -> unit
+val get_ethernet_src : Cstruct.t -> Cstruct.t
+val copy_ethernet_src : Cstruct.t -> string
+val set_ethernet_src : string -> int -> Cstruct.t -> unit
+val blit_ethernet_src : Cstruct.t -> int -> Cstruct.t -> unit
+val get_ethernet_ethertype : Cstruct.t -> Cstruct.uint16
+val set_ethernet_ethertype : Cstruct.t -> Cstruct.uint16 -> unit
+```
 You can also declare C-like enums:
 
 ```
-cenum foo64 {
-  ONE64;
-  TWO64;
-  THREE64
-} as uint64_t
+cenum foo32 {
+  ONE32;
+  TWO32 = 0xfffffffel;
+  THREE32
+} as uint32_t
+
+cenum bar16 {
+  ONE = 1;
+  TWO;
+  FOUR = 4;
+  FIVE
+} as uint16_t
+```
+
+This generates signatures of the form:
+
+```
+type foo32 = | ONE32 | TWO32 | THREE32
+val int_to_foo32 : int32 -> foo32 option
+val foo32_to_int : foo32 -> int32
+val foo32_to_string : foo32 -> string
+val string_to_foo32 : string -> foo32 option
+type bar16 = | ONE | TWO | FOUR | FIVE
+val int_to_bar16 : int -> bar16 option
+val bar16_to_int : bar16 -> int
+val bar16_to_string : bar16 -> string
+val string_to_bar16 : string -> bar16 option
 ```
 
 Please see the `lib_test/` directory for more in-depth examples.
+
+[![Build Status](https://travis-ci.org/avsm/ocaml-cstruct.png)](https://travis-ci.org/avsm/ocaml-cstruct)

_oasis

@@ -1,6 +1,6 @@
 OASISFormat: 0.3
 Name:        cstruct
-Version:     0.7.1
+Version:     0.7.2
 Synopsis:    Manipulate external buffers as C-like structs
 Authors:     Anil Madhavapeddy, Richard Mortier, Thomas Gazagnaire, Pierre Chambart
 License:     ISC

lib/META

@@ -1,6 +1,6 @@
 # OASIS_START
-# DO NOT EDIT (digest: c671864304beccb6078416a289ce5ee8)
-version = "0.7.1"
+# DO NOT EDIT (digest: 930869fcefc42a7e26a3e025657bc63c)
+version = "0.7.2"
 description = "Manipulate external buffers as C-like structs"
 requires = "bigarray ocplib-endian ocplib-endian.bigstring"
 archive(byte) = "cstruct.cma"
@@ -9,7 +9,7 @@ archive(native) = "cstruct.cmxa"
 archive(native, plugin) = "cstruct.cmxs"
 exists_if = "cstruct.cma"
 package "unix" (
- version = "0.7.1"
+ version = "0.7.2"
  description = "Manipulate external buffers as C-like structs"
  requires = "cstruct unix"
  archive(byte) = "unix_cstruct.cma"
@@ -20,7 +20,7 @@ package "unix" (
 )
 
 package "syntax" (
- version = "0.7.1"
+ version = "0.7.2"
  description = "Syntax extension for Cstruct"
  requires = "camlp4"
  archive(syntax, preprocessor) = "cstruct-syntax.cma"
@@ -29,7 +29,7 @@ package "syntax" (
 )
 
 package "lwt" (
- version = "0.7.1"
+ version = "0.7.2"
  description = "Manipulate external buffers as C-like structs"
  requires = "cstruct lwt.unix"
  archive(byte) = "lwt_cstruct.cma"
@@ -40,7 +40,7 @@ package "lwt" (
 )
 
 package "async" (
- version = "0.7.1"
+ version = "0.7.2"
  description = "Manipulate external buffers as C-like structs"
  requires = "cstruct async threads"
  archive(byte) = "async_cstruct.cma"

lib/cstruct.ml

@@ -132,23 +132,23 @@ external unsafe_blit_string_to_bigstring : string -> int -> buffer -> int -> int
 external unsafe_blit_bigstring_to_string : buffer -> int -> string -> int -> int -> unit = "caml_blit_bigstring_to_string" "noalloc"
 
 let copy src srcoff len =
-  if src.len - srcoff < len then raise (Invalid_argument (invalid_bounds srcoff len));
+  if len < 0 || srcoff < 0 || src.len - srcoff < len then raise (Invalid_argument (invalid_bounds srcoff len));
   let s = String.create len in
   unsafe_blit_bigstring_to_string src.buffer (src.off+srcoff) s 0 len;
   s
 
 let blit src srcoff dst dstoff len =
-  if src.len - srcoff < len then raise (Invalid_argument (invalid_bounds srcoff len));
+  if len < 0 || srcoff < 0 || src.len - srcoff < len then raise (Invalid_argument (invalid_bounds srcoff len));
   if dst.len - dstoff < len then raise (Invalid_argument (invalid_bounds dstoff len));
   unsafe_blit_bigstring_to_bigstring src.buffer (src.off+srcoff) dst.buffer (dst.off+dstoff) len
 
 let blit_from_string src srcoff dst dstoff len =
-  if String.length src - srcoff < len then raise (Invalid_argument (invalid_bounds srcoff len));
+  if len < 0 || srcoff < 0 || dstoff < 0 || String.length src - srcoff < len then raise (Invalid_argument (invalid_bounds srcoff len));
   if dst.len - dstoff < len then raise (Invalid_argument (invalid_bounds dstoff len));
   unsafe_blit_string_to_bigstring src srcoff dst.buffer (dst.off+dstoff) len
 
 let blit_to_string src srcoff dst dstoff len =
-  if src.len - srcoff < len then raise (Invalid_argument (invalid_bounds srcoff len));
+  if len < 0 || srcoff < 0 || dstoff < 0 || src.len - srcoff < len then raise (Invalid_argument (invalid_bounds srcoff len));
   if String.length dst - dstoff < len then raise (Invalid_argument (invalid_bounds dstoff len));
   unsafe_blit_bigstring_to_string src.buffer (src.off+srcoff) dst dstoff len
 

lib_test/basic.ml

@@ -30,27 +30,27 @@ cstruct bar {
 
 let _ = 
   (* Test basic set/get functions *)
-  let be = Bigarray.(Array1.create char c_layout sizeof_foo) in
+  let be = Cstruct.of_bigarray (Bigarray.(Array1.create char c_layout sizeof_foo)) in
   for i = 0 to 255 do
     set_bar_a be i;
     assert(get_bar_a be = i)
   done;
-  let le = Bigarray.(Array1.create char c_layout sizeof_bar) in
+  let le = Cstruct.of_bigarray (Bigarray.(Array1.create char c_layout sizeof_bar)) in
   for i = 0 to 255 do
     set_foo_a le i;
     assert(get_foo_a le = i)
   done;
-  let be = Bigarray.(Array1.create char c_layout sizeof_foo) in
+  let be = Cstruct.of_bigarray (Bigarray.(Array1.create char c_layout sizeof_foo)) in
   for i = 0 to 65535 do
     set_bar_b be i;
     assert(get_bar_b be = i)
   done;
-  let le = Bigarray.(Array1.create char c_layout sizeof_bar) in
+  let le = Cstruct.of_bigarray(Bigarray.(Array1.create char c_layout sizeof_bar)) in
   for i = 0 to 65535 do
     set_foo_b le i;
     assert(get_foo_b le = i)
   done;
-  let be = Bigarray.(Array1.create char c_layout sizeof_foo) in
+  let be = Cstruct.of_bigarray (Bigarray.(Array1.create char c_layout sizeof_foo)) in
   let rec fn = function
    |i when i < 0l -> ()
    |i ->
@@ -59,7 +59,7 @@ let _ =
       fn (Int32.sub i 0x10l)
   in fn 0xffffffff_l;
   (* Get/set buffers and blits *)
-  let le = Bigarray.(Array1.create char c_layout sizeof_bar) in
+  let le = Cstruct.of_bigarray (Bigarray.(Array1.create char c_layout sizeof_bar)) in
   let rec fn = function
    |i when i < 0l -> ()
    |i ->
@@ -75,19 +75,15 @@ let _ =
   assert(copy_bar_d le = s1);
   Printf.printf "%s %s\n" (copy_foo_d be) (copy_bar_d le);
   (* Create sub-view and shift it back *)
-  let be = Bigarray.(Array1.create char c_layout sizeof_foo) in
+  let be = Cstruct.of_bigarray (Bigarray.(Array1.create char c_layout sizeof_foo)) in
   set_foo_a be 7;
   set_foo_b be 44;
   set_foo_c be 0xbeef_l;
   set_foo_d "abcdefgh" 0 be;
-  (* shifting the base array should fail *)
-  assert(not (Cstruct.shift_left be 1));
   (* get a subview *)
   let be2 = Cstruct.shift be 3 in
   assert(Cstruct.BE.get_uint32 be2 0 = 0xbeef_l);
-  (* shift it back *)
-  assert(Cstruct.shift_left be2 3);
-  assert(Cstruct.BE.get_uint32 be2 3 = 0xbeef_l);
-  assert(not (Cstruct.shift_left be2 1));
-  assert(get_foo_b be2 = 44);
-  assert(get_foo_a be2 = 7)
+  assert(Cstruct.BE.get_uint32 be 3 = 0xbeef_l);
+  assert(get_foo_b be = 44);
+  assert(get_foo_a be = 7)
+

lib_test/enum.ml

@@ -22,10 +22,17 @@ cenum foo64 {
 
 cenum foo32 {
   ONE32;
-  TWO32 = 3;
+  TWO32 = 0xfffffffel;
   THREE32
 } as uint32_t
 
+cenum bar16 {
+  ONE = 1;
+  TWO;
+  FOUR = 4;
+  FIVE
+} as uint16_t
+
 cenum foo16 {
   ONE16;
   TWO16;
@@ -47,9 +54,11 @@ let _ =
   ignore(foo32_to_int ONE32);
   ignore(foo16_to_int ONE16);
   ignore(foo8_to_int ONE8);
-  assert(foo32_to_int TWO32 = 3l);
-  assert(foo32_to_int THREE32 = 1l);
-  assert(int_to_foo32 3l = Some (TWO32));
-  assert(int_to_foo32 1l = Some (THREE32));
+  assert(bar16_to_int FOUR = 4);
+  assert(bar16_to_int FIVE = 5);
+  assert(foo32_to_int TWO32   = 0xfffffffel);
+  assert(foo32_to_int THREE32 = 0xffffffffl);
+  assert(int_to_foo32 0xfffffffel = Some (TWO32));
+  assert(int_to_foo32 0xffffffffl = Some (THREE32));
   assert(string_to_foo16 "ONE16" = Some ONE16);
-  print_endline (foo8_to_string ONE8)
+  assert(foo8_to_string ONE8 = "ONE8")

lib_test/enum.mli

@@ -26,6 +26,13 @@ cenum foo32 {
   THREE32
 } as uint32_t
 
+cenum bar16 {
+  ONE = 1;
+  TWO;
+  FOUR = 4;
+  FIVE
+} as uint16_t
+
 cenum foo16 {
   ONE16;
   TWO16;