bind10_src.py.in 47.9 KB
Newer Older
1
2
#!@PYTHON@

Naoki Kambe's avatar
Naoki Kambe committed
3
# Copyright (C) 2010,2011  Internet Systems Consortium.
4
5
6
7
8
9
10
11
12
13
14
15
16
17
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SYSTEMS CONSORTIUM
# DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
# INTERNET SYSTEMS CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
# FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

18
"""
19
20
This file implements the Boss of Bind (BoB, or bob) program.

Jeremy C. Reed's avatar
Jeremy C. Reed committed
21
Its purpose is to start up the BIND 10 system, and then manage the
Shane Kerr's avatar
Shane Kerr committed
22
23
processes, by starting and stopping processes, plus restarting
processes that exit.
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

To start the system, it first runs the c-channel program (msgq), then
connects to that. It then runs the configuration manager, and reads
its own configuration. Then it proceeds to starting other modules.

The Python subprocess module is used for starting processes, but
because this is not efficient for managing groups of processes,
SIGCHLD signals are caught and processed using the signal module.

Most of the logic is contained in the BoB class. However, since Python
requires that signal processing happen in the main thread, we do
signal handling outside of that class, in the code running for
__main__.
"""

39
40
41
import sys; sys.path.append ('@@PYTHONPATH@@')
import os

Jelte Jansen's avatar
Jelte Jansen committed
42
43
44
# If B10_FROM_SOURCE is set in the environment, we use data files
# from a directory relative to that, otherwise we use the ones
# installed on the system
45
46
if "B10_FROM_SOURCE" in os.environ:
    SPECFILE_LOCATION = os.environ["B10_FROM_SOURCE"] + "/src/bin/bind10/bob.spec"
Jelte Jansen's avatar
Jelte Jansen committed
47
48
49
50
51
else:
    PREFIX = "@prefix@"
    DATAROOTDIR = "@datarootdir@"
    SPECFILE_LOCATION = "@datadir@/@PACKAGE@/bob.spec".replace("${datarootdir}", DATAROOTDIR).replace("${prefix}", PREFIX)
    
52
53
54
55
56
import subprocess
import signal
import re
import errno
import time
57
import select
58
import random
Evan Hunt's avatar
Evan Hunt committed
59
import socket
60
from optparse import OptionParser, OptionValueError
61
62
63
import io
import pwd
import posix
64
import copy
65

66
from bind10_config import LIBEXECPATH
67
import bind10_config
68
import isc.cc
69
import isc.util.process
Michal Vaner's avatar
Michal Vaner committed
70
import isc.net.parse
71
import isc.log
72
from isc.log_messages.bind10_messages import *
73
74
import isc.bind10.component
import isc.bind10.special_component
75
import isc.bind10.socket_cache
76
import libutil_io_python
77
import tempfile
78

79
80
isc.log.init("b10-boss")
logger = isc.log.Logger("boss")
81
82
83

# Pending system-wide debug level definitions, the ones we
# use here are hardcoded for now
84
85
DBG_PROCESS = logger.DBGLVL_TRACE_BASIC
DBG_COMMANDS = logger.DBGLVL_TRACE_DETAIL
Michal Vaner's avatar
Michal Vaner committed
86

87
# Messages sent over the unix domain socket to indicate if it is followed by a real socket
88
89
CREATOR_SOCKET_OK = b"1\n"
CREATOR_SOCKET_UNAVAILABLE = b"0\n"
90

91
92
93
94
# RCodes of known exceptions for the get_token command
CREATOR_SOCKET_ERROR = 2
CREATOR_SHARE_ERROR = 3

Michal Vaner's avatar
Michal Vaner committed
95
# Assign this process some longer name
96
isc.util.process.rename(sys.argv[0])
97
98

# This is the version that gets displayed to the user.
99
100
# The VERSION string consists of the module name, the module version
# number, and the overall BIND 10 version number (set in configure.ac).
101
VERSION = "bind10 20110223 (BIND 10 @PACKAGE_VERSION@)"
102

103
# This is for boot_time of Boss
104
_BASETIME = time.gmtime()
105

106
107
class ProcessInfoError(Exception): pass

108
109
110
class ProcessInfo:
    """Information about a process"""

111
112
113
    dev_null = open(os.devnull, "w")

    def __init__(self, name, args, env={}, dev_null_stdout=False,
114
115
                 dev_null_stderr=False):
        self.name = name
116
117
118
119
        self.args = args
        self.env = env
        self.dev_null_stdout = dev_null_stdout
        self.dev_null_stderr = dev_null_stderr
120
121
        self.process = None
        self.pid = None
122

123
    def _preexec_work(self):
124
125
        """Function used before running a program that needs to run as a
        different user."""
126
127
128
129
        # First, put us into a separate process group so we don't get
        # SIGINT signals on Ctrl-C (the boss will shut everthing down by
        # other means).
        os.setpgrp()
130
131

    def _spawn(self):
132
133
134
135
        if self.dev_null_stdout:
            spawn_stdout = self.dev_null
        else:
            spawn_stdout = None
136
137
        if self.dev_null_stderr:
            spawn_stderr = self.dev_null
138
        else:
139
            spawn_stderr = None
140
141
142
        # Environment variables for the child process will be a copy of those
        # of the boss process with any additional specific variables given
        # on construction (self.env).
143
        spawn_env = copy.deepcopy(os.environ)
