X-Git-Url: https://code.grnet.gr/git/snf-image-creator/blobdiff_plain/7dc920817af8ab17b6a25d8d5df5ff9eb1a1713b..981b450428a56442f3bd034d9e5c951f87117625:/image_creator/os_type/windows.py diff --git a/image_creator/os_type/windows.py b/image_creator/os_type/windows.py index 0847190..96efdab 100644 --- a/image_creator/os_type/windows.py +++ b/image_creator/os_type/windows.py @@ -36,22 +36,20 @@ """This module hosts OS-specific code common for the various Microsoft Windows OSs.""" -from image_creator.os_type import OSBase, sysprep -from image_creator.util import FatalError, check_guestfs_version, get_command +from image_creator.os_type import OSBase, sysprep, add_sysprep_param +from image_creator.util import FatalError, get_kvm_binary +from image_creator.winexe import WinEXE, WinexeTimeout import hivex import tempfile import os +import signal import time import random import string import subprocess import struct -kvm = get_command('kvm') - -BOOT_TIMEOUT = 300 - # For more info see: http://technet.microsoft.com/en-us/library/jj612867.aspx KMS_CLIENT_SETUP_KEYS = { "Windows 8 Professional": "NG4HW-VH26C-733KW-K6F98-J8CK4", @@ -102,36 +100,53 @@ KMS_CLIENT_SETUP_KEYS = { "Windows Server 2008 for Itanium-Based Systems": "4DWFP-JF3DJ-B7DTH-78FJB-PDRHK"} +_POSINT = lambda x: type(x) == int and x >= 0 + class Windows(OSBase): """OS class for Windows""" + @add_sysprep_param( + 'shutdown_timeout', int, 120, "Shutdown Timeout (seconds)", _POSINT) + @add_sysprep_param( + 'boot_timeout', int, 300, "Boot Timeout (seconds)", _POSINT) + @add_sysprep_param( + 'connection_retries', int, 5, "Connection Retries", _POSINT) + @add_sysprep_param('password', str, None, 'Image Administrator Password') def __init__(self, image, **kargs): super(Windows, self).__init__(image, **kargs) - device = self.g.part_to_dev(self.root) - - self.last_part_num = self.g.part_list(device)[-1]['part_num'] + # The commit with the following message was added in + # libguestfs 1.17.18 and was backported in version 1.16.11: + # + # When a Windows guest doesn't have a HKLM\SYSTEM\MountedDevices node, + # inspection fails. However inspection should not completely fail just + # because we cannot get the drive letter mapping from a guest. + # + # Since Microsoft Sysprep removes the aforementioned key, image + # creation for windows can only be supported if the installed guestfs + # version is 1.17.18 or higher + if self.image.check_guestfs_version(1, 17, 18) < 0 and \ + (self.image.check_guestfs_version(1, 17, 0) >= 0 or + self.image.check_guestfs_version(1, 16, 11) < 0): + raise FatalError( + 'For windows support libguestfs 1.16.11 or above is required') + + device = self.image.g.part_to_dev(self.root) + + self.last_part_num = self.image.g.part_list(device)[-1]['part_num'] self.last_drive = None self.system_drive = None - for drive, partition in self.g.inspect_get_drive_mappings(self.root): - if partition == "%s%d" % (device, self.last_part_num): + for drive, part in self.image.g.inspect_get_drive_mappings(self.root): + if part == "%s%d" % (device, self.last_part_num): self.last_drive = drive - if partition == self.root: + if part == self.root: self.system_drive = drive assert self.system_drive - self.product_name = self.g.inspect_get_product_name(self.root) - - def needed_sysprep_params(self): - """Returns a list of needed sysprep parameters. Each element in the - list is a SysprepParam object. - """ - password = self.SysprepParam( - 'password', 'Image Administrator Password', 20, lambda x: True) - - return [password] + self.product_name = self.image.g.inspect_get_product_name(self.root) + self.syspreped = False @sysprep('Disabling IPv6 privacy extensions') def disable_ipv6_privacy_extensions(self): @@ -154,7 +169,7 @@ class Windows(OSBase): @sysprep('Enabling ping responses') def enable_pings(self): - """Enable ping responces""" + """Enable ping responses""" self._guest_exec('netsh firewall set icmpsetting 8') @@ -179,7 +194,7 @@ class Windows(OSBase): self._guest_exec( r"cmd /q /c for /f %l in ('wevtutil el') do wevtutil cl %l") - @sysprep('Executing sysprep on the image (may take more that 10 minutes)') + @sysprep('Executing Sysprep on the image (may take more that 10 minutes)') def microsoft_sysprep(self): """Run the Microsoft System Preparation Tool. This will remove system-specific data and will make the image ready to be deployed. @@ -195,7 +210,7 @@ class Windows(OSBase): """Install the appropriate KMS client setup key to the image to convert it to a KMS client. Computers that are running volume licensing editions of Windows 8, Windows Server 2012, Windows 7, Windows Server - 2008 R2, Windows Vista, and Windows Server 2008 are, by default, KMS + 2008 R2, Windows Vista, and Windows Server 2008 are by default KMS clients with no additional configuration needed. """ try: @@ -207,7 +222,7 @@ class Windows(OSBase): return self._guest_exec( - "cscript \Windows\system32\slmgr.vbs /ipk %s" % setup_key) + r"cscript \Windows\system32\slmgr.vbs /ipk %s" % setup_key) @sysprep('Shrinking the last filesystem') def shrink(self): @@ -215,13 +230,13 @@ class Windows(OSBase): # Query for the maximum number of reclaimable bytes cmd = ( - r'cmd /Q /C "SET SCRIPT=%TEMP%\QUERYMAX_%RANDOM%.TXT & ' + + r'cmd /Q /V:ON /C "SET SCRIPT=%TEMP%\QUERYMAX_%RANDOM%.TXT & ' + r'ECHO SELECT DISK 0 > %SCRIPT% & ' + 'ECHO SELECT PARTITION %d >> %%SCRIPT%% & ' % self.last_part_num + r'ECHO SHRINK QUERYMAX >> %SCRIPT% & ' + r'ECHO EXIT >> %SCRIPT% & ' + r'DISKPART /S %SCRIPT% & ' + - r'IF ERRORLEVEL 1 EXIT /B 1 & ' + + r'IF NOT !ERRORLEVEL! EQU 0 EXIT /B 1 & ' + r'DEL /Q %SCRIPT%"') stdout, stderr, rc = self._guest_exec(cmd) @@ -253,18 +268,24 @@ class Windows(OSBase): self.out.warn("Not enought available space to shrink the image!") return + self.out.output("\tReclaiming %dMB ..." % querymax) + cmd = ( - r'cmd /Q /C "SET SCRIPT=%TEMP%\QUERYMAX_%RANDOM%.TXT & ' + + r'cmd /Q /V:ON /C "SET SCRIPT=%TEMP%\QUERYMAX_%RANDOM%.TXT & ' + r'ECHO SELECT DISK 0 > %SCRIPT% & ' + 'ECHO SELECT PARTITION %d >> %%SCRIPT%% & ' % self.last_part_num + 'ECHO SHRINK DESIRED=%d >> %%SCRIPT%% & ' % querymax + r'ECHO EXIT >> %SCRIPT% & ' + r'DISKPART /S %SCRIPT% & ' + - r'IF ERRORLEVEL 1 EXIT /B 1 & ' + + r'IF NOT !ERRORLEVEL! EQU 0 EXIT /B 1 & ' + r'DEL /Q %SCRIPT%"') - stdout, stderr, rc = self._guest_exec(cmd) + stdout, stderr, rc = self._guest_exec(cmd, False) + if rc != 0: + FatalError("Shrinking failed. Please make sure the media is " + "defraged with a command like this: " + "`Defrag.exe /U /X /W'") for line in stdout.splitlines(): if line.find('shrunk') >= 0: self.out.output(line) @@ -276,9 +297,9 @@ class Windows(OSBase): raise FatalError("Image is already syspreped!") txt = "System preparation parameter: `%s' is needed but missing!" - for param in self.needed_sysprep_params(): - if param[0] not in self.sysprep_params: - raise FatalError(txt % param[0]) + for name, param in self.needed_sysprep_params.items(): + if name not in self.sysprep_params: + raise FatalError(txt % name) self.mount(readonly=False) try: @@ -289,23 +310,17 @@ class Windows(OSBase): firewall_states = self._update_firewalls(0, 0, 0) # Delete the pagefile. It will be recreated when the system boots - systemroot = self.g.inspect_get_windows_systemroot(self.root) - pagefile = "%s/pagefile.sys" % systemroot - self.g.rm_rf(self.g.case_sensitive_path(pagefile)) + systemroot = self.image.g.inspect_get_windows_systemroot(self.root) + try: + pagefile = "%s/pagefile.sys" % systemroot + self.image.g.rm_rf(self.image.g.case_sensitive_path(pagefile)) + except RuntimeError: + pass finally: self.umount() - self.out.output("Shutting down helper VM ...", False) - self.g.sync() - # guestfs_shutdown which is the prefered way to shutdown the backend - # process was introduced in version 1.19.16 - if check_guestfs_version(self.g, 1, 19, 16) >= 0: - ret = self.g.shutdown() - else: - ret = self.g.kill_subprocess() - - self.out.success('done') + self.image.disable_guestfs() vm = None monitor = None @@ -313,39 +328,38 @@ class Windows(OSBase): self.out.output("Starting windows VM ...", False) monitorfd, monitor = tempfile.mkstemp() os.close(monitorfd) - vm, display = self._create_vm(monitor) - self.out.success("started (console on vnc display: %d)." % display) + vm = _VM(self.image.device, monitor, self.sysprep_params) + self.out.success("started (console on vnc display: %d)." % + vm.display) self.out.output("Waiting for OS to boot ...", False) - if not self._wait_on_file(monitor, token): - raise FatalError("Windows booting timed out.") - else: - time.sleep(10) # Just to be sure everything is up - self.out.success('done') + self._wait_vm_boot(vm, monitor, token) + self.out.success('done') + + self.out.output("Checking connectivity to the VM ...", False) + self._check_connectivity() + self.out.success('done') self.out.output("Disabling automatic logon ...", False) self._disable_autologon() self.out.success('done') - self.out.output('Preparing system from image creation:') + self.out.output('Preparing system for image creation:') tasks = self.list_syspreps() - enabled = filter(lambda x: x.enabled, tasks) + enabled = [task for task in tasks if task.enabled] size = len(enabled) # Make sure shrink runs in the end, before ms sysprep - enabled = filter(lambda x: self.sysprep_info(x).name != 'shrink', - enabled) + enabled = [task for task in enabled if + self.sysprep_info(task).name != 'shrink'] - shrink_enabled = False if len(enabled) != size: enabled.append(self.shrink) - shrink_enabled = True # Make sure the ms sysprep is the last task to run if it is enabled - enabled = filter( - lambda x: self.sysprep_info(x).name != 'microsoft-sysprep', - enabled) + enabled = [task for task in enabled if + self.sysprep_info(task).name != 'microsoft-sysprep'] ms_sysprep_enabled = False if len(enabled) != size: @@ -365,75 +379,46 @@ class Windows(OSBase): self.out.success("done") self.out.output("Waiting for windows to shut down ...", False) - vm.wait() + vm.wait(self.sysprep_params['shutdown_timeout']) self.out.success("done") finally: if monitor is not None: os.unlink(monitor) - if vm is not None: - self._destroy_vm(vm) - - self.out.output("Relaunching helper VM (may take a while) ...", - False) - self.g.launch() - self.out.success('done') - - self.mount(readonly=False) try: - if disabled_uac: - self._update_uac_remote_setting(0) - - self._update_firewalls(*firewall_states) + if vm is not None: + self.out.output("Destroying windows VM ...", False) + vm.destroy() + self.out.success("done") finally: - self.umount() - - def _create_vm(self, monitor): - """Create a VM with the image attached as the disk - - monitor: a file to be used to monitor when the OS is up - """ - - def random_mac(): - mac = [0x00, 0x16, 0x3e, - random.randint(0x00, 0x7f), - random.randint(0x00, 0xff), - random.randint(0x00, 0xff)] - - return ':'.join(map(lambda x: "%02x" % x, mac)) - - # Use ganeti's VNC port range for a random vnc port - vnc_port = random.randint(11000, 14999) - display = vnc_port - 5900 + self.image.enable_guestfs() - vm = kvm( - '-smp', '1', '-m', '1024', '-drive', - 'file=%s,format=raw,cache=unsafe,if=virtio' % self.image.device, - '-netdev', 'type=user,hostfwd=tcp::445-:445,id=netdev0', - '-device', 'virtio-net-pci,mac=%s,netdev=netdev0' % random_mac(), - '-vnc', ':%d' % display, '-serial', 'file:%s' % monitor, _bg=True) + self.mount(readonly=False) + try: + if disabled_uac: + self._update_uac_remote_setting(0) - return vm, display - - def _destroy_vm(self, vm): - """Destroy a VM previously created by _create_vm""" - if vm.process.alive: - vm.terminate() + self._update_firewalls(*firewall_states) + finally: + self.umount() def _shutdown(self): """Shuts down the windows VM""" self._guest_exec(r'shutdown /s /t 5') - def _wait_on_file(self, fname, msg): - """Wait until a message appears on a file""" + def _wait_vm_boot(self, vm, fname, msg): + """Wait until a message appears on a file or the vm process dies""" - for i in range(BOOT_TIMEOUT): + for _ in range(self.sysprep_params['boot_timeout']): time.sleep(1) with open(fname) as f: for line in f: if line.startswith(msg): return True - return False + if not vm.isalive(): + raise FatalError("Windows VM died unexpectedly!") + + raise FatalError("Windows VM booting timed out!") def _disable_autologon(self): """Disable automatic logon on the windows image""" @@ -448,13 +433,13 @@ class Windows(OSBase): def _registry_file_path(self, regfile): """Retrieves the case sensitive path to a registry file""" - systemroot = self.g.inspect_get_windows_systemroot(self.root) + systemroot = self.image.g.inspect_get_windows_systemroot(self.root) path = "%s/system32/config/%s" % (systemroot, regfile) try: - path = self.g.case_sensitive_path(path) - except RuntimeError as e: + path = self.image.g.case_sensitive_path(path) + except RuntimeError as error: raise FatalError("Unable to retrieve registry file: %s. Reason: %s" - % (regfile, str(e))) + % (regfile, str(error))) return path def _enable_os_monitor(self): @@ -468,7 +453,7 @@ class Windows(OSBase): softwarefd, software = tempfile.mkstemp() try: os.close(softwarefd) - self.g.download(path, software) + self.image.g.download(path, software) h = hivex.Hivex(software, write=True) @@ -533,7 +518,7 @@ class Windows(OSBase): h.commit(None) - self.g.upload(software, path) + self.image.g.upload(software, path) finally: os.unlink(software) @@ -559,7 +544,7 @@ class Windows(OSBase): systemfd, system = tempfile.mkstemp() try: os.close(systemfd) - self.g.download(path, system) + self.image.g.download(path, system) h = hivex.Hivex(system, write=True) @@ -591,7 +576,7 @@ class Windows(OSBase): 'value': struct.pack("