Source file body.ml

(*----------------------------------------------------------------------------
 *  Copyright (c) 2017 Inhabited Type LLC.
 *  Copyright (c) 2019 Antonio N. Monteiro.
 *
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 *  3. Neither the name of the author nor the names of his contributors
 *     may be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
 *  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *  DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
 *  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 *  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *---------------------------------------------------------------------------*)

module Reader = struct
  type t =
    { faraday : Faraday.t
    ; mutable read_scheduled : bool
    ; mutable on_eof : unit -> unit
    ; mutable on_read : Bigstringaf.t -> off:int -> len:int -> unit
    ; buffered_bytes : int ref
    ; done_reading : int -> unit
    }

  let default_done_reading = Sys.opaque_identity (fun _ -> ())
  let default_on_eof = Sys.opaque_identity (fun () -> ())
  let default_on_read = Sys.opaque_identity (fun _ ~off:_ ~len:_ -> ())

  let create buffer ~done_reading =
    { faraday = Faraday.of_bigstring buffer
    ; read_scheduled = false
    ; on_eof = default_on_eof
    ; on_read = default_on_read
    ; buffered_bytes = ref 0
    ; done_reading
    }

  let create_empty () =
    let t = create Bigstringaf.empty ~done_reading:default_done_reading in
    Faraday.close t.faraday;
    t

  let empty = create_empty ()
  let is_closed t = Faraday.is_closed t.faraday
  let unsafe_faraday t = t.faraday

  let rec do_execute_read t on_eof on_read =
    match Faraday.operation t.faraday with
    | `Yield -> ()
    | `Close ->
      t.read_scheduled <- false;
      t.on_eof <- default_on_eof;
      t.on_read <- default_on_read;
      on_eof ()
    | `Writev [] -> assert false
    | `Writev (iovec :: _) ->
      t.read_scheduled <- false;
      t.on_eof <- default_on_eof;
      t.on_read <- default_on_read;
      let { Httpaf.IOVec.buffer; off; len } = iovec in
      Faraday.shift t.faraday len;
      on_read buffer ~off ~len;
      (* Application is done reading, we can give flow control tokens back to
         the peer. *)
      t.done_reading len;
      execute_read t

  and execute_read t =
    if t.read_scheduled then do_execute_read t t.on_eof t.on_read

  let schedule_read t ~on_eof ~on_read =
    if t.read_scheduled
    then failwith "Body.schedule_read: reader already scheduled";
    if is_closed t
    then do_execute_read t on_eof on_read
    else (
      t.read_scheduled <- true;
      t.on_eof <- on_eof;
      t.on_read <- on_read)

  let close t =
    Faraday.close t.faraday;
    execute_read t

  let has_pending_output t = Faraday.has_pending_output t.faraday
end

module Writer = struct
  module Writer = Serialize.Writer

  type t =
    { faraday : Faraday.t
    ; buffered_bytes : int ref
    ; writer : Serialize.Writer.t
    }

  let create buffer ~writer =
    { faraday = Faraday.of_bigstring buffer; buffered_bytes = ref 0; writer }

  let create_empty ~writer =
    let t = create Bigstringaf.empty ~writer in
    Faraday.close t.faraday;
    t

  let ready_to_write t = Serialize.Writer.wakeup t.writer

  let write_char t c =
    Faraday.write_char t.faraday c;
    ready_to_write t

  let write_string t ?off ?len s =
    Faraday.write_string ?off ?len t.faraday s;
    ready_to_write t

  let write_bigstring t ?off ?len b =
    Faraday.write_bigstring ?off ?len t.faraday b;
    ready_to_write t

  let schedule_bigstring t ?off ?len (b : Bigstringaf.t) =
    Faraday.schedule_bigstring ?off ?len t.faraday b;
    ready_to_write t

  let flush t kontinue =
    Faraday.flush t.faraday kontinue;
    ready_to_write t

  let is_closed t = Faraday.is_closed t.faraday
  let has_pending_output t = Faraday.has_pending_output t.faraday

  let close t =
    Serialize.Writer.unyield t.writer;
    Faraday.close t.faraday;
    ready_to_write t

  let unsafe_faraday t = t.faraday

  let transfer_to_writer t writer ~max_frame_size ~max_bytes stream_id =
    let faraday = t.faraday in
    match Faraday.operation faraday with
    | `Yield | `Close -> 0
    | `Writev iovecs ->
      let buffered = t.buffered_bytes in
      let iovecs = Httpaf.IOVec.shiftv iovecs !buffered in
      let lengthv = Httpaf.IOVec.lengthv iovecs in
      let writev_len = if max_bytes < lengthv then max_bytes else lengthv in
      buffered := !buffered + writev_len;
      let frame_info = Writer.make_frame_info ~max_frame_size stream_id in
      Writer.schedule_iovecs writer frame_info ~len:writev_len iovecs;
      Writer.flush writer (fun () ->
        Faraday.shift faraday writev_len;
        buffered := !buffered - writev_len);
      writev_len
end