Synnefo

#!/usr/bin/env python

# Copyright 2011 GRNET S.A. All rights reserved.

#

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions

# are met:

#

#   1. Redistributions of source code must retain the above copyright

#      notice, this list of conditions and the following disclaimer.

#

#  2. Redistributions in binary form must reproduce the above copyright

#     notice, this list of conditions and the following disclaimer in the

#     documentation and/or other materials provided with the distribution.

#

# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND

# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

# ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE

# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

# SUCH DAMAGE.

#

# The views and conclusions contained in the software and documentation are

# those of the authors and should not be interpreted as representing official

# policies, either expressed or implied, of GRNET S.A.

""" Message queue setup, dispatch and admin

This program sets up connections to the queues configured in settings.py

and implements the message wait and dispatch loops. Actual messages are

handled in the dispatched functions.

"""

from django.core.management import setup_environ

# Fix path to import synnefo settings

import sys

import os

path = os.path.normpath(os.path.join(os.getcwd(), '..'))

sys.path.append(path)

from synnefo import settings

setup_environ(settings)

import logging

import time

import daemon.runner

import daemon.daemon

from lockfile import LockTimeout

from signal import signal, SIGINT, SIGTERM

# Take care of differences between python-daemon versions.

try:

    from daemon import pidfile as pidlockfile

except:

    from daemon import pidlockfile

from synnefo.lib.amqp import AMQPClient

from synnefo.logic import callbacks

from synnefo.util.dictconfig import dictConfig

log = logging.getLogger()

# Queue names

QUEUES = []

# Queue bindings to exchanges

BINDINGS = []

class Dispatcher:

    debug = False

    client_promises = []

    def __init__(self, debug=False):

        self.debug = debug

        self._init()

    def wait(self):

        log.info("Waiting for messages..")

        while True:

            try:

                self.client.basic_wait()

            except SystemExit:

                break

            except Exception as e:

                log.exception("Caught unexpected exception: %s", e)

        self.client.basic_cancel()

        self.client.close()

    def _init(self):

        global QUEUES, BINDINGS

        log.info("Initializing")

        self.client = AMQPClient()

        # Connect to AMQP host

        self.client.connect()

        # Declare queues and exchanges

        for exchange in settings.EXCHANGES:

            self.client.exchange_declare(exchange=exchange,

                                         type="topic")

        for queue in QUEUES:

            # Queues are mirrored to all RabbitMQ brokers

            self.client.queue_declare(queue=queue, mirrored=True)

        bindings = BINDINGS

        # Bind queues to handler methods

        for binding in bindings:

            try:

                callback = getattr(callbacks, binding[3])

            except AttributeError:

                log.error("Cannot find callback %s", binding[3])

                raise SystemExit(1)

            self.client.queue_bind(queue=binding[0], exchange=binding[1],

                                   routing_key=binding[2])

            consume_promise = self.client.basic_consume(queue=binding[0],

                                                        callback=callback)

            log.debug("Binding %s(%s) to queue %s with handler %s",

                      binding[1], binding[2], binding[0], binding[3])

            self.client_promises.append(consume_promise)

