utils.py 55.7 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#

# Copyright (C) 2006, 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


22
23
24
25
"""Ganeti utility module.

This module holds functions that can be used in both daemons (all) and
the command line scripts.
26

Iustin Pop's avatar
Iustin Pop committed
27
28
29
30
31
32
"""


import sys
import os
import time
33
import subprocess
Iustin Pop's avatar
Iustin Pop committed
34
35
36
37
import re
import socket
import tempfile
import shutil
38
import errno
39
import pwd
Guido Trotter's avatar
Guido Trotter committed
40
import itertools
41
42
import select
import fcntl
43
import resource
44
import logging
Michael Hanselmann's avatar
Michael Hanselmann committed
45
import signal
46
47

from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
48

49
50
51
52
53
54
try:
  from hashlib import sha1
except ImportError:
  import sha
  sha1 = sha.new

Iustin Pop's avatar
Iustin Pop committed
55
from ganeti import errors
Iustin Pop's avatar
Iustin Pop committed
56
from ganeti import constants
Iustin Pop's avatar
Iustin Pop committed
57

58

Iustin Pop's avatar
Iustin Pop committed
59
60
61
_locksheld = []
_re_shell_unquoted = re.compile('^[-.,=:/_+@A-Za-z0-9]+$')

62
debug = False
63
debug_locks = False
64
65

#: when set to True, L{RunCmd} is disabled
66
no_fork = False
67

68

Iustin Pop's avatar
Iustin Pop committed
69
class RunResult(object):
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
  """Holds the result of running external programs.

  @type exit_code: int
  @ivar exit_code: the exit code of the program, or None (if the program
      didn't exit())
  @type signal: int or None
  @ivar signal: the signal that caused the program to finish, or None
      (if the program wasn't terminated by a signal)
  @type stdout: str
  @ivar stdout: the standard output of the program
  @type stderr: str
  @ivar stderr: the standard error of the program
  @type failed: boolean
  @ivar failed: True in case the program was
      terminated by a signal or exited with a non-zero exit code
  @ivar fail_reason: a string detailing the termination reason
Iustin Pop's avatar
Iustin Pop committed
86
87
88
89
90
91

  """
  __slots__ = ["exit_code", "signal", "stdout", "stderr",
               "failed", "fail_reason", "cmd"]


Iustin Pop's avatar
Iustin Pop committed
92
  def __init__(self, exit_code, signal_, stdout, stderr, cmd):
Iustin Pop's avatar
Iustin Pop committed
93
94
    self.cmd = cmd
    self.exit_code = exit_code
Iustin Pop's avatar
Iustin Pop committed
95
    self.signal = signal_
Iustin Pop's avatar
Iustin Pop committed
96
97
    self.stdout = stdout
    self.stderr = stderr
Iustin Pop's avatar
Iustin Pop committed
98
    self.failed = (signal_ is not None or exit_code != 0)
Iustin Pop's avatar
Iustin Pop committed
99
100
101
102
103
104
105
106

    if self.signal is not None:
      self.fail_reason = "terminated by signal %s" % self.signal
    elif self.exit_code is not None:
      self.fail_reason = "exited with exit code %s" % self.exit_code
    else:
      self.fail_reason = "unable to determine termination reason"

107
108
109
    if self.failed:
      logging.debug("Command '%s' failed (%s); output: %s",
                    self.cmd, self.fail_reason, self.output)
110

Iustin Pop's avatar
Iustin Pop committed
111
112
113
114
115
116
117
118
119
  def _GetOutput(self):
    """Returns the combined stdout and stderr for easier usage.

    """
    return self.stdout + self.stderr

  output = property(_GetOutput, None, None, "Return full output")


120
def RunCmd(cmd, env=None, output=None, cwd='/'):
Iustin Pop's avatar
Iustin Pop committed
121
122
123
124
125
  """Execute a (shell) command.

  The command should not read from its standard input, as it will be
  closed.

126
  @type  cmd: string or list
127
  @param cmd: Command to run
128
  @type env: dict
129
  @param env: Additional environment
130
  @type output: str
131
  @param output: if desired, the output of the command can be
132
133
      saved in a file instead of the RunResult instance; this
      parameter denotes the file name (if not None)
134
135
136
  @type cwd: string
  @param cwd: if specified, will be used as the working
      directory for the command; the default will be /
137
  @rtype: L{RunResult}
138
139
  @return: RunResult instance
  @raise erors.ProgrammerError: if we call this when forks are disabled
Iustin Pop's avatar
Iustin Pop committed
140
141

  """
142
143
144
  if no_fork:
    raise errors.ProgrammerError("utils.RunCmd() called with fork() disabled")

Iustin Pop's avatar
Iustin Pop committed
145
146
  if isinstance(cmd, list):
    cmd = [str(val) for val in cmd]
147
148
149
150
151
    strcmd = " ".join(cmd)
    shell = False
  else:
    strcmd = cmd
    shell = True
152
  logging.debug("RunCmd '%s'", strcmd)
153
154
155
156
157
158

  cmd_env = os.environ.copy()
  cmd_env["LC_ALL"] = "C"
  if env is not None:
    cmd_env.update(env)

159
160
161
162
163
164
165
166
167
168
169
170
  try:
    if output is None:
      out, err, status = _RunCmdPipe(cmd, cmd_env, shell, cwd)
    else:
      status = _RunCmdFile(cmd, cmd_env, shell, output, cwd)
      out = err = ""
  except OSError, err:
    if err.errno == errno.ENOENT:
      raise errors.OpExecError("Can't execute '%s': not found (%s)" %
                               (strcmd, err))
    else:
      raise
171
172
173
174
175
176
177
178
179
180

  if status >= 0:
    exitcode = status
    signal_ = None
  else:
    exitcode = None
    signal_ = -status

  return RunResult(exitcode, signal_, out, err, strcmd)

181

182
def _RunCmdPipe(cmd, env, via_shell, cwd):
183
184
185
186
187
188
189
190
  """Run a command and return its output.

  @type  cmd: string or list
  @param cmd: Command to run
  @type env: dict
  @param env: The environment to use
  @type via_shell: bool
  @param via_shell: if we should run via the shell
191
192
  @type cwd: string
  @param cwd: the working directory for the program
193
194
195
196
  @rtype: tuple
  @return: (out, err, status)

  """
