ns2 Network Simulator 2.29: SensorQueryAgent Class Reference

00326                                    : Agent(PT_MESSAGE) { 
00327     query_interval_ = 120;
00328     gen_query_event_ = new Event;
00329     query_handler_ = new SensorQueryHandler(this);
00330     node_dead_ = 0;
00331 }

00327 {
00328     char wrk[256];
00329     int n;
00330     double curTime = (&Scheduler::instance() == NULL ? 0 : 
00331               Scheduler::instance().clock());
00332     
00333     sprintf(wrk, "a -t "TIME_FORMAT" -s %d -d %d -n %s",
00334         curTime, here_.addr_, dst_.addr_, name);
00335     n = strlen(wrk);
00336     wrk[n] = '\n';
00337     wrk[n+1] = 0;
00338     if (channel_)
00339         (void)Tcl_Write(channel_, wrk, n+1);
00340     // keep agent trace name
00341     if (traceName_ != NULL)
00342         delete[] traceName_;
00343     traceName_ = new char[strlen(name)+1];
00344     strcpy(traceName_, name);
00345 }

00099 { return here_.addr_; }

00529 {
00530         Packet* p = allocpkt();
00531 
00532     if (n > 0)
00533             p->allocdata(n);
00534 
00535     return(p);
00536 }

00518 {
00519     Packet* p = Packet::alloc();
00520     initpkt(p);
00521     return (p);
00522 }

00373 {
00374     app_ = app;
00375 }

00111 {
00112   if (argc == 2)
00113     {
00114       if (strcmp (argv[1], "start") == 0)
00115         {
00116           startUp();
00117           return (TCL_OK);
00118         }
00119       if (strcmp (argv[1], "stop") == 0)
00120     {
00121       stop();
00122       return (TCL_OK);
00123     }
00124       if (strcmp (argv[1], "generate-query") == 0)
00125         {
00126           generate_query(-1,-1,-1);
00127           return (TCL_OK);
00128         }
00129     }
00130   else if (argc == 3)
00131     {
00132       if (strcasecmp (argv[1], "tracetarget") == 0)
00133         {
00134           TclObject *obj;
00135       if ((obj = TclObject::lookup (argv[2])) == 0)
00136             {
00137               fprintf (stderr, "%s: %s lookup of %s failed\n", __FILE__, argv[1],
00138                        argv[2]);
00139               return TCL_ERROR;
00140             }
00141           tracetarget_ = (Trace *) obj;
00142           return TCL_OK;
00143         }
00144       else if (strcasecmp (argv[1], "addr") == 0) {
00145         int temp;
00146         temp = Address::instance().str2addr(argv[2]);
00147         myaddr_ = temp;
00148         return TCL_OK;
00149       }
00150       else if (strcasecmp (argv[1], "attach-tag-dbase") == 0)
00151         {
00152           TclObject *obj;
00153           if ((obj = TclObject::lookup (argv[2])) == 0)
00154             {
00155               fprintf (stderr, "%s: %s lookup of %s failed\n", __FILE__, argv[1],
00156                        argv[2]);
00157               return TCL_ERROR;
00158             }
00159           tag_dbase_ = (tags_database *) obj;
00160           return TCL_OK;
00161         }
00162     }
00163   else if (argc == 5) {
00164     if (strcmp (argv[1], "generate-query") == 0)
00165       {
00166     int p1 = atoi(argv[2]);
00167     int p2 = atoi(argv[3]);
00168     int p3 = atoi(argv[4]);
00169     generate_query(p1,p2,p3);
00170     return (TCL_OK);
00171       }
00172   }
00173   
00174   return (Agent::command (argc, argv));
00175 }

00390 {
00391 /*
00392     dst_ = dst;
00393 */
00394 }

00101 { return dst_.addr_; }

00103 {
00104     if (!debug_)
00105         return;
00106     va_list ap;
00107     va_start(ap, fmt);
00108     vprintf(fmt, ap);
00109 }

00094 {
00095     if (delay_bind(varName, localName, "agent_addr_", (int*)&(here_.addr_), tracer)) return TCL_OK;
00096     if (delay_bind(varName, localName, "agent_port_", (int*)&(here_.port_), tracer)) return TCL_OK;
00097     if (delay_bind(varName, localName, "dst_addr_", (int*)&(dst_.addr_), tracer)) return TCL_OK;
00098     if (delay_bind(varName, localName, "dst_port_", (int*)&(dst_.port_), tracer)) return TCL_OK;
00099     if (delay_bind(varName, localName, "fid_", (int*)&fid_, tracer)) return TCL_OK;
00100     if (delay_bind(varName, localName, "prio_", (int*)&prio_, tracer)) return TCL_OK;
00101     if (delay_bind(varName, localName, "flags_", (int*)&flags_, tracer)) return TCL_OK;
00102     if (delay_bind(varName, localName, "ttl_", &defttl_, tracer)) return TCL_OK;
00103     if (delay_bind(varName, localName, "class_", (int*)&fid_, tracer)) return TCL_OK;
00104     return Connector::delay_bind_dispatch(varName, localName, tracer);
00105 }

