Files
virt-v2v/input/nbdkit_ssh.ml
Richard W.M. Jones 7a82e130c2 lib: Only get nbdkit config and version once
The configuration (--dump-config) and version of nbdkit won't change
while we are running, so we only need to get it once.  We also don't
need the config parameter to Nbdkit.version so drop that.
2024-07-30 15:57:57 +01:00

137 lines
4.6 KiB
OCaml

(* virt-v2v
* Copyright (C) 2009-2020 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 Common_gettext.Gettext
open Std_utils
open Tools_utils
open Types
open Utils
let nbdkit_min_version = (1, 12, 0)
type password =
| AskForPassword
| PasswordFile of string
let error_unless_nbdkit_version_ge min_version =
let version = Nbdkit.version () in
if version < min_version then (
let min_major, min_minor, min_release = min_version in
error (f_"nbdkit is too old. nbdkit >= %d.%d.%d is required.")
min_major min_minor min_release
)
let error_unless_nbdkit_min_version () =
error_unless_nbdkit_version_ge nbdkit_min_version
(* Create an nbdkit module specialized for reading from SSH sources. *)
let create_ssh ?bandwidth ?cor ?(retry=true)
~server ?port ?user ?password path =
if not (Nbdkit.is_installed ()) then
error (f_"nbdkit is not installed or not working");
if not (Nbdkit.probe_plugin "ssh") then
error (f_"nbdkit-ssh-plugin is not installed");
if not (Nbdkit.probe_filter "cow") then
error (f_"nbdkit-cow-filter is not installed or not working");
error_unless_nbdkit_min_version ();
(* Construct the nbdkit command. *)
let cmd = Nbdkit.create "ssh" in
Nbdkit.add_arg cmd "host" server;
Nbdkit.add_arg cmd "path" path;
Option.iter (Nbdkit.add_arg cmd "port") port;
Option.iter (Nbdkit.add_arg cmd "user") user;
(* Retry filter (if it exists) can be used to get around brief
* interruptions in service. It must be closest to the plugin.
*)
if retry then
Nbdkit.add_filter_if_available cmd "retry";
(* Caching extents speeds up qemu-img, especially its consecutive
* block_status requests with req_one=1.
*)
Nbdkit.add_filter_if_available cmd "cacheextents";
(* IMPORTANT! Add the COW filter. It must be furthest away
* except for the rate filter.
*)
Nbdkit.add_filter cmd "cow";
(* Add the cow-on-read flag if supported. *)
(match cor with
| None -> ()
| Some cor ->
if Nbdkit.probe_filter_parameter "cow" "cow-on-read=.*/PATH" then
Nbdkit.add_arg cmd "cow-on-read" cor
);
(* Add the rate filter. This must be furthest away so that
* we don't end up rate-limiting internal nbdkit operations.
*)
if Nbdkit.probe_filter "rate" then (
match bandwidth with
| None -> ()
| Some bandwidth ->
Nbdkit.add_filter cmd "rate";
match bandwidth with
| StaticBandwidth rate ->
Nbdkit.add_arg cmd "rate" rate
| DynamicBandwidth (None, filename) ->
Nbdkit.add_arg cmd "rate-file" filename
| DynamicBandwidth (Some rate, filename) ->
Nbdkit.add_args cmd ["rate", rate; "rate-file", filename]
);
(* Handle the password parameter specially. *)
(match password with
| None -> ()
| Some AskForPassword ->
(* Because we will start nbdkit in the background and then wait
* for 30 seconds for it to start up, we cannot use the
* password=- feature of nbdkit to read the password
* interactively (since in the words of the movie the user has
* only "30 seconds to comply"). In any case this feature broke
* in the VDDK plugin in nbdkit 1.18 and 1.20. So in the
* AskForPassword case we read the password here.
*)
printf "password: ";
let open Unix in
let orig = tcgetattr stdin in
let tios = { orig with c_echo = false } in
tcsetattr stdin TCSAFLUSH tios; (* Disable echo. *)
let password = read_line () in
tcsetattr stdin TCSAFLUSH orig; (* Restore echo. *)
printf "\n";
let password_file = Filename.temp_file "v2vnbdkit" ".txt" in
On_exit.unlink password_file;
with_open_out password_file (fun chan -> output_string chan password);
Nbdkit.add_arg cmd "password" ("+" ^ password_file)
| Some (PasswordFile password_file) ->
Nbdkit.add_arg cmd "password" ("+" ^ password_file)
);
cmd