merge xapi-inventory

Makefile

@@ -244,7 +244,7 @@ install: build doc sdk doc-json
 		gzip http-lib pciutil sexpr stunnel uuid xml-light2 zstd xapi-compression safe-resources \
 		message-switch message-switch-async message-switch-cli message-switch-core message-switch-lwt \
 		message-switch-unix xapi-idl forkexec xapi-forkexecd xapi-storage xapi-storage-script xapi-storage-cli \
-		xapi-nbd varstored-guard xapi-log xapi-open-uri xapi-tracing xapi-expiry-alerts cohttp-posix
+		xapi-nbd varstored-guard xapi-log xapi-open-uri xapi-tracing xapi-expiry-alerts cohttp-posix xapi-inventory
 # docs
 	mkdir -p $(DESTDIR)$(DOCDIR)
 	cp -r $(XAPIDOC)/jekyll $(DESTDIR)$(DOCDIR)
@@ -264,7 +264,7 @@ uninstall:
 		gzip http-lib pciutil sexpr stunnel uuid xml-light2 zstd xapi-compression safe-resources \
 		message-switch message-switch-async message-switch-cli message-switch-core message-switch-lwt \
 		message-switch-unix xapi-idl forkexec xapi-forkexecd xapi-storage xapi-storage-script xapi-log \
