robur/ocaml-solo5-elftool
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove inline record, documentation

Browse source 
The single-field records are unnecessary and a left-over from an earlier
iteration of the code.
This commit is contained in:
Reynir Björnsson 2021-12-15 16:12:31 +01:00
parent cceb83ccd7
commit 01d1db661c
2 changed files with 23 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
lib/solo5_elftool.ml
View file

@ -4,12 +4,8 @@ type mft_type =
| Reserved_first
type mft_entry =
| Dev_block_basic of {
name : string;
}
| Dev_net_basic of {
name : string;
}
| Dev_block_basic of string
| Dev_net_basic of string
type mft = {
version : int;
@ -23,9 +19,9 @@ let mft_type_of_int : int32 -> mft_type = function
| _ -> assert false
let pp_mft_entry ppf = function
| Dev_block_basic { name; _ } ->
| Dev_block_basic name ->
Fmt.pf ppf {|{@[<1>@ "name": %S,@ "type": "BLOCK_BASIC"@]@ }|} name
| Dev_net_basic { name; _ } ->
| Dev_net_basic name ->
Fmt.pf ppf {|{@[<1>@ "name": %S,@ "type": "NET_BASIC"@]@ }|} name
let pp_mft ppf { version; entries } =
@ -68,7 +64,10 @@ let parse_mft buf =
let* () = guard "manifest too small"
(Cstruct.length buf >= 4 + 8 + sizeof_mft_entry)
in
(* FIXME: explanation why solo5 adds this padding *)
(* Solo5 defines a struct mft1_note consisting of the ELF note header
* followed by a struct mft for reading and writing the ELF note. The note
* header is 20 bytes long, so to get 8-byte alignment the note header is
* padded with 4 bytes. See {[solo5/mft_abi.h]}. *)
let buf = Cstruct.shift buf 4 in
let version = Cstruct.LE.get_uint32 buf 0
and entries = Cstruct.LE.get_uint32 buf 4
@ -79,6 +78,9 @@ let parse_mft buf =
let* () = guard "too many manifest entries"
(Int32.unsigned_compare entries mft_max_entries <= 0)
in
(* We have checked that entries interpreted unsigned is between 0 and
* mft_max_entries, so this is safely equivalent to:
* (Option.get (Int32.unsigned_to_int entries) *)
let entries = Int32.to_int entries in
let buf = Cstruct.shift buf 8 in
let* () = guard "unexpected note size"
@ -100,8 +102,8 @@ let parse_mft buf =
let* acc = r in
let* mft_entry = parse_mft_entry buf in
match mft_entry with
| `Dev_block_basic name -> Ok (Dev_block_basic { name } :: acc)
| `Dev_net_basic name -> Ok (Dev_net_basic { name } :: acc)
| `Dev_block_basic name -> Ok (Dev_block_basic name :: acc)
| `Dev_net_basic name -> Ok (Dev_net_basic name :: acc)
| `Reserved_first -> Error (`Msg "found RESERVED_FIRST not as first entry"))
(Ok [])
entries

16
lib/solo5_elftool.mli
View file

@ -1,17 +1,21 @@
(** An entry in the manifest representing a device. *)
type mft_entry =
| Dev_block_basic of {
name : string;
}
| Dev_net_basic of {
name : string;
}
| Dev_block_basic of string
| Dev_net_basic of string
(** The Solo5 manifest *)
type mft = {
version : int;
(** [version] is at the moment always 1. *)
entries : mft_entry list;
(** [entries] in the manifest. *)
}
val pp_mft_entry : Format.formatter -> mft_entry -> unit
val pp_mft : Format.formatter -> mft -> unit
(** Pretty-prints the manifest as JSON in a similar style as the Solo5 command
* line tool {[solo5-elftool query-manifest]}. *)
val query_manifest : Owee_buf.t -> (mft, [> `Msg of string ]) result
(** [query_manifest buf] is the solo5 manifest of [buf], or an error message.
* @raise Owee_buf.Invalid_format If [buf] does not contain valid ELF format *)