tools.py

   1 """A few things that didn't seem to fit anywhere else."""
   2
   3 import cPickle
   4 import errno
   5 import os
   6 import pwd
   7 import tempfile
   8 import threading
   9 import fcntl
  10 import commands
  11 import logger
  12 try:
  13    import sioc
  14 except:
  15    pass
  16
  17 PID_FILE = '/var/run/nm.pid'
  18
  19 def get_default_if():
  20     interface = get_if_from_hwaddr(get_hwaddr_from_plnode())
  21     if not interface: interface = "eth0"
  22     return interface
  23
  24 def get_hwaddr_from_plnode():
  25     for line in open("/usr/boot/plnode.txt", 'r').readlines():
  26         if line.startswith("NET_DEVICE"):
  27             return line.split("=")[1].strip().strip('"')
  28     return None
  29
  30 def get_if_from_hwaddr(hwaddr):
  31     devs = sioc.gifconf()
  32     for dev in devs:
  33         dev_hwaddr = sioc.gifhwaddr(dev)
  34         if dev_hwaddr == hwaddr: return dev
  35     return None
  36
  37 def as_daemon_thread(run):
  38     """Call function <run> with no arguments in its own thread."""
  39     thr = threading.Thread(target=run)
  40     thr.setDaemon(True)
  41     thr.start()
  42
  43 def close_nonstandard_fds():
  44     """Close all open file descriptors other than 0, 1, and 2."""
  45     _SC_OPEN_MAX = 4
  46     for fd in range(3, os.sysconf(_SC_OPEN_MAX)):
  47         try: os.close(fd)
  48         except OSError: pass  # most likely an fd that isn't open
  49
  50 # after http://www.erlenstar.demon.co.uk/unix/faq_2.html
  51 def daemon():
  52     """Daemonize the current process."""
  53     if os.fork() != 0: os._exit(0)
  54     os.setsid()
  55     if os.fork() != 0: os._exit(0)
  56     os.chdir('/')
  57     os.umask(0)
  58     devnull = os.open(os.devnull, os.O_RDWR)
  59     os.dup2(devnull, 0)
  60     # xxx fixme - this is just to make sure that nothing gets stupidly lost - should use devnull
  61     crashlog = os.open('/var/log/nm.daemon', os.O_RDWR | os.O_APPEND | os.O_CREAT, 0644)
  62     os.dup2(crashlog, 1)
  63     os.dup2(crashlog, 2)
  64
  65 def fork_as(su, function, *args):
  66     """fork(), cd / to avoid keeping unused directories open, close all nonstandard file descriptors (to avoid capturing open sockets), fork() again (to avoid zombies) and call <function> with arguments <args> in the grandchild process.  If <su> is not None, set our group and user ids appropriately in the child process."""
  67     child_pid = os.fork()
  68     if child_pid == 0:
  69         try:
  70             os.chdir('/')
  71             close_nonstandard_fds()
  72             if su:
  73                 pw_ent = pwd.getpwnam(su)
  74                 os.setegid(pw_ent[3])
  75                 os.seteuid(pw_ent[2])
  76             child_pid = os.fork()
  77             if child_pid == 0: function(*args)
  78         except:
  79             os.seteuid(os.getuid())  # undo su so we can write the log file
  80             os.setegid(os.getgid())
  81             logger.log_exc()
  82         os._exit(0)
  83     else: os.waitpid(child_pid, 0)
  84
  85 def pid_file():
  86     """We use a pid file to ensure that only one copy of NM is running at a given time.  If successful, this function will write a pid file containing the pid of the current process.  The return value is the pid of the other running process, or None otherwise."""
  87     other_pid = None
  88     if os.access(PID_FILE, os.F_OK):  # check for a pid file
  89         handle = open(PID_FILE)  # pid file exists, read it
  90         other_pid = int(handle.read())
  91         handle.close()
  92         # check for a process with that pid by sending signal 0
  93         try: os.kill(other_pid, 0)
  94         except OSError, e:
  95             if e.errno == errno.ESRCH: other_pid = None  # doesn't exist
  96             else: raise  # who knows
  97     if other_pid == None:
  98         # write a new pid file
  99         write_file(PID_FILE, lambda f: f.write(str(os.getpid())))
 100     return other_pid
 101
 102 def write_file(filename, do_write, **kw_args):
 103     """Write file <filename> atomically by opening a temporary file, using <do_write> to write that file, and then renaming the temporary file."""
 104     os.rename(write_temp_file(do_write, **kw_args), filename)
 105
 106 def write_temp_file(do_write, mode=None, uidgid=None):
 107     fd, temporary_filename = tempfile.mkstemp()
 108     if mode: os.chmod(temporary_filename, mode)
 109     if uidgid: os.chown(temporary_filename, *uidgid)
 110     f = os.fdopen(fd, 'w')
 111     try: do_write(f)
 112     finally: f.close()
 113     return temporary_filename
 114
 115 # utilities functions to get (cached) information from the node
 116
 117 # get node_id from /etc/planetlab/node_id and cache it
 118 _node_id=None
 119 def node_id():
 120     global _node_id
 121     if _node_id is None:
 122         try:
 123             _node_id=int(file("/etc/planetlab/node_id").read())
 124         except:
 125             _node_id=""
 126     return _node_id
 127
 128 # get slicefamily from /etc/planetlab/slicefamily and cache it
 129 # http://svn.planet-lab.org/wiki/SliceFamily
 130 _slicefamily=None
 131 def slicefamily():
 132     global _slicefamily
 133     if _slicefamily is None:
 134         try:
 135             _slicefamily=file("/etc/planetlab/slicefamily").read().strip()
 136         except:
 137             _slicefamily=""
 138     return _slicefamily
 139
 140 _root_context_arch=None
 141 def root_context_arch():
 142     global _root_context_arch
 143     if not _root_context_arch:
 144         _root_context_arch=commands.getoutput("uname -i")
 145     return _root_context_arch
 146
 147
 148 class NMLock:
 149     def __init__(self, file):
 150         logger.log("Lock %s initialized." % file, 2)
 151         self.fd = os.open(file, os.O_RDWR|os.O_CREAT, 0600)
 152         flags = fcntl.fcntl(self.fd, fcntl.F_GETFD)
 153         flags |= fcntl.FD_CLOEXEC
 154         fcntl.fcntl(self.fd, fcntl.F_SETFD, flags)
 155     def __del__(self):
 156         os.close(self.fd)
 157     def acquire(self):
 158         logger.log("Lock acquired.", 2)
 159         fcntl.lockf(self.fd, fcntl.LOCK_SH)
 160     def release(self):
 161         logger.log("Lock released.", 2)
 162         fcntl.lockf(self.fd, fcntl.LOCK_UN)