00079 {
00080     delay_bind_init_one("agent_addr_");
00081     delay_bind_init_one("agent_port_");
00082     delay_bind_init_one("dst_addr_");
00083     delay_bind_init_one("dst_port_");
00084     delay_bind_init_one("fid_");
00085     delay_bind_init_one("prio_");
00086     delay_bind_init_one("flags_");
00087     delay_bind_init_one("ttl_");
00088     delay_bind_init_one("class_");
00089     Connector::delay_bind_init_all();
00090 }

00223 {
00224     char wrk[256];
00225 
00226     // XXX we don't know InstVar outside of Tcl! Is there any
00227     // tracedvars hidden in InstVar? If so, shall we have a tclclInt.h?
00228     TracedVar* var = tracedvar_;
00229     for ( ;  var != 0;  var = var->next_) 
00230         flushAVar(var);
00231 
00232     // we need to flush all var values to trace file, 
00233     // so nam can do backtracing
00234     sprintf(wrk, "a -t "TIME_FORMAT" -s %d -d %d -n %s -x",
00235         Scheduler::instance().clock(), here_.addr_,
00236         dst_.addr_, traceName_); 
00237     if (traceName_ != NULL)
00238         delete[] traceName_;
00239     traceName_ = NULL;
00240 }

00102 { return dst_.port_; }

00115 {
00116     if (drop_ != 0)
00117         drop_->recv(p, s);
00118     else
00119         Packet::free(p);
00120 }

00107 {
00108     if (drop_ != 0)
00109         drop_->recv(p);
00110     else
00111         Packet::free(p);
00112 }

00203 {
00204   Packet *p = allocpkt();
00205   hdr_ip *iph = HDR_IP(p);
00206   hdr_cmn *hdrc = HDR_CMN(p);
00207   unsigned char *walk;
00208   Scheduler &s = Scheduler::instance();
00209   int obj_name;
00210   int next_hop_level = 0, num_src_hops = 0;
00211   int X = 65000, Y = 65000;
00212   int action = QUERY_PKT;
00213 
00214   if(node_dead_) {
00215     trace("Node %d: node failed, cannot generate query");
00216     return;
00217   }
00218 
00219   // Need to ask our routing module to direct the packet
00220   hdrc->next_hop_ = myaddr_;
00221   hdrc->addr_type_ = NS_AF_INET;
00222   iph->daddr() = myaddr_;
00223   iph->dport() = ROUTER_PORT;
00224   iph->ttl_ = 300;   // since only 300 ids in source route in packet
00225 
00226   iph->saddr() = myaddr_;
00227   iph->sport() = 0;
00228 
00229   // LM agent checks if the source port is 0 to identify a query packet  
00230   // 2 bytes each for X and Y co-ords
00231   // 1 byte for level - used in next hop lookup
00232   // 4 bytes for object name; 2 byte for number of hops in src route
00233   // 4 bytes for origin_time
00234   // 90 bytes to store 30 source route ids and their levels (1 byte each)
00235   // (assuming max_levels = 15) 
00236   p->allocdata(105);
00237   walk = p->accessdata();
00238 
00239   (*walk++) = action & 0xFF;
00240 
00241   // X coord = 65000 initially
00242   (*walk++) = (X >> 8) & 0xFF;
00243   (*walk++) = X & 0xFF;
00244 
00245   // Y coord = 65000 initially
00246   (*walk++) = (Y >> 8) & 0xFF;
00247   (*walk++) = Y & 0xFF;
00248 
00249   // Indicates next hop level
00250   (*walk++) = next_hop_level & 0xFF;
00251 
00252   if(p1 != -1 && p2 != -1 && p3 != -1)
00253     obj_name = (int) ((p1 * pow(2,24)) + (p2 * pow(2,16)) + p3) ;
00254   else
00255     obj_name = tag_dbase_->get_random_tag();
00256 
00257   //  p1 = Random::integer(10);
00258   //  p2 = Random::integer(10);
00259   //  p3 = Random::integer(50);
00260 
00261   (*walk++) = (obj_name >> 24) & 0xFF;
00262   (*walk++) = (obj_name >> 16) & 0xFF;
00263   (*walk++) = (obj_name >> 8) & 0xFF;
00264   (*walk++) = (obj_name) & 0xFF;
00265 
00266   double now = Scheduler::instance().clock();
00267   trace("Node %d: Generating query for object %d.%d.%d at time %f",myaddr_,(obj_name >> 24) & 0xFF,(obj_name >> 16) & 0xFF, obj_name & 0xFFFF,now);
00268   
00269 
00270   int origin_time = (int) now;
00271   (*walk++) = (origin_time >> 24) & 0xFF;
00272   (*walk++) = (origin_time >> 16) & 0xFF;
00273   (*walk++) = (origin_time >> 8) & 0xFF;
00274   (*walk++) = (origin_time) & 0xFF;
00275 
00276   // Number of source route hops in packet (= 0); 2 bytes
00277   (*walk++) = (num_src_hops >> 8) & 0xFF;
00278   (*walk++) = (num_src_hops) & 0xFF;
00279 
00280   // Above fields will be 4 bytes each. 20 bytes for the IP header will be
00281   // added in LM agent. No source route hops on query creation.
00282   hdrc->size_ = 24; 
00283   hdrc->direction() = hdr_cmn::DOWN;
00284 
00285   s.schedule(target_,p,0);
00286   //  double sched_time = CONST_INTERVAL + Random::uniform(query_interval_);
00287   //  trace("Node %d: Scheduling query gen at %f from now %f",myaddr_,sched_time,s.clock());
00288   //  s.schedule(query_handler_, gen_query_event_, sched_time);
00289   //  s.schedule(this, gen_query_event_, Random::uniform(query_interval_));
00290 }

