File: input_libvirt.ml

package info (click to toggle)
virt-v2v 2.10.0-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 25,524 kB
  • sloc: ml: 20,100; sh: 8,450; ansic: 6,880; makefile: 2,929; python: 1,114; perl: 865; xml: 118
file content (239 lines) | stat: -rw-r--r-- 8,431 bytes parent folder | download | duplicates (2)
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
(* helper-v2v-input
 * 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.
 *)

open Printf
open Unix

open Std_utils
open Tools_utils
open Common_gettext.Gettext

open Parse_libvirt_xml

open Types
open Utils

open Input

let rec get_source_from_libvirt options args =
  if options.input_options <> [] then
    error (f_"no -io (input options) are allowed here");

  let guest =
    match args with
    | [arg] -> arg
    | _ ->
       error (f_"-i libvirt: expecting a libvirt guest name \
                 on the command line") in

  (* Connect to the hypervisor. *)
  let conn =
    let auth = Libvirt_utils.auth_for_password_file
                 ?password_file:options.input_password () in
    Libvirt.Connect.connect_auth ?name:options.input_conn auth in

  (* Parse the libvirt XML. *)
  let source, disks, _ = parse_libvirt_domain conn guest in
  source, disks

and get_source_from_libvirt_xml _ args =
  let xmlfile =
    match args with
    | [arg] -> arg
    | _ ->
       error (f_"-i libvirtxml: expecting a libvirt XML filename \
                 on the command line") in
  let xml = read_whole_file xmlfile in
  let source, disks = parse_libvirt_xml xml in
  source, disks

and setup_servers options dir disks =
  (* Check nbdkit is installed. *)
  if not (Nbdkit.is_installed ()) then
    error (f_"nbdkit is not installed or not working.  It is required to \
              use ‘-i libvirt|libvirtxml’.");

  if not (Nbdkit.probe_plugin "file") then
    error (f_"nbdkit-file-plugin is not installed or not working");
  if not (Nbdkit.probe_plugin "nbd") then
    error (f_"nbdkit-nbd-plugin is not installed or not working");
  if options.read_only && not (Nbdkit.probe_filter "cow") then
    error (f_"nbdkit-cow-filter is not installed or not working");

  let nr_disks = List.length disks in

  List.mapi (
    fun i { d_format = format; d_type; d_checksum } ->
      let sockname = sprintf "in%d" i in
      let socket = sprintf "%s/%s" dir sockname in
      On_exit.unlink socket;

      (match d_type with
       (* Forward to another NBD server using nbdkit-nbd-plugin. *)
       | NBD (hostname, port) ->
          let cmd = Nbdkit.create ~name:sockname "nbd" in
          if options.read_only then
            Nbdkit.add_filter cmd "cow";
          Nbdkit.add_arg cmd "hostname" hostname;
          Nbdkit.add_arg cmd "port" (string_of_int port);
          Nbdkit.add_arg cmd "shared" "true";
          let _, pid = Nbdkit.run_unix socket cmd in

          (* --exit-with-parent should ensure nbdkit is cleaned
           * up when we exit, but it's not supported everywhere.
           *)
          On_exit.kill pid;

          Option.iter (do_checksum_nbd socket i nr_disks) d_checksum

       (* Forward to an HTTP/HTTPS server using nbdkit-curl-plugin. *)
       | HTTP url ->
          if not options.read_only then
            error (f_"in-place mode does not work with HTTP source");

          let cor = dir // "convert" in
          let cmd = Nbdkit_curl.create_curl ~name:sockname ~cor url in
          let _, pid = Nbdkit.run_unix socket cmd in

          (* --exit-with-parent should ensure nbdkit is cleaned
           * up when we exit, but it's not supported everywhere.
           *)
          On_exit.kill pid;

          Option.iter (do_checksum_nbd socket i nr_disks) d_checksum

       | BlockDev filename | LocalFile filename ->
          match format with
          | Some "raw" ->
             (* It's much faster to compute the checksum over
              * the raw file or block device than over NBD:
              *)
             Option.iter (do_checksum_raw_file filename i nr_disks) d_checksum;

             let cmd = Nbdkit.create ~name:sockname "file" in
             if options.read_only then
               Nbdkit.add_filter cmd "cow";
             Nbdkit.add_arg cmd "file" filename;
             Nbdkit.add_arg cmd "cache" "none";
             let _, pid = Nbdkit.run_unix socket cmd in

             (* --exit-with-parent should ensure nbdkit is cleaned
              * up when we exit, but it's not supported everywhere.
              *)
             On_exit.kill pid

          (* We use qemu-nbd for all other formats including auto-detect. *)
          | _ ->
             let cmd = QemuNBD.create filename in
             QemuNBD.set_snapshot cmd options.read_only;
             QemuNBD.set_format cmd format;
             let _, pid = QemuNBD.run_unix socket cmd in
             On_exit.kill pid;

             Option.iter (do_checksum_nbd socket i nr_disks) d_checksum
      );

      NBD_URI.Unix (socket, None)
  ) disks

