Implement bitstring_to_chan, bitstring_to_file.
[ocaml-bitstring.git] / bitmatch.mli
1 (** Bitmatch library. *)
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  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  *
18  * $Id: bitmatch.mli,v 1.20 2008-05-08 21:28:28 rjones Exp $
19  *)
20
21 (**
22    {{:#reference}Jump straight to the reference section for
23    documentation on types and functions}.
24
25    {2 Introduction}
26
27    Bitmatch adds Erlang-style bitstrings and matching over bitstrings
28    as a syntax extension and library for OCaml.  You can use
29    this module to both parse and generate binary formats, for
30    example, communications protocols, disk formats and binary files.
31
32    {{:http://code.google.com/p/bitmatch/}OCaml bitmatch website}
33
34    {2 Examples}
35
36    A function which can parse IPv4 packets:
37
38 {[
39 let display pkt =
40   bitmatch pkt with
41   (* IPv4 packet header
42     0                   1                   2                   3   
43     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 
44    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
45    |   4   |  IHL  |Type of Service|          Total Length         |
46    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
47    |         Identification        |Flags|      Fragment Offset    |
48    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
49    |  Time to Live |    Protocol   |         Header Checksum       |
50    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
51    |                       Source Address                          |
52    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
53    |                    Destination Address                        |
54    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
55    |                    Options                    |    Padding    |
56    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
57   *)
58   | { 4 : 4; hdrlen : 4; tos : 8;   length : 16;
59       identification : 16;          flags : 3; fragoffset : 13;
60       ttl : 8; protocol : 8;        checksum : 16;
61       source : 32;
62       dest : 32;
63       options : (hdrlen-5)*32 : bitstring;
64       payload : -1 : bitstring } ->
65
66     printf "IPv4:\n";
67     printf "  header length: %d * 32 bit words\n" hdrlen;
68     printf "  type of service: %d\n" tos;
69     printf "  packet length: %d bytes\n" length;
70     printf "  identification: %d\n" identification;
71     printf "  flags: %d\n" flags;
72     printf "  fragment offset: %d\n" fragoffset;
73     printf "  ttl: %d\n" ttl;
74     printf "  protocol: %d\n" protocol;
75     printf "  checksum: %d\n" checksum;
76     printf "  source: %lx  dest: %lx\n" source dest;
77     printf "  header options + padding:\n";
78     Bitmatch.hexdump_bitstring stdout options;
79     printf "  packet payload:\n";
80     Bitmatch.hexdump_bitstring stdout payload
81
82   | { version : 4 } ->
83     eprintf "unknown IP version %d\n" version;
84     exit 1
85
86   | { _ } as pkt ->
87     eprintf "data is smaller than one nibble:\n";
88     Bitmatch.hexdump_bitstring stderr pkt;
89     exit 1
90 ]}
91
92    A program which can parse
93    {{:http://lxr.linux.no/linux/include/linux/ext3_fs.h}Linux EXT3 filesystem superblocks}:
94
95 {[
96 let bits = Bitmatch.bitstring_of_file "tests/ext3_sb"
97
98 let () =
99   bitmatch bits with
100   | { s_inodes_count : 32 : littleendian;       (* Inodes count *)
101       s_blocks_count : 32 : littleendian;       (* Blocks count *)
102       s_r_blocks_count : 32 : littleendian;     (* Reserved blocks count *)
103       s_free_blocks_count : 32 : littleendian;  (* Free blocks count *)
104       s_free_inodes_count : 32 : littleendian;  (* Free inodes count *)
105       s_first_data_block : 32 : littleendian;   (* First Data Block *)
106       s_log_block_size : 32 : littleendian;     (* Block size *)
107       s_log_frag_size : 32 : littleendian;      (* Fragment size *)
108       s_blocks_per_group : 32 : littleendian;   (* # Blocks per group *)
109       s_frags_per_group : 32 : littleendian;    (* # Fragments per group *)
110       s_inodes_per_group : 32 : littleendian;   (* # Inodes per group *)
111       s_mtime : 32 : littleendian;              (* Mount time *)
112       s_wtime : 32 : littleendian;              (* Write time *)
113       s_mnt_count : 16 : littleendian;          (* Mount count *)
114       s_max_mnt_count : 16 : littleendian;      (* Maximal mount count *)
115       0xef53 : 16 : littleendian } ->           (* Magic signature *)
116
117     printf "ext3 superblock:\n";
118     printf "  s_inodes_count = %ld\n" s_inodes_count;
119     printf "  s_blocks_count = %ld\n" s_blocks_count;
120     printf "  s_free_inodes_count = %ld\n" s_free_inodes_count;
121     printf "  s_free_blocks_count = %ld\n" s_free_blocks_count
122
123   | { _ } ->
124     eprintf "not an ext3 superblock!\n%!";
125     exit 2
126 ]}
127
128    Constructing packets for a simple binary message
129    protocol:
130
131 {[
132 (*
133   +---------------+---------------+--------------------------+
134   | type          | subtype       | parameter                |
135   +---------------+---------------+--------------------------+
136    <-- 16 bits --> <-- 16 bits --> <------- 32 bits -------->
137
138   All fields are in network byte order.
139 *)
140
141 let make_message typ subtype param =
142   (BITSTRING {
143      typ : 16;
144      subtype : 16;
145      param : 32
146    }) ;;
147 ]}
148
149    {2 Loading, creating bitstrings}
150
151    The basic data type is the {!bitstring}, a string of bits of
152    arbitrary length.  Bitstrings can be any length in bits and
153    operations do not need to be byte-aligned (although they will
154    generally be more efficient if they are byte-aligned).
155
156    Internally a bitstring is stored as a normal OCaml [string]
157    together with an offset and length, where the offset and length are
158    measured in bits.  Thus one can efficiently form substrings of
159    bitstrings, overlay a bitstring on existing data, and load and save
160    bitstrings from files or other external sources.
161
162    To load a bitstring from a file use {!bitstring_of_file} or
163    {!bitstring_of_chan}.
164
165    There are also functions to create bitstrings from arbitrary data.
166    See the {{:#reference}reference} below.
167
168    {2 Matching bitstrings with patterns}
169
170    Use the [bitmatch] operator (part of the syntax extension) to break
171    apart a bitstring into its fields.  [bitmatch] works a lot like the
172    OCaml [match] operator.
173
174    The general form of [bitmatch] is:
175
176    [bitmatch {] {i bitstring-expression} [} with]
177
178    [| {] {i pattern} [} ->] {i code}
179
180    [| {] {i pattern} [} ->] {i code}
181
182    [|] ...
183
184    As with normal match, the statement attempts to match the
185    bitstring against each pattern in turn.  If none of the patterns
186    match then the standard library [Match_failure] exception is
187    thrown.
188
189    Patterns look a bit different from normal match patterns.  They
190    consist of a list of bitfields separated by [;] where each bitfield
191    contains a bind variable, the width (in bits) of the field, and
192    other information.  Some example patterns:
193
194 {[
195 bitmatch bits with
196
197 | { version : 8; name : 8; param : 8 } -> ...
198
199    (* Bitstring of at least 3 bytes.  First byte is the version
200       number, second byte is a field called name, third byte is
201       a field called parameter. *)
202
203 | { flag : 1 } ->
204    printf "flag is %b\n" flag
205
206    (* A single flag bit (mapped into an OCaml boolean). *)
207
208 | { len : 4; data : 1+len } ->
209    printf "len = %d, data = 0x%Lx\n" len data
210
211    (* A 4-bit length, followed by 1-16 bits of data, where the
212       length of the data is computed from len. *)
213
214 | { ipv6_source : 128 : bitstring;
215     ipv6_dest : 128 : bitstring } -> ...
216
217    (* IPv6 source and destination addresses.  Each is 128 bits
218       and is mapped into a bitstring type which will be a substring
219       of the main bitstring expression. *)
220 ]}
221
222    You can also add conditional when-clauses:
223
224 {[
225 | { version : 4 }
226     when version = 4 || version = 6 -> ...
227
228    (* Only match and run the code when version is 4 or 6.  If
229       it isn't we will drop through to the next case. *)
230 ]}
231
232    Note that the pattern is only compared against the first part of
233    the bitstring (there may be more data in the bitstring following
234    the pattern, which is not matched).  In terms of regular
235    expressions you might say that the pattern matches [^pattern], not
236    [^pattern$].  To ensure that the bitstring contains only the
237    pattern, add a length -1 bitstring to the end and test that its
238    length is zero in the when-clause:
239
240 {[
241 | { n : 4;
242     rest : -1 : bitstring }
243     when Bitmatch.bitstring_length rest = 0 -> ...
244
245    (* Only matches exactly 4 bits. *)
246 ]}
247
248    Normally the first part of each field is a binding variable,
249    but you can also match a constant, as in:
250
251 {[
252 | { (4|6) : 4 } -> ...
253
254    (* Only matches if the first 4 bits contain either
255       the integer 4 or the integer 6. *)
256 ]}
257
258    One may also match on strings:
259
260 {[
261 | { "MAGIC" : 5*8 : string } -> ...
262
263    (* Only matches if the string "MAGIC" appears at the start
264       of the input. *)
265 ]}
266
267    {3:patternfieldreference Pattern field reference}
268
269    The exact format of each pattern field is:
270
271    [pattern : length [: qualifier [,qualifier ...]]]
272
273    [pattern] is the pattern, binding variable name, or constant to
274    match.  [length] is the length in bits which may be either a
275    constant or an expression.  The length expression is just an OCaml
276    expression and can use any values defined in the program, and refer
277    back to earlier fields (but not to later fields).
278
279    Integers can only have lengths in the range \[1..64\] bits.  See the
280    {{:#integertypes}integer types} section below for how these are
281    mapped to the OCaml int/int32/int64 types.  This is checked
282    at compile time if the length expression is constant, otherwise it is
283    checked at runtime and you will get a runtime exception eg. in
284    the case of a computed length expression.
285
286    A bitstring field of length -1 matches all the rest of the
287    bitstring (thus this is only useful as the last field in a
288    pattern).
289
290    A bitstring field of length 0 matches an empty bitstring
291    (occasionally useful when matching optional subfields).
292
293    Qualifiers are a list of identifiers which control the type,
294    signedness and endianness of the field.  Permissible qualifiers are:
295
296    - [int] (field has an integer type)
297    - [string] (field is a string type)
298    - [bitstring] (field is a bitstring type)
299    - [signed] (field is signed)
300    - [unsigned] (field is unsigned)
301    - [bigendian] (field is big endian - a.k.a network byte order)
302    - [littleendian] (field is little endian - a.k.a Intel byte order)
303    - [nativeendian] (field is same endianness as the machine)
304
305    The default settings are [int], [unsigned], [bigendian].
306
307    Note that many of these qualifiers cannot be used together,
308    eg. bitstrings do not have endianness.  The syntax extension should
309    give you a compile-time error if you use incompatible qualifiers.
310
311    {3 Other cases in bitmatch}
312
313    As well as a list of fields, it is possible to name the
314    bitstring and/or have a default match case:
315
316 {[
317 | { _ } -> ...
318
319    (* Default match case. *)
320
321 | { _ } as pkt -> ...
322
323    (* Default match case, with 'pkt' bound to the whole bitstring. *)
324 ]}
325
326    {2 Constructing bitstrings}
327
328    Bitstrings may be constructed using the [BITSTRING] operator (as an
329    expression).  The [BITSTRING] operator takes a list of fields,
330    similar to the list of fields for matching:
331
332 {[
333 let version = 1 ;;
334 let data = 10 ;;
335 let bits =
336   BITSTRING {
337     version : 4;
338     data : 12
339   } ;;
340
341    (* Constructs a 16-bit bitstring with the first four bits containing
342       the integer 1, and the following 12 bits containing the integer 10,
343       arranged in network byte order. *)
344
345 Bitmatch.hexdump_bitstring stdout bits ;;
346
347    (* Prints:
348
349       00000000  10 0a         |..              |
350     *)
351 ]}
352
353    The format of each field is the same as for pattern fields (see
354    {{:#patternfieldreference}Pattern field reference section}), and
355    things like computed length fields, fixed value fields, insertion
356    of bitstrings within bitstrings, etc. are all supported.
357
358    {3 Construction exception}
359
360    The [BITSTRING] operator may throw a {!Construct_failure}
361    exception at runtime.
362
363    Runtime errors include:
364
365    - int field length not in the range \[1..64\]
366    - a bitstring with a length declared which doesn't have the
367      same length at runtime
368    - trying to insert an out of range value into an int field
369      (eg. an unsigned int field which is 2 bits wide can only
370      take values in the range \[0..3\]).
371
372    {2:integertypes Integer types}
373
374    Integer types are mapped to OCaml types [bool], [int], [int32] or
375    [int64] using a system which tries to ensure that (a) the types are
376    reasonably predictable and (b) the most efficient type is
377    preferred.
378
379    The rules are slightly different depending on whether the bit
380    length expression in the field is a compile-time constant or a
381    computed expression.
382
383    Detection of compile-time constants is quite simplistic so only an
384    simple integer literals and simple expressions (eg. [5*8]) are
385    recognized as constants.
386
387    In any case the bit size of an integer is limited to the range
388    \[1..64\].  This is detected as a compile-time error if that is
389    possible, otherwise a runtime check is added which can throw an
390    [Invalid_argument] exception.
391
392    The mapping is thus:
393
394    {v
395    Bit size         ---- OCaml type ----
396                 Constant        Computed expression
397
398    1            bool            int64
399    2..31        int             int64
400    32           int32           int64
401    33..64       int64           int64
402    v}
403
404    A possible future extension may allow people with 64 bit computers
405    to specify a more optimal [int] type for bit sizes in the range
406    [32..63].  If this was implemented then such code {i could not even
407    be compiled} on 32 bit platforms, so it would limit portability.
408
409    Another future extension may be to allow computed
410    expressions to assert min/max range for the bit size,
411    allowing a more efficient data type than int64 to be
412    used.  (Of course under such circumstances there would
413    still need to be a runtime check to enforce the
414    size).
415
416    {2 Compiling}
417
418    Using the compiler directly you can do:
419
420    {v
421    ocamlc -I +bitmatch \
422      -pp "camlp4o `ocamlc -where`/bitmatch/pa_bitmatch.cmo" \
423      bitmatch.cma test.ml -o test
424    v}
425
426    Simpler method using findlib:
427
428    {v
429    ocamlfind ocamlc \
430      -package bitmatch.syntax -syntax bitmatch.syntax \
431      -linkpkg test.ml -o test
432    v}
433
434    {2 Security and type safety}
435
436    {3 Security on input}
437
438    The main concerns for input are buffer overflows and denial
439    of service.
440
441    It is believed that this library is robust against attempted buffer
442    overflows.  In addition to OCaml's normal bounds checks, we check
443    that field lengths are >= 0, and many additional checks.
444
445    Denial of service attacks are more problematic.  We only work
446    forwards through the bitstring, thus computation will eventually
447    terminate.  As for computed lengths, code such as this is thought
448    to be secure:
449
450    {[
451    bitmatch bits with
452    | { len : 64;
453        buffer : Int64.to_int len : bitstring } ->
454    ]}
455
456    The [len] field can be set arbitrarily large by an attacker, but
457    when pattern-matching against the [buffer] field this merely causes
458    a test such as [if len <= remaining_size] to fail.  Even if the
459    length is chosen so that [buffer] bitstring is allocated, the
460    allocation of sub-bitstrings is efficient and doesn't involve an
461    arbitary-sized allocation or any copying.
462
463    However the above does not necessarily apply to strings used in
464    matching, since they may cause the library to use the
465    {!Bitmatch.string_of_bitstring} function, which allocates a string.
466    So you should take care if you use the [string] type particularly
467    with a computed length that is derived from external input.
468
469    The main protection against attackers should be to ensure that the
470    main program will only read input bitstrings up to a certain
471    length, which is outside the scope of this library.
472
473    {3 Security on output}
474
475    As with the input side, computed lengths are believed to be
476    safe.  For example:
477
478    {[
479    let len = read_untrusted_source () in
480    let buffer = allocate_bitstring () in
481    BITSTRING {
482    buffer : len : bitstring
483    }
484    ]}
485
486    This code merely causes a check that buffer's length is the same as
487    [len].  However the program function [allocate_bitstring] must
488    refuse to allocate an oversized buffer (but that is outside the
489    scope of this library).
490
491    {3 Order of evaluation}
492
493    In [bitmatch] statements, fields are evaluated left to right.
494
495    Note that the when-clause is evaluated {i last}, so if you are
496    relying on the when-clause to filter cases then your code may do a
497    lot of extra and unncessary pattern-matching work on fields which
498    may never be needed just to evaluate the when-clause.  You can
499    usually rearrange the code to do only the first part of the match,
500    followed by the when-clause, followed by a second inner bitmatch.
501
502    {3 Safety}
503
504    The current implementation is believed to be fully type-safe,
505    and makes compile and run-time checks where appropriate.  If
506    you find a case where a check is missing please submit a
507    bug report or a patch.
508
509    {2 Limits}
510
511    These are thought to be the current limits:
512
513    Integers: \[1..64\] bits.
514
515    Bitstrings (32 bit platforms): maximum length is limited
516    by the string size, ie. 16 MBytes.
517
518    Bitstrings (64 bit platforms): maximum length is thought to be
519    limited by the string size, ie. effectively unlimited.
520
521    Bitstrings must be loaded into memory before we can match against
522    them.  Thus available memory may be considered a limit for some
523    applications.
524
525    {2:reference Reference}
526    {3 Types}
527 *)
528
529 type endian = BigEndian | LittleEndian | NativeEndian
530
531 val string_of_endian : endian -> string
532 (** Endianness. *)
533
534 type bitstring = string * int * int
535 (** [bitstring] is the basic type used to store bitstrings.
536
537     The type contains the underlying data (a string),
538     the current bit offset within the string and the
539     current bit length of the string (counting from the
540     bit offset).  Note that the offset and length are
541     in {b bits}, not bytes.
542
543     Normally you don't need to use the bitstring type
544     directly, since there are functions and syntax
545     extensions which hide the details.
546
547     See also {!bitstring_of_string}, {!bitstring_of_file},
548     {!hexdump_bitstring}, {!bitstring_length}.
549 *)
550
551 (** {3 Exceptions} *)
552
553 exception Construct_failure of string * string * int * int
554 (** [Construct_failure (message, file, line, char)] may be
555     raised by the [BITSTRING] constructor.
556
557     Common reasons are that values are out of range of
558     the fields that contain them, or that computed lengths
559     are impossible (eg. negative length bitfields).
560
561     [message] is the error message.
562
563     [file], [line] and [char] point to the original source
564     location of the [BITSTRING] constructor that failed.
565 *)
566
567 (** {3 Bitstrings} *)
568
569 val empty_bitstring : bitstring
570 (** [empty_bitstring] is the empty, zero-length bitstring. *)
571
572 val create_bitstring : int -> bitstring
573 (** [create_bitstring n] creates an [n] bit bitstring
574     containing all zeroes. *)
575
576 val make_bitstring : int -> char -> bitstring
577 (** [make_bitstring n c] creates an [n] bit bitstring
578     containing the repeated 8 bit pattern in [c].
579
580     For example, [make_bitstring 16 '\x5a'] will create
581     the bitstring [0x5a5a] or in binary [0101 1010 0101 1010].
582
583     Note that the length is in bits, not bytes. *)
584
585 val bitstring_of_string : string -> bitstring
586 (** [bitstring_of_string str] creates a bitstring
587     of length [String.length str * 8] (bits) containing the
588     bits in [str].
589
590     Note that the bitstring uses [str] as the underlying
591     string (see the representation of {!bitstring}) so you
592     should not change [str] after calling this. *)
593
594 val bitstring_of_file : string -> bitstring
595 (** [bitstring_of_file filename] loads the named file
596     into a bitstring. *)
597
598 val bitstring_of_chan : in_channel -> bitstring
599 (** [bitstring_of_chan chan] loads the contents of
600     the input channel [chan] as a bitstring.
601
602     The length of the final bitstring is determined
603     by the remaining input in [chan], but will always
604     be a multiple of 8 bits.
605
606     See also {!bitstring_of_chan_max}. *)
607
608 val bitstring_of_chan_max : in_channel -> int -> bitstring
609 (** [bitstring_of_chan_max chan max] works like
610     {!bitstring_of_chan} but will only read up to
611     [max] bytes from the channel (or fewer if the end of input
612     occurs before that). *)
613
614 val bitstring_of_file_descr : Unix.file_descr -> bitstring
615 (** [bitstring_of_file_descr fd] loads the contents of
616     the file descriptor [fd] as a bitstring.
617
618     See also {!bitstring_of_chan}, {!bitstring_of_file_descr_max}. *)
619
620 val bitstring_of_file_descr_max : Unix.file_descr -> int -> bitstring
621 (** [bitstring_of_file_descr_max fd max] works like
622     {!bitstring_of_file_descr} but will only read up to
623     [max] bytes from the channel (or fewer if the end of input
624     occurs before that). *)
625
626 val bitstring_length : bitstring -> int
627 (** [bitstring_length bitstring] returns the length of
628     the bitstring in bits. *)
629
630 val string_of_bitstring : bitstring -> string
631 (** [string_of_bitstring bitstring] converts a bitstring to a string
632     (eg. to allow comparison).
633
634     This function is inefficient.  In the best case when the bitstring
635     is nicely byte-aligned we do a [String.sub] operation.  If the
636     bitstring isn't aligned then this involves a lot of bit twiddling
637     and is particularly inefficient.
638
639     If the bitstring is not a multiple of 8 bits wide then the
640     final byte of the string contains the high bits set to the
641     remaining bits and the low bits set to 0. *)
642
643 val bitstring_to_file : bitstring -> string -> unit
644 (** [bitstring_to_file bits filename] writes the bitstring [bits]
645     to the file [filename].  It overwrites the output file.
646
647     Some restrictions apply, see {!bitstring_to_chan}. *)
648
649 val bitstring_to_chan : bitstring -> out_channel -> unit
650 (** [bitstring_to_file bits filename] writes the bitstring [bits]
651     to the channel [chan].
652
653     Channels are made up of bytes, bitstrings can be any bit length
654     including fractions of bytes.  So this function only works
655     if the length of the bitstring is an exact multiple of 8 bits
656     (otherwise it raises [Invalid_argument "bitstring_to_chan"]).
657
658     Furthermore the function is efficient only in the case where
659     the bitstring is stored fully aligned, otherwise it has to
660     do inefficient bit twiddling like {!string_of_bitstring}.
661
662     In the common case where the bitstring was generated by the
663     [BITSTRING] operator and is an exact multiple of 8 bits wide,
664     then this function will always work efficiently.
665 *)
666
667 (** {3 Printing bitstrings} *)
668
669 val hexdump_bitstring : out_channel -> bitstring -> unit
670 (** [hexdump_bitstring chan bitstring] prints the bitstring
671     to the output channel in a format similar to the
672     Unix command [hexdump -C]. *)
673
674 (** {3 Bitstring buffer} *)
675
676 module Buffer : sig
677   type t
678   val create : unit -> t
679   val contents : t -> bitstring
680   val add_bits : t -> string -> int -> unit
681   val add_bit : t -> bool -> unit
682   val add_byte : t -> int -> unit
683 end
684 (** Buffers are mainly used by the [BITSTRING] constructor, but
685     may also be useful for end users.  They work much like the
686     standard library [Buffer] module. *)
687
688 (** {3 Miscellaneous} *)
689
690 val package : string
691 (** The package name, always ["ocaml-bitmatch"] *)
692
693 val version : string
694 (** The package version as a string. *)
695
696 val debug : bool ref
697 (** Set this variable to true to enable extended debugging.
698     This only works if debugging was also enabled in the
699     [pa_bitmatch.ml] file at compile time, otherwise it
700     does nothing. *)
701
702 (**/**)
703
704 (* Private functions, called from generated code.  Do not use
705  * these directly - they are not safe.
706  *)
707
708 val extract_bitstring : string -> int -> int -> int -> bitstring * int * int
709
710 val extract_remainder : string -> int -> int -> bitstring * int * int
711
712 val extract_bit : string -> int -> int -> int -> bool * int * int
713
714 val extract_char_unsigned : string -> int -> int -> int -> int * int * int
715
716 val extract_int_be_unsigned : string -> int -> int -> int -> int * int * int
717
718 val extract_int_le_unsigned : string -> int -> int -> int -> int * int * int
719
720 val extract_int_ne_unsigned : string -> int -> int -> int -> int * int * int
721
722 val extract_int32_be_unsigned : string -> int -> int -> int -> int32 * int * int
723
724 val extract_int32_le_unsigned : string -> int -> int -> int -> int32 * int * int
725
726 val extract_int32_ne_unsigned : string -> int -> int -> int -> int32 * int * int
727
728 val extract_int64_be_unsigned : string -> int -> int -> int -> int64 * int * int
729
730 val extract_int64_le_unsigned : string -> int -> int -> int -> int64 * int * int
731
732 val extract_int64_ne_unsigned : string -> int -> int -> int -> int64 * int * int
733
734 val construct_bit : Buffer.t -> bool -> int -> exn -> unit
735
736 val construct_char_unsigned : Buffer.t -> int -> int -> exn -> unit
737
738 val construct_int_be_unsigned : Buffer.t -> int -> int -> exn -> unit
739
740 val construct_int_ne_unsigned : Buffer.t -> int -> int -> exn -> unit
741
742 val construct_int32_be_unsigned : Buffer.t -> int32 -> int -> exn -> unit
743
744 val construct_int32_ne_unsigned : Buffer.t -> int32 -> int -> exn -> unit
745
746 val construct_int64_be_unsigned : Buffer.t -> int64 -> int -> exn -> unit
747
748 val construct_int64_ne_unsigned : Buffer.t -> int64 -> int -> exn -> unit
749
750 val construct_string : Buffer.t -> string -> unit