source/steps/CheckHardwareRequirements.py

   1 #!/usr/bin/python
   2 #
   3 # Copyright (c) 2003 Intel Corporation
   4 # All rights reserved.
   5 #
   6 # Copyright (c) 2004-2006 The Trustees of Princeton University
   7 # All rights reserved.
   8 # expected /proc/partitions format
   9
  10 import os
  11 import popen2
  12 import string
  13
  14 import systeminfo
  15 from Exceptions import *
  16 import utils
  17 import notify_messages
  18 import BootAPI
  19
  20
  21 def Run(vars, log):
  22     """
  23     Make sure the hardware we are running on is sufficient for
  24     the PlanetLab OS to be installed on. In the process, identify
  25     the list of block devices that may be used for a node installation,
  26     and identify the cdrom device that we booted off of.
  27
  28     Return 1 if requiremenst met, 0 if requirements not met. Raise
  29     BootManagerException if any problems occur that prevent the requirements
  30     from being checked.
  31
  32     Expect the following variables from the store:
  33
  34     MINIMUM_MEMORY          minimum amount of memory in kb required
  35                             for install
  36     NODE_ID                 the node_id from the database for this node
  37     MINIMUM_DISK_SIZE       any disks smaller than this size, in GB, are not used
  38     TOTAL_MINIMUM_DISK_SIZE total disk size in GB, if all usable disks
  39                             meet this number, there isn't enough disk space for
  40                             this node to be usable after install
  41     SKIP_HARDWARE_REQUIREMENT_CHECK
  42                             If set, don't check if minimum requirements are met
  43     Sets the following variables:
  44     INSTALL_BLOCK_DEVICES    list of block devices to install onto
  45     """
  46
  47     log.write("\n\nStep: Checking if hardware requirements met.\n")
  48
  49     try:
  50         MINIMUM_MEMORY = int(vars["MINIMUM_MEMORY"])
  51         if MINIMUM_MEMORY == "":
  52             raise ValueError("MINIMUM_MEMORY")
  53
  54         NODE_ID = vars["NODE_ID"]
  55         if NODE_ID == "":
  56             raise ValueError("NODE_ID")
  57
  58         MINIMUM_DISK_SIZE = int(vars["MINIMUM_DISK_SIZE"])
  59
  60         # use vs_ or lxc_variants
  61         varname = vars['virt'] + "_TOTAL_MINIMUM_DISK_SIZE"
  62         TOTAL_MINIMUM_DISK_SIZE = int(vars[varname])
  63
  64         SKIP_HARDWARE_REQUIREMENT_CHECK = int(vars["SKIP_HARDWARE_REQUIREMENT_CHECK"])
  65
  66     except KeyError as var:
  67         raise BootManagerException("Missing variable in install store: {}".format(var))
  68     except ValueError as var:
  69         raise BootManagerException("Variable in install store blank, shouldn't be: {}".format(var))
  70
  71     # lets see if we have enough memory to run
  72     log.write("Checking for available memory.\n")
  73
  74     total_mem = systeminfo.get_total_phsyical_mem(vars, log)
  75     if total_mem is None:
  76         raise BootManagerException("Unable to read total physical memory")
  77
  78     if total_mem < MINIMUM_MEMORY:
  79         if not SKIP_HARDWARE_REQUIREMENT_CHECK:
  80             log.write("Insufficient memory to run node: {} kb\n".format(total_mem))
  81             log.write("Required memory: {} kb\n".format(MINIMUM_MEMORY))
  82
  83             include_pis = 0
  84             include_techs = 1
  85             include_support = 0
  86
  87             sent = 0
  88             try:
  89                 sent = BootAPI.call_api_function(vars, "BootNotifyOwners",
  90                                                  (notify_messages.MSG_INSUFFICIENT_MEMORY,
  91                                                   include_pis,
  92                                                   include_techs,
  93                                                   include_support))
  94             except BootManagerException as e:
  95                 log.write("Call to BootNotifyOwners failed: {}.\n".format(e))
  96
  97             if sent == 0:
  98                 log.write("Unable to notify site contacts of problem.\n")
  99             else:
 100                 log.write("Notified contacts of problem.\n")
 101
 102             return 0
 103         else:
 104             log.write("Memory requirements not met, but running anyway: {} kb\n"
 105                       .format(total_mem))
 106     else:
 107         log.write("Looks like we have enough memory: {} kb\n".format(total_mem))
 108
 109
 110
 111     # get a list of block devices to attempt to install on
 112     # (may include cdrom devices)
 113     install_devices = systeminfo.get_block_devices_dict(vars, log)
 114
 115     # save the list of block devices in the log
 116     log.write("Detected block devices:\n")
 117     log.write(repr(install_devices) + "\n")
 118
 119     if not install_devices or len(install_devices) == 0:
 120         log.write("No block devices detected.\n")
 121
 122         include_pis = 0
 123         include_techs = 1
 124         include_support = 0
 125
 126         sent = 0
 127         try:
 128             sent = BootAPI.call_api_function(vars, "BootNotifyOwners",
 129                                              (notify_messages.MSG_INSUFFICIENT_DISK,
 130                                               include_pis,
 131                                               include_techs,
 132                                               include_support))
 133         except BootManagerException as e:
 134             log.write("Call to BootNotifyOwners failed: {}.\n".format(e))
 135
 136         if sent == 0:
 137             log.write("Unable to notify site contacts of problem.\n")
 138
 139         return 0
 140
 141     # now, lets remove any block devices we know won't work (readonly,cdroms),
 142     # or could be other writable removable disks (usb keychains, zip disks, etc)
 143     # i'm not aware of anything that helps with the latter test, so,
 144     # what we'll probably do is simply not use any block device below
 145     # some size threshold (set in installstore)
 146
 147     # also, keep track of the total size for all devices that appear usable
 148     total_size = 0
 149
 150     # do not modify subject of current loop
 151     ignored_devices = []
 152     for device, details in install_devices.items():
 153
 154         major, minor, blocks, gb_size, readonly = details
 155
 156         # if the device string starts with
 157         # planetlab or dm- (device mapper), ignore it (could be old lvm setup)
 158         if device[:14] == "/dev/planetlab" or device[:8] == "/dev/dm-":
 159             ignored_devices.append(device)
 160             continue
 161
 162         if gb_size < MINIMUM_DISK_SIZE:
 163             log.write("Device is too small to use: {} \n"
 164                       "(appears to be {:4.2f} Gb)\n".format(device, gb_size))
 165             ignored_devices.append(device)
 166             continue
 167
 168         if readonly:
 169             log.write("Device is readonly, not using: {}\n".format(device))
 170             ignored_devices.append(device)
 171             continue
 172
 173         # add this sector count to the total count of usable
 174         # sectors we've found.
 175         total_size = total_size + gb_size
 176
 177     # delayed erasure
 178     for device in ignored_devices:
 179         try:
 180             del install_devices[device]
 181         except KeyError as e:
 182             pass
 183
 184     if len(install_devices) == 0:
 185         log.write("No suitable block devices found for install.\n")
 186
 187         include_pis = 0
 188         include_techs = 1
 189         include_support = 0
 190
 191         sent = 0
 192         try:
 193             sent = BootAPI.call_api_function(vars, "BootNotifyOwners",
 194                                              (notify_messages.MSG_INSUFFICIENT_DISK,
 195                                               include_pis,
 196                                               include_techs,
 197                                               include_support))
 198         except BootManagerException as e:
 199             log.write("Call to BootNotifyOwners failed: {}.\n".format(e))
 200
 201         if sent == 0:
 202             log.write("Unable to notify site contacts of problem.\n")
 203
 204         return 0
 205
 206
 207     # show the devices we found that are usable
 208     log.write("Usable block devices:\n")
 209     log.write(repr(install_devices.keys()) + "\n")
 210
 211     # save the list of devices for the following steps
 212     vars["INSTALL_BLOCK_DEVICES"] = install_devices.keys()
 213
 214
 215     # ensure the total disk size is large enough. if
 216     # not, we need to email the tech contacts the problem, and
 217     # put the node into debug mode.
 218     if total_size < TOTAL_MINIMUM_DISK_SIZE:
 219         if not SKIP_HARDWARE_REQUIREMENT_CHECK:
 220             log.write("The total usable disk size of all disks is " \
 221                        "insufficient to be usable as a PlanetLab node.\n")
 222             include_pis = 0
 223             include_techs = 1
 224             include_support = 0
 225
 226             sent = 0
 227             try:
 228                 sent = BootAPI.call_api_function(vars, "BootNotifyOwners",
 229                                                  (notify_messages.MSG_INSUFFICIENT_DISK,
 230                                                   include_pis,
 231                                                   include_techs,
 232                                                   include_support))
 233             except BootManagerException as e:
 234                 log.write("Call to BootNotifyOwners failed: {}.\n".format(e))
 235
 236             if sent == 0:
 237                 log.write("Unable to notify site contacts of problem.\n")
 238
 239             return 0
 240
 241         else:
 242             log.write("The total usable disk size of all disks is " \
 243                        "insufficient, but running anyway.\n")
 244
 245     log.write("Total size for all usable block devices: {:4.2f} Gb\n".format(total_size))
 246
 247     return 1