def _init_queues():

    global QUEUES, BINDINGS

    # Queue declarations

    prefix = settings.BACKEND_PREFIX_ID.split('-')[0]

    QUEUE_GANETI_EVENTS_OP = "%s-events-op" % prefix

    QUEUE_GANETI_EVENTS_NET = "%s-events-net" % prefix

    QUEUE_GANETI_BUILD_PROGR = "%s-events-progress" % prefix

    QUEUE_RECONC = "%s-reconciliation" % prefix

    if settings.DEBUG is True:

        QUEUE_DEBUG = "%s-debug" % prefix  # Debug queue, retrieves all messages

    QUEUES = (QUEUE_GANETI_EVENTS_OP, QUEUE_GANETI_EVENTS_NET, QUEUE_RECONC,

              QUEUE_GANETI_BUILD_PROGR)

    # notifications of type "ganeti-op-status"

    DB_HANDLER_KEY_OP = 'ganeti.%s.event.op' % prefix

    # notifications of type "ganeti-net-status"

    DB_HANDLER_KEY_NET = 'ganeti.%s.event.net' % prefix

    # notifications of type "ganeti-create-progress"

    BUILD_MONITOR_HANDLER = 'ganeti.%s.event.progress' % prefix

    # reconciliation

    RECONC_HANDLER = 'reconciliation.%s.*' % prefix

    BINDINGS = [

    # Queue                   # Exchange                # RouteKey              # Handler

    (QUEUE_GANETI_EVENTS_OP,  settings.EXCHANGE_GANETI, DB_HANDLER_KEY_OP,      'update_db'),

    (QUEUE_GANETI_EVENTS_NET, settings.EXCHANGE_GANETI, DB_HANDLER_KEY_NET,     'update_net'),

    (QUEUE_GANETI_BUILD_PROGR, settings.EXCHANGE_GANETI, BUILD_MONITOR_HANDLER,  'update_build_progress'),

    ]

    if settings.DEBUG is True:

        BINDINGS += [

            # Queue       # Exchange          # RouteKey  # Handler

            (QUEUE_DEBUG, settings.EXCHANGE_GANETI, '#',  'dummy_proc'),

            (QUEUE_DEBUG, settings.EXCHANGE_CRON,   '#',  'dummy_proc'),

            (QUEUE_DEBUG, settings.EXCHANGE_API,    '#',  'dummy_proc'),

        ]

        QUEUES += (QUEUE_DEBUG,)

def _exit_handler(signum, frame):

    """"Catch exit signal in children processes"""

    log.info("Caught signal %d, will raise SystemExit", signum)

    raise SystemExit

def _parent_handler(signum, frame):

    """"Catch exit signal in parent process and forward it to children."""

    global children

    log.info("Caught signal %d, sending SIGTERM to children %s",

             signum, children)

    [os.kill(pid, SIGTERM) for pid in children]

def child(cmdline):

    """The context of the child process"""

    # Cmd line argument parsing

    (opts, args) = parse_arguments(cmdline)

    disp = Dispatcher(debug=opts.debug)

    # Start the event loop

    disp.wait()