197
  poller = select.poll()
198
  child = subprocess.Popen(cmd, shell=via_shell,
199
200
201
                           stderr=subprocess.PIPE,
                           stdout=subprocess.PIPE,
                           stdin=subprocess.PIPE,
202
203
                           close_fds=True, env=env,
                           cwd=cwd)
204
205

  child.stdin.close()
206
207
208
209
210
211
212
213
214
215
216
217
218
  poller.register(child.stdout, select.POLLIN)
  poller.register(child.stderr, select.POLLIN)
  out = StringIO()
  err = StringIO()
  fdmap = {
    child.stdout.fileno(): (out, child.stdout),
    child.stderr.fileno(): (err, child.stderr),
    }
  for fd in fdmap:
    status = fcntl.fcntl(fd, fcntl.F_GETFL)
    fcntl.fcntl(fd, fcntl.F_SETFL, status | os.O_NONBLOCK)

  while fdmap:
219
220
221
222
223
224
225
226
227
228
229
230
    try:
      pollresult = poller.poll()
    except EnvironmentError, eerr:
      if eerr.errno == errno.EINTR:
        continue
      raise
    except select.error, serr:
      if serr[0] == errno.EINTR:
        continue
      raise

    for fd, event in pollresult:
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
      if event & select.POLLIN or event & select.POLLPRI:
        data = fdmap[fd][1].read()
        # no data from read signifies EOF (the same as POLLHUP)
        if not data:
          poller.unregister(fd)
          del fdmap[fd]
          continue
        fdmap[fd][0].write(data)
      if (event & select.POLLNVAL or event & select.POLLHUP or
          event & select.POLLERR):
        poller.unregister(fd)
        del fdmap[fd]

  out = out.getvalue()
  err = err.getvalue()
Iustin Pop's avatar
Iustin Pop committed
246
247

  status = child.wait()
248
  return out, err, status
Iustin Pop's avatar
Iustin Pop committed
249

250

251
def _RunCmdFile(cmd, env, via_shell, output, cwd):
252
253
254
255
256
257
258
259
260
261
  """Run a command and save its output to a file.

  @type  cmd: string or list
  @param cmd: Command to run
  @type env: dict
  @param env: The environment to use
  @type via_shell: bool
  @param via_shell: if we should run via the shell
  @type output: str
  @param output: the filename in which to save the output
262
263
  @type cwd: string
  @param cwd: the working directory for the program
264
265
266
267
268
269
270
271
272
273
  @rtype: int
  @return: the exit status

  """
  fh = open(output, "a")
  try:
    child = subprocess.Popen(cmd, shell=via_shell,
                             stderr=subprocess.STDOUT,
                             stdout=fh,
                             stdin=subprocess.PIPE,
274
275
                             close_fds=True, env=env,
                             cwd=cwd)
276
277
278
279
280
281

    child.stdin.close()
    status = child.wait()
  finally:
    fh.close()
  return status
Iustin Pop's avatar
Iustin Pop committed
282
283
284
285
286
287
288
289


def RemoveFile(filename):
  """Remove a file ignoring some errors.

  Remove a file, ignoring non-existing ones or directories. Other
  errors are passed.

290
291
292
  @type filename: str
  @param filename: the file to be removed

Iustin Pop's avatar
Iustin Pop committed
293
294
295
296
  """
  try:
    os.unlink(filename)
  except OSError, err:
297
    if err.errno not in (errno.ENOENT, errno.EISDIR):
Iustin Pop's avatar
Iustin Pop committed
298
299
300
      raise


301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
def RenameFile(old, new, mkdir=False, mkdir_mode=0750):
  """Renames a file.

  @type old: string
  @param old: Original path
  @type new: string
  @param new: New path
  @type mkdir: bool
  @param mkdir: Whether to create target directory if it doesn't exist
  @type mkdir_mode: int
  @param mkdir_mode: Mode for newly created directories

  """
  try:
    return os.rename(old, new)
  except OSError, err:
    # In at least one use case of this function, the job queue, directory
    # creation is very rare. Checking for the directory before renaming is not
    # as efficient.
    if mkdir and err.errno == errno.ENOENT:
      # Create directory and try again
      os.makedirs(os.path.dirname(new), mkdir_mode)
      return os.rename(old, new)
    raise


Iustin Pop's avatar
Iustin Pop committed
327
328
329
330
331
332
def _FingerprintFile(filename):
  """Compute the fingerprint of a file.

  If the file does not exist, a None will be returned
  instead.

333
334
335
336
337
  @type filename: str
  @param filename: the filename to checksum
  @rtype: str
  @return: the hex digest of the sha checksum of the contents
      of the file
Iustin Pop's avatar
Iustin Pop committed
338
339
340
341
342
343
344

  """
  if not (os.path.exists(filename) and os.path.isfile(filename)):
    return None

  f = open(filename)

345
  fp = sha1()
Iustin Pop's avatar
Iustin Pop committed
346
347
348
349
350
351
352
353
354
355
356
357
358
  while True:
    data = f.read(4096)
    if not data:
      break

    fp.update(data)

  return fp.hexdigest()


def FingerprintFiles(files):
  """Compute fingerprints for a list of files.

359
360
361
362
363
  @type files: list
  @param files: the list of filename to fingerprint
  @rtype: dict
  @return: a dictionary filename: fingerprint, holding only
      existing files
Iustin Pop's avatar
Iustin Pop committed
364
365
366
367
368
369
370
371
372
373
374
375

  """
  ret = {}

  for filename in files:
    cksum = _FingerprintFile(filename)
    if cksum:
      ret[filename] = cksum

  return ret


376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
def ForceDictType(target, key_types, allowed_values=None):
  """Force the values of a dict to have certain types.

  @type target: dict
  @param target: the dict to update
  @type key_types: dict
  @param key_types: dict mapping target dict keys to types
                    in constants.ENFORCEABLE_TYPES
  @type allowed_values: list
  @keyword allowed_values: list of specially allowed values

  """
  if allowed_values is None:
    allowed_values = []

  for key in target:
    if key not in key_types:
      msg = "Unknown key '%s'" % key
      raise errors.TypeEnforcementError(msg)

    if target[key] in allowed_values:
      continue

