space/src/ODPFlowScheduler.hpp

Go to the documentation of this file.

/*  Sirikata
 *  ODPFlowScheduler.hpp
 *
 *  Copyright (c) 2010, 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 _ODP_FLOW_SCHEDULER_HPP_
#define _ODP_FLOW_SCHEDULER_HPP_

#include <sirikata/space/SpaceContext.hpp>
#include <sirikata/core/queue/AbstractQueue.hpp>
#include "ForwarderServiceQueue.hpp"
#include <sirikata/core/util/RegionWeightCalculator.hpp>
#include <sirikata/core/options/CommonOptions.hpp>
#include <sirikata/space/ObjectSegmentation.hpp>

namespace Sirikata {

class ODPFlowScheduler : public AbstractQueue<Message*> {
public:
    typedef AbstractQueue<Message*>::Type Type;

    ODPFlowScheduler(SpaceContext* ctx, ForwarderServiceQueue* parent, ServerID sid, uint32 serv_id)
     : mContext(ctx),
       mParent(parent),
       mDestServer(sid),
       mServiceID(serv_id),
       mSenderTotalWeight(0.0),
       mSenderCapacity(0.0),
       mReceiverTotalWeight(0.0),
       mReceiverCapacity(0.0)
    {
        mWeightCalculator =
            RegionWeightCalculatorFactory::getSingleton().getConstructor(GetOptionValue<String>(OPT_REGION_WEIGHT))(GetOptionValue<String>(OPT_REGION_WEIGHT_ARGS))
            ;
    }

    virtual ~ODPFlowScheduler() {
        delete mWeightCalculator;
    }

    // Interface: AbstractQueue<Message*>
    virtual QueueEnum::PushResult push(const Type& msg) { assert(false); return QueueEnum::PushExceededMaximumSize; }
    virtual const Type& front() const = 0;
    virtual Type& front() = 0;
    virtual Type pop() = 0;
    virtual bool empty() const = 0;
    virtual uint32 size() const = 0;

    // ODP push interface. Note: Must be thread safe!
    virtual bool push(Sirikata::Protocol::Object::ObjectMessage* msg, const OSegEntry& sourceObjectData, const OSegEntry& dstObjectData) = 0;

    // Get the sum of the weights of active queues.
    virtual float totalActiveWeight() = 0;
    // Get the total used weight of active queues.  If all flows are saturating,
    // this should equal totalActiveWeights, otherwise it will be smaller.  This
    // version computes used weights from the perspective of the downstream send
    // scheduler, i.e. ServerMessageQueue, using its total weight and capacity.
    virtual float totalSenderUsedWeight() = 0;
    // Get the total used weight of active queues.  If all flows are saturating,
    // this should equal totalActiveWeights, otherwise it will be smaller.  This
    // version computes used weights from the perspective of the downstream recv
    // scheduler, i.e. ServerMessageReceiver, using its total weight and capacity.
    virtual float totalReceiverUsedWeight() = 0;

    // Updates statistics from the downstream send scheduler.  These are just
    // stored and are used to compute rate information for this scheduler and is
    // input for stats which are sent back to the sender.
    void updateSenderStats(double total_weight, double capacity) {
        mSenderTotalWeight = total_weight;
        mSenderCapacity = capacity;
    }
    // Updates statistics from the downstream receive scheduler.  These are just
    // stored and are used to compute rate information for this scheduler and is
    // input for stats which are sent back to the receiver.
    void updateReceiverStats(double total_weight, double capacity) {
        mReceiverTotalWeight = total_weight;
        mReceiverCapacity = capacity;
    }
protected:
    // Should be called by implementations when an ODP message is successfully added.
    void notifyPushFront() {
        mParent->notifyPushFront(mDestServer, mServiceID);
    }

    Message* createMessageFromODP(Sirikata::Protocol::Object::ObjectMessage* obj_msg, ServerID dest_serv) {
        Message* svr_obj_msg = new Message(
            mContext->id(),
            SERVER_PORT_OBJECT_MESSAGE_ROUTING,
            dest_serv,
            SERVER_PORT_OBJECT_MESSAGE_ROUTING,
            obj_msg
        );
        return svr_obj_msg;
    }

    SpaceContext* mContext;
    ForwarderServiceQueue* mParent;
    ServerID mDestServer;
    uint32 mServiceID;


    double mSenderTotalWeight; // Total input weight for this pair (sum of used weights)
    double mSenderCapacity; // Capacity of sender
    double mReceiverTotalWeight; // Total input weight to receiver (sum of used weights)
    double mReceiverCapacity; // Capacity of receiver

    RegionWeightCalculator* mWeightCalculator;
}; // class ODPFlowScheduler

} // namespace Sirikata

#endif //_ODP_FLOW_SCHEDULER_HPP_