File: elements.mli

package info (click to toggle)
libguestfs 1%3A1.40.2-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 123,660 kB
  • sloc: ansic: 460,074; ml: 63,059; sh: 14,955; java: 9,512; makefile: 9,133; cs: 6,300; haskell: 5,652; python: 3,856; perl: 3,619; erlang: 2,435; xml: 1,683; ruby: 350; pascal: 255; lex: 135; yacc: 128; cpp: 10
file content (61 lines) | stat: -rw-r--r-- 2,741 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
(* virt-dib
 * Copyright (C) 2015 Red Hat Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *)

(** Parsing and handling of elements. *)

type element = {
  directory : string;           (** directory of the element *)
  hooks : hooks_map;            (** available hooks, and scripts for each hook*)
}
and hooks_map = (string, string list) Hashtbl.t (** hook name, scripts *)

val builtin_elements_blacklist : string list
(** These are the elements which we don't ever try to use. *)

val builtin_scripts_blacklist : string list
(** These are the scripts which we don't ever try to run.

    Usual reason could be that they are not compatible the way
    virt-dib works, e.g. they expect the tree of elements outside
    the chroot, which is not available in the appliance. *)

val load_elements : debug:int -> string list -> (string, element) Hashtbl.t
(** [load_elements ~debug paths] loads elements from the specified
    [paths]; returns a [Hashtbl.t] of {!element} structs indexed by
    the element name. *)

val load_dependencies : StringSet.elt list -> (string, element) Hashtbl.t -> StringSet.t
(** [load_dependencies element_set elements] returns the whole set of
    elements needed to use [element_set], including [element_list]
    themselves.  In other words, this recursively resolves the
    dependencies of [element_set]. *)

val copy_elements : StringSet.t -> (string, element) Hashtbl.t -> string list -> string -> unit
(** [copy_elements element_set elements blacklisted_scripts destdir]
    copies the elements in [element_set] (with the element definitions
    provided as [elements]) into the [destdir] directory.

    [blacklisted_scripts] contains names of scripts to never copy. *)

val load_hooks : debug:int -> string -> hooks_map
(** [load_hooks ~debug path] loads the hooks from the specified
    [path] (which usually represents an element). *)

val load_scripts : Guestfs.guestfs -> string -> string list
(** [load_scripts g path] loads the scripts from the specified [path]
    (which usually represents a directory of an hook). *)