144
        spawn_env.update(self.env)
145
        spawn_env['PATH'] = LIBEXECPATH + ':' + spawn_env['PATH']
146
147
        self.process = subprocess.Popen(self.args,
                                        stdin=subprocess.PIPE,
148
                                        stdout=spawn_stdout,
149
                                        stderr=spawn_stderr,
150
                                        close_fds=True,
151
                                        env=spawn_env,
152
                                        preexec_fn=self._preexec_work)
153
154
        self.pid = self.process.pid

155
156
157
158
159
    # spawn() and respawn() are the same for now, but in the future they
    # may have different functionality
    def spawn(self):
        self._spawn()

160
161
162
    def respawn(self):
        self._spawn()

163
164
class CChannelConnectError(Exception): pass

165
166
class ProcessStartError(Exception): pass

167
168
class BoB:
    """Boss of BIND class."""
169
    
170
    def __init__(self, msgq_socket_file=None, data_path=None,
171
                 config_filename=None, clear_config=False,
172
173
                 verbose=False, nokill=False, setuid=None, setgid=None,
                 username=None, cmdctl_port=None, wait_time=10):
174
175
        """
            Initialize the Boss of BIND. This is a singleton (only one can run).
176
        
177
178
179
            The msgq_socket_file specifies the UNIX domain socket file that the
            msgq process listens on.  If verbose is True, then the boss reports
            what it is doing.
180

181
            Data path and config filename are passed through to config manager
182
183
184
185
            (if provided) and specify the config file to be used.

            The cmdctl_port is passed to cmdctl and specify on which port it
            should listen.
186
187
188
189

            wait_time controls the amount of time (in seconds) that Boss waits
            for selected processes to initialize before continuing with the
            initialization.  Currently this is only the configuration manager.
190
        """
191
        self.cc_session = None
192
        self.ccs = None
193
194
        self.curproc = None
        self.msgq_socket_file = msgq_socket_file
195
        self.component_config = {}
196
        # Some time in future, it may happen that a single component has
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
197
198
199
200
201
202
203
        # multple processes (like a pipeline-like component). If so happens,
        # name "components" may be inapropriate. But as the code isn't probably
        # completely ready for it, we leave it at components for now. We also
        # want to support multiple instances of a single component. If it turns
        # out that we'll have a single component with multiple same processes
        # or if we start multiple components with the same configuration (we do
        # this now, but it might change) is an open question.
204
        self.components = {}
Jelte Jansen's avatar
Jelte Jansen committed
205
206
        # Simply list of components that died and need to wait for a
        # restart. Components manage their own restart schedule now
207
        self.components_to_restart = []
208
        self.runnable = False
209
        self.uid = setuid
210
        self.gid = setgid
211
        self.username = username
212
        self.verbose = verbose
213
        self.nokill = nokill
214
215
        self.data_path = data_path
        self.config_filename = config_filename
216
        self.clear_config = clear_config
217
        self.cmdctl_port = cmdctl_port
218
        self.wait_time = wait_time
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
        self._component_configurator = isc.bind10.component.Configurator(self,
            isc.bind10.special_component.get_specials())
        # The priorities here make them start in the correct order. First
        # the socket creator (which would drop root privileges by then),
        # then message queue and after that the config manager (which uses
        # the config manager)
        self.__core_components = {
            'sockcreator': {
                'kind': 'core',
                'special': 'sockcreator',
                'priority': 200
            },
            'msgq': {
                'kind': 'core',
                'special': 'msgq',
                'priority': 199
            },
            'cfgmgr': {
                'kind': 'core',
                'special': 'cfgmgr',
                'priority': 198
            }
        }
        self.__started = False
        self.exitcode = 0
244

245
246
247
        # If -v was set, enable full debug logging.
        if self.verbose:
            logger.set_severity("DEBUG", 99)
248
        # This is set in init_socket_srv
249
        self._socket_path = None
250
        self._socket_cache = None
251
252
        self._tmpdir = None
        self._srv_socket = None
253
        self._unix_sockets = {}
254

255
256
257
258
259
260
261
262
263
264
265
    def __propagate_component_config(self, config):
        comps = dict(config)
        # Fill in the core components, so they stay alive
        for comp in self.__core_components:
            if comp in comps:
                raise Exception(comp + " is core component managed by " +
                                "bind10 boss, do not set it")
            comps[comp] = self.__core_components[comp]
        # Update the configuration
        self._component_configurator.reconfigure(comps)

266
    def config_handler(self, new_config):
267
        # If this is initial update, don't do anything now, leave it to startup
268
269
        if not self.runnable:
            return
270
271
        logger.debug(DBG_COMMANDS, BIND10_RECEIVED_NEW_CONFIGURATION,
                     new_config)
272
273
274
275
276
277
        try:
            if 'components' in new_config:
                self.__propagate_component_config(new_config['components'])
            return isc.config.ccsession.create_answer(0)
        except Exception as e:
            return isc.config.ccsession.create_answer(1, str(e))
278

Shane Kerr's avatar
Shane Kerr committed
279
    def get_processes(self):
280
        pids = list(self.components.keys())
Shane Kerr's avatar
Shane Kerr committed
281
282
283
        pids.sort()
        process_list = [ ]
        for pid in pids:
284
285
            process_list.append([pid, self.components[pid].name(),
                                 self.components[pid].address()])
Shane Kerr's avatar
Shane Kerr committed
286
287
        return process_list

