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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
|
"""
Copyright (C) 2023 Michael Ablassmeier <abi@grinser.de>
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 3 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, see <https://www.gnu.org/licenses/>.
"""
import json
import logging
import tempfile
import subprocess
from typing import List
from argparse import Namespace
from libvirtnbdbackup.ssh.exceptions import sshError
from libvirtnbdbackup.objects import processInfo
from libvirtnbdbackup.qemu import command
from libvirtnbdbackup.virt.client import DomainDisk
log = logging.getLogger(__name__)
class util:
"""Wrapper for qemu executables"""
def __init__(self, exportName: str) -> None:
self.exportName = exportName
self.restoreCmd = [
"qemu-nbd",
"--fork",
"--discard=unmap",
"-x",
f"{self.exportName}",
]
@staticmethod
def _getcompress(args: Namespace, targetFile: str) -> List:
"""Check if --compress option is set and if so, use
qemu's compress driver during data write'"""
cmd = []
if args.compress is not True:
cmd.append(targetFile)
cmd.append("--format=qcow2")
else:
cmd.append("--image-opts")
cmd.append(
f"driver=compress,file.driver=qcow2,file.file.driver=file,file.file.filename={targetFile}" # pylint: disable=line-too-long
)
return cmd
@staticmethod
def map(cType, context: str) -> str:
"""Read extent map using nbdinfo utility"""
cmd = f"nbdinfo --json --map={context} '{cType.uri}'"
log.debug("Starting CMD: [%s]", cmd)
extentMap = subprocess.run(
cmd,
shell=True,
check=True,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
return json.loads(extentMap.stdout)
@staticmethod
def create( # pylint: disable=R0913: disable=R0913
args: Namespace,
targetFile: str,
fileSize: int,
diskFormat: str,
qcowOptions: list,
sshClient=None,
) -> processInfo:
"""Create the target qcow image"""
fileParam = f"{targetFile}"
if sshClient:
fileParam = f"'{targetFile}'"
cmd = [
"qemu-img",
"create",
"-f",
f"{diskFormat}",
fileParam,
"-o",
f"size={fileSize}",
]
if args.preallocate:
cmd.append("-o")
cmd.append("preallocation=full")
if qcowOptions:
cmd = cmd + qcowOptions
if not sshClient:
return command.run(cmd)
return sshClient.run(" ".join(cmd))
def info(self, targetFile: str, sshClient=None) -> processInfo:
"""Return qemu image information"""
fileParam = f"{targetFile}"
if sshClient:
fileParam = f"'{targetFile}'"
cmd = [
"qemu-img",
"info",
fileParam,
"--output",
"json",
"--force-share",
]
if not sshClient:
return command.run(cmd, toPipe=True)
return sshClient.run(" ".join(cmd))
def startRestoreNbdServer(self, args: Namespace, targetFile: str) -> processInfo:
"""Start local nbd server process for restore operation"""
pidFile = self._gt("qemu-nbd", ".pid")
cmd = self.restoreCmd
cmd = cmd + self._getcompress(args, targetFile)
cmd.append("-k")
cmd.append(args.socketfile)
cmd.append("--pid-file")
cmd.append(pidFile)
return command.run(cmd, pidFile=pidFile)
@staticmethod
def _gt(prefix: str, suffix: str, delete: bool = False) -> str:
"""Create named temporary file."""
with tempfile.NamedTemporaryFile(
delete=delete, prefix=prefix, suffix=suffix
) as tf1:
return tf1.name
@staticmethod
def _addTls(cmd: List[str], certpath: str) -> None:
"""Add required tls related options to qemu-nbd command
line."""
cmd.append("--object")
cmd.append(
f"tls-creds-x509,id=tls0,endpoint=server,dir={certpath},verify-peer=false"
)
cmd.append("--tls-creds tls0")
def startRemoteRestoreNbdServer(
self, args: Namespace, targetFile: str
) -> processInfo:
"""Start nbd server process remotely over ssh for restore operation"""
pidFile = self._gt("qemu-nbd-restore", ".pid")
logFile = self._gt("qemu-nbd-restore", ".log")
cmd = self.restoreCmd
cmd = cmd + self._getcompress(args, targetFile)
cmd.append("-p")
cmd.append(f"{args.nbd_port}")
cmd.append("--pid-file")
cmd.append(pidFile)
if args.tls is True:
self._addTls(cmd, args.tls_cert)
if args.nbd_ip != "":
cmd.append("-b")
cmd.append(args.nbd_ip)
cmd.append(f"> {logFile} 2>&1")
logging.debug(cmd)
try:
return args.sshClient.run(" ".join(cmd), pidFile, logFile)
except sshError:
log.error("Executing command failed: check [%s] for errors.", logFile)
raise
def startNbdkitProcess(
self, args: Namespace, nbdkitModule: str, blockMap, fullImage: str
) -> processInfo:
"""Execute nbdkit process for virtnbdmap"""
debug = "0"
hexdump = "0"
pidFile = self._gt("nbdkit", ".pid")
if args.verbose:
debug = "1"
if args.hexdump:
hexdump = "1"
debug = "1"
cmd = [
"nbdkit",
"--pidfile",
f"{pidFile}",
"-i",
f"{args.listen_address}",
"-p",
f"{args.listen_port}",
"-e",
f"{self.exportName}",
"--filter=blocksize",
"--filter=cow",
"-v",
"python",
f"{nbdkitModule}",
f"maxlen={args.blocksize}",
f"blockmap={blockMap}",
f"disk={fullImage}",
f"debug={debug}",
f"hexdump={hexdump}",
"-t",
f"{args.threads}",
]
return command.run(cmd, pidFile=pidFile)
def startBackupNbdServer(
self, diskFormat: str, diskFile: str, socketFile: str, bitMap: str
) -> processInfo:
"""Start nbd server process for offline backup operation"""
bitmapOpt = "--"
if bitMap != "":
bitmapOpt = f"--bitmap={bitMap}"
pidFile = f"{socketFile}.pid"
cmd = [
"qemu-nbd",
"-r",
f"--format={diskFormat}",
"-x",
f"{self.exportName}",
f"{diskFile}",
"-k",
f"{socketFile}",
"-t",
"-e 2",
"--fork",
"--detect-zeroes=on",
f"--pid-file={pidFile}",
bitmapOpt,
]
return command.run(cmd, pidFile=pidFile)
def startRemoteBackupNbdServer(
self, args: Namespace, disk: DomainDisk, bitMap: str, port: int
) -> processInfo:
"""Start nbd server process remotely over ssh for restore operation"""
pidFile = self._gt("qemu-nbd-backup", ".pid")
logFile = self._gt("qemu-nbd-backup", ".log")
cmd = [
"qemu-nbd",
"-r",
f"--format={disk.format}",
"-x",
f"{self.exportName}",
f"'{disk.path}'",
"-p",
f"{port}",
"--pid-file",
f"{pidFile}",
"--fork",
]
if args.nbd_ip != "":
cmd.append("-b")
cmd.append(args.nbd_ip)
if bitMap != "":
cmd.append(f"--bitmap={bitMap}")
if args.tls is True:
self._addTls(cmd, args.tls_cert)
cmd.append(f"> {logFile} 2>&1")
try:
return args.sshClient.run(" ".join(cmd), pidFile, logFile)
except sshError:
log.error("Executing command failed: check [%s] for errors.", logFile)
raise
def disconnect(self, device: str) -> processInfo:
"""Disconnect device"""
log.info("Disconnecting device [%s]", device)
cmd = ["qemu-nbd", "-d", f"{device}"]
return command.run(cmd)
|