/* -*- Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -*- */ /* * Copyright (c) 1990-1997 Regents of the University of California. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. 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. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgement: * This product includes software developed by the Computer Systems * Engineering Group at Lawrence Berkeley Laboratory. * 4. Neither the name of the University nor of the Laboratory may be used * to endorse or promote products derived from this software without * specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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. * * * Here is one set of parameters from one of Sally's simulations * (this is from tcpsim, the older simulator): * * ed [ q_weight=0.002 thresh=5 linterm=30 maxthresh=15 * mean_pktsize=500 dropmech=random-drop queue-size=60 * plot-file=none bytes=false doubleq=false dqthresh=50 * wait=true ] * * 1/"linterm" is the max probability of dropping a packet. * There are different options that make the code * more messy that it would otherwise be. For example, * "doubleq" and "dqthresh" are for a queue that gives priority to * small (control) packets, * "bytes" indicates whether the queue should be measured in bytes * or in packets, * "dropmech" indicates whether the drop function should be random-drop * or drop-tail when/if the queue overflows, and * the commented-out Holt-Winters method for computing the average queue * size can be ignored. * "wait" indicates whether the gateway should wait between dropping * packets. */ /* * FRED * Author: Srinivas R. Avasarala (Computer Science, Purdue University) * * Note that this code is written based on the paper, D. Lin and R. Morris, * "Dynamics of Random Early Detection," in Proceedings of ACM SIGCOMM, September 1997. */ #ifndef lint static const char rcsid[] = "@(#) $Header: /nfs/jade/vint/CVSROOT/ns-2/red.cc,v 1.54 2000/10/05 21:25:34 sfloyd Exp $ (LBL)"; #endif #include #include #include "config.h" #include "template.h" #include "random.h" #include "flags.h" #include "delay.h" #include "fred.h" static class FREDClass : public TclClass { public: FREDClass() : TclClass("Queue/FRED") {} TclObject* create(int argc, const char*const* argv) { //printf("creating FRED Queue. argc = %d\n", argc); //mod to enable FRED to take arguments if (argc==5) return (new FREDQueue(argv[4])); else return (new FREDQueue("Drop")); } } class_fred; /* * modified to enable instantiation with special Trace objects - ratul */ FREDQueue::FREDQueue(const char * trace) : link_(NULL), bcount_(0), de_drop_(NULL), EDTrace(NULL), tchan_(0), idle_(1), first_reset_(1) { // printf("Making trace type %s\n", trace); if (strlen(trace) >=20) { printf("trace type too long - allocate more space to traceType in fred.h and recompile\n"); exit(0); } bind("which_", &which_); strcpy(traceType, trace); bind_bool("bytes_", &edp_.bytes); // boolean: use bytes? bind_bool("queue_in_bytes_", &qib_); // boolean: q in bytes? bind("thresh_", &edp_.th_min); // minthresh bind("maxthresh_", &edp_.th_max); // maxthresh bind("mean_pktsize_", &edp_.mean_pktsize); // avg pkt size bind("q_weight_", &edp_.q_w); // for EWMA bind_bool("wait_", &edp_.wait); bind("linterm_", &edp_.max_p_inv); bind_bool("setbit_", &edp_.setbit); // mark instead of drop bind_bool("gentle_", &edp_.gentle); // increase the packet // drop prob. slowly // when ave queue // exceeds maxthresh bind_bool("drop_tail_", &drop_tail_); // drop last pkt bind_bool("drop_front_", &drop_front_); // drop first pkt bind_bool("drop_rand_", &drop_rand_); // drop pkt at random bind_bool("ns1_compat_", &ns1_compat_); // ns-1 compatibility bind("ave_", &edv_.v_ave); // average queue sie bind("prob1_", &edv_.v_prob1); // dropping probability bind("curq_", &curq_); // current queue size bind("minq_", &edp_.minq); // added for FRED 2 or 4 q_ = new PacketQueue(); // underlying queue pq_ = q_; reset(); #ifdef notdef print_edp(); print_edv(); #endif } void FREDQueue::reset() { /* * If queue is measured in bytes, scale min/max thresh * by the size of an average packet (which is specified by user). */ if (qib_ && first_reset_ == 1) { //printf ("edp_.th_min: %5.3f \n", edp_.th_min); edp_.th_min *= edp_.mean_pktsize; edp_.th_max *= edp_.mean_pktsize; //printf ("edp_.th_min: %5.3f \n", edp_.th_min); first_reset_ = 0; } /* * Compute the "packet time constant" if we know the * link bandwidth. The ptc is the max number of (avg sized) * pkts per second which can be placed on the link. * The link bw is given in bits/sec, so scale mean psize * accordingly. */ if (link_) edp_.ptc = link_->bandwidth() / (8. * edp_.mean_pktsize); edv_.v_ave = 0.0; edv_.count = 0; edv_.count_bytes = 0; edv_.old = 0; edv_.v_a = 1 / (edp_.th_max - edp_.th_min); edv_.v_b = - edp_.th_min / (edp_.th_max - edp_.th_min); if (edp_.gentle) { edv_.v_c = ( 1.0 - 1 / edp_.max_p_inv ) / edp_.th_max; edv_.v_d = 2 / edp_.max_p_inv - 1.0; } idle_ = 1; if (&Scheduler::instance() != NULL) idletime_ = Scheduler::instance().clock(); else idletime_ = 0.0; /* sched not instantiated yet */ if (debug_) printf("Doing a queue reset\n"); Queue::reset(); if (debug_) printf("Done queue reset\n"); bcount_ = 0; // for FRED, set flow table to zeroes // printf("initting flow table\n"); for (int idx=0; idx= 1) { old_ave = new_ave; new_ave *= 1.0 - q_w; // added for FRED, this action was missed by original RED if (&Scheduler::instance() != NULL) idletime_ = Scheduler::instance().clock(); else idletime_ = 0.0; } old_ave = new_ave; new_ave *= 1.0 - q_w; new_ave += q_w * nqueued; // added for FRED if (edv_.Nactive) edv_.avgcq = edv_.v_ave/edv_.Nactive; else edv_.avgcq = edv_.v_ave; if (edv_.avgcq < 1) edv_.avgcq = 1; // printf("estimator: ret newave %f\n\n", new_ave); return new_ave; } /* * Return the next packet in the queue for transmission. */ Packet* FREDQueue::deque() { Packet *p; p = q_->deque(); if (p != 0) { idle_ = 0; bcount_ -= hdr_cmn::access(p)->size(); // added for FRED, actually a part of avg calculation if (bcount_ == 0) { if (&Scheduler::instance() != NULL) idletime_ = Scheduler::instance().clock(); else idletime_ = 0.0; /* sched not instantiated yet */ } // calc avg queue len - added for FRED edv_.v_ave = estimator(qib_?bcount_:q_->length(),0,edv_.v_ave,edp_.q_w); // added for FRED hdr_ip* hdr = hdr_ip::access(p); int fid = hdr->flowid(); struct flowv *pfv = flowlkup(fid); (pfv->qlen)--; // for now qlen in measured in #pkts and not #bytes if (pfv->qlen == 0) { (edv_.Nactive)--; freeflowstate(fid); } } else { idle_ = 1; // deque() may invoked by Queue::reset at init // time (before the scheduler is instantiated). // deal with this case if (&Scheduler::instance() != NULL) idletime_ = Scheduler::instance().clock(); else idletime_ = 0.0; } return (p); } /* * Calculate the drop probability. */ double FREDQueue::calculate_p(double v_ave, double th_max, int gentle, double v_a, double v_b, double v_c, double v_d, double max_p_inv) { double p; if (gentle && v_ave >= th_max) { // p ranges from max_p to 1 as the average queue // size ranges from th_max to twice th_max p = v_c * v_ave + v_d; } else { // p ranges from 0 to max_p as the average queue // size ranges from th_min to th_max p = v_a * v_ave + v_b; p /= max_p_inv; } if (p > 1.0) p = 1.0; return p; } /* * Make uniform instead of geometric interdrop periods. */ double FREDQueue::modify_p(double p, int count, int count_bytes, int bytes, int mean_pktsize, int wait, int size) { double count1 = (double) count; if (bytes) count1 = (double) (count_bytes/mean_pktsize); if (wait) { if (count1 * p < 1.0) p = 0.0; else if (count1 * p < 2.0) p /= (2 - count1 * p); else p = 1.0; } else { if (count1 * p < 1.0) p /= (1.0 - count1 * p); else p = 1.0; } if (bytes && p < 1.0) { p = p * size / mean_pktsize; } if (p > 1.0) p = 1.0; return p; } /* * should the packet be dropped/marked due to a probabilistic drop? */ int FREDQueue::drop_early(Packet* pkt) { hdr_cmn* ch = hdr_cmn::access(pkt); edv_.v_prob1 = calculate_p(edv_.v_ave, edp_.th_max, edp_.gentle, edv_.v_a, edv_.v_b, edv_.v_c, edv_.v_d, edp_.max_p_inv); edv_.v_prob = modify_p(edv_.v_prob1, edv_.count, edv_.count_bytes, edp_.bytes, edp_.mean_pktsize, edp_.wait, ch->size()); // drop probability is computed, pick random number and act double u = Random::uniform(); if (u <= edv_.v_prob) { // DROP or MARK edv_.count = 0; edv_.count_bytes = 0; hdr_flags* hf = hdr_flags::access(pickPacketForECN(pkt)); if (edp_.setbit && hf->ect() && edv_.v_ave < edp_.th_max) { hf->ce() = 1; // mark Congestion Experienced bit return (0); // no drop } else { return (1); // drop } } return (0); // no DROP/mark } /* * Pick packet for early congestion notification (ECN). This packet is then * marked or dropped. Having a separate function do this is convenient for * supporting derived classes that use the standard RED algorithm to compute * average queue size but use a different algorithm for choosing the packet for * ECN notification. */ Packet* FREDQueue::pickPacketForECN(Packet* pkt) { return pkt; /* pick the packet that just arrived */ } /* * Pick packet to drop. Having a separate function do this is convenient for * supporting derived classes that use the standard RED algorithm to compute * average queue size but use a different algorithm for choosing the victim. */ Packet* FREDQueue::pickPacketToDrop() { int victim; if (drop_front_) victim = min(1, q_->length()-1); else if (drop_rand_) victim = Random::integer(q_->length()); else /* default is drop_tail_ */ victim = q_->length() - 1; return(q_->lookup(victim)); } /* * Receive a new packet arriving at the queue. * The average queue size is computed. If the average size * exceeds the threshold, then the dropping probability is computed, * and the newly-arriving packet is dropped with that probability. * The packet is also dropped if the maximum queue size is exceeded. * * "Forced" drops mean a packet arrived when the underlying queue was * full or when the average q size exceeded maxthresh. * "Unforced" means a RED random drop. * * For forced drops, either the arriving packet is dropped or one in the * queue is dropped, depending on the setting of drop_tail_. * For unforced drops, the arriving packet is always the victim. */ #define DTYPE_NONE 0 /* ok, no drop */ #define DTYPE_FORCED 1 /* a "forced" drop */ #define DTYPE_UNFORCED 2 /* an "unforced" (random) drop */ void FREDQueue::enque(Packet* pkt) { /* if flow has no state table, add it */ hdr_ip* hdr = hdr_ip::access(pkt); int fid = hdr->flowid(); struct flowv *pfv; if ((pfv = flowlkup(fid)) == NULL) { if ((pfv = allocflowstate(fid)) == NULL) { printf("flow table full, change MAX_FLOWS in fred.h and recompile\n"); return; } } /* * if we were idle, we pretend that m packets arrived during * the idle period. m is set to be the ptc times the amount * of time we've been idle for */ int m = 0; if (idle_) { // A packet that arrives to an idle queue will never be dropped. double now = Scheduler::instance().clock(); /* To account for the period when the queue was empty. */ idle_ = 0; m = int(edp_.ptc * (now - idletime_)); edv_.v_ave = estimator( qib_ ? bcount_ : q_->length(), m + 1, edv_.v_ave, edp_.q_w); } /* * Run the estimator with either 1 new packet arrival, or with * the scaled version above [scaled by m due to idle time] * (bcount_ maintains the byte count in the underlying queue). * If the underlying queue is able to delete packets without * us knowing, then bcount_ will not be maintained properly! */ /*********************************************************** commented here and moved inside the idle loop above a/c FRED edv_.v_ave = estimator( qib_ ? bcount_ : q_->length(), m + 1, edv_.v_ave, edp_.q_w); //printf("v_ave: %6.4f (%13.12f) q: %d)\n", //double(edv_.v_ave), double(edv_.v_ave), q_->length()); ***********************************************************/ edv_.maxq = edp_.th_min; if (edv_.v_ave >= edp_.th_max) { edv_.maxq = 2; } // identify and manage non-adaptive flows if ( (pfv->qlen >= edv_.maxq) || ((edv_.v_ave >= edp_.th_max) && (pfv->qlen > 2*edv_.avgcq)) || ((pfv->qlen >= edv_.avgcq) && (pfv->strike > 1))) { (pfv->strike)++; // deliver to special "edrop" target, if defined if (de_drop_ != NULL) { // trace first if asked // if no snoop object (de_drop_) is defined, // this packet will not be traced as a special case. if (EDTrace != NULL) ((Trace *)EDTrace)->recvOnly(pkt); de_drop_->recv(pkt); } else { drop(pkt); } return; } register double qavg = edv_.v_ave; int qlen = qib_ ? bcount_ : q_->length(); int qlim = qib_ ? (qlim_ * edp_.mean_pktsize) : qlim_; curq_ = qlen; // helps to trace queue during arrival, if enabled hdr_cmn* ch = hdr_cmn::access(pkt); // operate in random drop mode if ((qavg >= edp_.th_min) && (qavg < edp_.th_max)) { /* * count and count_bytes keeps a tally of arriving traffic * that has not been dropped (i.e. how long, in terms of traffic, * it has been since the last early drop) */ ++edv_.count; edv_.count_bytes += ch->size(); // only random drop from robust flows if (pfv->qlen >= ((edp_.minq > edv_.avgcq)? edp_.minq : edv_.avgcq)) { if (drop_early(pkt)) { // deliver to special "edrop" target, if defined if (de_drop_ != NULL) { // trace first if asked // if no snoop object (de_drop_) is defined, // this packet will not be traced as a special case. if (EDTrace != NULL) ((Trace *)EDTrace)->recvOnly(pkt); de_drop_->recv(pkt); } else { drop(pkt); } edv_.count = 0; edv_.count_bytes = 0; return; } } } else if (qavg < edp_.th_min) { // no drop mode edv_.count = 0; edv_.count_bytes = 0; } else { // drop mode // deliver to special "edrop" target, if defined if (de_drop_ != NULL) { // trace first if asked // if no snoop object (de_drop_) is defined, // this packet will not be traced as a special case. if (EDTrace != NULL) ((Trace *)EDTrace)->recvOnly(pkt); de_drop_->recv(pkt); } else { drop(pkt); } edv_.count = 0; edv_.count_bytes = 0; return; } /* dunno if below lines are reqd. if (qlen >= qlim) { // see if we've exceeded the queue size droptype = DTYPE_FORCED; } */ if (pfv->qlen == 0) { ++(edv_.Nactive); } pfv->qlen += 1; // for now, qlen in measured in #pkts and not #bytes edv_.v_ave = estimator(qib_?bcount_:q_->length(), 0, edv_.v_ave, edp_.q_w); q_->enque(pkt); bcount_ += ch->size(); return; } int FREDQueue::command(int argc, const char*const* argv) { Tcl& tcl = Tcl::instance(); if (argc == 2) { if (strcmp(argv[1], "reset") == 0) { reset(); return (TCL_OK); } if (strcmp(argv[1], "early-drop-target") == 0) { if (de_drop_ != NULL) tcl.resultf("%s", de_drop_->name()); return (TCL_OK); } if (strcmp(argv[1], "edrop-trace") == 0) { if (EDTrace != NULL) { tcl.resultf("%s", EDTrace->name()); if (debug_) printf("edrop trace exists according to FRED\n"); } else { if (debug_) printf("edrop trace doesn't exist according to FRED\n"); tcl.resultf("0"); } return (TCL_OK); } if (strcmp(argv[1], "trace-type") == 0) { tcl.resultf("%s", traceType); return (TCL_OK); } } else if (argc == 3) { // attach a file for variable tracing if (strcmp(argv[1], "attach") == 0) { int mode; const char* id = argv[2]; tchan_ = Tcl_GetChannel(tcl.interp(), (char*)id, &mode); if (tchan_ == 0) { tcl.resultf("FRED: trace: can't attach %s for writing", id); return (TCL_ERROR); } return (TCL_OK); } // tell FRED about link stats if (strcmp(argv[1], "link") == 0) { LinkDelay* del = (LinkDelay*)TclObject::lookup(argv[2]); if (del == 0) { tcl.resultf("FRED: no LinkDelay object %s", argv[2]); return(TCL_ERROR); } // set ptc now link_ = del; edp_.ptc = link_->bandwidth() /(8. * edp_.mean_pktsize); return (TCL_OK); } if (strcmp(argv[1], "early-drop-target") == 0) { NsObject* p = (NsObject*)TclObject::lookup(argv[2]); if (p == 0) { tcl.resultf("no object %s", argv[2]); return (TCL_ERROR); } de_drop_ = p; return (TCL_OK); } if (strcmp(argv[1], "edrop-trace") == 0) { if (debug_) printf("Ok, Here\n"); NsObject * t = (NsObject *)TclObject::lookup(argv[2]); if (debug_) printf("Ok, Here too\n"); if (t == 0) { tcl.resultf("no object %s", argv[2]); return (TCL_ERROR); } EDTrace = t; if (debug_) printf("Ok, Here too too too %d\n", ((Trace *)EDTrace)->type_); return (TCL_OK); } if (!strcmp(argv[1], "packetqueue-attach")) { delete q_; if (!(q_ = (PacketQueue*) TclObject::lookup(argv[2]))) return (TCL_ERROR); else { pq_ = q_; return (TCL_OK); } } } return (Queue::command(argc, argv)); } /* * Routine called by TracedVar facility when variables change values. * Currently used to trace values of avg queue size, drop probability, * and the instantaneous queue size seen by arriving packets. * Note that the tracing of each var must be enabled in tcl to work. */ void FREDQueue::trace(TracedVar* v) { char wrk[500], *p; if (((p = strstr(v->name(), "ave")) == NULL) && ((p = strstr(v->name(), "prob")) == NULL) && ((p = strstr(v->name(), "curq")) == NULL)) { fprintf(stderr, "FRED:unknown trace var %s\n", v->name()); return; } if (tchan_) { int n; double t = Scheduler::instance().clock(); // XXX: be compatible with nsv1 FRED trace entries if (*p == 'c') { sprintf(wrk, "Q %g %d", t, int(*((TracedInt*) v))); } else { sprintf(wrk, "%c %g %g", *p, t, double(*((TracedDouble*) v))); } n = strlen(wrk); wrk[n] = '\n'; wrk[n+1] = 0; (void)Tcl_Write(tchan_, wrk, n+1); } return; } /* for debugging help */ void FREDQueue::print_edp() { printf("mean_pktsz: %d\n", edp_.mean_pktsize); printf("bytes: %d, wait: %d, setbit: %d\n", edp_.bytes, edp_.wait, edp_.setbit); printf("minth: %f, maxth: %f\n", edp_.th_min, edp_.th_max); printf("max_p_inv: %f, qw: %f, ptc: %f\n", edp_.max_p_inv, edp_.q_w, edp_.ptc); printf("qlim: %d, idletime: %f\n", qlim_, idletime_); printf("=========\n"); } void FREDQueue::print_edv() { printf("v_a: %f, v_b: %f\n", edv_.v_a, edv_.v_b); }