pa_bitstring.ml

   1 (* Bitstring syntax extension.
   2  * Copyright (C) 2008 Red Hat Inc., Richard W.M. Jones
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version,
   8  * with the OCaml linking exception described in COPYING.LIB.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18  *
  19  * $Id$
  20  *)
  21
  22 open Printf
  23
  24 open Camlp4.PreCast
  25 open Syntax
  26 open Ast
  27
  28 open Bitstring
  29 module P = Bitstring_persistent
  30
  31 (* If this is true then we emit some debugging code which can
  32  * be useful to tell what is happening during matches.  You
  33  * also need to do 'Bitstring.debug := true' in your main program.
  34  *
  35  * If this is false then no extra debugging code is emitted.
  36  *)
  37 let debug = false
  38
  39 (* Hashtable storing named persistent patterns. *)
  40 let pattern_hash : (string, P.pattern) Hashtbl.t = Hashtbl.create 13
  41
  42 let locfail _loc msg = Loc.raise _loc (Failure msg)
  43
  44 (* Work out if an expression is an integer constant.
  45  *
  46  * Returns [Some i] if so (where i is the integer value), else [None].
  47  *
  48  * Fairly simplistic algorithm: we can only detect simple constant
  49  * expressions such as [k], [k+c], [k-c] etc.
  50  *)
  51 let rec expr_is_constant = function
  52   | <:expr< $int:i$ >> ->              (* Literal integer constant. *)
  53     Some (int_of_string i)
  54   | <:expr< $lid:op$ $a$ $b$ >> ->
  55     (match expr_is_constant a, expr_is_constant b with
  56      | Some a, Some b ->               (* Integer binary operations. *)
  57          let ops = ["+", (+); "-", (-); "*", ( * ); "/", (/);
  58                     (* NB: explicit fun .. -> is necessary here to work
  59                      * around a camlp4 bug in OCaml 3.10.0.
  60                      *)
  61                     "land", (fun a b -> a land b);
  62                     "lor", (fun a b -> a lor b);
  63                     "lxor", (fun a b -> a lxor b);
  64                     "lsl", (fun a b -> a lsl b);
  65                     "lsr", (fun a b -> a lsr b);
  66                     "asr", (fun a b -> a asr b);
  67                     "mod", (fun a b -> a mod b)] in
  68          (try Some ((List.assoc op ops) a b) with Not_found -> None)
  69      | _ -> None)
  70   | _ -> None
  71
  72 (* Generate a fresh, unique symbol each time called. *)
  73 let gensym =
  74   let i = ref 1000 in
  75   fun name ->
  76     incr i; let i = !i in
  77     sprintf "__pabitstring_%s_%d" name i
  78
  79 (* Used to keep track of which qualifiers we've seen in parse_field. *)
  80 type whatset_t = {
  81   endian_set : bool; signed_set : bool; type_set : bool;
  82   offset_set : bool; check_set : bool; bind_set : bool;
  83   save_offset_to_set : bool;
  84 }
  85 let noneset = {
  86   endian_set = false; signed_set = false; type_set = false;
  87   offset_set = false; check_set = false; bind_set = false;
  88   save_offset_to_set = false
  89 }
  90
  91 (* Deal with the qualifiers which appear for a field of both types. *)
  92 let parse_field _loc field qs =
  93   let fail = locfail _loc in
  94
  95   let whatset, field =
  96     match qs with
  97     | None -> noneset, field
  98     | Some qs ->
  99         let check already_set msg = if already_set then fail msg in
 100         let apply_qualifier (whatset, field) =
 101           function
 102           | "endian", Some expr ->
 103               check whatset.endian_set "an endian flag has been set already";
 104               let field = P.set_endian_expr field expr in
 105               { whatset with endian_set = true }, field
 106           | "endian", None ->
 107               fail "qualifier 'endian' should be followed by an expression"
 108           | "offset", Some expr ->
 109               check whatset.offset_set "an offset has been set already";
 110               let field = P.set_offset field expr in
 111               { whatset with offset_set = true }, field
 112           | "offset", None ->
 113               fail "qualifier 'offset' should be followed by an expression"
 114           | "check", Some expr ->
 115               check whatset.check_set "a check-qualifier has been set already";
 116               let field = P.set_check field expr in
 117               { whatset with check_set = true }, field
 118           | "check", None ->
 119               fail "qualifier 'check' should be followed by an expression"
 120           | "bind", Some expr ->
 121               check whatset.bind_set "a bind expression has been set already";
 122               let field = P.set_bind field expr in
 123               { whatset with bind_set = true }, field
 124           | "bind", None ->
 125               fail "qualifier 'bind' should be followed by an expression"
 126           | "save_offset_to", Some expr (* XXX should be a pattern *) ->
 127               check whatset.save_offset_to_set
 128                 "a save_offset_to-qualifier has been set already";
 129               let id =
 130                 match expr with
 131                 | <:expr< $lid:id$ >> -> id
 132                 | _ ->
 133                     failwith "pa_bitstring: internal error: save_offset_to only supports simple identifiers at the moment.  In future we should support full patterns." in
 134               let field = P.set_save_offset_to_lident field id in
 135               { whatset with save_offset_to_set = true }, field
 136           | "save_offset_to", None ->
 137               fail "qualifier 'save_offset_to' should be followed by a binding expression"
 138           | s, Some _ ->
 139               fail (s ^ ": unknown qualifier, or qualifier should not be followed by an expression")
 140           | qual, None ->
 141               let endian_quals = ["bigendian", BigEndian;
 142                                   "littleendian", LittleEndian;
 143                                   "nativeendian", NativeEndian] in
 144               let sign_quals = ["signed", true; "unsigned", false] in
 145               let type_quals = ["int", P.set_type_int;
 146                                 "string", P.set_type_string;
 147                                 "bitstring", P.set_type_bitstring] in
 148               if List.mem_assoc qual endian_quals then (
 149                 check whatset.endian_set "an endian flag has been set already";
 150                 let field = P.set_endian field (List.assoc qual endian_quals) in
 151                 { whatset with endian_set = true }, field
 152               ) else if List.mem_assoc qual sign_quals then (
 153                 check whatset.signed_set "a signed flag has been set already";
 154                 let field = P.set_signed field (List.assoc qual sign_quals) in
 155                 { whatset with signed_set = true }, field
 156               ) else if List.mem_assoc qual type_quals then (
 157                 check whatset.type_set "a type flag has been set already";
 158                 let field = (List.assoc qual type_quals) field in
 159                 { whatset with type_set = true }, field
 160               ) else
 161                 fail (qual ^ ": unknown qualifier, or qualifier should be followed by an expression") in
 162         List.fold_left apply_qualifier (noneset, field) qs in
 163
 164   (* If type is set to string or bitstring then endianness and
 165    * signedness qualifiers are meaningless and must not be set.
 166    *)
 167   let () =
 168     let t = P.get_type field in
 169     if (t = P.Bitstring || t = P.String) &&
 170       (whatset.endian_set || whatset.signed_set) then
 171         fail "string types and endian or signed qualifiers cannot be mixed" in
 172
 173   (* Default endianness, signedness, type if not set already. *)
 174   let field =
 175     if whatset.endian_set then field else P.set_endian field BigEndian in
 176   let field =
 177     if whatset.signed_set then field else P.set_signed field false in
 178   let field =
 179     if whatset.type_set then field else P.set_type_int field in
 180
 181   field
 182
 183 type functype = ExtractFunc | ConstructFunc
 184
 185 (* Choose the right constructor function. *)
 186 let build_bitstring_call _loc functype length endian signed =
 187   match functype, length, endian, signed with
 188     (* XXX The meaning of signed/unsigned breaks down at
 189      * 31, 32, 63 and 64 bits.
 190      *)
 191   | (ExtractFunc, Some 1, _, _) -> <:expr< Bitstring.extract_bit >>
 192   | (ConstructFunc, Some 1, _, _) -> <:expr< Bitstring.construct_bit >>
 193   | (functype, Some (2|3|4|5|6|7|8), _, signed) ->
 194       let funcname = match functype with
 195         | ExtractFunc -> "extract"
 196         | ConstructFunc -> "construct" in
 197       let sign = if signed then "signed" else "unsigned" in
 198       let call = sprintf "%s_char_%s" funcname sign in
 199       <:expr< Bitstring.$lid:call$ >>
 200   | (functype, len, endian, signed) ->
 201       let funcname = match functype with
 202         | ExtractFunc -> "extract"
 203         | ConstructFunc -> "construct" in
 204       let t = match len with
 205         | Some i when i <= 31 -> "int"
 206         | Some 32 -> "int32"
 207         | _ -> "int64" in
 208       let sign = if signed then "signed" else "unsigned" in
 209       match endian with
 210       | P.ConstantEndian constant ->
 211           let endianness = match constant with
 212           | BigEndian -> "be"
 213           | LittleEndian -> "le"
 214           | NativeEndian -> "ne" in
 215           let call = sprintf "%s_%s_%s_%s" funcname t endianness sign in
 216           <:expr< Bitstring.$lid:call$ >>
 217       | P.EndianExpr expr ->
 218           let call = sprintf "%s_%s_%s_%s" funcname t "ee" sign in
 219           <:expr< Bitstring.$lid:call$ $expr$ >>
 220
 221 (* Generate the code for a constructor, ie. 'BITSTRING ...'. *)
 222 let output_constructor _loc fields =
 223   (* This function makes code to raise a Bitstring.Construct_failure exception
 224    * containing a message and the current _loc context.
 225    * (Thanks to Bluestorm for suggesting this).
 226    *)
 227   let construct_failure _loc msg =
 228     <:expr<
 229       Bitstring.Construct_failure
 230         ($`str:msg$,
 231          $`str:Loc.file_name _loc$,
 232          $`int:Loc.start_line _loc$,
 233          $`int:Loc.start_off _loc - Loc.start_bol _loc$)
 234     >>
 235   in
 236   let raise_construct_failure _loc msg =
 237     <:expr< raise $construct_failure _loc msg$ >>
 238   in
 239
 240   (* Bitstrings are created like the 'Buffer' module (in fact, using
 241    * the Buffer module), by appending snippets to a growing buffer.
 242    * This is reasonably efficient and avoids a lot of garbage.
 243    *)
 244   let buffer = gensym "buffer" in
 245
 246   (* General exception which is raised inside the constructor functions
 247    * when an int expression is out of range at runtime.
 248    *)
 249   let exn = gensym "exn" in
 250   let exn_used = ref false in
 251
 252   (* Convert each field to a simple bitstring-generating expression. *)
 253   let fields = List.map (
 254     fun field ->
 255       let fexpr = P.get_expr field in
 256       let flen = P.get_length field in
 257       let endian = P.get_endian field in
 258       let signed = P.get_signed field in
 259       let t = P.get_type field in
 260       let _loc = P.get_location field in
 261
 262       let fail = locfail _loc in
 263
 264       (* offset(), check(), bind(), save_offset_to() not supported in
 265        * constructors.
 266        *
 267        * Implementation of forward-only offsets is fairly
 268        * straightforward: we would need to just calculate the length of
 269        * padding here and add it to what has been constructed.  For
 270        * general offsets, including going backwards, that would require
 271        * a rethink in how we construct bitstrings.
 272        *)
 273       if P.get_offset field <> None then
 274         fail "offset expressions are not supported in BITSTRING constructors";
 275       if P.get_check field <> None then
 276         fail "check expressions are not supported in BITSTRING constructors";
 277       if P.get_bind field <> None then
 278         fail "bind expressions are not supported in BITSTRING constructors";
 279       if P.get_save_offset_to field <> None then
 280         fail "save_offset_to is not supported in BITSTRING constructors";
 281
 282       (* Is flen an integer constant?  If so, what is it?  This
 283        * is very simple-minded and only detects simple constants.
 284        *)
 285       let flen_is_const = expr_is_constant flen in
 286
 287       let int_construct_const (i, endian, signed) =
 288         build_bitstring_call _loc ConstructFunc (Some i) endian signed in
 289       let int_construct (endian, signed) =
 290         build_bitstring_call _loc ConstructFunc None endian signed in
 291
 292       let expr =
 293         match t, flen_is_const with
 294         (* Common case: int field, constant flen.
 295          *
 296          * Range checks are done inside the construction function
 297          * because that's a lot simpler w.r.t. types.  It might
 298          * be better to move them here. XXX
 299          *)
 300         | P.Int, Some i when i > 0 && i <= 64 ->
 301             let construct_fn = int_construct_const (i,endian,signed) in
 302             exn_used := true;
 303
 304             <:expr<
 305               $construct_fn$ $lid:buffer$ $fexpr$ $`int:i$ $lid:exn$
 306             >>
 307
 308         | P.Int, Some _ ->
 309             fail "length of int field must be [1..64]"
 310
 311         (* Int field, non-constant length.  We need to perform a runtime
 312          * test to ensure the length is [1..64].
 313          *
 314          * Range checks are done inside the construction function
 315          * because that's a lot simpler w.r.t. types.  It might
 316          * be better to move them here. XXX
 317          *)
 318         | P.Int, None ->
 319             let construct_fn = int_construct (endian,signed) in
 320             exn_used := true;
 321
 322             <:expr<
 323               if $flen$ >= 1 && $flen$ <= 64 then
 324                 $construct_fn$ $lid:buffer$ $fexpr$ $flen$ $lid:exn$
 325               else
 326                 $raise_construct_failure _loc "length of int field must be [1..64]"$
 327             >>
 328
 329         (* String, constant length > 0, must be a multiple of 8. *)
 330         | P.String, Some i when i > 0 && i land 7 = 0 ->
 331             let bs = gensym "bs" in
 332             let j = i lsr 3 in
 333             <:expr<
 334               let $lid:bs$ = $fexpr$ in
 335               if String.length $lid:bs$ = $`int:j$ then
 336                 Bitstring.construct_string $lid:buffer$ $lid:bs$
 337               else
 338                 $raise_construct_failure _loc "length of string does not match declaration"$
 339             >>
 340
 341         (* String, constant length -1, means variable length string
 342          * with no checks.
 343          *)
 344         | P.String, Some (-1) ->
 345             <:expr< Bitstring.construct_string $lid:buffer$ $fexpr$ >>
 346
 347         (* String, constant length = 0 is probably an error, and so is
 348          * any other value.
 349          *)
 350         | P.String, Some _ ->
 351             fail "length of string must be > 0 and a multiple of 8, or the special value -1"
 352
 353         (* String, non-constant length.
 354          * We check at runtime that the length is > 0, a multiple of 8,
 355          * and matches the declared length.
 356          *)
 357         | P.String, None ->
 358             let bslen = gensym "bslen" in
 359             let bs = gensym "bs" in
 360             <:expr<
 361               let $lid:bslen$ = $flen$ in
 362               if $lid:bslen$ > 0 then (
 363                 if $lid:bslen$ land 7 = 0 then (
 364                   let $lid:bs$ = $fexpr$ in
 365                   if String.length $lid:bs$ = ($lid:bslen$ lsr 3) then
 366                     Bitstring.construct_string $lid:buffer$ $lid:bs$
 367                   else
 368                     $raise_construct_failure _loc "length of string does not match declaration"$
 369                 ) else
 370                   $raise_construct_failure _loc "length of string must be a multiple of 8"$
 371               ) else
 372                 $raise_construct_failure _loc "length of string must be > 0"$
 373             >>
 374
 375         (* Bitstring, constant length >= 0. *)
 376         | P.Bitstring, Some i when i >= 0 ->
 377             let bs = gensym "bs" in
 378             <:expr<
 379               let $lid:bs$ = $fexpr$ in
 380               if Bitstring.bitstring_length $lid:bs$ = $`int:i$ then
 381                 Bitstring.construct_bitstring $lid:buffer$ $lid:bs$
 382               else
 383                 $raise_construct_failure _loc "length of bitstring does not match declaration"$
 384             >>
 385
 386         (* Bitstring, constant length -1, means variable length bitstring
 387          * with no checks.
 388          *)
 389         | P.Bitstring, Some (-1) ->
 390             <:expr< Bitstring.construct_bitstring $lid:buffer$ $fexpr$ >>
 391
 392         (* Bitstring, constant length < -1 is an error. *)
 393         | P.Bitstring, Some _ ->
 394             fail "length of bitstring must be >= 0 or the special value -1"
 395
 396         (* Bitstring, non-constant length.
 397          * We check at runtime that the length is >= 0 and matches
 398          * the declared length.
 399          *)
 400         | P.Bitstring, None ->
 401             let bslen = gensym "bslen" in
 402             let bs = gensym "bs" in
 403             <:expr<
 404               let $lid:bslen$ = $flen$ in
 405               if $lid:bslen$ >= 0 then (
 406                 let $lid:bs$ = $fexpr$ in
 407                 if Bitstring.bitstring_length $lid:bs$ = $lid:bslen$ then
 408                   Bitstring.construct_bitstring $lid:buffer$ $lid:bs$
 409                 else
 410                   $raise_construct_failure _loc "length of bitstring does not match declaration"$
 411               ) else
 412                 $raise_construct_failure _loc "length of bitstring must be > 0"$
 413             >> in
 414       expr
 415   ) fields in
 416
 417   (* Create the final bitstring.  Start by creating an empty buffer
 418    * and then evaluate each expression above in turn which will
 419    * append some more to the bitstring buffer.  Finally extract
 420    * the bitstring.
 421    *
 422    * XXX We almost have enough information to be able to guess
 423    * a good initial size for the buffer.
 424    *)
 425   let fields =
 426     match fields with
 427     | [] -> <:expr< [] >>
 428     | h::t -> List.fold_left (fun h t -> <:expr< $h$; $t$ >>) h t in
 429
 430   let expr =
 431     <:expr<
 432       let $lid:buffer$ = Bitstring.Buffer.create () in
 433       $fields$;
 434       Bitstring.Buffer.contents $lid:buffer$
 435     >> in
 436
 437   if !exn_used then
 438     <:expr<
 439       let $lid:exn$ = $construct_failure _loc "value out of range"$ in
 440       $expr$
 441     >>
 442   else
 443     expr
 444
 445 (* Generate the code for a bitmatch statement.  '_loc' is the
 446  * location, 'bs' is the bitstring parameter, 'cases' are
 447  * the list of cases to test against.
 448  *)
 449 let output_bitmatch _loc bs cases =
 450   (* These symbols are used through the generated code to record our
 451    * current position within the bitstring:
 452    *
 453    *   data - original bitstring data (string, never changes)
 454    *   off  - current offset within data (int, increments as we move through
 455    *            the bitstring)
 456    *   len  - current remaining length within data (int, decrements as
 457    *            we move through the bitstring)
 458    *
 459    * Also:
 460    *
 461    *   original_off - saved offset at the start of the match (never changes)
 462    *   original_len - saved length at the start of the match (never changes)
 463    *   off_aligned  - true if the original offset is byte-aligned (allows
 464    *            us to make some common optimizations)
 465    *)
 466   let data = gensym "data"
 467   and off = gensym "off"
 468   and len = gensym "len"
 469   and original_off = gensym "original_off"
 470   and original_len = gensym "original_len"
 471   and off_aligned = gensym "off_aligned"
 472
 473   (* This is where the result will be stored (a reference). *)
 474   and result = gensym "result" in
 475
 476   (* This generates the field extraction code for each
 477    * field in a single case.  There must be enough remaining data
 478    * in the bitstring to satisfy the field.
 479    *
 480    * As we go through the fields, symbols 'data', 'off' and 'len'
 481    * track our position and remaining length in the bitstring.
 482    *
 483    * The whole thing is a lot of nested 'if'/'match' statements.
 484    * Code is generated from the inner-most (last) field outwards.
 485    *)
 486   let rec output_field_extraction inner = function
 487     | [] -> inner
 488     | field :: fields ->
 489         let fpatt = P.get_patt field in
 490         let flen = P.get_length field in
 491         let endian = P.get_endian field in
 492         let signed = P.get_signed field in
 493         let t = P.get_type field in
 494         let _loc = P.get_location field in
 495
 496         let fail = locfail _loc in
 497
 498         (* Is flen (field len) an integer constant?  If so, what is it?
 499          * This will be [Some i] if it's a constant or [None] if it's
 500          * non-constant or we couldn't determine.
 501          *)
 502         let flen_is_const = expr_is_constant flen in
 503
 504         (* Surround the inner expression by check and bind clauses, so:
 505          *   if $check$ then
 506          *     let $bind...$ in
 507          *       $inner$
 508          * where the check and bind are switched on only if they are
 509          * present in the field.  (In the common case when neither
 510          * clause is present, expr = inner).  Note the order of the
 511          * check & bind is visible to the user and defined in the
 512          * documentation, so it must not change.
 513          *)
 514         let expr = inner in
 515         let expr =
 516           match P.get_bind field with
 517           | None -> expr
 518           | Some bind_expr ->
 519               <:expr< let $fpatt$ = $bind_expr$ in $expr$ >> in
 520         let expr =
 521           match P.get_check field with
 522           | None -> expr
 523           | Some check_expr ->
 524               <:expr< if $check_expr$ then $expr$ >> in
 525
 526         (* Compute the offset of this field within the match, if it
 527          * can be known at compile time.
 528          *
 529          * Actually, we'll compute two things: the 'natural_field_offset'
 530          * is the offset assuming this field had no offset() qualifier
 531          * (in other words, its position, immediately following the
 532          * preceding field).  'field_offset' is the real field offset
 533          * taking into account any offset() qualifier.
 534          *
 535          * This will be [Some i] if our current offset is known
 536          * at compile time, or [None] if we can't determine it.
 537          *)
 538         let natural_field_offset, field_offset =
 539           let has_constant_offset field =
 540             match P.get_offset field with
 541             | None -> false
 542             | Some expr ->
 543                 match expr_is_constant expr with
 544                 | None -> false
 545                 | Some i -> true
 546           in
 547           let get_constant_offset field =
 548             match P.get_offset field with
 549             | None -> assert false
 550             | Some expr ->
 551                 match expr_is_constant expr with
 552                 | None -> assert false
 553                 | Some i -> i
 554           in
 555
 556           let has_constant_len field =
 557             match expr_is_constant (P.get_length field) with
 558             | None -> false
 559             | Some i when i > 0 -> true
 560             | Some _ -> false
 561           in
 562           let get_constant_len field =
 563             match expr_is_constant (P.get_length field) with
 564             | None -> assert false
 565             | Some i when i > 0 -> i
 566             | Some _ -> assert false
 567           in
 568
 569           (* NB: We are looping over the PRECEDING fields in reverse order. *)
 570           let rec loop = function
 571             (* first field has constant offset 0 *)
 572             | [] -> Some 0
 573             (* preceding field with constant offset & length *)
 574             | f :: _
 575                 when has_constant_offset f && has_constant_len f ->
 576                 Some (get_constant_offset f + get_constant_len f)
 577             (* preceding field with no offset & constant length *)
 578             | f :: fs
 579                 when P.get_offset f = None && has_constant_len f ->
 580                 (match loop fs with
 581                  | None -> None
 582                  | Some offset -> Some (offset + get_constant_len f))
 583             (* else, can't work out the offset *)
 584             | _ -> None
 585           in
 586
 587           let natural_field_offset = loop fields in
 588
 589           let field_offset =
 590             match P.get_offset field with
 591             | None -> natural_field_offset
 592             | Some expr -> (* has an offset() clause *)
 593                 match expr_is_constant expr with
 594                 | None -> None
 595                 | i -> i in
 596
 597           natural_field_offset, field_offset in
 598
 599         (* Also compute if the field_offset is known to be byte-aligned at
 600          * compile time, which is usually both the common and best possible
 601          * case for generating optimized code.
 602          *
 603          * This is None if not aligned / don't know.
 604          * Or Some byte_offset if we can work it out.
 605          *)
 606         let field_offset_aligned =
 607           match field_offset with
 608           | None -> None                (* unknown, assume no *)
 609           | Some off when off land 7 = 0 -> Some (off lsr 3)
 610           | Some _ -> None in           (* definitely no *)
 611
 612         (* Now build the code which matches a single field. *)
 613         let int_extract_const i endian signed =
 614           build_bitstring_call _loc ExtractFunc (Some i) endian signed in
 615         let int_extract endian signed =
 616           build_bitstring_call _loc ExtractFunc None endian signed in
 617
 618         let expr =
 619           match t, flen_is_const, field_offset_aligned with
 620           (* Very common cases: int field, constant 8/16/32/64 bit length,
 621            * aligned to the match at a known offset.  We still have to
 622            * check if the bitstring is aligned (can only be known at
 623            * runtime) but we may be able to directly access the
 624            * bytes in the string.
 625            *)
 626           | P.Int, Some ((8(*|16|32|64*)) as i), Some field_byte_offset ->
 627               let extract_fn = int_extract_const i endian signed in
 628               let o = gensym "off" and v = gensym "val" in
 629
 630               (* The fast-path code when everything is aligned. *)
 631               let fastpath =
 632                 <:expr<
 633                   let $lid:o$ = ($lid:original_off$ lsr 3) +
 634                     $`int:field_byte_offset$ in
 635                   Char.code (String.unsafe_get $lid:data$ $lid:o$)
 636                 >> in
 637
 638               <:expr<
 639                 if $lid:len$ >= $`int:i$ then (
 640                   let $lid:v$ =
 641                     if $lid:off_aligned$ then
 642                       $fastpath$
 643                     else
 644                       $extract_fn$ $lid:data$ $lid:off$ $lid:len$ $`int:i$ in
 645                   let $lid:off$ = $lid:off$ + $`int:i$
 646                   and $lid:len$ = $lid:len$ - $`int:i$ in
 647                   match $lid:v$ with $fpatt$ when true -> $expr$ | _ -> ()
 648                 )
 649               >>
 650
 651           (* Common case: int field, constant flen *)
 652           | P.Int, Some i, _ when i > 0 && i <= 64 ->
 653               let extract_fn = int_extract_const i endian signed in
 654               let v = gensym "val" in
 655               <:expr<
 656                 if $lid:len$ >= $`int:i$ then (
 657                   let $lid:v$ =
 658                     $extract_fn$ $lid:data$ $lid:off$ $lid:len$ $`int:i$ in
 659                   let $lid:off$ = $lid:off$ + $`int:i$
 660                   and $lid:len$ = $lid:len$ - $`int:i$ in
 661                   match $lid:v$ with $fpatt$ when true -> $expr$ | _ -> ()
 662                 )
 663               >>
 664
 665           | P.Int, Some _, _ ->
 666               fail "length of int field must be [1..64]"
 667
 668           (* Int field, non-const flen.  We have to test the range of
 669            * the field at runtime.  If outside the range it's a no-match
 670            * (not an error).
 671            *)
 672           | P.Int, None, _ ->
 673               let extract_fn = int_extract endian signed in
 674               let v = gensym "val" in
 675               <:expr<
 676                 if $flen$ >= 1 && $flen$ <= 64 && $flen$ <= $lid:len$ then (
 677                   let $lid:v$ =
 678                     $extract_fn$ $lid:data$ $lid:off$ $lid:len$ $flen$ in
 679                   let $lid:off$ = $lid:off$ + $flen$
 680                   and $lid:len$ = $lid:len$ - $flen$ in
 681                   match $lid:v$ with $fpatt$ when true -> $expr$ | _ -> ()
 682                 )
 683               >>
 684
 685           (* String, constant flen > 0. *)
 686           | P.String, Some i, _ when i > 0 && i land 7 = 0 ->
 687               let bs = gensym "bs" in
 688               <:expr<
 689                 if $lid:len$ >= $`int:i$ then (
 690                   let $lid:bs$ =
 691                     Bitstring.extract_bitstring $lid:data$ $lid:off$ $lid:len$
 692                       $`int:i$ in
 693                   let $lid:off$ = $lid:off$ + $`int:i$
 694                   and $lid:len$ = $lid:len$ - $`int:i$ in
 695                   match Bitstring.string_of_bitstring $lid:bs$ with
 696                   | $fpatt$ when true -> $expr$
 697                   | _ -> ()
 698                 )
 699               >>
 700
 701           (* String, constant flen = -1, means consume all the
 702            * rest of the input.
 703            *)
 704           | P.String, Some i, _ when i = -1 ->
 705               let bs = gensym "bs" in
 706               <:expr<
 707                 let $lid:bs$ =
 708                   Bitstring.extract_remainder $lid:data$ $lid:off$ $lid:len$ in
 709                 let $lid:off$ = $lid:off$ + $lid:len$ in
 710                 let $lid:len$ = 0 in
 711                 match Bitstring.string_of_bitstring $lid:bs$ with
 712                 | $fpatt$ when true -> $expr$
 713                 | _ -> ()
 714               >>
 715
 716           | P.String, Some _, _ ->
 717               fail "length of string must be > 0 and a multiple of 8, or the special value -1"
 718
 719           (* String field, non-const flen.  We check the flen is > 0
 720            * and a multiple of 8 (-1 is not allowed here), at runtime.
 721            *)
 722           | P.String, None, _ ->
 723               let bs = gensym "bs" in
 724               <:expr<
 725                 if $flen$ >= 0 && $flen$ <= $lid:len$
 726                   && $flen$ land 7 = 0 then (
 727                     let $lid:bs$ =
 728                       Bitstring.extract_bitstring
 729                         $lid:data$ $lid:off$ $lid:len$ $flen$ in
 730                     let $lid:off$ = $lid:off$ + $flen$
 731                     and $lid:len$ = $lid:len$ - $flen$ in
 732                     match Bitstring.string_of_bitstring $lid:bs$ with
 733                     | $fpatt$ when true -> $expr$
 734                     | _ -> ()
 735                   )
 736               >>
 737
 738           (* Bitstring, constant flen >= 0.
 739            * At the moment all we can do is assign the bitstring to an
 740            * identifier.
 741            *)
 742           | P.Bitstring, Some i, _ when i >= 0 ->
 743               let ident =
 744                 match fpatt with
 745                 | <:patt< $lid:ident$ >> -> ident
 746                 | <:patt< _ >> -> "_"
 747                 | _ ->
 748                     fail "cannot compare a bitstring to a constant" in
 749               <:expr<
 750                 if $lid:len$ >= $`int:i$ then (
 751                   let $lid:ident$ =
 752                     Bitstring.extract_bitstring $lid:data$ $lid:off$ $lid:len$
 753                       $`int:i$ in
 754                   let $lid:off$ = $lid:off$ + $`int:i$
 755                   and $lid:len$ = $lid:len$ - $`int:i$ in
 756                   $expr$
 757                 )
 758               >>
 759
 760           (* Bitstring, constant flen = -1, means consume all the
 761            * rest of the input.
 762            *)
 763           | P.Bitstring, Some i, _ when i = -1 ->
 764               let ident =
 765                 match fpatt with
 766                 | <:patt< $lid:ident$ >> -> ident
 767                 | <:patt< _ >> -> "_"
 768                 | _ ->
 769                     fail "cannot compare a bitstring to a constant" in
 770               <:expr<
 771                 let $lid:ident$ =
 772                   Bitstring.extract_remainder $lid:data$ $lid:off$ $lid:len$ in
 773                 let $lid:off$ = $lid:off$ + $lid:len$ in
 774                 let $lid:len$ = 0 in
 775                   $expr$
 776               >>
 777
 778           | P.Bitstring, Some _, _ ->
 779               fail "length of bitstring must be >= 0 or the special value -1"
 780
 781           (* Bitstring field, non-const flen.  We check the flen is >= 0
 782            * (-1 is not allowed here) at runtime.
 783            *)
 784           | P.Bitstring, None, _ ->
 785               let ident =
 786                 match fpatt with
 787                 | <:patt< $lid:ident$ >> -> ident
 788                 | <:patt< _ >> -> "_"
 789                 | _ ->
 790                     fail "cannot compare a bitstring to a constant" in
 791               <:expr<
 792                 if $flen$ >= 0 && $flen$ <= $lid:len$ then (
 793                   let $lid:ident$ =
 794                     Bitstring.extract_bitstring $lid:data$ $lid:off$ $lid:len$
 795                       $flen$ in
 796                   let $lid:off$ = $lid:off$ + $flen$
 797                   and $lid:len$ = $lid:len$ - $flen$ in
 798                   $expr$
 799                 )
 800               >>
 801         in
 802
 803         (* Computed offset: only offsets forward are supported.
 804          *
 805          * We try hard to optimize this based on what we know.  Are
 806          * we at a predictable offset now?  (Look at the outer 'fields'
 807          * list and see if they all have constant field length starting
 808          * at some constant offset).  Is this offset constant?
 809          *
 810          * Based on this we can do a lot of the computation at
 811          * compile time, or defer it to runtime only if necessary.
 812          *
 813          * In all cases, the off and len fields get updated.
 814          *)
 815         let expr =
 816           match P.get_offset field with
 817           | None -> expr (* common case: there was no offset expression *)
 818           | Some offset_expr ->
 819               (* This will be [Some i] if offset is a constant expression
 820                * or [None] if it's a non-constant.
 821                *)
 822               let requested_offset = expr_is_constant offset_expr in
 823
 824               (* Look at the field offset (if known) and requested offset
 825                * cases and determine what code to generate.
 826                *)
 827               match natural_field_offset, requested_offset with
 828                 (* This is the good case: both the field offset and
 829                  * the requested offset are constant, so we can remove
 830                  * almost all the runtime checks.
 831                  *)
 832               | Some natural_field_offset, Some requested_offset ->
 833                   let move = requested_offset - natural_field_offset in
 834                   if move < 0 then
 835                     fail (sprintf "requested offset is less than the field offset (%d < %d)" requested_offset natural_field_offset);
 836                   (* Add some code to move the offset and length by a
 837                    * constant amount, and a runtime test that len >= 0
 838                    * (XXX possibly the runtime test is unnecessary?)
 839                    *)
 840                   <:expr<
 841                     let $lid:off$ = $lid:off$ + $`int:move$ in
 842                     let $lid:len$ = $lid:len$ - $`int:move$ in
 843                     if $lid:len$ >= 0 then $expr$
 844                   >>
 845               (* In any other case, we need to use runtime checks.
 846                *
 847                * XXX It's not clear if a backwards move detected at runtime
 848                * is merely a match failure, or a runtime error.  At the
 849                * moment it's just a match failure since bitmatch generally
 850                * doesn't raise runtime errors.
 851                *)
 852               | _ ->
 853                   let move = gensym "move" in
 854                   <:expr<
 855                     let $lid:move$ =
 856                       $offset_expr$ - ($lid:off$ - $lid:original_off$) in
 857                     if $lid:move$ >= 0 then (
 858                       let $lid:off$ = $lid:off$ + $lid:move$ in
 859                       let $lid:len$ = $lid:len$ - $lid:move$ in
 860                       if $lid:len$ >= 0 then $expr$
 861                     )
 862                   >> in (* end of computed offset code *)
 863
 864         (* save_offset_to(patt) saves the current offset into a variable. *)
 865         let expr =
 866           match P.get_save_offset_to field with
 867           | None -> expr (* no save_offset_to *)
 868           | Some patt ->
 869               <:expr<
 870                 let $patt$ = $lid:off$ - $lid:original_off$ in
 871                 $expr$
 872               >> in
 873
 874         (* Emit extra debugging code. *)
 875         let expr =
 876           if not debug then expr else (
 877             let field = P.string_of_pattern_field field in
 878
 879             <:expr<
 880               if !Bitstring.debug then (
 881                 Printf.eprintf "PA_BITSTRING: TEST:\n";
 882                 Printf.eprintf "  %s\n" $str:field$;
 883                 Printf.eprintf "  off %d len %d\n%!" $lid:off$ $lid:len$;
 884                 (*Bitstring.hexdump_bitstring stderr
 885                   ($lid:data$,$lid:off$,$lid:len$);*)
 886               );
 887               $expr$
 888             >>
 889           ) in
 890
 891         output_field_extraction expr fields
 892   in
 893
 894   (* Convert each case in the match. *)
 895   let cases = List.map (
 896     fun (fields, bind, whenclause, code) ->
 897       let inner = <:expr< $lid:result$ := Some ($code$); raise Exit >> in
 898       let inner =
 899         match whenclause with
 900         | Some whenclause ->
 901             <:expr< if $whenclause$ then $inner$ >>
 902         | None -> inner in
 903       let inner =
 904         match bind with
 905         | Some name ->
 906             <:expr<
 907               let $lid:name$ = ($lid:data$, $lid:off$, $lid:len$) in
 908               $inner$
 909               >>
 910         | None -> inner in
 911       output_field_extraction inner (List.rev fields)
 912   ) cases in
 913
 914   (* Join them into a single expression.
 915    *
 916    * Don't do it with a normal fold_right because that leaves
 917    * 'raise Exit; ()' at the end which causes a compiler warning.
 918    * Hence a bit of complexity here.
 919    *
 920    * Note that the number of cases is always >= 1 so List.hd is safe.
 921    *)
 922   let cases = List.rev cases in
 923   let cases =
 924     List.fold_left (fun base case -> <:expr< $case$ ; $base$ >>)
 925       (List.hd cases) (List.tl cases) in
 926
 927   (* The final code just wraps the list of cases in a
 928    * try/with construct so that each case is tried in
 929    * turn until one case matches (that case sets 'result'
 930    * and raises 'Exit' to leave the whole statement).
 931    * If result isn't set by the end then we will raise
 932    * Match_failure with the location of the bitmatch
 933    * statement in the original code.
 934    *)
 935   let loc_fname = Loc.file_name _loc in
 936   let loc_line = string_of_int (Loc.start_line _loc) in
 937   let loc_char = string_of_int (Loc.start_off _loc - Loc.start_bol _loc) in
 938
 939   <:expr<
 940     (* Note we save the original offset/length at the start of the match
 941      * in 'original_off'/'original_len' symbols.  'data' never changes.
 942      * This code also ensures that if original_off/original_len/off_aligned
 943      * aren't actually used, we don't get a warning.
 944      *)
 945     let ($lid:data$, $lid:original_off$, $lid:original_len$) = $bs$ in
 946     let $lid:off$ = $lid:original_off$ and $lid:len$ = $lid:original_len$ in
 947     let $lid:off_aligned$ = $lid:off$ land 7 = 0 in
 948     ignore $lid:off_aligned$;
 949     let $lid:result$ = ref None in
 950     (try
 951       $cases$
 952     with Exit -> ());
 953     match ! $lid:result$ with
 954     | Some x -> x
 955     | None -> raise (Match_failure ($str:loc_fname$,
 956                                     $int:loc_line$, $int:loc_char$))
 957   >>
 958
 959 (* Add a named pattern. *)
 960 let add_named_pattern _loc name pattern =
 961   Hashtbl.add pattern_hash name pattern
 962
 963 (* Expand a named pattern from the pattern_hash. *)
 964 let expand_named_pattern _loc name =
 965   try Hashtbl.find pattern_hash name
 966   with Not_found ->
 967     locfail _loc (sprintf "named pattern not found: %s" name)
 968
 969 (* Add named patterns from a file.  See the documentation on the
 970  * directory search path in bitstring_persistent.mli
 971  *)
 972 let load_patterns_from_file _loc filename =
 973   let chan =
 974     if Filename.is_relative filename && Filename.is_implicit filename then (
 975       (* Try current directory. *)
 976       try open_in filename
 977       with _ ->
 978         (* Try OCaml library directory. *)
 979         try open_in (Filename.concat Bitstring_config.ocamllibdir filename)
 980         with exn -> Loc.raise _loc exn
 981     ) else (
 982       try open_in filename
 983       with exn -> Loc.raise _loc exn
 984     ) in
 985   let names = ref [] in
 986   (try
 987      let rec loop () =
 988        let name = P.named_from_channel chan in
 989        names := name :: !names
 990      in
 991      loop ()
 992    with End_of_file -> ()
 993   );
 994   close_in chan;
 995   let names = List.rev !names in
 996   List.iter (
 997     function
 998     | name, P.Pattern patt ->
 999         if patt = [] then
1000           locfail _loc (sprintf "pattern %s: no fields" name);
1001         add_named_pattern _loc name patt
1002     | _, P.Constructor _ -> () (* just ignore these for now *)
1003   ) names
1004
1005 EXTEND Gram
1006   GLOBAL: expr str_item;
1007
1008   (* Qualifiers are a list of identifiers ("string", "bigendian", etc.)
1009    * followed by an optional expression (used in certain cases).  Note
1010    * that we are careful not to declare any explicit reserved words.
1011    *)
1012   qualifiers: [
1013     [ LIST0
1014         [ q = LIDENT;
1015           e = OPT [ "("; e = expr; ")" -> e ] -> (q, e) ]
1016         SEP "," ]
1017   ];
1018
1019   (* Field used in the bitmatch operator (a pattern).  This can actually
1020    * return multiple fields, in the case where the 'field' is a named
1021    * persitent pattern.
1022    *)
1023   patt_field: [
1024     [ fpatt = patt; ":"; len = expr LEVEL "top";
1025       qs = OPT [ ":"; qs = qualifiers -> qs ] ->
1026         let field = P.create_pattern_field _loc in
1027         let field = P.set_patt field fpatt in
1028         let field = P.set_length field len in
1029         [parse_field _loc field qs]     (* Normal, single field. *)
1030     | ":"; name = LIDENT ->
1031         expand_named_pattern _loc name (* Named -> list of fields. *)
1032     ]
1033   ];
1034
1035   (* Case inside bitmatch operator. *)
1036   patt_fields: [
1037     [ "{";
1038       fields = LIST0 patt_field SEP ";";
1039       "}" ->
1040         List.concat fields
1041     ]
1042   ];
1043
1044   patt_case: [
1045     [ fields = patt_fields;
1046       bind = OPT [ "as"; name = LIDENT -> name ];
1047       whenclause = OPT [ "when"; e = expr -> e ]; "->";
1048       code = expr ->
1049         (fields, bind, whenclause, code)
1050     ]
1051   ];
1052
1053   (* Field used in the BITSTRING constructor (an expression). *)
1054   constr_field: [
1055     [ fexpr = expr LEVEL "top"; ":"; len = expr LEVEL "top";
1056       qs = OPT [ ":"; qs = qualifiers -> qs ] ->
1057         let field = P.create_constructor_field _loc in
1058         let field = P.set_expr field fexpr in
1059         let field = P.set_length field len in
1060         parse_field _loc field qs
1061     ]
1062   ];
1063
1064   constr_fields: [
1065     [ "{";
1066       fields = LIST0 constr_field SEP ";";
1067       "}" ->
1068         fields
1069     ]
1070   ];
1071
1072   (* 'bitmatch' expressions. *)
1073   expr: LEVEL ";" [
1074     [ "bitmatch";
1075       bs = expr; "with"; OPT "|";
1076       cases = LIST1 patt_case SEP "|" ->
1077         output_bitmatch _loc bs cases
1078     ]
1079
1080   (* Constructor. *)
1081   | [ "BITSTRING";
1082       fields = constr_fields ->
1083         output_constructor _loc fields
1084     ]
1085   ];
1086
1087   (* Named persistent patterns.
1088    *
1089    * NB: Currently only allowed at the top level.  We can probably lift
1090    * this restriction later if necessary.  We only deal with patterns
1091    * at the moment, not constructors, but the infrastructure to do
1092    * constructors is in place.
1093    *)
1094   str_item: LEVEL "top" [
1095     [ "let"; "bitmatch";
1096       name = LIDENT; "="; fields = patt_fields ->
1097         add_named_pattern _loc name fields;
1098         (* The statement disappears, but we still need a str_item so ... *)
1099         <:str_item< >>
1100     | "open"; "bitmatch"; filename = STRING ->
1101         load_patterns_from_file _loc filename;
1102         <:str_item< >>
1103     ]
1104   ];
1105
1106 END