Iustin Pop's avatar
Iustin Pop committed
399
400
401
    ktype = key_types[key]
    if ktype not in constants.ENFORCEABLE_TYPES:
      msg = "'%s' has non-enforceable type %s" % (key, ktype)
402
403
      raise errors.ProgrammerError(msg)

Iustin Pop's avatar
Iustin Pop committed
404
    if ktype == constants.VTYPE_STRING:
405
406
407
408
409
410
      if not isinstance(target[key], basestring):
        if isinstance(target[key], bool) and not target[key]:
          target[key] = ''
        else:
          msg = "'%s' (value %s) is not a valid string" % (key, target[key])
          raise errors.TypeEnforcementError(msg)
Iustin Pop's avatar
Iustin Pop committed
411
    elif ktype == constants.VTYPE_BOOL:
412
413
414
415
416
417
418
419
420
421
422
423
      if isinstance(target[key], basestring) and target[key]:
        if target[key].lower() == constants.VALUE_FALSE:
          target[key] = False
        elif target[key].lower() == constants.VALUE_TRUE:
          target[key] = True
        else:
          msg = "'%s' (value %s) is not a valid boolean" % (key, target[key])
          raise errors.TypeEnforcementError(msg)
      elif target[key]:
        target[key] = True
      else:
        target[key] = False
Iustin Pop's avatar
Iustin Pop committed
424
    elif ktype == constants.VTYPE_SIZE:
425
426
427
428
429
430
      try:
        target[key] = ParseUnit(target[key])
      except errors.UnitParseError, err:
        msg = "'%s' (value %s) is not a valid size. error: %s" % \
              (key, target[key], err)
        raise errors.TypeEnforcementError(msg)
Iustin Pop's avatar
Iustin Pop committed
431
    elif ktype == constants.VTYPE_INT:
432
433
434
435
436
437
438
      try:
        target[key] = int(target[key])
      except (ValueError, TypeError):
        msg = "'%s' (value %s) is not a valid integer" % (key, target[key])
        raise errors.TypeEnforcementError(msg)


Iustin Pop's avatar
Iustin Pop committed
439
440
441
def IsProcessAlive(pid):
  """Check if a given pid exists on the system.

442
443
  @note: zombie status is not handled, so zombie processes
      will be returned as alive
444
445
446
447
  @type pid: int
  @param pid: the process ID to check
  @rtype: boolean
  @return: True if the process exists
Iustin Pop's avatar
Iustin Pop committed
448
449

  """
450
451
452
  if pid <= 0:
    return False

Iustin Pop's avatar
Iustin Pop committed
453
  try:
454
455
456
    os.stat("/proc/%d/status" % pid)
    return True
  except EnvironmentError, err:
457
    if err.errno in (errno.ENOENT, errno.ENOTDIR):
Iustin Pop's avatar
Iustin Pop committed
458
      return False
459
    raise
Iustin Pop's avatar
Iustin Pop committed
460
461


462
def ReadPidFile(pidfile):
463
  """Read a pid from a file.
464

465
466
467
  @type  pidfile: string
  @param pidfile: path to the file containing the pid
  @rtype: int
468
  @return: The process id, if the file exists and contains a valid PID,
469
           otherwise 0
470
471
472
473

  """
  try:
    pf = open(pidfile, 'r')
474
475
476
477
  except EnvironmentError, err:
    if err.errno != errno.ENOENT:
      logging.exception("Can't read pid file?!")
    return 0
478
479
480

  try:
    pid = int(pf.read())
481
  except ValueError, err:
482
    logging.info("Can't parse pid file contents", exc_info=True)
483
    return 0
484

485
  return pid
486
487


Iustin Pop's avatar
Iustin Pop committed
488
489
490
491
def MatchNameComponent(key, name_list):
  """Try to match a name against a list.

  This function will try to match a name like test1 against a list
492
493
494
495
496
  like C{['test1.example.com', 'test2.example.com', ...]}. Against
  this list, I{'test1'} as well as I{'test1.example'} will match, but
  not I{'test1.ex'}. A multiple match will be considered as no match
  at all (e.g. I{'test1'} against C{['test1.example.com',
  'test1.example.org']}).
Iustin Pop's avatar
Iustin Pop committed
497

498
499
500
501
  @type key: str
  @param key: the name to be searched
  @type name_list: list
  @param name_list: the list of strings against which to search the key
Iustin Pop's avatar
Iustin Pop committed
502

503
504
505
  @rtype: None or str
  @return: None if there is no match I{or} if there are multiple matches,
      otherwise the element from the list which matches
Iustin Pop's avatar
Iustin Pop committed
506
507
508
509
510
511
512
513
514

  """
  mo = re.compile("^%s(\..*)?$" % re.escape(key))
  names_filtered = [name for name in name_list if mo.match(name) is not None]
  if len(names_filtered) != 1:
    return None
  return names_filtered[0]


515
class HostInfo:
516
  """Class implementing resolver and hostname functionality
517
518

  """
519
  def __init__(self, name=None):
520
521
    """Initialize the host name object.

522
523
    If the name argument is not passed, it will use this system's
    name.
524
525

    """
526
527
528
529
530
    if name is None:
      name = self.SysName()

    self.query = name
    self.name, self.aliases, self.ipaddrs = self.LookupHostname(name)
531
532
    self.ip = self.ipaddrs[0]

533
534
535
536
537
538
  def ShortName(self):
    """Returns the hostname without domain.

    """
    return self.name.split('.')[0]

539
540
541
  @staticmethod
  def SysName():
    """Return the current system's name.
542

543
    This is simply a wrapper over C{socket.gethostname()}.
Iustin Pop's avatar
Iustin Pop committed
544

545
546
    """
    return socket.gethostname()
Iustin Pop's avatar
Iustin Pop committed
547

548
549
550
  @staticmethod
  def LookupHostname(hostname):
    """Look up hostname
Iustin Pop's avatar
Iustin Pop committed
551

552
553
    @type hostname: str
    @param hostname: hostname to look up
554

555
556
557
558
    @rtype: tuple
    @return: a tuple (name, aliases, ipaddrs) as returned by
        C{socket.gethostbyname_ex}
    @raise errors.ResolverError: in case of errors in resolving
559
560
561
562
563
564
565

    """
    try:
      result = socket.gethostbyname_ex(hostname)
    except socket.gaierror, err:
      # hostname not found in DNS
      raise errors.ResolverError(hostname, err.args[0], err.args[1])