288
    def _get_stats_data(self):
289
290
        return { 'boot_time':
                     time.strftime('%Y-%m-%dT%H:%M:%SZ', _BASETIME)
291
                 }
292

Jelte Jansen's avatar
Jelte Jansen committed
293
    def command_handler(self, command, args):
294
        logger.debug(DBG_COMMANDS, BIND10_RECEIVED_COMMAND, command)
295
        answer = isc.config.ccsession.create_answer(1, "command not implemented")
Jelte Jansen's avatar
Jelte Jansen committed
296
        if type(command) != str:
Jelte Jansen's avatar
Jelte Jansen committed
297
            answer = isc.config.ccsession.create_answer(1, "bad command")
298
        else:
299
            if command == "shutdown":
300
                self.runnable = False
Jelte Jansen's avatar
Jelte Jansen committed
301
                answer = isc.config.ccsession.create_answer(0)
302
            elif command == "getstats":
303
304
                answer = isc.config.ccsession.create_answer(
                    0, self._get_stats_data())
Shane Kerr's avatar
Shane Kerr committed
305
306
307
            elif command == "ping":
                answer = isc.config.ccsession.create_answer(0, "pong")
            elif command == "show_processes":
308
309
                answer = isc.config.ccsession. \
                    create_answer(0, self.get_processes())
310
311
            elif command == "get_socket":
                answer = self._get_socket(args)
312
313
314
315
316
317
318
319
320
321
            elif command == "drop_socket":
                if "token" not in args:
                    answer = isc.config.ccsession. \
                        create_answer(1, "Missing token parameter")
                else:
                    try:
                        self._socket_cache.drop_socket(args["token"])
                        answer = isc.config.ccsession.create_answer(0)
                    except Exception as e:
                        answer = isc.config.ccsession.create_answer(1, str(e))
Jelte Jansen's avatar
Jelte Jansen committed
322
            else:
323
                answer = isc.config.ccsession.create_answer(1,
324
                                                            "Unknown command")
Jelte Jansen's avatar
Jelte Jansen committed
325
        return answer
326

327
    def kill_started_components(self):
328
329
330
331
        """
            Called as part of the exception handling when a process fails to
            start, this runs through the list of started processes, killing
            each one.  It then clears that list.
332
        """
333
        logger.info(BIND10_KILLING_ALL_PROCESSES)
334

335
336
337
338
        for pid in self.components:
            logger.info(BIND10_KILL_PROCESS, self.components[pid].name())
            self.components[pid].kill(True)
        self.components = {}
339

Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
340
    def _read_bind10_config(self):
341
342
343
        """
            Reads the parameters associated with the BoB module itself.

344
            This means the list of components we should start now.
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
345
346
347
348

            This could easily be combined into start_all_processes, but
            it stays because of historical reasons and because the tests
            replace the method sometimes.
349
        """
350
        logger.info(BIND10_READING_BOSS_CONFIGURATION)
351
352

        config_data = self.ccs.get_full_config()
353
        self.__propagate_component_config(config_data['components'])
354
355
356
357

    def log_starting(self, process, port = None, address = None):
        """
            A convenience function to output a "Starting xxx" message if the
358
359
            logging is set to DEBUG with debuglevel DBG_PROCESS or higher.
            Putting this into a separate method ensures
360
361
362
363
364
365
366
367
368
            that the output form is consistent across all processes.

            The process name (passed as the first argument) is put into
            self.curproc, and is used to indicate which process failed to
            start if there is an error (and is used in the "Started" message
            on success).  The optional port and address information are
            appended to the message (if present).
        """
        self.curproc = process
369
        if port is None and address is None:
370
            logger.info(BIND10_STARTING_PROCESS, self.curproc)
371
        elif address is None:
372
            logger.info(BIND10_STARTING_PROCESS_PORT, self.curproc,
373
374
                        port)
        else:
375
            logger.info(BIND10_STARTING_PROCESS_PORT_ADDRESS,
376
                        self.curproc, address, port)
377

378
379
380
381
382
383
    def log_started(self, pid = None):
        """
            A convenience function to output a 'Started xxxx (PID yyyy)'
            message.  As with starting_message(), this ensures a consistent
            format.
        """
384
385
386
387
        if pid is None:
            logger.debug(DBG_PROCESS, BIND10_STARTED_PROCESS, self.curproc)
        else:
            logger.debug(DBG_PROCESS, BIND10_STARTED_PROCESS_PID, self.curproc, pid)
388

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
    def process_running(self, msg, who):
        """
            Some processes return a message to the Boss after they have
            started to indicate that they are running.  The form of the
            message is a dictionary with contents {"running:", "<process>"}.
            This method checks the passed message and returns True if the
            "who" process is contained in the message (so is presumably
            running).  It returns False for all other conditions and will
            log an error if appropriate.
        """
        if msg is not None:
            try:
                if msg["running"] == who:
                    return True
                else:
                    logger.error(BIND10_STARTUP_UNEXPECTED_MESSAGE, msg)
            except:
                logger.error(BIND10_STARTUP_UNRECOGNISED_MESSAGE, msg)
        
        return False

410
    # The next few methods start the individual processes of BIND-10.  They
411
412
    # are called via start_all_processes().  If any fail, an exception is
    # raised which is caught by the caller of start_all_processes(); this kills
413
414
    # processes started up to that point before terminating the program.

415
    def start_msgq(self):
