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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
(* virt-v2v
* Copyright (C) 2009-2025 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.
*)
type options = {
output_alloc : Types.output_allocation;
output_conn : string option;
output_format : string;
output_options : (string * string) list;
output_name : string option;
output_password : string option;
output_storage : string option;
}
module type OUTPUT = sig
type poptions
(** Opaque parsed output options. *)
type t
(** Opaque data that the output mode needs to pass from
{!setup} to {!finalize}. *)
val to_string : options -> string
(** [to_string options] converts the destination to a printable
string (for messages). *)
val query_output_options : unit -> unit
(** When the user passes [-oo ?] this is used to print help. *)
val parse_options : options -> Types.source -> poptions
(** [parse_options source options] should check and parse the output
options passed on the command line. The return value {!poptions}
stores the parsed information and is passed to both
{!setup} and {!finalize} methods. *)
val setup : string -> poptions -> Types.source -> NBD_URI.t list ->
t * NBD_URI.t list
(** [setup dir poptions source input_disks]
Set up the output mode. Sets up a disk pipeline
for each output disk, and returns the list of output disks. *)
val finalize : string -> poptions -> t -> NBD_URI.t list ->
Types.source -> Types.inspect -> Types.target_meta ->
unit
(** [finalize dir poptions t output_disks inspect target_meta]
Finalizes the conversion and writes metadata. *)
val request_size : int option
(** Returns an optional {i hint} about the NBD request size that
optimizes performance. Note that the copy program may ignore
this. Use NBD block size options for enforcible limits. *)
end
(** Helper functions for output modes. *)
val error_option_cannot_be_used_in_output_mode : string -> string -> unit
(** [error_option_cannot_be_used_in_output_mode mode option]
prints error message that option cannot be used in this output mode. *)
val get_disk_sizes : NBD_URI.t list -> int64 list
(** Call NBD.get_size on each input disk. *)
val error_if_disk_count_gt : NBD_URI.t list -> int -> unit
(** This function lets an output module enforce a maximum disk count.
[error_if_disk_count_gt input_disks n] checks whether the domain
has more than [n] disks that need to be copied. *)
val create_local_output_disks : string ->
?compressed:bool ->
Types.output_allocation ->
string -> string -> string ->
NBD_URI.t list ->
NBD_URI.t list
(** When an output mode wants to create one output disk per
input disk, using the names "<output_storage>/<output_name>-sdX",
this function does it all, taking a list of input NBD URIs and
returning a list of output NBD URIs.
For anything more complicated, use {!output_to_local_file} instead. *)
type on_exit_kill = Kill | KillAndWait
val output_to_local_file : ?changeuid:((unit -> unit) -> unit) ->
?compressed:bool -> ?on_exit_kill:on_exit_kill ->
Types.output_allocation ->
string -> string -> int64 -> string ->
unit
(** When an output mode wants to create a local file with a
particular format (only "raw" or "qcow2" allowed) then
this common function can be used.
Optional parameter [?on_exit_kill] controls how the NBD server
is cleaned up. The default is {!Kill} which registers an
{!On_exit.kill} handler that kills (but does not wait for)
the server when virt-v2v exits. Most callers should use this.
Setting [~on_exit_kill:KillAndWait] should be used if the NBD
server must fully exit before we continue with the rest of
virt-v2v shut down. This is only necessary if some other action
(such as unmounting a host filesystem or removing a host device)
depends on the NBD server releasing resources. *)
val disk_path : string -> string -> int -> string
(** For [-o disk|qemu], return the output disk name of the i'th disk,
eg. 0 => /path/to/name-sda. *)
|