Iustin Pop's avatar
Iustin Pop committed
566

567
    return result
Iustin Pop's avatar
Iustin Pop committed
568
569
570
571
572


def ListVolumeGroups():
  """List volume groups and their size

573
574
575
576
  @rtype: dict
  @return:
       Dictionary with keys volume name and values
       the size of the volume
Iustin Pop's avatar
Iustin Pop committed
577
578
579
580
581
582
583
584
585
586
587
588
589

  """
  command = "vgs --noheadings --units m --nosuffix -o name,size"
  result = RunCmd(command)
  retval = {}
  if result.failed:
    return retval

  for line in result.stdout.splitlines():
    try:
      name, size = line.split()
      size = int(float(size))
    except (IndexError, ValueError), err:
590
      logging.error("Invalid output from vgs (%s): %s", err, line)
Iustin Pop's avatar
Iustin Pop committed
591
592
593
594
595
596
597
598
599
600
      continue

    retval[name] = size

  return retval


def BridgeExists(bridge):
  """Check whether the given bridge exists in the system

601
602
603
604
  @type bridge: str
  @param bridge: the bridge name to check
  @rtype: boolean
  @return: True if it does
Iustin Pop's avatar
Iustin Pop committed
605
606
607
608
609
610
611
612

  """
  return os.path.isdir("/sys/class/net/%s/bridge" % bridge)


def NiceSort(name_list):
  """Sort a list of strings based on digit and non-digit groupings.

613
614
615
  Given a list of names C{['a1', 'a10', 'a11', 'a2']} this function
  will sort the list in the logical order C{['a1', 'a2', 'a10',
  'a11']}.
Iustin Pop's avatar
Iustin Pop committed
616
617
618
619
620

  The sort algorithm breaks each name in groups of either only-digits
  or no-digits. Only the first eight such groups are considered, and
  after that we just use what's left of the string.

621
622
623
624
  @type name_list: list
  @param name_list: the names to be sorted
  @rtype: list
  @return: a copy of the name list sorted with our algorithm
Iustin Pop's avatar
Iustin Pop committed
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649

  """
  _SORTER_BASE = "(\D+|\d+)"
  _SORTER_FULL = "^%s%s?%s?%s?%s?%s?%s?%s?.*$" % (_SORTER_BASE, _SORTER_BASE,
                                                  _SORTER_BASE, _SORTER_BASE,
                                                  _SORTER_BASE, _SORTER_BASE,
                                                  _SORTER_BASE, _SORTER_BASE)
  _SORTER_RE = re.compile(_SORTER_FULL)
  _SORTER_NODIGIT = re.compile("^\D*$")
  def _TryInt(val):
    """Attempts to convert a variable to integer."""
    if val is None or _SORTER_NODIGIT.match(val):
      return val
    rval = int(val)
    return rval

  to_sort = [([_TryInt(grp) for grp in _SORTER_RE.match(name).groups()], name)
             for name in name_list]
  to_sort.sort()
  return [tup[1] for tup in to_sort]


def TryConvert(fn, val):
  """Try to convert a value ignoring errors.

650
651
652
653
654
655
656
657
658
659
  This function tries to apply function I{fn} to I{val}. If no
  C{ValueError} or C{TypeError} exceptions are raised, it will return
  the result, else it will return the original value. Any other
  exceptions are propagated to the caller.

  @type fn: callable
  @param fn: function to apply to the value
  @param val: the value to be converted
  @return: The converted value if the conversion was successful,
      otherwise the original value.
Iustin Pop's avatar
Iustin Pop committed
660
661
662
663
664
665
666
667
668
669

  """
  try:
    nv = fn(val)
  except (ValueError, TypeError), err:
    nv = val
  return nv


def IsValidIP(ip):
670
  """Verifies the syntax of an IPv4 address.
Iustin Pop's avatar
Iustin Pop committed
671

672
673
674
675
676
677
678
679
  This function checks if the IPv4 address passes is valid or not based
  on syntax (not IP range, class calculations, etc.).

  @type ip: str
  @param ip: the address to be checked
  @rtype: a regular expression match object
  @return: a regular epression match object, or None if the
      address is not valid
Iustin Pop's avatar
Iustin Pop committed
680
681
682

  """
  unit = "(0|[1-9]\d{0,2})"
683
  #TODO: convert and return only boolean
Iustin Pop's avatar
Iustin Pop committed
684
685
686
687
688
689
690
691
692
693
694
695
696
  return re.match("^%s\.%s\.%s\.%s$" % (unit, unit, unit, unit), ip)


def IsValidShellParam(word):
  """Verifies is the given word is safe from the shell's p.o.v.

  This means that we can pass this to a command via the shell and be
  sure that it doesn't alter the command line and is passed as such to
  the actual command.

  Note that we are overly restrictive here, in order to be on the safe
  side.

697
698
699
700
701
  @type word: str
  @param word: the word to check
  @rtype: boolean
  @return: True if the word is 'safe'

Iustin Pop's avatar
Iustin Pop committed
702
703
704
705
706
707
708
709
710
711
712
713
  """
  return bool(re.match("^[-a-zA-Z0-9._+/:%@]+$", word))


def BuildShellCmd(template, *args):
  """Build a safe shell command line from the given arguments.

  This function will check all arguments in the args list so that they
  are valid shell parameters (i.e. they don't contain shell
  metacharaters). If everything is ok, it will return the result of
  template % args.

714
715
716
717
718
719
  @type template: str
  @param template: the string holding the template for the
      string formatting
  @rtype: str
  @return: the expanded command line

Iustin Pop's avatar
Iustin Pop committed
720
721
722
  """
  for word in args:
    if not IsValidShellParam(word):
723
724
      raise errors.ProgrammerError("Shell argument '%s' contains"
                                   " invalid characters" % word)
Iustin Pop's avatar
Iustin Pop committed
725
726
727
  return template % args