416
417
418
419
        """
            Start the message queue and connect to the command channel.
        """
        self.log_starting("b10-msgq")
420
        msgq_proc = ProcessInfo("b10-msgq", ["b10-msgq"], self.c_channel_env,
421
                                True, not self.verbose)
422
423
        msgq_proc.spawn()
        self.log_started(msgq_proc.pid)
424

425
        # Now connect to the c-channel
426
427
428
429
        cc_connect_start = time.time()
        while self.cc_session is None:
            # if we have been trying for "a while" give up
            if (time.time() - cc_connect_start) > 5:
430
431
                raise CChannelConnectError("Unable to connect to c-channel after 5 seconds")

432
433
            # try to connect, and if we can't wait a short while
            try:
434
                self.cc_session = isc.cc.Session(self.msgq_socket_file)
435
            except isc.cc.session.SessionError:
436
437
                time.sleep(0.1)

438
439
440
441
        # Subscribe to the message queue.  The only messages we expect to receive
        # on this channel are once relating to process startup.
        self.cc_session.group_subscribe("Boss")

442
443
444
        return msgq_proc

    def start_cfgmgr(self):
445
446
447
448
        """
            Starts the configuration manager process
        """
        self.log_starting("b10-cfgmgr")
449
        args = ["b10-cfgmgr"]
450
        if self.data_path is not None:
451
            args.append("--data-path=" + self.data_path)
452
        if self.config_filename is not None:
453
            args.append("--config-filename=" + self.config_filename)
454
        if self.clear_config:
455
            args.append("--clear-config")
456
        bind_cfgd = ProcessInfo("b10-cfgmgr", args,
457
                                self.c_channel_env)
458
        bind_cfgd.spawn()
459
        self.log_started(bind_cfgd.pid)
460

461
462
463
        # Wait for the configuration manager to start up as subsequent initialization
        # cannot proceed without it.  The time to wait can be set on the command line.
        time_remaining = self.wait_time
464
465
466
467
468
469
470
471
472
        msg, env = self.cc_session.group_recvmsg()
        while time_remaining > 0 and not self.process_running(msg, "ConfigManager"):
            logger.debug(DBG_PROCESS, BIND10_WAIT_CFGMGR)
            time.sleep(1)
            time_remaining = time_remaining - 1
            msg, env = self.cc_session.group_recvmsg()
        
        if not self.process_running(msg, "ConfigManager"):
            raise ProcessStartError("Configuration manager process has not started")
473

474
475
        return bind_cfgd

476
477
478
479
480
481
    def start_ccsession(self, c_channel_env):
        """
            Start the CC Session

            The argument c_channel_env is unused but is supplied to keep the
            argument list the same for all start_xxx methods.
482
483
484

            With regards to logging, note that as the CC session is not a
            process, the log_starting/log_started methods are not used.
485
        """
486
        logger.info(BIND10_STARTING_CC)
487
        self.ccs = isc.config.ModuleCCSession(SPECFILE_LOCATION, 
488
                                      self.config_handler,
489
490
                                      self.command_handler,
                                      socket_file = self.msgq_socket_file)
491
        self.ccs.start()
492
        logger.debug(DBG_PROCESS, BIND10_STARTED_CC)
493
494
495
496
497
498
499
500
501
502
503
504
505

    # A couple of utility methods for starting processes...

    def start_process(self, name, args, c_channel_env, port=None, address=None):
        """
            Given a set of command arguments, start the process and output
            appropriate log messages.  If the start is successful, the process
            is added to the list of started processes.

            The port and address arguments are for log messages only.
        """
        self.log_starting(name, port, address)
        newproc = ProcessInfo(name, args, c_channel_env)
506
        newproc.spawn()
507
        self.log_started(newproc.pid)
508
        return newproc
509

Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
510
    def register_process(self, pid, component):
511
512
        """
        Put another process into boss to watch over it.  When the process
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
513
        dies, the component.failed() is called with the exit code.
514

515
516
        It is expected the info is a isc.bind10.component.BaseComponent
        subclass (or anything having the same interface).
517
        """
518
        self.components[pid] = component
519
520

    def start_simple(self, name):
521
522
523
524
525
526
527
528
529
530
531
532
        """
            Most of the BIND-10 processes are started with the command:

                <process-name> [-v]

            ... where -v is appended if verbose is enabled.  This method
            generates the arguments from the name and starts the process.

            The port and address arguments are for log messages only.
        """
        # Set up the command arguments.
        args = [name]
533
        if self.verbose:
534
            args += ['-v']
535

536
        # ... and start the process
537
        return self.start_process(name, args, self.c_channel_env)
538

539
540
541
542
543
544
    # The next few methods start up the rest of the BIND-10 processes.
    # Although many of these methods are little more than a call to
    # start_simple, they are retained (a) for testing reasons and (b) as a place
    # where modifications can be made if the process start-up sequence changes
    # for a given process.

545
    def start_auth(self):
546
547
548
        """
            Start the Authoritative server
        """
549
        authargs = ['b10-auth']
550
        if self.verbose:
551
            authargs += ['-v']
552

553
        # ... and start
554
        return self.start_process("b10-auth", authargs, self.c_channel_env)
555

556
    def start_resolver(self):
557
558
559
560
561
        """
            Start the Resolver.  At present, all these arguments and switches
            are pure speculation.  As with the auth daemon, they should be
            read from the configuration database.
        """
