rtmodule.cc

Go to the documentation of this file.

// -*-  Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -*- 

/*
 * Copyright (C) 2000 by the University of Southern California
 * $Id: rtmodule.cc,v 1.16 2005/08/25 18:58:12 johnh Exp $
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 *
 *
 * The copyright of this module includes the following
 * linking-with-specific-other-licenses addition:
 *
 * In addition, as a special exception, the copyright holders of
 * this module give you permission to combine (via static or
 * dynamic linking) this module with free software programs or
 * libraries that are released under the GNU LGPL and with code
 * included in the standard release of ns-2 under the Apache 2.0
 * license or under otherwise-compatible licenses with advertising
 * requirements (or modified versions of such code, with unchanged
 * license).  You may copy and distribute such a system following the
 * terms of the GNU GPL for this module and the licenses of the
 * other code concerned, provided that you include the source code of
 * that other code when and as the GNU GPL requires distribution of
 * source code.
 *
 * Note that people who make modified versions of this module
 * are not obligated to grant this special exception for their
 * modified versions; it is their choice whether to do so.  The GNU
 * General Public License gives permission to release a modified
 * version without this exception; this exception also makes it
 * possible to release a modified version which carries forward this
 * exception.
 *
 */

// $Header: /nfs/jade/vint/CVSROOT/ns-2/routing/rtmodule.cc,v 1.16 2005/08/25 18:58:12 johnh Exp $


#include "rtmodule.h"
#include <assert.h>
#include "node.h"


static class RoutingModuleClass : public TclClass {
public:
    RoutingModuleClass() : TclClass("RtModule") {}
    TclObject* create(int, const char*const*) {
        return (new RoutingModule);
    }
} class_routing_module;

static class BaseRoutingModuleClass : public TclClass {
public:
    BaseRoutingModuleClass() : TclClass("RtModule/Base") {}
    TclObject* create(int, const char*const*) {
        return (new BaseRoutingModule);
    }
} class_base_routing_module;

static class McastRoutingModuleClass : public TclClass {
public:
    McastRoutingModuleClass() : TclClass("RtModule/Mcast") {}
    TclObject* create(int, const char*const*) {
        return (new McastRoutingModule);
    }
} class_mcast_routing_module;

static class HierRoutingModuleClass : public TclClass {
public:
    HierRoutingModuleClass() : TclClass("RtModule/Hier") {}
    TclObject* create(int, const char*const*) {
        return (new HierRoutingModule);
    }
} class_hier_routing_module;


static class ManualRoutingModuleClass : public TclClass {
public:
    ManualRoutingModuleClass() : TclClass("RtModule/Manual") {}
    TclObject* create(int, const char*const*) {
        return (new ManualRoutingModule);
    }
} class_manual_routing_module;

static class SourceRoutingModuleClass : public TclClass {
public:
        SourceRoutingModuleClass() : TclClass("RtModule/Source") {}
        TclObject* create(int, const char*const*) {
                return (new SourceRoutingModule);
        }
} class_source_routing_module;

static class QSRoutingModuleClass : public TclClass {
public:
        QSRoutingModuleClass() : TclClass("RtModule/QS") {}
        TclObject* create(int, const char*const*) {
                return (new QSRoutingModule);
        }
} class_qs_routing_module;

static class VcRoutingModuleClass : public TclClass {
public:
    VcRoutingModuleClass() : TclClass("RtModule/VC") {}
    TclObject* create(int, const char*const*) {
        return (new VcRoutingModule);
    }
} class_vc_routing_module;


#ifdef HAVE_STL
static class PgmRoutingModuleClass : public TclClass {
public:
        PgmRoutingModuleClass() : TclClass("RtModule/PGM") {}
        TclObject* create(int, const char*const*) {
                return (new PgmRoutingModule);
        }
} class_pgm_routing_module;
#endif //STL

// LMS
static class LmsRoutingModuleClass : public TclClass {
public:
        LmsRoutingModuleClass() : TclClass("RtModule/LMS") {}
        TclObject* create(int, const char*const*) {
                return (new LmsRoutingModule);
        }
} class_lms_routing_module;