728
def FormatUnit(value, units):
Iustin Pop's avatar
Iustin Pop committed
729
730
  """Formats an incoming number of MiB with the appropriate unit.

731
732
  @type value: int
  @param value: integer representing the value in MiB (1048576)
733
734
735
736
737
738
  @type units: char
  @param units: the type of formatting we should do:
      - 'h' for automatic scaling
      - 'm' for MiBs
      - 'g' for GiBs
      - 't' for TiBs
739
740
  @rtype: str
  @return: the formatted value (with suffix)
Iustin Pop's avatar
Iustin Pop committed
741
742

  """
743
744
  if units not in ('m', 'g', 't', 'h'):
    raise errors.ProgrammerError("Invalid unit specified '%s'" % str(units))
Iustin Pop's avatar
Iustin Pop committed
745

746
747
748
749
750
751
752
753
754
755
756
  suffix = ''

  if units == 'm' or (units == 'h' and value < 1024):
    if units == 'h':
      suffix = 'M'
    return "%d%s" % (round(value, 0), suffix)

  elif units == 'g' or (units == 'h' and value < (1024 * 1024)):
    if units == 'h':
      suffix = 'G'
    return "%0.1f%s" % (round(float(value) / 1024, 1), suffix)
Iustin Pop's avatar
Iustin Pop committed
757
758

  else:
759
760
761
    if units == 'h':
      suffix = 'T'
    return "%0.1f%s" % (round(float(value) / 1024 / 1024, 1), suffix)
Iustin Pop's avatar
Iustin Pop committed
762
763
764
765
766


def ParseUnit(input_string):
  """Tries to extract number and scale from the given string.

767
768
769
  Input must be in the format C{NUMBER+ [DOT NUMBER+] SPACE*
  [UNIT]}. If no unit is specified, it defaults to MiB. Return value
  is always an int in MiB.
Iustin Pop's avatar
Iustin Pop committed
770
771

  """
772
  m = re.match('^([.\d]+)\s*([a-zA-Z]+)?$', str(input_string))
Iustin Pop's avatar
Iustin Pop committed
773
  if not m:
774
    raise errors.UnitParseError("Invalid format")
Iustin Pop's avatar
Iustin Pop committed
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794

  value = float(m.groups()[0])

  unit = m.groups()[1]
  if unit:
    lcunit = unit.lower()
  else:
    lcunit = 'm'

  if lcunit in ('m', 'mb', 'mib'):
    # Value already in MiB
    pass

  elif lcunit in ('g', 'gb', 'gib'):
    value *= 1024

  elif lcunit in ('t', 'tb', 'tib'):
    value *= 1024 * 1024

  else:
795
    raise errors.UnitParseError("Unknown unit: %s" % unit)
Iustin Pop's avatar
Iustin Pop committed
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811

  # Make sure we round up
  if int(value) < value:
    value += 1

  # Round up to the next multiple of 4
  value = int(value)
  if value % 4:
    value += 4 - value % 4

  return value


def AddAuthorizedKey(file_name, key):
  """Adds an SSH public key to an authorized_keys file.

812
813
814
815
816
  @type file_name: str
  @param file_name: path to authorized_keys file
  @type key: str
  @param key: string containing key

Iustin Pop's avatar
Iustin Pop committed
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
  """
  key_fields = key.split()

  f = open(file_name, 'a+')
  try:
    nl = True
    for line in f:
      # Ignore whitespace changes
      if line.split() == key_fields:
        break
      nl = line.endswith('\n')
    else:
      if not nl:
        f.write("\n")
      f.write(key.rstrip('\r\n'))
      f.write("\n")
      f.flush()
  finally:
    f.close()


def RemoveAuthorizedKey(file_name, key):
  """Removes an SSH public key from an authorized_keys file.

841
842
843
844
845
  @type file_name: str
  @param file_name: path to authorized_keys file
  @type key: str
  @param key: string containing key

Iustin Pop's avatar
Iustin Pop committed
846
847
848
849
850
  """
  key_fields = key.split()

  fd, tmpname = tempfile.mkstemp(dir=os.path.dirname(file_name))
  try:
851
    out = os.fdopen(fd, 'w')
Iustin Pop's avatar
Iustin Pop committed
852
    try:
853
854
855
856
857
858
      f = open(file_name, 'r')
      try:
        for line in f:
          # Ignore whitespace changes while comparing lines
          if line.split() != key_fields:
            out.write(line)
859
860
861
862
863
864
865
866
867
868
869
870

        out.flush()
        os.rename(tmpname, file_name)
      finally:
        f.close()
    finally:
      out.close()
  except:
    RemoveFile(tmpname)
    raise


871
872
def SetEtcHostsEntry(file_name, ip, hostname, aliases):
  """Sets the name of an IP address and hostname in /etc/hosts.
873

874
875
876
877
878
879
880
881
882
  @type file_name: str
  @param file_name: path to the file to modify (usually C{/etc/hosts})
  @type ip: str
  @param ip: the IP address
  @type hostname: str
  @param hostname: the hostname to be added
  @type aliases: list
  @param aliases: the list of aliases to add for the hostname

883
  """
884
  # FIXME: use WriteFile + fn rather than duplicating its efforts
885
886
887
  # Ensure aliases are unique
  aliases = UniqueSequence([hostname] + aliases)[1:]

888
  fd, tmpname = tempfile.mkstemp(dir=os.path.dirname(file_name))
889
  try:
890
891
892
893
894
895
    out = os.fdopen(fd, 'w')
    try:
      f = open(file_name, 'r')
      try:
        for line in f:
          fields = line.split()
896
          if fields and not fields[0].startswith('#') and ip == fields[0]:
897
898
899
            continue
          out.write(line)

900
        out.write("%s\t%s" % (ip, hostname))
901
902
903
904
905
        if aliases:
          out.write(" %s" % ' '.join(aliases))
        out.write('\n')

        out.flush()
906
        os.fsync(out)
907
        os.chmod(tmpname, 0644)
908
909
910
911
912
913
914
915
        os.rename(tmpname, file_name)
      finally:
        f.close()
    finally:
      out.close()
  except:
    RemoveFile(tmpname)
    raise
916
917