562
563
        if self.uid is not None and self.__started:
            logger.warn(BIND10_START_AS_NON_ROOT_RESOLVER)
564
        self.curproc = "b10-resolver"
565
        # XXX: this must be read from the configuration manager in the future
566
        resargs = ['b10-resolver']
567
        if self.verbose:
568
            resargs += ['-v']
569

570
        # ... and start
571
        return self.start_process("b10-resolver", resargs, self.c_channel_env)
Likun Zhang's avatar
Likun Zhang committed
572

573
574
575
576
577
578
579
580
581
582
583
    def start_cmdctl(self):
        """
            Starts the command control process
        """
        args = ["b10-cmdctl"]
        if self.cmdctl_port is not None:
            args.append("--port=" + str(self.cmdctl_port))
        if self.verbose:
            args.append("-v")
        return self.start_process("b10-cmdctl", args, self.c_channel_env,
                                  self.cmdctl_port)
584

585
    def start_all_components(self):
586
        """
587
588
            Starts up all the components.  Any exception generated during the
            starting of the components is handled by the caller.
589
        """
590
591
        # Start the real core (sockcreator, msgq, cfgmgr)
        self._component_configurator.startup(self.__core_components)
592

593
594
        # Connect to the msgq. This is not a process, so it's not handled
        # inside the configurator.
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
595
        self.start_ccsession(self.c_channel_env)
596
597

        # Extract the parameters associated with Bob.  This can only be
598
599
        # done after the CC Session is started.  Note that the logging
        # configuration may override the "-v" switch set on the command line.
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
600
        self._read_bind10_config()
601

602
        # TODO: Return the dropping of privileges
603

604
605
606
    def startup(self):
        """
            Start the BoB instance.
607

608
609
610
611
612
613
614
            Returns None if successful, otherwise an string describing the
            problem.
        """
        # Try to connect to the c-channel daemon, to see if it is already
        # running
        c_channel_env = {}
        if self.msgq_socket_file is not None:
615
616
             c_channel_env["BIND10_MSGQ_SOCKET_FILE"] = self.msgq_socket_file
        logger.debug(DBG_PROCESS, BIND10_CHECK_MSGQ_ALREADY_RUNNING)
617
        # try to connect, and if we can't wait a short while
618
        try:
619
            self.cc_session = isc.cc.Session(self.msgq_socket_file)
620
            logger.fatal(BIND10_MSGQ_ALREADY_RUNNING)
621
622
623
624
            return "b10-msgq already running, or socket file not cleaned , cannot start"
        except isc.cc.session.SessionError:
            # this is the case we want, where the msgq is not running
            pass
625

626
627
        # Start all components.  If any one fails to start, kill all started
        # components and exit with an error indication.
628
        try:
629
            self.c_channel_env = c_channel_env
630
            self.start_all_components()
631
        except Exception as e:
632
            self.kill_started_components()
633
            return "Unable to start " + self.curproc + ": " + str(e)
634

635
        # Started successfully
636
        self.runnable = True
637
        self.__started = True
638
639
        return None

640
    def stop_process(self, process, recipient, pid):
641
642
        """
        Stop the given process, friendly-like. The process is the name it has
643
644
645
        (in logs, etc), the recipient is the address on msgq. The pid is the
        pid of the process (if we have multiple processes of the same name,
        it might want to choose if it is for this one).
646
        """
647
        logger.info(BIND10_STOP_PROCESS, process)
648
649
650
        self.cc_session.group_sendmsg(isc.config.ccsession.
                                      create_command('shutdown', {'pid': pid}),
                                      recipient, recipient)
651

652
653
654
655
    def component_shutdown(self, exitcode=0):
        """
        Stop the Boss instance from a components' request. The exitcode
        indicates the desired exit code.
656

657
658
        If we did not start yet, it raises an exception, which is meant
        to propagate through the component and configurator to the startup
659
        routine and abort the startup immediately. If it is started up already,
660
        we just mark it so we terminate soon.
661

662
663
664
665
666
667
668
        It does set the exit code in both cases.
        """
        self.exitcode = exitcode
        if not self.__started:
            raise Exception("Component failed during startup");
        else:
            self.runnable = False
669
670
671

    def shutdown(self):
        """Stop the BoB instance."""
672
        logger.info(BIND10_SHUTDOWN)
Jelte Jansen's avatar
Jelte Jansen committed
673
674
675
676
        # If ccsession is still there, inform rest of the system this module
        # is stopping. Since everything will be stopped shortly, this is not
        # really necessary, but this is done to reflect that boss is also
        # 'just' a module.
677
        self.ccs.send_stopping()
Jelte Jansen's avatar
Jelte Jansen committed
678
679

        # try using the BIND 10 request to stop
680
        try:
681
            self._component_configurator.shutdown()
682
683
        except:
            pass
684
        # XXX: some delay probably useful... how much is uncertain
685
686
        # I have changed the delay from 0.5 to 1, but sometime it's 
        # still not enough.
687
        time.sleep(1)
688
        self.reap_children()
689
690
691

        # Send TERM and KILL signals to modules if we're not prevented
        # from doing so
692
        if not self.nokill:
693
            # next try sending a SIGTERM
694
            self.__kill_children(False)
695
696
            # finally, send SIGKILL (unmaskable termination) until everybody
            # dies
697
698
699
700
            while self.components:
                # XXX: some delay probably useful... how much is uncertain
                time.sleep(0.1)
                self.reap_children()