RoutingModule::RoutingModule() : 
    next_rtm_(NULL), n_(NULL), classifier_(NULL) {
    bind("classifier_", (TclObject**)&classifier_);
}

int RoutingModule::command(int argc, const char*const* argv)
{
    Tcl& tcl = Tcl::instance();
    if (argc == 2) {
        if (strcmp(argv[1], "node") == 0) {
            assert(n_ != NULL);
            tcl.resultf("%s", n_->name());
            return TCL_OK;
        } else if (strcmp(argv[1], "module-name") == 0) {
            if (module_name() != NULL)
                tcl.resultf("%s", module_name());
            else 
                tcl.result("");
            return TCL_OK;
        }
        
    } else if (argc == 3) {
        if (strcmp(argv[1], "attach-node") == 0) {
            n_ = (Node*)TclObject::lookup(argv[2]);
            if (n_ == NULL) {
                tcl.add_errorf("Wrong object name %s",argv[2]);
                return TCL_ERROR;
            }
            return TCL_OK;
        }
        //if (strcmp(argv[1], "attach-classifier") == 0) {
        //classifier_ = (Classifier*)(TclObject::lookup(argv[2]));
        //if (classifier_ == NULL) {
        //tcl.add_errorf("Wrong object name %s",argv[2]);
        //return TCL_ERROR;
        //}
        //return TCL_OK;
        //}
    }
    return TclObject::command(argc, argv);
}

