Return to ServerProcessUnix.cpp CVS log

Up to [Pegasus] / pegasus / src / Service

BUG#: 7231
TITLE: cimserver start-up command does not time out
DESCRIPTION: When privilege separation is enabled, allow the cimserver start-up command to time out even if the server initialization hangs.

//%2006////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation, The Open Group.
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; VERITAS Software Corporation; The Open Group.
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
// EMC Corporation; Symantec Corporation; The Open Group.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
//
//%/////////////////////////////////////////////////////////////////////////////

#include <fcntl.h>
#include <unistd.h>

#include <Pegasus/Common/Signal.h>
#include <Pegasus/Common/Executor.h>
#include <Pegasus/Common/AtomicInt.h>
#include <Pegasus/Common/Thread.h>
#include <Pegasus/Common/Threads.h>

#define MAX_WAIT_TIME 240

PEGASUS_USING_PEGASUS;
PEGASUS_USING_STD;

Boolean handleSigUsr1 = false;
Boolean graveError = false;

void sigUsr1Handler(int s_n, PEGASUS_SIGINFO_T * s_info, void * sig)
{
    handleSigUsr1 = true;
}

void sigTermHandler(int s_n, PEGASUS_SIGINFO_T * s_info, void * sig)
{
    graveError= handleSigUsr1=true;
}


#if defined(PEGASUS_ENABLE_PRIVILEGE_SEPARATION)
/**
    Indicates whether the Executor has been instructed to daemonize or
    otherwise exit.
*/
static AtomicInt _hasDaemonized(0);

/**
    A watchdog thread that used to allow the server start-up command to
    time out and return control even if the server initialization is not
    complete.
*/
static Thread* _waitForDaemonizationThread = 0;

/**
    Wait for server start-up to complete.  If the MAX_WAIT_TIME elapses
    before the Executor is instructed to daemonize, then initiate the
    daemonization.  This is necessary to prevent a server start-up hang
    from hanging the cimserver command.
*/
static ThreadReturnType PEGASUS_THREAD_CDECL _waitForDaemonization(void* parm)
{
    Thread *myself = reinterpret_cast<Thread *>(parm);
    AtomicInt* hasDaemonized = reinterpret_cast<AtomicInt*>(myself->get_parm());

    Uint32 waitTimeMsec = MAX_WAIT_TIME * 1000;

    while (!hasDaemonized->get() && waitTimeMsec > 0)
    {
        Threads::sleep(100);
        waitTimeMsec -= 100;
    }

    if (!hasDaemonized->get())
    {
        MessageLoaderParms parms(
            "src.Service.ServerProcessUnix.CIMSERVER_START_TIMEOUT",
            "The cimserver command timed out waiting for the CIM server "
                "to start.");
        PEGASUS_STD(cerr) << MessageLoader::getMessage(parms) <<
            PEGASUS_STD(endl);
        *hasDaemonized = 1;
        Executor::daemonizeExecutor();
    }

    myself->exit_self((ThreadReturnType)1);
    return 0;
}
#endif


//constructor
ServerProcess::ServerProcess() {}

//destructor
ServerProcess::~ServerProcess() {}

// no-ops
void ServerProcess::cimserver_set_process(void* p) {}
void ServerProcess::cimserver_exitRC(int rc) {}
int ServerProcess::cimserver_initialize() { return 1; }

// for all OSes supporting signals provide a cimserver_wait function
// that waits to be awakened by signal PEGASUS_SIGTERM or PEGASUS_SIGHUP
#ifdef PEGASUS_HAS_SIGNALS
int ServerProcess::cimserver_wait()
{
    int sig = -1;
    sigset_t set;
    sigemptyset(&set);
    sigaddset(&set, PEGASUS_SIGTERM);
    sigaddset(&set, PEGASUS_SIGHUP);
    errno = 0;
    do
    {
#if defined(PEGASUS_OS_ZOS) || defined(PEGASUS_OS_SOLARIS)
        sig = sigwait(&set);
#else // else for platforms = LINUX, HPUX, AIX
        sigwait(&set, &sig);
#endif
    } while (errno == EINTR);
    return sig;
}
#else
int ServerProcess::cimserver_wait() { return 1; }
#endif