00104 { return type_; }

00092 {
00093     recv((Packet*)e);
00094 }

00364 {
00365     if (app_)
00366         app_->resume();
00367 }

00457 {
00458     hdr_cmn* ch = hdr_cmn::access(p);
00459     ch->uid() = uidcnt_++;
00460     ch->ptype() = type_;
00461     ch->size() = size_;
00462     ch->timestamp() = Scheduler::instance().clock();
00463     ch->iface() = UNKN_IFACE.value(); // from packet.h (agent is local)
00464     ch->direction() = hdr_cmn::NONE;
00465 
00466     ch->error() = 0;    /* pkt not corrupt to start with */
00467 
00468     hdr_ip* iph = hdr_ip::access(p);
00469     iph->saddr() = here_.addr_;
00470     iph->sport() = here_.port_;
00471     iph->daddr() = dst_.addr_;
00472     iph->dport() = dst_.port_;
00473     
00474     //DEBUG
00475     //if (dst_ != -1)
00476     //  printf("pl break\n");
00477     
00478     iph->flowid() = fid_;
00479     iph->prio() = prio_;
00480     iph->ttl() = defttl_;
00481 
00482     hdr_flags* hf = hdr_flags::access(p);
00483     hf->ecn_capable_ = 0;
00484     hf->ecn_ = 0;
00485     hf->eln_ = 0;
00486     hf->ecn_to_echo_ = 0;
00487     hf->fs_ = 0;
00488     hf->no_ts_ = 0;
00489     hf->pri_ = 0;
00490     hf->cong_action_ = 0;
00491     hf->qs_ = 0;
00492 #ifdef HAVE_STL
00493 
00494     hdr_nv* nv = hdr_nv::access(p);
00495     if (0)
00496         printf("Off hdr_nv %d, ip_hdr %d myaddr %d\n",
00497                hdr_nv::offset(), hdr_ip::offset(), here_.addr_);
00498     NixNode* pNixNode = NixNode::GetNodeObject(here_.addr_);
00499     if (0)
00500         printf("Node Object %p\n", pNixNode);
00501     if (pNixNode) { 
00502         // If we get non-null, indicates nixvector routing in use
00503         // Delete any left over nv in the packet
00504         // Get a nixvector to the target (may create new)
00505         NixVec* pNv = pNixNode->GetNixVector(dst_.addr_);
00506         pNv->Reset();
00507         nv->nv() = pNv; // And set the nixvec in the packet
00508         nv->h_used = 0; // And reset used portion to 0
00509     }
00510 #endif //HAVE_STL
00511 }