int BaseRoutingModule::command(int argc, const char*const* argv) {
    Tcl& tcl = Tcl::instance();
    if (argc == 3) {
        if (strcmp(argv[1] , "route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->route_notify(this);
            return TCL_OK;
        }
        if (strcmp(argv[1] , "unreg-route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->unreg_route_notify(this);
            return TCL_OK;
        }
    }
    return (RoutingModule::command(argc, argv));
}

int SourceRoutingModule::command(int argc, const char*const* argv) {
    Tcl& tcl = Tcl::instance();
    if (argc == 3) {
        if (strcmp(argv[1] , "route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->route_notify(this);
            return TCL_OK;
        }
        if (strcmp(argv[1] , "unreg-route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->unreg_route_notify(this);
            return TCL_OK;
        }
    }
    return (RoutingModule::command(argc, argv));
}

int QSRoutingModule::command(int argc, const char*const* argv) {
    Tcl& tcl = Tcl::instance();
    if (argc == 3) {
        if (strcmp(argv[1] , "route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->route_notify(this);
            return TCL_OK;
        }
        if (strcmp(argv[1] , "unreg-route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->unreg_route_notify(this);
            return TCL_OK;
        }
    }
    return (RoutingModule::command(argc, argv));
}

int McastRoutingModule::command(int argc, const char*const* argv) {
    Tcl& tcl = Tcl::instance();
    if (argc == 3) {
        if (strcmp(argv[1] , "route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->route_notify(this);
            return TCL_OK;
        }
        if (strcmp(argv[1] , "unreg-route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->unreg_route_notify(this);
            return TCL_OK;
        }
    }
    return (RoutingModule::command(argc, argv));
}

int HierRoutingModule::command(int argc, const char*const* argv) {
    Tcl& tcl = Tcl::instance();
    if (argc == 3) {
        //if (strcmp(argv[1], "attach-classifier") == 0) {
        //classifier_ = (HierClassifier*)(TclObject::lookup(argv[2]));
        //if (classifier_ == NULL) {
        //tcl.add_errorf("Wrong object name %s",argv[2]);
        //return TCL_ERROR;
        //}
        //return TCL_OK;
        //}
        if (strcmp(argv[1] , "route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->route_notify(this);
            return TCL_OK;
        }
        if (strcmp(argv[1] , "unreg-route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->unreg_route_notify(this);
            return TCL_OK;
        }
    }
    return (RoutingModule::command(argc, argv));
}


int ManualRoutingModule::command(int argc, const char*const* argv) {
    Tcl& tcl = Tcl::instance();
    if (argc == 3) {
        if (strcmp(argv[1] , "route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from node_", argv[2]);
                return TCL_ERROR;
            }
            n_->route_notify(this);
            return TCL_OK;
        }
        if (strcmp(argv[1] , "unreg-route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->unreg_route_notify(this);
            return TCL_OK;
        }
    }
    return (RoutingModule::command(argc, argv));
}

void VcRoutingModule::add_route(char *, NsObject *) { }
    

int VcRoutingModule::command(int argc, const char*const* argv) {
    Tcl& tcl = Tcl::instance();
    if (argc == 3) {
        if (strcmp(argv[1] , "route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->route_notify(this);
            return TCL_OK;
        }
        if (strcmp(argv[1] , "unreg-route-notify") == 0) {
            Node *node = (Node *)(TclObject::lookup(argv[2]));
            if (node == NULL) {
                tcl.add_errorf("Invalid node object %s", argv[2]);
                return TCL_ERROR;
            }
            if (node != n_) {
                tcl.add_errorf("Node object %s different from n_", argv[2]);
                return TCL_ERROR;
            }
            n_->unreg_route_notify(this);
            return TCL_OK;
        }
    }
    return (RoutingModule::command(argc, argv));
}

void RoutingModule::route_notify(RoutingModule *rtm) {
    if (next_rtm_ != NULL)
        next_rtm_->route_notify(rtm);
    else
        next_rtm_ = rtm;
}

void RoutingModule::unreg_route_notify(RoutingModule *rtm) {
    if (next_rtm_) {
        if (next_rtm_ == rtm) {
            //RoutingModule *tmp = next_rtm_;
            next_rtm_ = next_rtm_->next_rtm_;
            //free (tmp);
        }
        else {
            next_rtm_->unreg_route_notify(rtm);
        }
    }
}

void RoutingModule::add_route(char *dst, NsObject *target) 
{
    if (classifier_) 
        classifier_->do_install(dst,target); 
    if (next_rtm_ != NULL)
        next_rtm_->add_route(dst, target); 
}

void RoutingModule::delete_route(char *dst, NsObject *nullagent)
{
    if (classifier_) 
        classifier_->do_install(dst, nullagent); 
    if (next_rtm_)
        next_rtm_->add_route(dst, nullagent); 
}

void RoutingModule::set_table_size(int nn)
{
    if (classifier_)
        classifier_->set_table_size(nn);
    if (next_rtm_)
        next_rtm_->set_table_size(nn);
}

void RoutingModule::set_table_size(int level, int size)
{
    if (classifier_)
        classifier_->set_table_size(level, size);
    if (next_rtm_)
        next_rtm_->set_table_size(level, size);
}

//  void BaseRoutingModule::add_route(char *dst, NsObject *target) {
//      if (classifier_) 
//          ((DestHashClassifier *)classifier_)->do_install(dst, target);
//      if (next_rtm_ != NULL)
//          next_rtm_->add_route(dst, target); 
//  }

//  void McastRoutingModule::add_route(char *dst, NsObject *target) {
//      if (classifier_) 
//          ((DestHashClassifier *)classifier_)->do_install(dst, target);
//      if (next_rtm_ != NULL)
//          next_rtm_->add_route(dst, target); 
//  }

//  void HierRoutingModule::add_route(char *dst, NsObject *target) {
//      if (classifier_) 
//          ((HierClassifier *)classifier_)->do_install(dst, target);
//      if (next_rtm_ != NULL)
//          next_rtm_->add_route(dst, target); 
//  }

void ManualRoutingModule::add_route(char *dst, NsObject *target) {
    int slot = classifier_->install_next(target);
    if (strcmp(dst, "default") == 0) {
        classifier_->set_default(slot);
    } else {
        int encoded_dst_address = 
            (atoi(dst)) << (AddrParamsClass::instance().node_shift(1));
        if (0 > (classifier_->do_set_hash(0, encoded_dst_address, 0, slot))) {
            fprintf(stderr, "HashClassifier::set_hash() return value less than 0\n"); }
    }
    if (next_rtm_ != NULL)
        next_rtm_->add_route(dst, target); 
}

---