-		xapi-open-uri xapi-tracing xapi-expiry-alerts cohttp-posix
+		xapi-open-uri xapi-tracing xapi-expiry-alerts cohttp-posix xapi-inventory
 
 compile_flags.txt: Makefile
 	(ocamlc -config-var ocamlc_cflags;\

ocaml/libs/xapi-inventory/.gitarchive-info

@@ -0,0 +1,2 @@
+Changeset: $Format:%H$
+Commit date: $Format:%cD$

ocaml/libs/xapi-inventory/.gitattributes

@@ -0,0 +1 @@
+.gitarchive-info export-subst

ocaml/libs/xapi-inventory/.gitignore

@@ -0,0 +1,7 @@
+_build/
+*.install
+.merlin
+
+*.orig
+*.rej
+xcp_inventory_config.ml

ocaml/libs/xapi-inventory/.travis.yml

@@ -0,0 +1,12 @@
+language: c
+service: docker
+install:
+  - wget https://raw.githubusercontent.com/ocaml/ocaml-ci-scripts/master/.travis-docker.sh
+  - wget https://raw.githubusercontent.com/xapi-project/xs-opam/master/tools/xs-opam-ci.env
+  - source xs-opam-ci.env
+script: bash -ex .travis-docker.sh
+env:
+  global:
+    - PACKAGE=xapi-inventory
+  jobs:
+    - PINS="xapi-inventory:."

ocaml/libs/xapi-inventory/ChangeLog

@@ -0,0 +1,36 @@
+## v1.2.3 (17 Jun 2022):
+* maintenance: Decrease direct usages of Threadext
+* Add license to opam metadata
+
+## v1.2.2 (28 Jul 2021):
+* maintenance: clean up opam metadata
+* maintenance: change default filename to /etc/xensource-inventory
+* maintenance: use dune instead of jbuilder
+* maintenance: fix travis
+
+## v1.2.1 (3 Dec 2018):
+- Removed conflict between xcp-inventory and xapi-inventory.
+- Ported build to dune and deprecated the old package xcp-inventory.
+
+## v1.2.0 (9 Jan 2018):
+* inventory: preserve old ~limit:2 semantic
+
+## v1.1.0 (14 Dec 2017):
+* Reindentation and file mode change.
+* Replace xapi-stdext with xapi-stdext-subpackages and astring.
+* CA-276606: Ported build from _oasis to jbuilder.
+* Sync opam file with xs-opam
+
+## v1.0.2 (03 Febr 2017):
+* fix Makfile to make installation via Opam work
+* add Git meta data files .gitarchive-info and .gitattributes
+
+## v1.0.1 (22 Jun 2016):
+* Update to Stdext 2.0.0
+
+## v0.9.1 (3 Jun 2014):
+* second public release
+* Update to cohttp-0.11.2 interface
+
+## v0.9.0 (5 Jun 2013):
+* first public release

ocaml/libs/xapi-inventory/INSTALL

@@ -0,0 +1,6 @@
+The easiest way to install this package is via opam:
+
+    opam init
+    opam remote add xen-org git://github.com/xen-org/opam-repo-dev
+    opam install xcp-inventory
+

ocaml/libs/xapi-inventory/MAINTAINERS

@@ -0,0 +1,13 @@
+How to submit changes to this project
+=====================================
+
+Please submit changes as pull requests to the repository on github.
+Please ensure that all changes have descriptive commit comments and
+include a Signed-off-by: line.
+
+Maintainers list
+----------------
+
+* Jonathan Ludlam <jonathan.ludlam@eu.citrix.com>
+* Dave Scott <david.scott@eu.citrix.com>
+

ocaml/libs/xapi-inventory/README.md

@@ -0,0 +1,4 @@
+# The XCP inventory library
+
+Maintains a database of key-value pairs at a specific location in the
+filesystem.

ocaml/libs/xapi-inventory/lib/dune

@@ -0,0 +1,12 @@
+(library
+  (name inventory)
+  (public_name xapi-inventory)
+  (wrapped false)
+  (libraries
+    uuidm
+    astring
+    xapi-stdext-unix
+    xapi-stdext-threads
+    threads
+  )
+)

ocaml/libs/xapi-inventory/lib/inventory.ml

@@ -0,0 +1,147 @@
+(*
+ * Copyright (C) 2006-2010 Citrix Systems Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation; version 2.1 only. with the special
+ * exception on linking described in file LICENSE.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *)
+(* Code to parse the XenSource inventory file *)
+
+open Xapi_stdext_unix
+module M = Xapi_stdext_threads.Threadext.Mutex
+
+let inventory_filename = ref "/etc/xensource-inventory"
+
+(* Keys which must exist: *)
+let _installation_uuid = "INSTALLATION_UUID"
+
+let _control_domain_uuid = "CONTROL_DOMAIN_UUID"
+
+let _management_interface = "MANAGEMENT_INTERFACE"
+
+let _management_address_type = "MANAGEMENT_ADDRESS_TYPE"
+
+let _build_number = "BUILD_NUMBER"
+
+(* Optional keys: *)
+let _current_interfaces = "CURRENT_INTERFACES"
+
+let _oem_manufacturer = "OEM_MANUFACTURER"
+
+let _oem_model = "OEM_MODEL"
+
+let _oem_build_number = "OEM_BUILD_NUMBER"
+
+let _machine_serial_number = "MACHINE_SERIAL_NUMBER"
+
+let _machine_serial_name = "MACHINE_SERIAL_NAME"
+
+let _stunnel_idle_timeout = "STUNNEL_IDLE_TIMEOUT"
+
+let _stunnel_legacy = "STUNNEL_LEGACY"
+
+let loaded_inventory = ref false
+
+let inventory = Hashtbl.create 10
+
+let inventory_m = Mutex.create ()
+
+(* Compute the minimum necessary inventory file contents *)
+let minimum_default_entries () =
+  let host_uuid = Uuidm.to_string (Uuidm.create `V4) in
+  let dom0_uuid = Uuidm.to_string (Uuidm.create `V4) in
+  [
+    (_installation_uuid, host_uuid)
+  ; (_control_domain_uuid, dom0_uuid)
+  ; (_management_interface, "")
+  ; (_management_address_type, "IPv4")
+  ; (_build_number, "0")
+  ]
+
+(* trim any quotes off the ends *)
+let strip_quotes v =
+  if String.length v >= 2 && v.[0] = '\'' && v.[String.length v - 1] = '\'' then
+    String.sub v 1 (String.length v - 2)
+  else
+    v
+
+let parse_inventory_entry line =
+  match Astring.String.cut ~sep:"=" line with
+  | Some (k, v) ->
+      (* trim whitespace *)
+      Some (k, v |> strip_quotes |> String.trim)
+  | None ->
+      None
+
+let string_of_table h =
+  let lines =
+    List.fold_left
+      (fun acc (k, v) -> Printf.sprintf "%s='%s'\n" k v :: acc)
+      [] h
+  in
+  String.concat "" lines
+
+let read_inventory_contents () =
+  if not (Sys.file_exists !inventory_filename) then
+    Unixext.write_string_to_file !inventory_filename
+      (string_of_table (minimum_default_entries ())) ;
+  (* Perhaps we should blank the old inventory before we read the new one?
+     	   What is the desired behaviour? *)
+  Unixext.file_lines_iter
+    (fun line ->
+      match parse_inventory_entry line with
+      | Some (k, v) ->
+          Hashtbl.add inventory k v
+      | None ->
+          ()
+    )
+    !inventory_filename ;
+  loaded_inventory := true
+
+let read_inventory () = M.execute inventory_m read_inventory_contents
+
+let reread_inventory () =
+  M.execute inventory_m (fun () ->
+      Hashtbl.clear inventory ; read_inventory_contents ()
+  )
+
+exception Missing_inventory_key of string
+
+let lookup ?default key =
+  M.execute inventory_m (fun () ->
+      if not !loaded_inventory then read_inventory_contents () ;
+      if Hashtbl.mem inventory key then
+        Hashtbl.find inventory key
+      else
+        match default with
+        | None ->
+            raise (Missing_inventory_key key)
+        | Some v ->
+            v
+  )
+
+let flush_to_disk_locked () =
+  let h = Hashtbl.fold (fun k v acc -> (k, v) :: acc) inventory [] in
+  Unixext.write_string_to_file !inventory_filename (string_of_table h)
+
+let update key value =
+  M.execute inventory_m (fun () ->
+      Hashtbl.clear inventory ;
+      read_inventory_contents () ;
+      Hashtbl.replace inventory key value ;
+      flush_to_disk_locked ()
+  )
+
+let remove key =
+  M.execute inventory_m (fun () ->
+      Hashtbl.clear inventory ;
+      read_inventory_contents () ;
+      Hashtbl.remove inventory key ;
+      flush_to_disk_locked ()
+  )

quality-gate.sh

@@ -25,7 +25,7 @@ verify-cert () {
 }
 
 mli-files () {
-  N=519
+  N=520
   # do not count ml files from the tests in ocaml/{tests/perftest/quicktest}
   MLIS=$(git ls-files -- '**/*.mli' | grep -vE "ocaml/tests|ocaml/perftest|ocaml/quicktest" | xargs -I {} sh -c "echo {} | cut -f 1 -d '.'" \;)
   MLS=$(git  ls-files -- '**/*.ml'  | grep -vE "ocaml/tests|ocaml/perftest|ocaml/quicktest" | xargs -I {} sh -c "echo {} | cut -f 1 -d '.'" \;)

xapi-inventory.opam

@@ -0,0 +1,28 @@
+opam-version: "2.0"
+name: "xapi-inventory"
+maintainer: "xen-api@lists.xen.org"
+authors: "xen-api@lists.xen.org"
+homepage: "https://github.com/xapi-project/xcp-inventory"
+bug-reports: "https://github.com/xapi-project/xcp-inventory/issues"
+dev-repo: "git+http://github.com/xapi-project/xcp-inventory.git"
+license: "LGPL-2.1-only WITH OCaml-LGPL-linking-exception"
+tags: [ "org:xapi-project" ]
+build: [
+  ["dune" "build" "-p" name "-j" jobs]
+  ["dune" "runtest" "-p" name "-j" jobs] {with-test}
+]
+depends: [
+  "ocaml"
+  "ocamlfind" {build}
+  "dune" {build}
+  "base-threads"
+  "astring"
+  "xapi-stdext-unix"
+  "xapi-stdext-threads"
+  "cmdliner"
+  "uuidm"
+]
+synopsis: "Library for accessing the xapi toolstack inventory file"
+description: """
+The inventory file provides global host identify information
+needed by multiple services."""