918
919
920
def AddHostToEtcHosts(hostname):
  """Wrapper around SetEtcHostsEntry.

921
922
923
924
  @type hostname: str
  @param hostname: a hostname that will be resolved and added to
      L{constants.ETC_HOSTS}

925
926
927
928
929
  """
  hi = HostInfo(name=hostname)
  SetEtcHostsEntry(constants.ETC_HOSTS, hi.ip, hi.name, [hi.ShortName()])


930
def RemoveEtcHostsEntry(file_name, hostname):
931
  """Removes a hostname from /etc/hosts.
932

933
  IP addresses without names are removed from the file.
934
935
936
937
938
939

  @type file_name: str
  @param file_name: path to the file to modify (usually C{/etc/hosts})
  @type hostname: str
  @param hostname: the hostname to be removed

940
  """
941
  # FIXME: use WriteFile + fn rather than duplicating its efforts
942
943
944
945
946
947
948
949
950
951
952
953
954
955
  fd, tmpname = tempfile.mkstemp(dir=os.path.dirname(file_name))
  try:
    out = os.fdopen(fd, 'w')
    try:
      f = open(file_name, 'r')
      try:
        for line in f:
          fields = line.split()
          if len(fields) > 1 and not fields[0].startswith('#'):
            names = fields[1:]
            if hostname in names:
              while hostname in names:
                names.remove(hostname)
              if names:
956
                out.write("%s %s\n" % (fields[0], ' '.join(names)))
957
958
959
              continue

          out.write(line)
960
961

        out.flush()
962
        os.fsync(out)
963
        os.chmod(tmpname, 0644)
964
965
966
        os.rename(tmpname, file_name)
      finally:
        f.close()
Iustin Pop's avatar
Iustin Pop committed
967
    finally:
968
969
970
971
      out.close()
  except:
    RemoveFile(tmpname)
    raise
Iustin Pop's avatar
Iustin Pop committed
972
973


974
975
976
def RemoveHostFromEtcHosts(hostname):
  """Wrapper around RemoveEtcHostsEntry.

977
978
979
980
981
  @type hostname: str
  @param hostname: hostname that will be resolved and its
      full and shot name will be removed from
      L{constants.ETC_HOSTS}

982
983
984
985
986
987
  """
  hi = HostInfo(name=hostname)
  RemoveEtcHostsEntry(constants.ETC_HOSTS, hi.name)
  RemoveEtcHostsEntry(constants.ETC_HOSTS, hi.ShortName())


Iustin Pop's avatar
Iustin Pop committed
988
989
990
def CreateBackup(file_name):
  """Creates a backup of a file.

991
992
993
994
995
  @type file_name: str
  @param file_name: file to be backed up
  @rtype: str
  @return: the path to the newly created backup
  @raise errors.ProgrammerError: for invalid file names
Iustin Pop's avatar
Iustin Pop committed
996
997
998

  """
  if not os.path.isfile(file_name):
999
1000
    raise errors.ProgrammerError("Can't make a backup of a non-file '%s'" %
                                file_name)
Iustin Pop's avatar
Iustin Pop committed
1001

1002
  prefix = '%s.backup-%d.' % (os.path.basename(file_name), int(time.time()))
Iustin Pop's avatar
Iustin Pop committed
1003
  dir_name = os.path.dirname(file_name)
1004
1005
1006

  fsrc = open(file_name, 'rb')
  try:
Iustin Pop's avatar
Iustin Pop committed
1007
    (fd, backup_name) = tempfile.mkstemp(prefix=prefix, dir=dir_name)
1008
1009
1010
1011
1012
1013
1014
1015
    fdst = os.fdopen(fd, 'wb')
    try:
      shutil.copyfileobj(fsrc, fdst)
    finally:
      fdst.close()
  finally:
    fsrc.close()

Iustin Pop's avatar
Iustin Pop committed
1016
1017
1018
1019
1020
  return backup_name


def ShellQuote(value):
  """Quotes shell argument according to POSIX.
1021

1022
1023
1024
1025
1026
  @type value: str
  @param value: the argument to be quoted
  @rtype: str
  @return: the quoted value

Iustin Pop's avatar
Iustin Pop committed
1027
1028
1029
1030
1031
1032
1033
1034
  """
  if _re_shell_unquoted.match(value):
    return value
  else:
    return "'%s'" % value.replace("'", "'\\''")


def ShellQuoteArgs(args):
1035
1036
1037
1038
1039
1040
  """Quotes a list of shell arguments.

  @type args: list
  @param args: list of arguments to be quoted
  @rtype: str
  @return: the quoted arguments concatenaned with spaces
Iustin Pop's avatar
Iustin Pop committed
1041
1042
1043

  """
  return ' '.join([ShellQuote(i) for i in args])
1044
1045


1046
def TcpPing(target, port, timeout=10, live_port_needed=False, source=None):
1047
1048
  """Simple ping implementation using TCP connect(2).

1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
  Check if the given IP is reachable by doing attempting a TCP connect
  to it.

  @type target: str
  @param target: the IP or hostname to ping
  @type port: int
  @param port: the port to connect to
  @type timeout: int
  @param timeout: the timeout on the connection attemp
  @type live_port_needed: boolean
  @param live_port_needed: whether a closed port will cause the
      function to return failure, as if there was a timeout
  @type source: str or None
  @param source: if specified, will cause the connect to be made
      from this specific source address; failures to bind other
      than C{EADDRNOTAVAIL} will be ignored
1065
1066
1067
1068

  """
  sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

1069
  success = False
1070

1071
1072
1073
1074
1075
1076
  if source is not None:
    try:
      sock.bind((source, 0))
    except socket.error, (errcode, errstring):
      if errcode == errno.EADDRNOTAVAIL:
        success = False
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086

  sock.settimeout(timeout)

  try:
    sock.connect((target, port))
    sock.close()
    success = True
  except socket.timeout:
    success = False
  except socket.error, (errcode, errstring):
1087
    success = (not live_port_needed) and (errcode == errno.ECONNREFUSED)
1088
1089

  return success
1090
1091


1092
1093
1094
def OwnIpAddress(address):
  """Check if the current host has the the given IP address.

1095
  Currently this is done by TCP-pinging the address from the loopback
1096
1097
1098
1099
1100
  address.

  @type address: string
  @param address: the addres to check
  @rtype: bool
1101
  @return: True if we own the address
1102
1103
1104
1105
1106
1107

  """
  return TcpPing(address, constants.DEFAULT_NODED_PORT,
                 source=constants.LOCALHOST_IP_ADDRESS)


