python/vserver.py

   1 # Copyright 2005 Princeton University
   2
   3 import errno
   4 import fcntl
   5 import os
   6 import re
   7 import sys
   8 import time
   9 import traceback
  10
  11 import mountimpl
  12 import passfdimpl
  13 import utmp
  14 import vserverimpl, vduimpl
  15 import cpulimit, bwlimit
  16
  17
  18
  19 #
  20 # these are the flags taken from the kernel linux/vserver/legacy.h
  21 #
  22 FLAGS_LOCK = 1
  23 FLAGS_SCHED = 2  # XXX - defined in util-vserver/src/chcontext.c
  24 FLAGS_NPROC = 4
  25 FLAGS_PRIVATE = 8
  26 FLAGS_INIT = 16
  27 FLAGS_HIDEINFO = 32
  28 FLAGS_ULIMIT = 64
  29 FLAGS_NAMESPACE = 128
  30
  31 # default values for new vserver scheduler
  32 SCHED_TOKENS_MIN = 50
  33 SCHED_TOKENS_MAX = 100
  34 SCHED_TOKENS = 100
  35 SCHED_INTERVAL = 1000
  36
  37
  38 class VServer:
  39
  40     INITSCRIPTS = [('/etc/rc.vinit', 'start'),
  41                    ('/etc/rc.d/rc', '%(runlevel)d')]
  42
  43     def __init__(self, name, disk_usage_set = False):
  44
  45         self.name = name
  46         self.config_file = "/etc/vservers/%s.conf" % name
  47         self.dir = "%s/%s" % (vserverimpl.VSERVER_BASEDIR, name)
  48         if not (os.path.isdir(self.dir) and
  49                 os.access(self.dir, os.R_OK | os.W_OK | os.X_OK)):
  50             raise Exception, "no such vserver: " + name
  51         self.config = self.__read_config_file("/etc/vservers.conf")
  52         self.config.update(self.__read_config_file(self.config_file))
  53         self.flags = 0
  54         flags = self.config["S_FLAGS"].split(" ")
  55         if "lock" in flags:
  56             self.flags |= FLAGS_LOCK
  57         if "nproc" in flags:
  58             self.flags |= FLAGS_NPROC
  59         self.remove_caps = ~vserverimpl.CAP_SAFE;
  60         self.ctx = int(self.config["S_CONTEXT"])
  61         self.disk_usage_set = disk_usage_set
  62
  63     config_var_re = re.compile(r"^ *([A-Z_]+)=(.*)\n?$", re.MULTILINE)
  64
  65     def __read_config_file(self, filename):
  66
  67         f = open(filename, "r")
  68         data = f.read()
  69         f.close()
  70         config = {}
  71         for m in self.config_var_re.finditer(data):
  72             (key, val) = m.groups()
  73             config[key] = val.strip('"')
  74         return config
  75
  76     def __update_config_file(self, filename, newvars):
  77
  78         # read old file, apply changes
  79         f = open(filename, "r")
  80         data = f.read()
  81         f.close()
  82         todo = newvars.copy()
  83         changed = False
  84         for m in self.config_var_re.finditer(data):
  85             (key, val) = m.groups()
  86             newval = todo.pop(key, None)
  87             if newval != None:
  88                 data = data[:m.start(2)] + str(newval) + data[m.end(2):]
  89                 changed = True
  90         for (newkey, newval) in todo.items():
  91             data += "%s=%s\n" % (newkey, newval)
  92             changed = True
  93
  94         if not changed:
  95             return
  96
  97         # write new file
  98         newfile = filename + ".new"
  99         f = open(newfile, "w")
 100         f.write(data)
 101         f.close()
 102
 103         # 'copy' original file, rename new to original
 104         backup = filename + ".old"
 105         try:
 106             os.unlink(backup)
 107         except OSError, ex:
 108             if ex.errno != errno.ENOENT:
 109                 raise
 110         os.link(filename, backup)
 111         os.rename(newfile, filename)
 112
 113     def __do_chroot(self):
 114
 115         os.chroot(self.dir)
 116         os.chdir("/")
 117
 118     def set_disklimit(self, block_limit):
 119
 120         # block_limit is in kB
 121         if self.disk_usage_set:
 122             block_usage = vserverimpl.DLIMIT_KEEP
 123             inode_usage = vserverimpl.DLIMIT_KEEP
 124         else:
 125             # init_disk_info() must have been called to get usage values
 126             block_usage = self.disk_blocks
 127             inode_usage = self.disk_inodes
 128             if block_limit < block_usage:
 129                 raise Exception, ("%s disk usage (%u blocks) > limit (%u)" %
 130                                   (self.name, block_usage, block_limit))
 131             self.disk_usage_set = True
 132
 133         vserverimpl.setdlimit(self.dir,
 134                               self.ctx,
 135                               block_usage,
 136                               block_limit,
 137                               inode_usage,
 138                               vserverimpl.DLIMIT_INF,  # inode limit
 139                               2)   # %age reserved for root
 140
 141     def get_disklimit(self):
 142
 143         try:
 144             blocksused, blocktotal, inodesused, inodestotal, reserved = \
 145                         vserverimpl.getdlimit(self.dir, self.ctx)
 146         except OSError, ex:
 147             if ex.errno == errno.ESRCH:
 148                 # get here if no vserver disk limit has been set for xid
 149                 # set blockused to -1 to indicate no limit
 150                 blocktotal = -1
 151
 152         return blocktotal
 153
 154     def set_sched(self, shares = 32, besteffort = True):
 155         # for the old CKRM scheduler
 156         if cpulimit.checkckrm() is True:
 157             cpulimit.cpuinit()
 158             cpulimit.vs2ckrm_on(self.name)
 159             try:
 160                 cpulimit.cpulimit(self.name,shares)
 161             except OSError, ex:
 162                 if ex.errno == 22:
 163                     print "invalid shares argument"
 164                     # should re-raise exception?!
 165
 166         # for the new vserver scheduler
 167         else:
 168             global SCHED_TOKENS_MIN, SCHED_TOKENS_MAX, SCHED_TOKENS, SCHED_INTERVAL
 169             tokensmin = SCHED_TOKENS_MIN
 170             tokensmax = SCHED_TOKENS_MAX
 171             tokens    = SCHED_TOKENS
 172             interval  = SCHED_INTERVAL
 173             fillrate = shares
 174
 175             if besteffort is True:
 176                 cpuguaranteed = 0
 177             else:
 178                 cpuguaranteed = 1
 179
 180             try:
 181                 vserverimpl.setsched(self.ctx,fillrate,interval,tokens,tokensmin,tokensmax,cpuguaranteed)
 182             except OSError, ex:
 183                 if ex.errno == 22:
 184                     print "kernel does not support vserver scheduler"
 185                 else:
 186                     raise ex
 187
 188     def get_sched(self):
 189         # have no way of querying scheduler right now on a per vserver basis
 190         return (-1, False)
 191
 192     def set_memlimit(self, limit):
 193         ret = vserverimpl.setrlimit(self.ctx,5,limit)
 194         return ret
 195
 196     def get_memlimit(self):
 197         ret = vserverimpl.getrlimit(self.ctx,5)
 198         return ret
 199
 200     def set_tasklimit(self, limit):
 201         ret = vserverimpl.setrlimit(self.ctx,6,limit)
 202         return ret
 203
 204     def get_tasklimit(self):
 205         ret = vserverimpl.getrlimit(self.ctx,6)
 206         return ret
 207
 208     def set_bwlimit(self, eth, limit, cap, minrate, maxrate):
 209         if cap == "-1":
 210             bwlimit.off(self.ctx,eth)
 211         else:
 212             bwlimit.on(self.ctx, eth, limit, cap, minrate, maxrate)
 213
 214     def get_bwlimit(self, eth):
 215         # not implemented yet
 216         bwlimit = -1
 217         cap = "unknown"
 218         minrate = "unknown"
 219         maxrate = "unknown"
 220         return (bwlimit, cap, minrate, maxrate)
 221
 222     def open(self, filename, mode = "r", bufsize = -1):
 223
 224         (sendsock, recvsock) = passfdimpl.socketpair()
 225         child_pid = os.fork()
 226         if child_pid == 0:
 227             try:
 228                 # child process
 229                 self.__do_chroot()
 230                 f = open(filename, mode)
 231                 passfdimpl.sendmsg(f.fileno(), sendsock)
 232                 os._exit(0)
 233             except EnvironmentError, ex:
 234                 (result, errmsg) = (ex.errno, ex.strerror)
 235             except Exception, ex:
 236                 (result, errmsg) = (255, str(ex))
 237             os.write(sendsock, errmsg)
 238             os._exit(result)
 239
 240         # parent process
 241
 242         # XXX - need this since a lambda can't raise an exception
 243         def __throw(ex):
 244             raise ex
 245
 246         os.close(sendsock)
 247         throw = lambda : __throw(Exception(errmsg))
 248         while True:
 249             try:
 250                 (pid, status) = os.waitpid(child_pid, 0)
 251                 if os.WIFEXITED(status):
 252                     result = os.WEXITSTATUS(status)
 253                     if result != 255:
 254                         errmsg = os.strerror(result)
 255                         throw = lambda : __throw(IOError(result, errmsg))
 256                     else:
 257                         errmsg = "unexpected exception in child"
 258                 else:
 259                     result = -1
 260                     errmsg = "child killed"
 261                 break
 262             except OSError, ex:
 263                 if ex.errno != errno.EINTR:
 264                     os.close(recvsock)
 265                     raise ex
 266         fcntl.fcntl(recvsock, fcntl.F_SETFL, os.O_NONBLOCK)
 267         try:
 268             (fd, errmsg) = passfdimpl.recvmsg(recvsock)
 269         except OSError, ex:
 270             if ex.errno != errno.EAGAIN:
 271                 throw = lambda : __throw(ex)
 272             fd = 0
 273         os.close(recvsock)
 274         if not fd:
 275             throw()
 276
 277         return os.fdopen(fd, mode, bufsize)
 278
 279     def __do_chcontext(self, state_file = None):
 280
 281         vserverimpl.chcontext(self.ctx)
 282
 283         if not state_file:
 284             return
 285         print >>state_file, "S_CONTEXT=%d" % self.ctx
 286         print >>state_file, "S_PROFILE=%s" % self.config.get("S_PROFILE", "")
 287         state_file.close()
 288
 289     def __prep(self, runlevel, log):
 290
 291         """ Perform all the crap that the vserver script does before
 292         actually executing the startup scripts. """
 293
 294         # remove /var/run and /var/lock/subsys files
 295         # but don't remove utmp from the top-level /var/run
 296         RUNDIR = "/var/run"
 297         LOCKDIR = "/var/lock/subsys"
 298         filter_fn = lambda fs: filter(lambda f: f != 'utmp', fs)
 299         garbage = reduce((lambda (out, ff), (dir, subdirs, files):
 300                           (out + map((dir + "/").__add__, ff(files)),
 301                            lambda fs: fs)),
 302                          list(os.walk(RUNDIR)),
 303                          ([], filter_fn))[0]
 304         garbage += filter(os.path.isfile, map((LOCKDIR + "/").__add__,
 305                                               os.listdir(LOCKDIR)))
 306         for f in garbage:
 307             os.unlink(f)
 308
 309         # set the initial runlevel
 310         f = open(RUNDIR + "/utmp", "w")
 311         utmp.set_runlevel(f, runlevel)
 312         f.close()
 313
 314         # mount /proc and /dev/pts
 315         self.__do_mount("none", "/proc", "proc")
 316         # XXX - magic mount options
 317         self.__do_mount("none", "/dev/pts", "devpts", 0, "gid=5,mode=0620")
 318
 319     def __do_mount(self, *mount_args):
 320
 321         try:
 322             mountimpl.mount(*mount_args)
 323         except OSError, ex:
 324             if ex.errno == errno.EBUSY:
 325                 # assume already mounted
 326                 return
 327             raise ex
 328
 329     def enter(self):
 330
 331         state_file = open("/var/run/vservers/%s.ctx" % self.name, "w")
 332         self.__do_chroot()
 333         self.__do_chcontext(state_file)
 334
 335     def start(self, wait, runlevel = 3):
 336
 337         # XXX - temporary hack
 338         self.set_disklimit(int(self.config.get("DISKLIMIT", 5000000)))
 339
 340         child_pid = os.fork()
 341         if child_pid == 0:
 342             # child process
 343             try:
 344                 # get a new session
 345                 os.setsid()
 346
 347                 # open state file to record vserver info
 348                 state_file = open("/var/run/vservers/%s.ctx" % self.name, "w")
 349
 350                 # use /dev/null for stdin, /var/log/boot.log for stdout/err
 351                 os.close(0)
 352                 os.close(1)
 353                 os.open("/dev/null", os.O_RDONLY)
 354                 self.__do_chroot()
 355                 log = open("/var/log/boot.log", "w", 0)
 356                 os.dup2(1, 2)
 357                 # XXX - close all other fds
 358
 359                 print >>log, ("%s: starting the virtual server %s" %
 360                               (time.asctime(time.gmtime()), self.name))
 361
 362                 # perform pre-init cleanup
 363                 self.__prep(runlevel, log)
 364
 365                 # execute each init script in turn
 366                 # XXX - we don't support all scripts that vserver script does
 367                 cmd_pid = 0
 368                 first_child = True
 369                 for cmd in self.INITSCRIPTS + [None]:
 370                     # wait for previous command to terminate, unless it
 371                     # is the last one and the caller has specified to wait
 372                     if cmd_pid and (cmd != None or wait):
 373                         try:
 374                             os.waitpid(cmd_pid, 0)
 375                         except:
 376                             print >>log, "error waiting for %s:" % cmd_pid
 377                             traceback.print_exc()
 378
 379                     # end of list
 380                     if cmd == None:
 381                         os._exit(0)
 382
 383                     # fork and exec next command
 384                     cmd_pid = os.fork()
 385                     if cmd_pid == 0:
 386                         try:
 387                             # enter vserver context
 388                             self.__do_chcontext(state_file)
 389                             arg_subst = { 'runlevel': runlevel }
 390                             cmd_args = [cmd[0]] + map(lambda x: x % arg_subst,
 391                                                       cmd[1:])
 392                             print >>log, "executing '%s'" % " ".join(cmd_args)
 393                             os.execl(cmd[0], *cmd_args)
 394                         except:
 395                             traceback.print_exc()
 396                             os._exit(1)
 397                     else:
 398                         # don't want to write state_file multiple times
 399                         state_file = None
 400
 401             # we get here due to an exception in the top-level child process
 402             except Exception, ex:
 403                 traceback.print_exc()
 404             os._exit(0)
 405
 406         # parent process
 407         return child_pid
 408
 409     def update_resources(self, resources):
 410
 411         self.config.update(resources)
 412
 413         # write new values to configuration file
 414         self.__update_config_file(self.config_file, resources)
 415
 416         # disklimit can be applied without a process in context
 417         disklimit = resources.get("DISKLIMIT", 0)
 418         if disklimit:
 419             self.set_disklimit(disklimit)
 420
 421         #
 422         # Figure out if any processes are active in context, apply new
 423         # values if there are.
 424         #
 425
 426     def init_disk_info(self):
 427
 428         (self.disk_inodes, self.disk_blocks, size) = vduimpl.vdu(self.dir)
 429
 430         return size