String ServerProcess::getHome() { return String::EMPTY; }

// daemon_init , RW Stevens, "Advance UNIX Programming"

int ServerProcess::cimserver_fork()
{
    getSigHandle()->registerHandler(SIGTERM, sigTermHandler);
    getSigHandle()->activate(SIGTERM);
    umask(S_IRWXG | S_IRWXO);

#if defined(PEGASUS_ENABLE_PRIVILEGE_SEPARATION)
    if (Executor::detectExecutor() == 0)
    {
        // We don't need to fork if we're running with Privilege Separation
        setsid();

        _waitForDaemonizationThread = new Thread(
            _waitForDaemonization, &_hasDaemonized, false);
        if (_waitForDaemonizationThread->run() != PEGASUS_THREAD_OK)
        {
            // Unable to start watchdog thread.
            delete _waitForDaemonizationThread;
            _waitForDaemonizationThread = 0;
        }

        return 0;
    }
#endif

    getSigHandle()->registerHandler(PEGASUS_SIGUSR1, sigUsr1Handler);
    getSigHandle()->activate(PEGASUS_SIGUSR1);

    pid_t pid;
    if( (pid = fork() ) < 0)
    {
        getSigHandle()->deactivate(PEGASUS_SIGUSR1);
        getSigHandle()->deactivate(SIGTERM);
        return -1;
    }
    else if (pid != 0)
    {
        //
        // parent wait for child
        // if there is a problem with signal, parent process terminates
        // when waitTime expires
        //
        Uint32 waitTime = MAX_WAIT_TIME;

        while (!handleSigUsr1 && waitTime > 0)
        {
            sleep(1);
            waitTime--;
        }

        if (!handleSigUsr1)
        {
            MessageLoaderParms parms(
                "src.Service.ServerProcessUnix.CIMSERVER_START_TIMEOUT",
                "The cimserver command timed out waiting for the CIM server "
                    "to start.");
            PEGASUS_STD(cerr) << MessageLoader::getMessage(parms) <<
                PEGASUS_STD(endl);
        }
        exit(graveError);
    }

    setsid();
    umask(S_IRWXG | S_IRWXO);

    // spawned daemon process doesn't need the old signal handlers of its parent
    getSigHandle()->deactivate(PEGASUS_SIGUSR1);
    getSigHandle()->deactivate(SIGTERM);

    return 0;
}


// notify parent process to terminate so user knows that cimserver
// is ready to serve CIM requests.
void ServerProcess::notify_parent(int id)
{
    pid_t ppid = getppid();
    if (id)
    {
        kill(ppid, SIGTERM);
    }
    else
    {
#if defined(PEGASUS_ENABLE_PRIVILEGE_SEPARATION)
        if (Executor::detectExecutor() == 0)
        {
            // Note:  This logic contains a race condition which may allow the
            // Executor to daemonize twice.  However, the Executor is expected
            // to handle this condition gracefully.
            if (!_hasDaemonized.get())
            {
                Executor::daemonizeExecutor();
            }
        }
        else
#endif
        {
            kill(ppid, PEGASUS_SIGUSR1);
        }
    }

#if defined(PEGASUS_ENABLE_PRIVILEGE_SEPARATION)
    if (_waitForDaemonizationThread)
    {
        _hasDaemonized = 1;
        delete _waitForDaemonizationThread;
        _waitForDaemonizationThread = 0;
    }
#endif
}


// Platform specific run
int ServerProcess::platform_run(
    int argc,
    char** argv,
    Boolean shutdownOption,
    Boolean debugOutputOption)
{
    return cimserver_run(argc, argv, shutdownOption, debugOutputOption);
}