701
                self.__kill_children(True)
702
            logger.info(BIND10_SHUTDOWN_COMPLETE)
703

704
    def __kill_children(self, forceful):
705
706
707
708
709
710
711
712
        '''Terminate remaining subprocesses by sending a signal.

        The forceful paramter will be passed Component.kill().
        This is a dedicated subroutine of shutdown(), just to unify two
        similar cases.

        '''
        logmsg = BIND10_SEND_SIGKILL if forceful else BIND10_SEND_SIGTERM
713
714
715
        # We need to make a copy of values as the components may be modified
        # in the loop.
        for component in list(self.components.values()):
716
717
718
            logger.info(logmsg, component.name(), component.pid())
            try:
                component.kill(forceful)
719
720
721
722
723
724
725
726
727
728
            except OSError as ex:
                # If kill() failed due to EPERM, it doesn't make sense to
                # keep trying, so we just log the fact and forget that
                # component.  Ignore other OSErrors (usually ESRCH because
                # the child finally exited)
                signame = "SIGKILL" if forceful else "SIGTERM"
                logger.info(BIND10_SEND_SIGNAL_FAIL, signame,
                            component.name(), component.pid(), ex)
                if ex.errno == errno.EPERM:
                    del self.components[component.pid()]
729

Shane Kerr's avatar
Shane Kerr committed
730
731
732
    def _get_process_exit_status(self):
        return os.waitpid(-1, os.WNOHANG)

733
734
735
    def reap_children(self):
        """Check to see if any of our child processes have exited, 
        and note this for later handling. 
736
        """
737
738
        while True:
            try:
Shane Kerr's avatar
Shane Kerr committed
739
                (pid, exit_status) = self._get_process_exit_status()
740
741
742
743
744
            except OSError as o:
                if o.errno == errno.ECHILD: break
                # XXX: should be impossible to get any other error here
                raise
            if pid == 0: break
745
746
747
            if pid in self.components:
                # One of the components we know about.  Get information on it.
                component = self.components.pop(pid)
748
749
                logger.info(BIND10_PROCESS_ENDED, component.name(), pid,
                            exit_status)
750
                if component.is_running() and self.runnable:
751
752
753
                    # Tell it it failed. But only if it matters (we are
                    # not shutting down and the component considers itself
                    # to be running.
754
755
756
757
758
                    component_restarted = component.failed(exit_status);
                    # if the process wants to be restarted, but not just yet,
                    # it returns False
                    if not component_restarted:
                        self.components_to_restart.append(component)
759
            else:
760
                logger.info(BIND10_UNKNOWN_CHILD_PROCESS_ENDED, pid)
761
762

    def restart_processes(self):
763
764
765
766
767
768
769
770
771
        """
            Restart any dead processes:

            * Returns the time when the next process is ready to be restarted. 
            * If the server is shutting down, returns 0.
            * If there are no processes, returns None.

            The values returned can be safely passed into select() as the 
            timeout value.
772

773
        """
774
        if not self.runnable:
775
            return 0
776
        still_dead = []
Jelte Jansen's avatar
Jelte Jansen committed
777
778
        # keep track of the first time we need to check this queue again,
        # if at all
779
        next_restart_time = None
780
        now = time.time()
781
        for component in self.components_to_restart:
782
783
784
785
786
787
            # If the component was removed from the configurator between since
            # scheduled to restart, just ignore it.  The object will just be
            # dropped here.
            if not self._component_configurator.has_component(component):
                logger.info(BIND10_RESTART_COMPONENT_SKIPPED, component.name())
            elif not component.restart(now):
788
789
790
791
792
793
794
                still_dead.append(component)
                if next_restart_time is None or\
                   next_restart_time > component.get_restart_time():
                    next_restart_time = component.get_restart_time()
        self.components_to_restart = still_dead

        return next_restart_time
795

796
797
798
799
800
    def _get_socket(self, args):
        """
        Implementation of the get_socket CC command. It asks the cache
        to provide the token and sends the information back.
        """
801
802
803
804
805
806
807
808
809
810
        try:
            try:
                addr = isc.net.parse.addr_parse(args['address'])
                port = isc.net.parse.port_parse(args['port'])
                protocol = args['protocol']
                if protocol not in ['UDP', 'TCP']:
                    raise ValueError("Protocol must be either UDP or TCP")
                share_mode = args['share_mode']
                if share_mode not in ['ANY', 'SAMEAPP', 'NO']:
                    raise ValueError("Share mode must be one of ANY, SAMEAPP" +
811
                                     " or NO")
812
813
814
815
816
817
818
                share_name = args['share_name']
            except KeyError as ke:
                return \
                    isc.config.ccsession.create_answer(1,
                                                       "Missing parameter " +
                                                       str(ke))

819
820
821
            # FIXME: This call contains blocking IPC. It is expected to be
            # short, but if it turns out to be problem, we'll need to do
            # something about it.
822
823
824
825
826
827
            token = self._socket_cache.get_token(protocol, addr, port,
                                                 share_mode, share_name)
            return isc.config.ccsession.create_answer(0, {
                'token': token,
                'path': self._socket_path
            })
828
        except isc.bind10.socket_cache.SocketError as e:
829
830
            return isc.config.ccsession.create_answer(CREATOR_SOCKET_ERROR,
                                                      str(e))
831
        except isc.bind10.socket_cache.ShareError as e:
832
833
            return isc.config.ccsession.create_answer(CREATOR_SHARE_ERROR,
                                                      str(e))
834
835
        except Exception as e:
            return isc.config.ccsession.create_answer(1, str(e))
836

837
838
839
840
    def socket_request_handler(self, token, unix_socket):
        """
        This function handles a token that comes over a unix_domain socket.
        The function looks into the _socket_cache and sends the socket
841
        identified by the token back over the unix_socket.
842
        """
843
        try:
844
            token = str(token, 'ASCII') # Convert from bytes to str
845
            fd = self._socket_cache.get_socket(token, unix_socket.fileno())
846
847
848
849
850
            # FIXME: These two calls are blocking in their nature. An OS-level
            # buffer is likely to be large enough to hold all these data, but
            # if it wasn't and the remote application got stuck, we would have
            # a problem. If there appear such problems, we should do something
            # about it.
851
            unix_socket.sendall(CREATOR_SOCKET_OK)
852
853
            libutil_io_python.send_fd(unix_socket.fileno(), fd)
        except Exception as e:
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
854
            logger.info(BIND10_NO_SOCKET, token, e)
855
            unix_socket.sendall(CREATOR_SOCKET_UNAVAILABLE)
856
857
858
859
860
861
862

    def socket_consumer_dead(self, unix_socket):
        """
        This function handles when a unix_socket closes. This means all
        sockets sent to it are to be considered closed. This function signals
        so to the _socket_cache.
        """
Michal 'vorner' Vaner's avatar
Michal 'vorner' Vaner committed
863
        logger.info(BIND10_LOST_SOCKET_CONSUMER, unix_socket.fileno())
864
865
866
867
868
869
870
871
        try:
            self._socket_cache.drop_application(unix_socket.fileno())
        except ValueError:
            # This means the application holds no sockets. It's harmless, as it
            # can happen in real life - for example, it requests a socket, but
            # get_socket doesn't find it, so the application dies. It should be
            # rare, though.
            pass
872

873
    def set_creator(self, creator):
874
875
876
877
878
879
880
881
882
883
884
        """
        Registeres a socket creator into the boss. The socket creator is not
        used directly, but through a cache. The cache is created in this
        method.

        If called more than once, it raises a ValueError.
        """
        if self._socket_cache is not None:
            raise ValueError("A creator was inserted previously")
        self._socket_cache = isc.bind10.socket_cache.Cache(creator)

885
886
887
888
889
890
891
892
893
894
895
896
897
    def init_socket_srv(self):
        """
        Creates and listens on a unix-domain socket to be able to send out
        the sockets.

        This method should be called after switching user, or the switched
        applications won't be able to access the socket.
        """
        self._srv_socket = socket.socket(socket.AF_UNIX)
        # We create a temporary directory somewhere safe and unique, to avoid
        # the need to find the place ourself or bother users. Also, this
        # secures the socket on some platforms, as it creates a private
        # directory.
898
        self._tmpdir = tempfile.mkdtemp(prefix='sockcreator-')
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
        # Get the name
        self._socket_path = os.path.join(self._tmpdir, "sockcreator")
        # And bind the socket to the name
        self._srv_socket.bind(self._socket_path)
        self._srv_socket.listen(5)

    def remove_socket_srv(self):
        """
        Closes and removes the listening socket and the directory where it
        lives, as we created both.

        It does nothing if the _srv_socket is not set (eg. it was not yet
        initialized).
        """
        if self._srv_socket is not None:
            self._srv_socket.close()
            os.remove(self._socket_path)
            os.rmdir(self._tmpdir)

918
919
920
921
922
    def _srv_accept(self):
        """
        Accept a socket from the unix domain socket server and put it to the
        others we care about.
        """
923
        (socket, conn) = self._srv_socket.accept()
924
        self._unix_sockets[socket.fileno()] = (socket, b'')
925

926
927
928
929
930
931
    def _socket_data(self, socket_fileno):
        """
        This is called when a socket identified by the socket_fileno needs
        attention. We try to read data from there. If it is closed, we remove
        it.
        """
932
933
        (sock, previous) = self._unix_sockets[socket_fileno]
        while True:
934
935
936
937
938
939
940
941
942
            try:
                data = sock.recv(1, socket.MSG_DONTWAIT)
            except socket.error as se:
                # These two might be different on some systems
                if se.errno == errno.EAGAIN or se.errno == errno.EWOULDBLOCK:
                    # No more data now. Oh, well, just store what we have.
                    self._unix_sockets[socket_fileno] = (sock, previous)
                    return
                else:
943
                    data = b'' # Pretend it got closed
944
945
946
947
948
            if len(data) == 0: # The socket got to it's end
                del self._unix_sockets[socket_fileno]
                self.socket_consumer_dead(sock)
                sock.close()
                return
949
950
            else:
                if data == b"\n":
951
952
953
                    # Handle this token and clear it
                    self.socket_request_handler(previous, sock)
                    previous = b''
954
955
                else:
                    previous += data
956

957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
    def run(self, wakeup_fd):
        """
        The main loop, waiting for sockets, commands and dead processes.
        Runs as long as the runnable is true.

        The wakeup_fd descriptor is the read end of pipe where CHLD signal
        handler writes.
        """
        ccs_fd = self.ccs.get_socket().fileno()
        while self.runnable:
            # clean up any processes that exited
            self.reap_children()
            next_restart = self.restart_processes()
            if next_restart is None:
                wait_time = None
            else:
                wait_time = max(next_restart - time.time(), 0)

            # select() can raise EINTR when a signal arrives,
            # even if they are resumable, so we have to catch
            # the exception
            try:
