Module `Tezos_shell_benchmarks.Io_helpers`Source

Helpers for loading contexts, saving contexts, writing to contexts, etc. Also contains the Key_map module, heavily used for preparing benchmarks and computing statistics.

Sourceval assert_ok : msg:string -> 'a Tezos_base.TzPervasives.tzresult -> 'a

Source

val commit : 
  Tezos_protocol_environment.Context.t ->
  Tezos_base.TzPervasives.Context_hash.t Lwt.t

Source

val flush : 
  Tezos_protocol_environment.Context.t ->
  Tezos_protocol_environment.Context.t Lwt.t

Source

val prepare_empty_context : 
  string ->
  (Tezos_base.TzPervasives.Context_hash.t, Tezos_base.TzPervasives.tztrace)
    result
    Lwt.t

Source

val load_context_from_disk : 
  string ->
  Tezos_base.TzPervasives.Context_hash.t ->
  Tezos_protocol_environment.Context.t * Tezos_context.Context.index

Source

val with_context : 
  base_dir:string ->
  context_hash:Tezos_base.TzPervasives.Context_hash.t ->
  (Tezos_protocol_environment.Context.t -> 'a Lwt.t) ->
  'a

Sourceval prepare_base_dir : string -> unit

Source

val initialize_key : 
  Random.State.t ->
  Tezos_protocol_environment.Context.t ->
  Tezos_protocol_environment.Context.key ->
  int ->
  Tezos_protocol_environment.Context.t Lwt.t

This function updates the context with random bytes at a given depth.

Source

val commit_and_reload : 
  string ->
  Tezos_context.Context.index ->
  Tezos_protocol_environment.Context.t ->
  (Tezos_protocol_environment.Context.t * Tezos_context.Context.index) Lwt.t

Sourcemodule Key_map : sig ... end

Maps from string lists to bytes. No balancing. A key cannot be a prefix or a suffix to another key.

Sourceval sample_without_replacement : int -> 'a list -> 'a list * 'a list

Sourceval file_copy : string -> string -> unit

Sourceval set_infos : string -> Unix.stats -> unit

Sourceval iter_dir : (string -> unit) -> string -> unit

Sourceval copy_rec : string -> string -> unit

Sourceval split_absolute_path : string -> string list option

Split a absolute path name.

For example, split_absolute_pat "/a/b/c" = Some ["a"; "b"; "c"]. It returns None for illigal paths such as "a/b/c", "/a/../b" and "/a/b/.".

Sourceval purge_disk_cache : unit -> unit

Purge disk cache.

This function assumes Linux OS and purge_disk_cache.exe is placed at the current directory, owned by root with setuid. The source code for purge_disk_cache.exe is available at devtools/benchmarks-tools/purge_disk_cache/.

Even if the function fails to execute the command, it does NOT fail but prints just a warning.

Source

val load_head_block : 
  string ->
  (int32
   * Tezos_base.TzPervasives.Block_hash.t
   * Tezos_base.TzPervasives.Context_hash.t)
    Tezos_base.TzPervasives.tzresult
    Lwt.t

load_head_block data_dir takes the path of the Tezos node data directory (typically $HOME/.tezos-node) and returns the information of the current head.

Sourcemodule Meminfo : sig ... end

Reading /proc/meminfo. Only for Linux

Sourceval with_memory_restriction : float -> ((unit -> unit) -> 'a) -> 'a

with_memory_restriction gib f executes f trying to restrict the MemAvailable of /proc/meminfo to gib GiB. It only works in Linux.

Function f takes a function to re-restrict the MemAvailable during the exection of f.

Source

val fill_disk_cache : 
  rng:Random.State.t ->
  restrict_memory:(unit -> unit) ->
  Tezos_protocol_environment.Context.t ->
  (Tezos_protocol_environment.Context.key * _) array list ->
  unit Lwt.t

fill_disk_cache ~rng ~restrict_memory context keys loads keys in context randomly, until Linux kernel's disk cache is completely filled.

restrict_memory is the function obtained by with_memory_restriction. It is used to keep the amount of MemAvailable at the same level.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-shell-libs.shell-benchmarks/Tezos_shell_benchmarks/Io_helpers/index.html

Module `Tezos_shell_benchmarks.Io_helpers`Source

package octez-shell-libs

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-shell-libs.shell-benchmarks/Tezos_shell_benchmarks/Io_helpers/index.html

Module Tezos_shell_benchmarks.Io_helpersSource

Module `Tezos_shell_benchmarks.Io_helpers`Source