(* Handle the <disk><checksum> field over an NBD endpoint. *)
and do_checksum_nbd socket i n { checksum_method;
                                 checksum_expected; checksum_on_fail } =
  message (f_"Checking %s checksum of disk %d/%d") checksum_method (i+1) n;
  let prog = checksum_prog checksum_method in
  let uri = sprintf "nbd+unix:///?socket=%s" socket in
  let cmd = sprintf "%s %s - | %s" (quote Config.nbdcopy) (quote uri) prog in
  let lines = external_command cmd in
  let actual = get_checksum_from_output prog lines in
  match checksum_on_fail with
  | ChecksumPrint -> print_checksum i n actual
  | ChecksumOnFailError | ChecksumOnFailWarn ->
     if actual <> checksum_expected then
       checksum_failed checksum_on_fail i n actual checksum_expected

(* Handle the <disk><checksum> field over a local raw-format file or
 * block device.
 *)
and do_checksum_raw_file filename i n { checksum_method;
                                        checksum_expected; checksum_on_fail } =
  message (f_"Checking %s checksum of disk %d/%d") checksum_method (i+1) n;
  let prog = checksum_prog checksum_method in
  let cmd = sprintf "%s %s" prog (quote filename) in
  let lines = external_command cmd in
  let actual = get_checksum_from_output prog lines in
  match checksum_on_fail with
  | ChecksumPrint -> print_checksum i n actual
  | ChecksumOnFailError | ChecksumOnFailWarn ->
     if actual <> checksum_expected then
       checksum_failed checksum_on_fail i n actual checksum_expected

and checksum_prog = function
  | "md5" -> "md5sum"
  | "sha256" -> "sha256sum"
  | "sha512" -> "sha512sum"
  | v -> error (f_"unknown <checksum> method='%s'") v

and get_checksum_from_output prog = function
  | [ actual ] ->
     let n = String.cspan actual " \t\n" in
     String.sub actual 0 n
  | _ ->
     error (f_"unexpected output from the %s command") prog

and print_checksum i n actual =
  printf "Checksum of disk %d/%d: %s\n%!" (i+1) n actual

and checksum_failed on_fail i n actual expected =
  (match on_fail with
   | ChecksumPrint -> assert false
   | ChecksumOnFailWarn -> warning
   | ChecksumOnFailError -> error ~exit_code:1)
    (f_"bad checksum for disk %d/%d\n\
        Expected checksum: %s\n\
        Actual checksum: %s")
    (i+1) n actual expected

module Libvirt_ = struct
  let to_string options args =
    let xs = "-i libvirt" :: args in
    let xs =
      match options.input_conn with
      | Some ic -> ("-ic " ^ ic) :: xs
      | None -> xs in
    String.concat " " xs

  let query_input_options () =
    printf (f_"No input options can be used in this mode.\n")

  let setup dir options args =
    let source, data = get_source_from_libvirt options args in
    let uris = setup_servers options dir data in
    source, uris
end

module LibvirtXML = struct
  let to_string options args = String.concat " " ("-i libvirtxml" :: args)

  let query_input_options () =
    printf (f_"No input options can be used in this mode.\n")

  let setup dir options args =
    let source, data = get_source_from_libvirt_xml options args in
    let uris = setup_servers options dir data in
    source, uris
end