1108
def ListVisibleFiles(path):
1109
1110
1111
1112
1113
1114
  """Returns a list of visible files in a directory.

  @type path: str
  @param path: the directory to enumerate
  @rtype: list
  @return: the list of all files not starting with a dot
1115
1116

  """
1117
1118
1119
  files = [i for i in os.listdir(path) if not i.startswith(".")]
  files.sort()
  return files
1120
1121


1122
1123
1124
1125
1126
1127
def GetHomeDir(user, default=None):
  """Try to get the homedir of the given user.

  The user can be passed either as a string (denoting the name) or as
  an integer (denoting the user id). If the user is not found, the
  'default' argument is returned, which defaults to None.
1128
1129
1130

  """
  try:
1131
1132
1133
1134
1135
1136
1137
    if isinstance(user, basestring):
      result = pwd.getpwnam(user)
    elif isinstance(user, (int, long)):
      result = pwd.getpwuid(user)
    else:
      raise errors.ProgrammerError("Invalid type passed to GetHomeDir (%s)" %
                                   type(user))
1138
1139
1140
  except KeyError:
    return default
  return result.pw_dir
1141
1142


1143
def NewUUID():
1144
1145
  """Returns a random UUID.

1146
1147
1148
1149
  @note: This is a Linux-specific method as it uses the /proc
      filesystem.
  @rtype: str

1150
1151
1152
1153
1154
1155
  """
  f = open("/proc/sys/kernel/random/uuid", "r")
  try:
    return f.read(128).rstrip("\n")
  finally:
    f.close()
Iustin Pop's avatar
Iustin Pop committed
1156
1157


1158
1159
1160
1161
1162
1163
def GenerateSecret():
  """Generates a random secret.

  This will generate a pseudo-random secret, and return its sha digest
  (so that it can be used where an ASCII string is needed).

1164
1165
1166
  @rtype: str
  @return: a sha1 hexdigest of a block of 64 random bytes

1167
  """
1168
  return sha1(os.urandom(64)).hexdigest()
1169
1170


1171
1172
1173
1174
1175
1176
1177
1178
1179
def EnsureDirs(dirs):
  """Make required directories, if they don't exist.

  @param dirs: list of tuples (dir_name, dir_mode)
  @type dirs: list of (string, integer)

  """
  for dir_name, dir_mode in dirs:
    try:
Iustin Pop's avatar
Iustin Pop committed
1180
      os.mkdir(dir_name, dir_mode)
1181
1182
1183
    except EnvironmentError, err:
      if err.errno != errno.EEXIST:
        raise errors.GenericError("Cannot create needed directory"
Iustin Pop's avatar
Iustin Pop committed
1184
                                  " '%s': %s" % (dir_name, err))
1185
1186
1187
1188
    if not os.path.isdir(dir_name):
      raise errors.GenericError("%s is not a directory" % dir_name)


1189
1190
1191
1192
1193
def ReadFile(file_name, size=None):
  """Reads a file.

  @type size: None or int
  @param size: Read at most size bytes
1194
1195
  @rtype: str
  @return: the (possibly partial) conent of the file
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207

  """
  f = open(file_name, "r")
  try:
    if size is None:
      return f.read()
    else:
      return f.read(size)
  finally:
    f.close()


Iustin Pop's avatar
Iustin Pop committed
1208
1209
def WriteFile(file_name, fn=None, data=None,
              mode=None, uid=-1, gid=-1,
1210
              atime=None, mtime=None, close=True,
1211
              dry_run=False, backup=False,
1212
              prewrite=None, postwrite=None):
Iustin Pop's avatar
Iustin Pop committed
1213
1214
1215
1216
1217
1218
1219
1220
1221
  """(Over)write a file atomically.

  The file_name and either fn (a function taking one argument, the
  file descriptor, and which should write the data to it) or data (the
  contents of the file) must be passed. The other arguments are
  optional and allow setting the file mode, owner and group, and the
  mtime/atime of the file.

  If the function doesn't raise an exception, it has succeeded and the
1222
  target file has the new contents. If the function has raised an
Iustin Pop's avatar
Iustin Pop committed
1223
1224
1225
  exception, an existing target file should be unmodified and the
  temporary file should be removed.

1226
1227
1228
1229
1230
  @type file_name: str
  @param file_name: the target filename
  @type fn: callable
  @param fn: content writing function, called with
      file descriptor as parameter
1231
  @type data: str
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
  @param data: contents of the file
  @type mode: int
  @param mode: file mode
  @type uid: int
  @param uid: the owner of the file
  @type gid: int
  @param gid: the group of the file
  @type atime: int
  @param atime: a custom access time to be set on the file
  @type mtime: int
  @param mtime: a custom modification time to be set on the file
  @type close: boolean
  @param close: whether to close file after writing it
  @type prewrite: callable
  @param prewrite: function to be called before writing content
  @type postwrite: callable
  @param postwrite: function to be called after writing content

  @rtype: None or int
  @return: None if the 'close' parameter evaluates to True,
      otherwise the file descriptor

1254
  @raise errors.ProgrammerError: if any of the arguments are not valid
1255

Iustin Pop's avatar
Iustin Pop committed
1256
  """
1257
  if not os.path.isabs(file_name):
Iustin Pop's avatar
Iustin Pop committed
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
    raise errors.ProgrammerError("Path passed to WriteFile is not"
                                 " absolute: '%s'" % file_name)

  if [fn, data].count(None) != 1:
    raise errors.ProgrammerError("fn or data required")

  if [atime, mtime].count(None) == 1:
    raise errors.ProgrammerError("Both atime and mtime must be either"
                                 " set or None")

Michael Hanselmann's avatar
Michael Hanselmann committed
1268
1269
  if backup and not dry_run and os.path.isfile(file_name):
    CreateBackup(file_name)
Iustin Pop's avatar
Iustin Pop committed
1270
1271
1272

  dir_name, base_name = os.path.split(file_name)
  fd, new_name = tempfile.mkstemp('.new', base_name, dir_name)
1273
  do_remove = True