00251 {
00252     OldValue *p = new OldValue;
00253     assert(p != NULL);
00254     strncpy(p->val_, value, min(strlen(value)+1, TRACEVAR_MAXVALUELENGTH));
00255     p->var_ = v;
00256     p->next_ = NULL;
00257     if (oldValueList_ == NULL) 
00258         oldValueList_ = p;
00259     else {
00260         p->next_ = oldValueList_;
00261         oldValueList_ = p;
00262     }
00263 }

00061 { return debug_; }

00243 {
00244     OldValue *p = oldValueList_;
00245     while ((p != NULL) && (p->var_ != v))
00246         p = p->next_;
00247     return p;
00248 }

00311 {
00312     char wrk[256];
00313     int n;
00314     double curTime = (&Scheduler::instance() == NULL ? 0 : 
00315               Scheduler::instance().clock());
00316     
00317     sprintf(wrk, "v -t "TIME_FORMAT" -e monitor_agent %d %s",
00318         curTime, here_.addr_, traceName_);
00319     n = strlen(wrk);
00320     wrk[n] = '\n';
00321     wrk[n+1] = 0;
00322     if (channel_)
00323         (void)Tcl_Write(channel_, wrk, n+1);
00324 }

00100 { return here_.port_; }

00097 {
00098     Packet::free(p);
00099 }

00296 {
00297   unsigned char *walk = p->accessdata();
00298   int X = 0, Y = 0, obj_name = -1;
00299 
00300   if(node_dead_) {
00301     Packet::free(p);
00302     return;
00303   }
00304 
00305   ++walk;
00306   X = *walk++;
00307   X = (X << 8) | *walk++;
00308 
00309   Y = *walk++;
00310   Y = (Y << 8) | *walk++;
00311   
00312   ++walk;
00313   obj_name = *walk++;
00314   obj_name = (obj_name << 8) | *walk++;
00315   obj_name = (obj_name << 8) | *walk++;
00316   obj_name = (obj_name << 8) | *walk++;
00317 
00318   double now = Scheduler::instance().clock();
00319   trace("Node %d: SensorQueryAgent Found object %d.%d.%d at (%d,%d) at time %f", myaddr_, (obj_name >> 24) & 0xFF, (obj_name >> 16) & 0xFF, obj_name & 0xFFFF,X,Y,now);
00320 
00321   Packet::free(p);
00322 }

00355 {
00356     if (app_)
00357         app_->recv(nbytes); 
00358 }

00091 { sendmsg(nbytes); }

00084 { sendmsg(sz, data, 0); }

00080 { target_->recv(p, h); }

00401 {
00402     fprintf(stderr, 
00403     "Agent::sendmsg(int, AppData*, const char*) not implemented\n");
00404     abort();
00405 }

00413 {
00414     fprintf(stderr, 
00415     "Agent::sendmsg(int, AppData*, const char*) not implemented\n");
00416     abort();
00417 }

00103 { type_ = pkttype; }

00051 {drop_ = dt; }

00098 { return size_; }

00183 {
00184   //  Scheduler &s = Scheduler::instance();
00185   //  double sched_time = CONST_INTERVAL + Random::uniform(query_interval_);
00186   //  trace("Node %d: Scheduling query gen at %f from now %f",myaddr_,sched_time,s.clock());
00187   //  s.schedule(query_handler_, gen_query_event_, Random::uniform(query_interval_));
00188   trace("Node %d: SensorQueryAgent starting up at time %f",myaddr_,NOW);
00189   node_dead_ = 0;
00190 }

00095 {
00096   trace("Node %d: SensorQueryAgent going down at time %f",myaddr_,NOW);
00097 
00098   // Event id > 0 implies presence on the event queue
00099   if(gen_query_event_->uid_) {
00100     Scheduler &s = Scheduler::instance();
00101     s.cancel(gen_query_event_);
00102   }
00103   node_dead_ = 1;
00104 }

00049 { target_ = target; }

00048 { return target_; }

