tools.py

   1 # $Id$
   2 # $URL$
   3
   4 """A few things that didn't seem to fit anywhere else."""
   5
   6 import os
   7 import pwd
   8 import tempfile
   9 import fcntl
  10 import errno
  11 import threading
  12 import subprocess
  13
  14 import logger
  15
  16 PID_FILE = '/var/run/nm.pid'
  17
  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     try:
  26         for line in open("/usr/boot/plnode.txt", 'r').readlines():
  27             if line.startswith("NET_DEVICE"):
  28                 return line.split("=")[1].strip().strip('"')
  29     except:
  30         pass
  31     return None
  32
  33 def get_if_from_hwaddr(hwaddr):
  34     import sioc
  35     devs = sioc.gifconf()
  36     for dev in devs:
  37         dev_hwaddr = sioc.gifhwaddr(dev)
  38         if dev_hwaddr == hwaddr: return dev
  39     return None
  40
  41 ####################
  42 # daemonizing
  43 def as_daemon_thread(run):
  44     """Call function <run> with no arguments in its own thread."""
  45     thr = threading.Thread(target=run)
  46     thr.setDaemon(True)
  47     thr.start()
  48
  49 def close_nonstandard_fds():
  50     """Close all open file descriptors other than 0, 1, and 2."""
  51     _SC_OPEN_MAX = 4
  52     for fd in range(3, os.sysconf(_SC_OPEN_MAX)):
  53         try: os.close(fd)
  54         except OSError: pass  # most likely an fd that isn't open
  55
  56 # after http://www.erlenstar.demon.co.uk/unix/faq_2.html
  57 def daemon():
  58     """Daemonize the current process."""
  59     if os.fork() != 0: os._exit(0)
  60     os.setsid()
  61     if os.fork() != 0: os._exit(0)
  62     os.chdir('/')
  63     os.umask(0)
  64     devnull = os.open(os.devnull, os.O_RDWR)
  65     os.dup2(devnull, 0)
  66     # xxx fixme - this is just to make sure that nothing gets stupidly lost - should use devnull
  67     crashlog = os.open('/var/log/nm.daemon', os.O_RDWR | os.O_APPEND | os.O_CREAT, 0644)
  68     os.dup2(crashlog, 1)
  69     os.dup2(crashlog, 2)
  70
  71 def fork_as(su, function, *args):
  72     """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."""
  73     child_pid = os.fork()
  74     if child_pid == 0:
  75         try:
  76             os.chdir('/')
  77             close_nonstandard_fds()
  78             if su:
  79                 pw_ent = pwd.getpwnam(su)
  80                 os.setegid(pw_ent[3])
  81                 os.seteuid(pw_ent[2])
  82             child_pid = os.fork()
  83             if child_pid == 0: function(*args)
  84         except:
  85             os.seteuid(os.getuid())  # undo su so we can write the log file
  86             os.setegid(os.getgid())
  87             logger.log_exc("tools: fork_as")
  88         os._exit(0)
  89     else: os.waitpid(child_pid, 0)
  90
  91 ####################
  92 # manage files
  93 def pid_file():
  94     """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."""
  95     other_pid = None
  96     if os.access(PID_FILE, os.F_OK):  # check for a pid file
  97         handle = open(PID_FILE)  # pid file exists, read it
  98         other_pid = int(handle.read())
  99         handle.close()
 100         # check for a process with that pid by sending signal 0
 101         try: os.kill(other_pid, 0)
 102         except OSError, e:
 103             if e.errno == errno.ESRCH: other_pid = None  # doesn't exist
 104             else: raise  # who knows
 105     if other_pid == None:
 106         # write a new pid file
 107         write_file(PID_FILE, lambda f: f.write(str(os.getpid())))
 108     return other_pid
 109
 110 def write_file(filename, do_write, **kw_args):
 111     """Write file <filename> atomically by opening a temporary file, using <do_write> to write that file, and then renaming the temporary file."""
 112     os.rename(write_temp_file(do_write, **kw_args), filename)
 113
 114 def write_temp_file(do_write, mode=None, uidgid=None):
 115     fd, temporary_filename = tempfile.mkstemp()
 116     if mode: os.chmod(temporary_filename, mode)
 117     if uidgid: os.chown(temporary_filename, *uidgid)
 118     f = os.fdopen(fd, 'w')
 119     try: do_write(f)
 120     finally: f.close()
 121     return temporary_filename
 122
 123 # replace a target file with a new contents - checks for changes
 124 # return True if a change occurred, in which case
 125 # chown/chmod settings should be taken care of
 126 def replace_file_with_string (target, new_contents):
 127     try:
 128         current=file(target).read()
 129     except:
 130         current=""
 131     # xxx if verbose, report diffs...
 132     if current==new_contents:
 133         return False
 134     # overwrite target file
 135     f=file(target,'w')
 136     f.write(new_contents)
 137     f.close()
 138     return True
 139
 140 # not needed yet - should that unlink the new file ?
 141 #def replace_file_with_file (target, new):
 142 #    return replace_file_with_string (target, file(new).read())
 143
 144 ####################
 145 # utilities functions to get (cached) information from the node
 146
 147 # get node_id from /etc/planetlab/node_id and cache it
 148 _node_id=None
 149 def node_id():
 150     global _node_id
 151     if _node_id is None:
 152         try:
 153             _node_id=int(file("/etc/planetlab/node_id").read())
 154         except:
 155             _node_id=""
 156     return _node_id
 157
 158 _root_context_arch=None
 159 def root_context_arch():
 160     global _root_context_arch
 161     if not _root_context_arch:
 162         sp=subprocess.Popen(["uname","-i"],stdout=subprocess.PIPE)
 163         (_root_context_arch,_)=sp.communicate()
 164         _root_context_arch=_root_context_arch.strip()
 165     return _root_context_arch
 166
 167
 168 ####################
 169 class NMLock:
 170     def __init__(self, file):
 171         logger.log("tools: Lock %s initialized." % file, 2)
 172         self.fd = os.open(file, os.O_RDWR|os.O_CREAT, 0600)
 173         flags = fcntl.fcntl(self.fd, fcntl.F_GETFD)
 174         flags |= fcntl.FD_CLOEXEC
 175         fcntl.fcntl(self.fd, fcntl.F_SETFD, flags)
 176     def __del__(self):
 177         os.close(self.fd)
 178     def acquire(self):
 179         logger.log("tools: Lock acquired.", 2)
 180         fcntl.lockf(self.fd, fcntl.LOCK_SH)
 181     def release(self):
 182         logger.log("tools: Lock released.", 2)
 183         fcntl.lockf(self.fd, fcntl.LOCK_UN)