RESTART_EXIT_CODE = 5
+
def make_pidfile_name(name):
"""Returns the file name that would be used for a pidfile if 'name' were
provided to set_pidfile()."""
else:
return ovs.util.abs_file_name(ovs.dirs.RUNDIR, name)
+
def set_pidfile(name):
"""Sets up a following call to daemonize() to create a pidfile named
'name'. If 'name' begins with '/', then it is treated as an absolute path.
Otherwise, it is taken relative to ovs.util.RUNDIR, which is
$(prefix)/var/run by default.
-
+
If 'name' is null, then ovs.util.PROGRAM_NAME followed by ".pid" is
used."""
global _pidfile
_pidfile = make_pidfile_name(name)
+
def get_pidfile():
"""Returns an absolute path to the configured pidfile, or None if no
pidfile is configured."""
return _pidfile
+
def set_no_chdir():
"""Sets that we do not chdir to "/"."""
global _chdir
_chdir = False
+
def is_chdir_enabled():
"""Will we chdir to "/" as part of daemonizing?"""
return _chdir
+
def ignore_existing_pidfile():
"""Normally, daemonize() or daemonize_start() will terminate the program
with a message if a locked pidfile already exists. If this function is
global _overwrite_pidfile
_overwrite_pidfile = True
+
def set_detach():
"""Sets up a following call to daemonize() to detach from the foreground
session, running this process in the background."""
global _detach
_detach = True
+
def get_detach():
"""Will daemonize() really detach?"""
return _detach
+
def set_monitor():
"""Sets up a following call to daemonize() to fork a supervisory process to
monitor the daemon and restart it if it dies due to an error signal."""
global _monitor
_monitor = True
+
def _fatal(msg):
logging.error(msg)
sys.stderr.write("%s\n" % msg)
sys.exit(1)
+
def _make_pidfile():
"""If a pidfile has been configured, creates it and stores the running
process's pid in it. Ensures that the pidfile will be deleted when the
_fatal("failed to link \"%s\" as \"%s\" (%s)"
% (tmpfile, _pidfile, os.strerror(error)))
-
# Ensure that the pidfile will get deleted on exit.
ovs.fatal_signal.add_file_to_unlink(_pidfile)
_pidfile_dev = s.st_dev
_pidfile_ino = s.st_ino
+
def daemonize():
"""If configured with set_pidfile() or set_detach(), creates the pid file
and detaches from the foreground session."""
daemonize_start()
daemonize_complete()
+
def _waitpid(pid, options):
while True:
try:
pass
return -e.errno, 0
+
def _fork_and_wait_for_startup():
try:
rfd, wfd = os.pipe()
_daemonize_fd = wfd
return pid
+
def _fork_notify_startup(fd):
if fd is not None:
error, bytes_written = ovs.socket_util.write_fully(fd, "0")
sys.exit(1)
os.close(fd)
+
def _should_restart(status):
global RESTART_EXIT_CODE
return True
return False
+
def _monitor_daemon(daemon_pid):
# XXX should log daemon's stderr output at startup time
# XXX should use setproctitle module if available
elif retval == daemon_pid:
status_msg = ("pid %d died, %s"
% (daemon_pid, ovs.process.status_msg(status)))
-
+
if _should_restart(status):
if os.WCOREDUMP(status):
# Disable further core dumps to save disk space.
# Running in new daemon process.
+
def _close_standard_fds():
"""Close stdin, stdout, stderr. If we're started from e.g. an SSH session,
then this keeps us from holding that session open artificially."""
os.dup2(null_fd, 1)
os.dup2(null_fd, 2)
+
def daemonize_start():
"""If daemonization is configured, then starts daemonization, by forking
and returning in the child process. The parent process hangs around until
the child lets it know either that it completed startup successfully (by
calling daemon_complete()) or that it failed to start up (by exiting with a
nonzero exit code)."""
-
+
if _detach:
if _fork_and_wait_for_startup() > 0:
# Running in parent process.
_close_standard_fds()
_monitor_daemon(daemon_pid)
# Running in daemon process
-
+
if _pidfile:
_make_pidfile()
+
def daemonize_complete():
"""If daemonization is configured, then this function notifies the parent
process that the child process has completed startup successfully."""
os.chdir("/")
_close_standard_fds()
+
def usage():
sys.stdout.write("""
Daemon options:
--overwrite-pidfile with --pidfile, start even if already running
""" % (ovs.dirs.RUNDIR, ovs.util.PROGRAM_NAME))
+
def __read_pidfile(pidfile, delete_if_stale):
if _pidfile_dev is not None:
try:
except IOError:
pass
+
def read_pidfile(pidfile):
"""Opens and reads a PID from 'pidfile'. Returns the positive PID if
successful, otherwise a negative errno value."""
return __read_pidfile(pidfile, False)
+
def _check_already_running():
pid = __read_pidfile(_pidfile, True)
if pid > 0:
LONG_OPTIONS = ["detach", "no-chdir", "pidfile", "pidfile-name=",
"overwrite-pidfile", "monitor"]
+
def parse_opt(option, arg):
if option == '--detach':
set_detach()
projects / openvswitch / commitdiff