00267 {
00268     if (channel_ == 0)
00269         return;
00270     char wrk[256], value[128];
00271     int n;
00272 
00273     // XXX we need to keep track of old values. What's the best way?
00274     v->value(value, 128);
00275 
00276     // XXX hack: how do I know ns has not started yet?
00277     // if there's nothing in value, return
00278     static int started = 0;
00279     if (!started) {
00280         Tcl::instance().evalc("[Simulator instance] is-started");
00281         if (Tcl::instance().result()[0] == '0')
00282             // Simulator not started, do nothing
00283             return;
00284         // remember for next time (so we don't always have to call to tcl)
00285         started = 1;
00286     };
00287 
00288     OldValue *ov = lookupOldValue(v);
00289     if (ov != NULL) {
00290         sprintf(wrk, 
00291             "f -t "TIME_FORMAT" -s %d -d %d -n %s -a %s -v %s -o %s -T v",
00292             Scheduler::instance().clock(), here_.addr_,
00293             dst_.addr_, v->name(), traceName_, value, ov->val_);
00294         strncpy(ov->val_, 
00295             value,
00296             min(strlen(value)+1, TRACEVAR_MAXVALUELENGTH));
00297     } else {
00298         // if there is value, insert it into old value list
00299         sprintf(wrk, "f -t "TIME_FORMAT" -s %d -d %d -n %s -a %s -v %s -T v",
00300             Scheduler::instance().clock(), here_.addr_,
00301             dst_.addr_, v->name(), traceName_, value);
00302         insertOldValue(v, value);
00303     }
00304     n = strlen(wrk);
00305     wrk[n] = '\n';
00306     wrk[n+1] = 0;
00307     (void)Tcl_Write(channel_, wrk, n+1);
00308 }

00075 {
00076   va_list ap; // Define a variable ap that will refer to each argument in turn
00077 
00078   if (!tracetarget_)
00079     return;
00080 
00081   // Initializes ap to first argument
00082   va_start (ap, fmt); 
00083   // Prints the elements in turn
00084   vsprintf (tracetarget_->buffer (), fmt, ap); 
00085   tracetarget_->dump ();
00086   // Does the necessary clean-up before returning
00087   va_end (ap); 
00088 }


Public Member Functions
nsaddr_t &	addr ()
virtual void	attachApp (Application *app)
virtual void	close ()
virtual int	command (int argc, const char const argv)
virtual void	connect (nsaddr_t dst)
nsaddr_t &	daddr ()
virtual void	debug (const char *fmt,...)
nsaddr_t &	dport ()
virtual void	drop (Packet *p)
void	generate_query (int p1, int p2, int p3)
packet_t	get_pkttype ()
int	isdebug () const
virtual void	listen ()
nsaddr_t &	port ()
virtual void	recv (Packet p, const char s)
void	recv (Packet p, Handler )
void	recvOnly (Packet *)
virtual void	send (int nbytes)
virtual void	send (int sz, AppData *data)
void	send (Packet p, Handler h)
virtual void	sendmsg (int nbytes, const char *flags=0)
virtual void	sendmsg (int sz, AppData , const char flags=0)
virtual void	sendto (int nbytes, const char *flags, ns_addr_t dst)
virtual void	sendto (int nbytes, const char *flags, nsaddr_t dst)
virtual void	sendto (int sz, AppData , const char flags, ns_addr_t dst)
virtual void	sendto (int sz, AppData , const char flags, nsaddr_t dst)
	SensorQueryAgent ()
void	set_pkttype (packet_t pkttype)
void	setDropTarget (NsObject *dt)
virtual int &	size ()
void	startUp ()
void	stop ()
void	target (NsObject *target)
NsObject *	target ()
virtual void	timeout (int tno)
void	trace (char *fmt,...)
Data Fields
Event *	gen_query_event_
nsaddr_t	myaddr_
int	node_dead_
SensorQueryHandler *	query_handler_
double	query_interval_
tags_database *	tag_dbase_
Trace *	tracetarget_
Protected Member Functions
void	addAgentTrace (const char *name)
Packet *	allocpkt (int) const
Packet *	allocpkt () const
virtual int	delay_bind_dispatch (const char varName, const char localName, TclObject *tracer)
virtual void	delay_bind_init_all ()
void	deleteAgentTrace ()
virtual void	drop (Packet p, const char s)
void	dumpTracedVars ()
void	handle (Event *)
virtual void	idle ()
void	initpkt (Packet *) const
void	insertOldValue (TracedVar v, const char value)
OldValue *	lookupOldValue (TracedVar *v)
void	monitorAgentTrace ()
virtual void	recvBytes (int bytes)
virtual void	reset ()
virtual void	trace (TracedVar *v)
virtual void	trace_event (char *eventtype)
Protected Attributes
Application *	app_
Tcl_Channel	channel_
int	debug_
int	defttl_
NsObject *	drop_
ns_addr_t	dst_
EventTrace *	et_
int	fid_
int	flags_
ns_addr_t	here_
OldValue *	oldValueList_
int	prio_
int	size_
NsObject *	target_
char *	traceName_
packet_t	type_
Static Protected Attributes
static int	uidcnt_

SensorQueryAgent Class Reference

Detailed Description

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation