source/utils.py

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