979
980
                (rlist, wlist, xlist) = \
                    select.select([wakeup_fd, ccs_fd,
981
982
                                   self._srv_socket.fileno()] +
                                   list(self._unix_sockets.keys()), [], [],
983
                                  wait_time)
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
            except select.error as err:
                if err.args[0] == errno.EINTR:
                    (rlist, wlist, xlist) = ([], [], [])
                else:
                    logger.fatal(BIND10_SELECT_ERROR, err)
                    break

            for fd in rlist + xlist:
                if fd == ccs_fd:
                    try:
                        self.ccs.check_command()
                    except isc.cc.session.ProtocolError:
                        logger.fatal(BIND10_MSGQ_DISAPPEARED)
                        self.runnable = False
                        break
                elif fd == wakeup_fd:
                    os.read(wakeup_fd, 32)
1001
1002
                elif fd == self._srv_socket.fileno():
                    self._srv_accept()
1003
1004
                elif fd in self._unix_sockets:
                    self._socket_data(fd)
1005

1006
1007
1008
1009
# global variables, needed for signal handlers
options = None
boss_of_bind = None

Shane Kerr's avatar
Shane Kerr committed
1010
1011
1012
1013
1014
1015
def reaper(signal_number, stack_frame):
    """A child process has died (SIGCHLD received)."""
    # don't do anything... 
    # the Python signal handler has been set up to write
    # down a pipe, waking up our select() bit
    pass
1016

Shane Kerr's avatar
Shane Kerr committed
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
def get_signame(signal_number):
    """Return the symbolic name for a signal."""
    for sig in dir(signal):
        if sig.startswith("SIG") and sig[3].isalnum():
            if getattr(signal, sig) == signal_number:
                return sig
    return "Unknown signal %d" % signal_number

# XXX: perhaps register atexit() function and invoke that instead
def fatal_signal(signal_number, stack_frame):
    """We need to exit (SIGINT or SIGTERM received)."""
    global options
    global boss_of_bind
1030
    logger.info(BIND10_RECEIVED_SIGNAL, get_signame(signal_number))
Shane Kerr's avatar
Shane Kerr committed
1031
1032
1033
    signal.signal(signal.SIGCHLD, signal.SIG_DFL)
    boss_of_bind.runnable = False

Michal Vaner's avatar
Michal Vaner committed
1034
1035
def process_rename(option, opt_str, value, parser):
    """Function that renames the process if it is requested by a option."""
1036
    isc.util.process.rename(value)
Michal Vaner's avatar
Michal Vaner committed
1037

1038
def parse_args(args=sys.argv[1:], Parser=OptionParser):
1039
1040
1041
1042
    """
    Function for parsing command line arguments. Returns the
    options object from OptionParser.
    """
1043
    parser = Parser(version=VERSION)
Evan Hunt's avatar
Evan Hunt committed
1044
1045
1046
    parser.add_option("-m", "--msgq-socket-file", dest="msgq_socket_file",
                      type="string", default=None,
                      help="UNIX domain socket file the b10-msgq daemon will use")
1047
    parser.add_option("-i", "--no-kill", action="store_true", dest="nokill",
1048
                      default=False, help="do not send SIGTERM and SIGKILL signals to modules during shutdown")
1049
    parser.add_option("-u", "--user", dest="user", type="string", default=None,
1050
                      help="Change user after startup (must run as root)")
Evan Hunt's avatar
Evan Hunt committed
1051
1052
    parser.add_option("-v", "--verbose", dest="verbose", action="store_true",
                      help="display more about what is going on")
Michal Vaner's avatar
Michal Vaner committed
1053
1054
1055
    parser.add_option("--pretty-name", type="string", action="callback",
                      callback=process_rename,
                      help="Set the process name (displayed in ps, top, ...)")
1056
1057
1058
    parser.add_option("-c", "--config-file", action="store",
                      dest="config_file", default=None,
                      help="Configuration database filename")
1059
1060
    parser.add_option("--clear-config", action="store_true",
                      dest="clear_config", default=False,
1061
1062
                      help="Create backup of the configuration file and " +
                           "start with a clean configuration")
1063
1064
1065
    parser.add_option("-p", "--data-path", dest="data_path",
                      help="Directory to search for configuration files",
                      default=None)
1066
1067
    parser.add_option("--cmdctl-port", dest="cmdctl_port", type="int",
                      default=None, help="Port of command control")
1068
1069
1070
    parser.add_option("--pid-file", dest="pid_file", type="string",
                      default=None,
                      help="file to dump the PID of the BIND 10 process")
1071
1072
    parser.add_option("-w", "--wait", dest="wait_time", type="int",
                      default=10, help="Time (in seconds) to wait for config manager to start up")
1073

1074
    (options, args) = parser.parse_args(args)
1075

1076
1077
1078
1079
1080
    if options.cmdctl_port is not None:
        try:
            isc.net.parse.port_parse(options.cmdctl_port)
        except ValueError as e:
            parser.error(e)
1081

1082
1083
1084
1085
    if args:
        parser.print_help()
        sys.exit(1)

1086
1087
    return options

JINMEI Tatuya's avatar