libcore/include/sirikata/core/network/IOService.hpp

Go to the documentation of this file.

/*  Sirikata Network Utilities
 *  IOService.hpp
 *
 *  Copyright (c) 2009, Daniel Reiter Horn
 *  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_IOSERVICE_HPP_
#define _SIRIKATA_IOSERVICE_HPP_

#include <sirikata/core/util/Platform.hpp>
#include <sirikata/core/network/IODefs.hpp>
#include <sirikata/core/util/AtomicTypes.hpp>
#include <sirikata/core/util/Noncopyable.hpp>
#include <boost/thread.hpp>
#include <sirikata/core/trace/WindowedStats.hpp>
#include <sirikata/core/task/Time.hpp>
#include <sirikata/core/command/Command.hpp>

namespace Sirikata {
namespace Network {

class SIRIKATA_EXPORT IOService : public Noncopyable {
    InternalIOService* mImpl;
    const String mName;

#ifdef SIRIKATA_TRACK_EVENT_QUEUES
    typedef std::tr1::function<void(const boost::system::error_code& e)> IOCallbackWithError;

    // Track all strands that have been allocated. This needs to be
    // thread safe.
    typedef boost::mutex Mutex;
    typedef boost::lock_guard<Mutex> LockGuard;
    Mutex mMutex;
    typedef std::tr1::unordered_set<IOStrand*> StrandSet;
    StrandSet mStrands;

    AtomicValue<uint32> mTimersEnqueued;
    AtomicValue<uint32> mEnqueued;

    // Tracks the latency of recent handlers through the queue
    Trace::WindowedStats<Duration> mWindowedTimerLatencyStats;
    Trace::WindowedStats<Duration> mWindowedHandlerLatencyStats;


    struct TagDuration
    {
        const char* tag;
        Duration dur;
    };
    Trace::WindowedStats<TagDuration> mWindowedLatencyTagStats;


    // Track tags that trigger events
    typedef std::tr1::unordered_map<const char*, uint32> TagCountMap;
    TagCountMap mTagCounts;
#endif

    IOService(const IOService&); // Disabled

    // For construction
    friend class IOServiceFactory;
    // For callbacks to track their lifetimes
    friend class IOStrand;

#ifdef SIRIKATA_TRACK_EVENT_QUEUES
    void decrementTimerCount(const boost::system::error_code&e, const Time& start, const Duration& timer_duration, const IOCallbackWithError& cb, const char* tag, const char* tagStat=NULL);
    void decrementCount(const Time& start, const IOCallback& cb, const char* tag, const char* tagStat=NULL);

    // Used to get let us add a record of a strand dispatch/post and provide a
    // wrapped handler which will let us clean up our record of it. This is
    // necessary because we can't do the dispatch/post for the strand using
    // a strand-wrapped handler because that doesn't have the same ordering
    // guarantees.
    IOCallback tracking_wrapper(const IOCallback& handler, const char* tag = NULL, const char* tagStat = NULL);

    // Invoked by strands when they are being destroyed so we can
    // track which ones are alive.
    void destroyingStrand(IOStrand* child);
#endif

  protected:

    friend class InternalIOStrand;
    friend class InternalIOWork;
    friend class TCPSocket;
    friend class TCPListener;
    friend class TCPResolver;
    friend class UDPSocket;
    friend class UDPResolver;
    friend class DeadlineTimer;
    friend class IOTimer;

public:


    IOService(const String& name);
    ~IOService();

    const String& name() const { return mName; }

    InternalIOService& asioService() {
        return *mImpl;
    }
    const InternalIOService& asioService() const {
        return *mImpl;
    }

    IOStrand* createStrand(const String& name);

    uint32 pollOne();
    uint32 poll();

    uint32 runOne();
    uint32 run();

    void runNoReturn();

    void stop();
    void reset();

    void dispatch(const IOCallback& handler, const char* tag = NULL,
        const char* tagStat = NULL);

    void post(const IOCallback& handler, const char* tag = NULL,
        const char* tagStat = NULL);
    void post(const Duration& waitFor, const IOCallback& handler,
        const char* tag = NULL, const char* tagStat=NULL);

#ifdef SIRIKATA_TRACK_EVENT_QUEUES
    uint32 numTimersEnqueued() const { return mTimersEnqueued.read(); }
    uint32 numEnqueued() const { return mEnqueued.read(); }

    Duration timerLatency() const { return mWindowedTimerLatencyStats.average(); }
    Duration handlerLatency() const { return mWindowedHandlerLatencyStats.average(); }

    void reportStats() const;
    void reportStatsFile(const char* filename, bool detailed) const;

    static void reportAllStats();
    static void reportAllStatsFile(const char* filename, bool detailed = false);

    // Respond to command to report all stats.
    void fillCommandResultWithStats(Command::Result& res);
#endif
    void commandReportStats(const Command::Command& cmd, Command::Commander* cmdr, Command::CommandID cmdid);
    static void commandReportAllStats(const Command::Command& cmd, Command::Commander* cmdr, Command::CommandID cmdid);
};

} // namespace Network
} // namespace Sirikata

#endif //_SIRIKATA_IOSERVICE_HPP_