def parse_arguments(args):

    from optparse import OptionParser

    default_pid_file = os.path.join("var", "run", "synnefo", "dispatcher.pid")

    parser = OptionParser()

    parser.add_option("-d", "--debug", action="store_true", default=False,

                      dest="debug", help="Enable debug mode")

    parser.add_option("-w", "--workers", default=2, dest="workers",

                      help="Number of workers to spawn", type="int")

    parser.add_option("-p", "--pid-file", dest="pid_file",

                      default=default_pid_file,

                      help="Save PID to file (default: %s)" % default_pid_file)

    parser.add_option("--purge-queues", action="store_true",

                      default=False, dest="purge_queues",

                      help="Remove all declared queues (DANGEROUS!)")

    parser.add_option("--purge-exchanges", action="store_true",

                      default=False, dest="purge_exchanges",

                      help="Remove all exchanges. Implies deleting all queues \

                           first (DANGEROUS!)")

    parser.add_option("--drain-queue", dest="drain_queue",

                      help="Strips a queue from all outstanding messages")

    return parser.parse_args(args)

def purge_queues():

    """

        Delete declared queues from RabbitMQ. Use with care!

    """

    global QUEUES, BINDINGS

    client = AMQPClient()

    client.connect()

    print "Queues to be deleted: ", QUEUES

    if not get_user_confirmation():

        return

    for queue in QUEUES:

        result = client.queue_delete(queue=queue)

        print "Deleting queue %s. Result: %s" % (queue, result)

    client.close()

def purge_exchanges():

    """Delete declared exchanges from RabbitMQ, after removing all queues"""

    global QUEUES, BINDINGS

    purge_queues()

    client = AMQPClient()

    client.connect()

    print "Exchanges to be deleted: ", settings.EXCHANGES

    if not get_user_confirmation():

        return

    for exchange in settings.EXCHANGES:

        result = client.exchange_delete(exchange=exchange)

        print "Deleting exchange %s. Result: %s" % (exchange, result)

    client.close()

def drain_queue(queue):

    """Strip a (declared) queue from all outstanding messages"""

    global QUEUES, BINDINGS

    if not queue:

        return

    if not queue in QUEUES:

        print "Queue %s not configured" % queue

        return

    print "Queue to be drained: %s" % queue

    if not get_user_confirmation():

        return

    client = AMQPClient()

    client.connect()

    # Register a temporary queue binding

    for binding in BINDINGS:

        if binding[0] == queue:

            exch = binding[1]

    tag = client.basic_consume(queue=queue, callback=callbacks.dummy_proc)

    print "Queue draining about to start, hit Ctrl+c when done"

    time.sleep(2)

    print "Queue draining starting"

    signal(SIGTERM, _exit_handler)

    signal(SIGINT, _exit_handler)

    num_processed = 0

    while True:

        client.basic_wait()

        num_processed += 1

        sys.stderr.write("Ignored %d messages\r" % num_processed)

    client.basic_cancel(tag)

    client.close()

def get_user_confirmation():

    ans = raw_input("Are you sure (N/y):")

    if not ans:

        return False

    if ans not in ['Y', 'y']:

        return False

    return True

def debug_mode():

    disp = Dispatcher(debug=True)

    signal(SIGINT, _exit_handler)

    signal(SIGTERM, _exit_handler)

    disp.wait()

def daemon_mode(opts):

    global children

    # Create pidfile,

    pidf = pidlockfile.TimeoutPIDLockFile(opts.pid_file, 10)

    if daemon.runner.is_pidfile_stale(pidf):

        log.warning("Removing stale PID lock file %s", pidf.path)

        pidf.break_lock()

    try:

        pidf.acquire()

    except (pidlockfile.AlreadyLocked, LockTimeout):

        log.critical("Failed to lock pidfile %s, another instance running?",

                     pidf.path)

        sys.exit(1)

    log.info("Became a daemon")

    # Fork workers

    children = []

    i = 0

    while i < opts.workers:

        newpid = os.fork()

        if newpid == 0:

            signal(SIGINT, _exit_handler)

            signal(SIGTERM, _exit_handler)

            child(sys.argv[1:])

            sys.exit(1)

        else:

            log.debug("%d, forked child: %d", os.getpid(), newpid)

            children.append(newpid)

        i += 1

    # Catch signals to ensure graceful shutdown

    signal(SIGINT, _parent_handler)

    signal(SIGTERM, _parent_handler)

    # Wait for all children processes to die, one by one

    try:

        for pid in children:

            try:

                os.waitpid(pid, 0)

            except Exception:

                pass

    finally:

        pidf.release()

def main():

    (opts, args) = parse_arguments(sys.argv[1:])

    dictConfig(settings.DISPATCHER_LOGGING)

    global log

    # Init the global variables containing the queues

    _init_queues()

    # Special case for the clean up queues action

    if opts.purge_queues:

        purge_queues()

        return

    # Special case for the clean up exch action

    if opts.purge_exchanges:

        purge_exchanges()

        return

    if opts.drain_queue:

        drain_queue(opts.drain_queue)

        return

    # Debug mode, process messages without spawning workers

    if opts.debug:

        debug_mode()

        return

    files_preserve = []

    for handler in log.handlers:

        stream = getattr(handler, 'stream')

        if stream and hasattr(stream, 'fileno'):

            files_preserve.append(handler.stream)

    daemon_context = daemon.daemon.DaemonContext(

        files_preserve=files_preserve,

        umask=022)

    daemon_context.open()

    # Catch every exception, make sure it gets logged properly

    try:

        daemon_mode(opts)

    except Exception:

        log.exception("Unknown error")

        raise

if __name__ == "__main__":

    sys.exit(main())

# vim: set sta sts=4 shiftwidth=4 sw=4 et ai :