libcore/include/sirikata/core/service/Context.hpp

Go to the documentation of this file.

/*  Sirikata
 *  Context.hpp
 *
 *  Copyright (c) 2009, Ewen Cheslack-Postava
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * 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.
 *  * Neither the name of Sirikata nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER
 * 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.
 */

#ifndef _SIRIKATA_CONTEXT_HPP_
#define _SIRIKATA_CONTEXT_HPP_

#include <sirikata/core/network/IOService.hpp>
#include <sirikata/core/network/IOStrand.hpp>
#include <sirikata/core/network/IOTimer.hpp>
#include <sirikata/core/util/Thread.hpp>
#include <sirikata/core/util/Timer.hpp>
#include "TimeProfiler.hpp"
#include "Service.hpp"
#include "Signal.hpp"
#include <sirikata/core/trace/TimeSeries.hpp>

#define FORCE_MONOTONIC_CLOCK 1

namespace Sirikata {

namespace Trace {
class Trace;
}

namespace Command {
class Commander;
}

class SIRIKATA_EXPORT Context : public Service {
public:

    enum ExecutionThreads {
        IncludeOriginal,
        AllNew
    };

    Context(const String& name, Network::IOService* ios, Network::IOStrand* strand, Trace::Trace* _trace, const Time& epoch, const Duration& simlen = Duration::zero());
    ~Context();

    Time epoch() const {
        return mEpoch.read();
    }
    Duration sinceEpoch(const Time& rawtime) const {
        return rawtime - mEpoch.read();
    }
    Time simTime(const Duration& sinceStart) const {
        if (sinceStart.toMicroseconds() < 0)
            return Time::null();
        return Time::null() + sinceStart;
    }
    Time simTime(const Time& rawTime) const {
        return simTime( sinceEpoch(rawTime) );
    }
    // WARNING: The evaluates Timer::now, which shouldn't be done too often
    Time simTime() const {
        Time curt = simTime( Timer::now() );

#if FORCE_MONOTONIC_CLOCK
        Time last = mLastSimTime.read();
        if (curt < last)
            curt = last;

        // FIXME this is to avoid const fallout since this didn't used to
        // need to modify data
        const_cast< Sirikata::AtomicValue<Time>& >(this->mLastSimTime) = curt;
#endif
        return curt;
    }

    // A low cost alternative to simTime(). Gets that last value simTime()
    // returned. This should be used when a Time is needed, but the cost of
    // calling simTime() is too high. Obviously not everybody can use this or
    // simTime() will never progress.
    Time recentSimTime() const {
        return this->mLastSimTime.read();
    }

    Time realTime() const {
        return simTime() + (mEpoch.read()-Time::null()) + Timer::getUTCOffset();
    }
    Time recentRealTime() const {
        return recentSimTime() + (mEpoch.read()-Time::null()) + Timer::getUTCOffset();
    }

    void add(Service* ps) {
        mServices.push_back(ps);
        ps->start();
    }

    void remove(Service* ps) {
        for(ServiceList::iterator it = mServices.begin(); it != mServices.end(); it++) {
            if (*it == ps) {
                mServices.erase(it);
                return;
            }
        }
    }

    void run(uint32 nthreads = 1, ExecutionThreads exthreads = IncludeOriginal);

    // Stop the simulation
    void shutdown();

    bool stopped() const { return mStopRequested.read(); }

    // Call after run returns to ensure all resources get cleaned up.
    void cleanup();

    Trace::Trace* trace() const {
        return mTrace;
    }

    Command::Commander* commander() const {
        return mCommander;
    }
    void setCommander(Command::Commander* c);

    const String name;
    Network::IOService* ioService;
    Network::IOStrand* mainStrand;
    TimeProfiler* profiler;

    Trace::TimeSeries* timeSeries;
protected:

    // Main Lifetime Management
    virtual void start();
    virtual void stop();
    Network::IOTimerPtr mFinishedTimer;


    // Forced Quit Management
    void startForceQuitTimer();

    // Forces quit by stopping event processing.  Should only be
    // invoked after waiting a sufficient period after an initial stop
    // request.
    void forceQuit() {
        SILOG(forcequit,fatal,"Fatal error: Quit forced by timeout.");
        ioService->stop();
    }

    void workerThread();
    void cleanupWorkerThreads();

    // Signal handling
    void handleSignal(Signal::Type stype);

    Trace::Trace* mTrace;
    Command::Commander* mCommander;

    Sirikata::AtomicValue<Time> mEpoch;
    Sirikata::AtomicValue<Time> mLastSimTime;
    Duration mSimDuration;
    typedef std::vector<Service*> ServiceList;
    ServiceList mServices;

    std::tr1::shared_ptr<Thread> mKillThread;
    Network::IOService* mKillService;
    Network::IOTimerPtr mKillTimer;

    Sirikata::AtomicValue<bool> mStopRequested;

    Signal::HandlerID mSignalHandler;

    ExecutionThreads mExecutionThreadsType;
    typedef std::vector<Thread*> ThreadList;
    ThreadList mWorkerThreads;
}; // class ObjectHostContext

} // namespace Sirikata


#endif //_SIRIKATA_CONTEXT_HPP_