source/utils.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, sys, shutil
  11 import subprocess
  12 import shlex
  13 import socket
  14 import fcntl
  15 import string
  16 import exceptions
  17
  18 from Exceptions import *
  19
  20 ####################
  21 # the simplest way to debug is to let the node take off,
  22 # ssh into it as root using the debug ssh key in /etc/planetlab
  23 # then go to /tmp/source
  24 # edit this file locally to turn on breakpoints if needed, then run
  25 # ./BootManager.py
  26 ####################
  27
  28 ### handling breakpoints in the startup process
  29 import select, sys, string
  30
  31 ### global debugging settings
  32
  33 # enabling this will cause the node to ask for breakpoint-mode at startup
  34 # production code should read False/False
  35 PROMPT_MODE=False
  36 # default for when prompt is turned off, or it's on but the timeout triggers
  37 BREAKPOINT_MODE=False
  38
  39 # verbose mode is just fine
  40 VERBOSE_MODE=True
  41 # in seconds : if no input, proceed
  42 PROMPT_TIMEOUT=5
  43
  44 def prompt_for_breakpoint_mode ():
  45
  46     global BREAKPOINT_MODE
  47     if PROMPT_MODE:
  48         default_answer=BREAKPOINT_MODE
  49         answer=''
  50         if BREAKPOINT_MODE:
  51             display="[y]/n"
  52         else:
  53             display="y/[n]"
  54         sys.stdout.write ("Want to run in breakpoint mode ? %s "%display)
  55         sys.stdout.flush()
  56         r,w,e = select.select ([sys.stdin],[],[],PROMPT_TIMEOUT)
  57         if r:
  58             answer = string.strip(sys.stdin.readline())
  59         else:
  60             sys.stdout.write("\nTimed-out (%d s)"%PROMPT_TIMEOUT)
  61         if answer:
  62             BREAKPOINT_MODE = ( answer == "y" or answer == "Y")
  63         else:
  64             BREAKPOINT_MODE = default_answer
  65     label="Off"
  66     if BREAKPOINT_MODE:
  67         label="On"
  68     sys.stdout.write("\nCurrent BREAKPOINT_MODE is %s\n"%label)
  69
  70 def breakpoint (message, cmd = None):
  71
  72     if BREAKPOINT_MODE:
  73
  74         if cmd is None:
  75             cmd="/bin/sh"
  76             message=message+" -- Entering bash - type ^D to proceed"
  77
  78         print message
  79         os.system(cmd)
  80
  81
  82 ########################################
  83 def makedirs( path ):
  84     """
  85     from python docs for os.makedirs:
  86     Throws an error exception if the leaf directory
  87     already exists or cannot be created.
  88
  89     That is real useful. Instead, we'll create the directory, then use a
  90     separate function to test for its existance.
  91
  92     Return 1 if the directory exists and/or has been created, a BootManagerException
  93     otherwise. Does not test the writability of said directory.
  94     """
  95     try:
  96         os.makedirs( path )
  97     except OSError:
  98         pass
  99     try:
 100         os.listdir( path )
 101     except OSError:
 102         raise BootManagerException, "Unable to create directory tree: %s" % path
 103
 104     return 1
 105
 106
 107
 108 def removedir( path ):
 109     """
 110     remove a directory tree, return 1 if successful, a BootManagerException
 111     if failure.
 112     """
 113     try:
 114         os.listdir( path )
 115     except OSError:
 116         return 1
 117
 118     try:
 119         shutil.rmtree( path )
 120     except OSError, desc:
 121         raise BootManagerException, "Unable to remove directory tree: %s" % path
 122
 123     return 1
 124
 125
 126 def sysexec( cmd, log=None, fsck=False, shell=False ):
 127     """
 128     execute a system command, output the results to the logger
 129     if log <> None
 130
 131     return 1 if command completed (return code of non-zero),
 132     0 if failed. A BootManagerException is raised if the command
 133     was unable to execute or was interrupted by the user with Ctrl+C
 134     """
 135     try:
 136         # Thierry - Jan. 6 2011
 137         # would probably make sense to look for | here as well
 138         # however this is fragile and hard to test thoroughly
 139         # let the caller set 'shell' when that is desirable
 140         if shell or cmd.__contains__(">"):
 141             prog = subprocess.Popen(cmd, shell=True)
 142             if VERBOSE_MODE:
 143                 print ("sysexec (shell mode) >>> %s" % cmd)
 144         else:
 145             prog = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 146             if VERBOSE_MODE:
 147                 print ("sysexec >>> %s" % cmd)
 148     except OSError:
 149         raise BootManagerException, \
 150               "Unable to create instance of subprocess.Popen " \
 151               "for command: %s" % cmd
 152     try:
 153         (stdoutdata, stderrdata) = prog.communicate()
 154     except KeyboardInterrupt:
 155         raise BootManagerException, "Interrupted by user"
 156
 157     if log is not None:
 158         if stdoutdata is not None:
 159             log.write(stdoutdata)
 160
 161     returncode = prog.wait()
 162
 163     if fsck:
 164        # The exit code returned by fsck is the sum of the following conditions:
 165        #      0    - No errors
 166        #      1    - File system errors corrected
 167        #      2    - System should be rebooted
 168        #      4    - File system errors left uncorrected
 169        #      8    - Operational error
 170        #      16   - Usage or syntax error
 171        #      32   - Fsck canceled by user request
 172        #      128  - Shared library error
 173        if returncode != 0 and returncode != 1:
 174             raise BootManagerException, "Running %s failed (rc=%d)" % (cmd,returncode)
 175     else:
 176         if returncode != 0:
 177             raise BootManagerException, "Running %s failed (rc=%d)" % (cmd,returncode)
 178
 179     prog = None
 180     return 1
 181
 182
 183 def sysexec_chroot( path, cmd, log=None, shell=False):
 184     """
 185     same as sysexec, but inside a chroot
 186     """
 187     preload = ""
 188     release = os.uname()[2]
 189     # 2.6.12 kernels need this
 190     if release[:5] == "2.6.1":
 191         library = "%s/lib/libc-opendir-hack.so" % path
 192         if not os.path.exists(library):
 193             shutil.copy("./libc-opendir-hack.so", library)
 194         preload = "/bin/env LD_PRELOAD=/lib/libc-opendir-hack.so"
 195     sysexec("chroot %s %s %s" % (path, preload, cmd), log, shell=shell)
 196
 197
 198 def sysexec_chroot_noerr( path, cmd, log=None, shell=False ):
 199     """
 200     same as sysexec_chroot, but capture boot manager exceptions
 201     """
 202     try:
 203         rc= 0
 204         rc= sysexec_chroot( cmd, log, shell=shell )
 205     except BootManagerException, e:
 206         pass
 207
 208     return rc
 209
 210
 211 def sysexec_noerr( cmd, log=None, shell=False ):
 212     """
 213     same as sysexec, but capture boot manager exceptions
 214     """
 215     try:
 216         rc= 0
 217         rc= sysexec( cmd, log, shell=shell )
 218     except BootManagerException, e:
 219         pass
 220
 221     return rc
 222
 223
 224
 225 def chdir( dir ):
 226     """
 227     change to a directory, return 1 if successful, a BootManagerException if failure
 228     """
 229     try:
 230         os.chdir( dir )
 231     except OSError:
 232         raise BootManagerException, "Unable to change to directory: %s" % dir
 233
 234     return 1
 235
 236
 237
 238 def removefile( filepath ):
 239     """
 240     removes a file, return 1 if successful, 0 if failure
 241     """
 242     try:
 243         os.remove( filepath )
 244     except OSError:
 245         raise BootManagerException, "Unable to remove file: %s" % filepath
 246
 247     return 1
 248
 249
 250
 251 # from: http://forums.devshed.com/archive/t-51149/
 252 #              Ethernet-card-address-Through-Python-or-C
 253
 254 def hexy(n):
 255     return "%02x" % (ord(n))
 256
 257 def get_mac_from_interface(ifname):
 258     """
 259     given a device name, like eth0, return its mac_address.
 260     return None if the device doesn't exist.
 261     """
 262
 263     SIOCGIFHWADDR = 0x8927 # magic number
 264
 265     s=socket.socket(socket.AF_INET,socket.SOCK_STREAM)
 266     ifname = string.strip(ifname)
 267     ifr = ifname + '\0'*(32-len(ifname))
 268
 269     try:
 270         r= fcntl.ioctl(s.fileno(),SIOCGIFHWADDR,ifr)
 271         addr = map(hexy,r[18:24])
 272         ret = (':'.join(map(str, addr)))
 273     except IOError, e:
 274         ret = None
 275
 276     return ret
 277
 278 def check_file_hash(filename, hash_filename):
 279     """Check the file's integrity with a given hash."""
 280     return sha1_file(filename) == open(hash_filename).read().split()[0].strip()
 281
 282 def sha1_file(filename):
 283     """Calculate sha1 hash of file."""
 284     try:
 285         try:
 286             import hashlib
 287             m = hashlib.sha1()
 288         except:
 289             import sha
 290             m=sha.new()
 291         f = file(filename, 'rb')
 292         while True:
 293             # 256 KB seems ideal for speed/memory tradeoff
 294             # It wont get much faster with bigger blocks, but
 295             # heap peak grows
 296             block = f.read(256 * 1024)
 297             if len(block) == 0:
 298                 # end of file
 299                 break
 300             m.update(block)
 301             # Simple trick to keep total heap even lower
 302             # Delete the previous block, so while next one is read
 303             # we wont have two allocated blocks with same size
 304             del block
 305         return m.hexdigest()
 306     except IOError:
 307         raise BootManagerException, "Cannot calculate SHA1 hash of %s" % filename