Iustin Pop's avatar
Iustin Pop committed
1274
1275
1276
1277
1278
1279
1280
  # here we need to make sure we remove the temp file, if any error
  # leaves it in place
  try:
    if uid != -1 or gid != -1:
      os.chown(new_name, uid, gid)
    if mode:
      os.chmod(new_name, mode)
1281
1282
    if callable(prewrite):
      prewrite(fd)
Iustin Pop's avatar
Iustin Pop committed
1283
1284
1285
1286
    if data is not None:
      os.write(fd, data)
    else:
      fn(fd)
1287
1288
    if callable(postwrite):
      postwrite(fd)
Iustin Pop's avatar
Iustin Pop committed
1289
1290
1291
    os.fsync(fd)
    if atime is not None and mtime is not None:
      os.utime(new_name, (atime, mtime))
Michael Hanselmann's avatar
Michael Hanselmann committed
1292
1293
    if not dry_run:
      os.rename(new_name, file_name)
1294
      do_remove = False
Iustin Pop's avatar
Iustin Pop committed
1295
  finally:
1296
1297
1298
1299
1300
    if close:
      os.close(fd)
      result = None
    else:
      result = fd
1301
1302
    if do_remove:
      RemoveFile(new_name)
Guido Trotter's avatar
Guido Trotter committed
1303

1304
1305
  return result

Guido Trotter's avatar
Guido Trotter committed
1306

1307
1308
1309
1310
1311
1312
1313
1314
def FirstFree(seq, base=0):
  """Returns the first non-existing integer from seq.

  The seq argument should be a sorted list of positive integers. The
  first time the index of an element is smaller than the element
  value, the index will be returned.

  The base argument is used to start at a different offset,
1315
1316
1317
  i.e. C{[3, 4, 6]} with I{offset=3} will return 5.

  Example: C{[0, 1, 3]} will return I{2}.
1318

1319
1320
1321
1322
1323
1324
  @type seq: sequence
  @param seq: the sequence to be analyzed.
  @type base: int
  @param base: use this value as the base index of the sequence
  @rtype: int
  @return: the first non-used index in the sequence
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334

  """
  for idx, elem in enumerate(seq):
    assert elem >= base, "Passed element is higher than base offset"
    if elem > idx + base:
      # idx is not used
      return idx + base
  return None


Guido Trotter's avatar
Guido Trotter committed
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
def all(seq, pred=bool):
  "Returns True if pred(x) is True for every element in the iterable"
  for elem in itertools.ifilterfalse(pred, seq):
    return False
  return True


def any(seq, pred=bool):
  "Returns True if pred(x) is True for at least one element in the iterable"
  for elem in itertools.ifilter(pred, seq):
    return True
  return False
1347
1348
1349
1350
1351
1352


def UniqueSequence(seq):
  """Returns a list with unique elements.

  Element order is preserved.
1353
1354
1355
1356
1357
1358

  @type seq: sequence
  @param seq: the sequence with the source elementes
  @rtype: list
  @return: list of unique elements from seq

1359
1360
1361
  """
  seen = set()
  return [i for i in seq if i not in seen and not seen.add(i)]
1362
1363
1364
1365
1366
1367
1368


def IsValidMac(mac):
  """Predicate to check if a MAC address is valid.

  Checks wether the supplied MAC address is formally correct, only
  accepts colon separated format.
1369
1370
1371
1372
1373
1374

  @type mac: str
  @param mac: the MAC to be validated
  @rtype: boolean
  @return: True is the MAC seems valid

1375
1376
1377
  """
  mac_check = re.compile("^([0-9a-f]{2}(:|$)){6}$")
  return mac_check.match(mac) is not None
1378
1379
1380
1381
1382


def TestDelay(duration):
  """Sleep for a fixed amount of time.

1383
1384
1385
1386
1387
  @type duration: float
  @param duration: the sleep duration
  @rtype: boolean
  @return: False for negative value, True otherwise

1388
1389
  """
  if duration < 0:
1390
    return False, "Invalid sleep duration"
1391
  time.sleep(duration)
1392
  return True, None
1393
1394


Iustin Pop's avatar
Iustin Pop committed
1395
1396
def _CloseFDNoErr(fd, retries=5):
  """Close a file descriptor ignoring errors.
1397

Iustin Pop's avatar
Iustin Pop committed
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
  @type fd: int
  @param fd: the file descriptor
  @type retries: int
  @param retries: how many retries to make, in case we get any
      other error than EBADF

  """
  try:
    os.close(fd)
  except OSError, err:
    if err.errno != errno.EBADF:
      if retries > 0:
        _CloseFDNoErr(fd, retries - 1)
    # else either it's closed already or we're out of retries, so we
    # ignore this and go on


def CloseFDs(noclose_fds=None):
  """Close file descriptors.

  This closes all file descriptors above 2 (i.e. except
  stdin/out/err).
1420

1421
1422
1423
1424
  @type noclose_fds: list or None
  @param noclose_fds: if given, it denotes a list of file descriptor
      that should not be closed

1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
  """
  # Default maximum for the number of available file descriptors.
  if 'SC_OPEN_MAX' in os.sysconf_names:
    try:
      MAXFD = os.sysconf('SC_OPEN_MAX')
      if MAXFD < 0:
        MAXFD = 1024
    except OSError:
      MAXFD = 1024
  else:
    MAXFD = 1024
Iustin Pop's avatar
Iustin Pop committed
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
  maxfd = resource.getrlimit(resource.RLIMIT_NOFILE)[1]
  if (maxfd == resource.RLIM_INFINITY):
    maxfd = MAXFD

  # Iterate through and close all file descriptors (except the standard ones)
  for fd in range(3, maxfd):
    if noclose_fds and fd in noclose_fds:
      continue
    _CloseFDNoErr(fd)


def Daemonize(logfile):
  """Daemonize the current process.

  This detaches the current process from the controlling terminal and
  runs it in the background as a daemon.

  @type logfile: str
  @param logfile: the logfile to which we should redirect stdout/stderr
  @rtype: int
Iustin Pop's avatar
Iustin Pop committed
1456
  @return: the value zero
Iustin Pop's avatar
Iustin Pop committed
1457
1458
1459
1460

  """
  UMASK = 077
  WORKDIR = "/"