changed comments to C style
authorThomas Martin <thomas.martin@rohde-schwarz.com>
Thu, 3 Jul 2008 14:13:57 +0000 (16:13 +0200)
committerThomas Martin <thomas.martin@rohde-schwarz.com>
Thu, 3 Jul 2008 14:13:57 +0000 (16:13 +0200)
src/build_msg.c
src/lq_mpr.c
src/lq_packet.h
src/main.c
src/net_olsr.c
src/olsr.c
src/process_package.c
src/process_routes.c
src/rebuild_packet.c
src/socket_parser.c
src/two_hop_neighbor_table.c

index 0690610..4278adc 100644 (file)
@@ -1214,8 +1214,9 @@ serialize_hna6(struct interface *ifp)
   m->v6.seqno = htons(get_msg_seqno());
   
   net_outbuffer_push(ifp, msg_buffer, curr_size);
-  
-  //printf("Sending HNA (%d bytes)...\n", outputsize);
+#if 0
+  printf("Sending HNA (%d bytes)...\n", outputsize);
+#endif
   return OLSR_FALSE;
 
 }
index 8423d57..c427be8 100644 (file)
@@ -81,7 +81,7 @@ void olsr_calculate_lq_mpr(void)
 
   for(i = 0; i < HASHSIZE; i++)
     {
-      // loop through all 2-hop neighbours
+      /* loop through all 2-hop neighbours */
 
       for (neigh2 = two_hop_neighbortable[i].next;
            neigh2 != &two_hop_neighbortable[i];
@@ -89,20 +89,20 @@ void olsr_calculate_lq_mpr(void)
         {
           best_1hop = LINK_COST_BROKEN;
 
-          // check whether this 2-hop neighbour is also a neighbour
+          /* check whether this 2-hop neighbour is also a neighbour */
 
           neigh = olsr_lookup_neighbor_table(&neigh2->neighbor_2_addr);
 
-          // if it's a neighbour and also symmetric, then examine
-          // the link quality
+          /* if it's a neighbour and also symmetric, then examine
+             the link quality */
           
           if (neigh != NULL && neigh->status == SYM)
             {
-              // if the direct link is better than the best route via
-              // an MPR, then prefer the direct link and do not select
-              // an MPR for this 2-hop neighbour
+              /* if the direct link is better than the best route via
+               * an MPR, then prefer the direct link and do not select
+               * an MPR for this 2-hop neighbour */
 
-              // determine the link quality of the direct link
+              /* determine the link quality of the direct link */
 
               struct link_entry *lnk = get_best_link_to_neighbor(&neigh->neighbor_main_addr);
 
@@ -111,7 +111,7 @@ void olsr_calculate_lq_mpr(void)
 
               best_1hop = lnk->linkcost;
 
-              // see wether we find a better route via an MPR
+              /* see wether we find a better route via an MPR */
 
               for (walker = neigh2->neighbor_2_nblist.next;
                    walker != &neigh2->neighbor_2_nblist;
@@ -119,18 +119,18 @@ void olsr_calculate_lq_mpr(void)
                 if (walker->path_linkcost < best_1hop)
                   break;
 
-              // we've reached the end of the list, so we haven't found
-              // a better route via an MPR - so, skip MPR selection for
-              // this 1-hop neighbor
+              /* we've reached the end of the list, so we haven't found
+               * a better route via an MPR - so, skip MPR selection for
+               * this 1-hop neighbor */
 
               if (walker == &neigh2->neighbor_2_nblist)
                 continue;
             }
 
-          // find the connecting 1-hop neighbours with the
-          // best total link qualities
+          /* find the connecting 1-hop neighbours with the
+           * best total link qualities */
 
-          // mark all 1-hop neighbours as not selected
+          /* mark all 1-hop neighbours as not selected */
 
           for (walker = neigh2->neighbor_2_nblist.next;
                walker != &neigh2->neighbor_2_nblist;
@@ -139,8 +139,8 @@ void olsr_calculate_lq_mpr(void)
 
           for (k = 0; k < olsr_cnf->mpr_coverage; k++)
             {
-              // look for the best 1-hop neighbour that we haven't
-              // yet selected
+              /* look for the best 1-hop neighbour that we haven't
+               * yet selected */
 
               neigh = NULL;
               best = LINK_COST_BROKEN;
@@ -156,9 +156,9 @@ void olsr_calculate_lq_mpr(void)
                     best = walker->path_linkcost;
                   }
 
-              // Found a 1-hop neighbor that we haven't previously selected.
-              // Use it as MPR only when the 2-hop path through it is better than
-              // any existing 1-hop path.
+              /* Found a 1-hop neighbor that we haven't previously selected.
+               * Use it as MPR only when the 2-hop path through it is better than
+               * any existing 1-hop path. */
               if ((neigh != NULL) && (best < best_1hop))
                 {
                   neigh->is_mpr = OLSR_TRUE;
@@ -168,8 +168,8 @@ void olsr_calculate_lq_mpr(void)
                     mpr_changes = OLSR_TRUE;
                 }
 
-              // no neighbour found => the requested MPR coverage cannot
-              // be satisfied => stop
+              /* no neighbour found => the requested MPR coverage cannot
+               * be satisfied => stop */
 
               else
                 break;
index e6b172d..f61dffc 100644 (file)
@@ -49,7 +49,7 @@
 #define LQ_HELLO_MESSAGE      201
 #define LQ_TC_MESSAGE         202
 
-// deserialized OLSR header
+/* deserialized OLSR header */
 
 struct olsr_common
 {
@@ -62,7 +62,7 @@ struct olsr_common
   olsr_u16_t         seqno;
 };
 
-// serialized IPv4 OLSR header
+/* serialized IPv4 OLSR header */
 
 struct olsr_header_v4
 {
@@ -75,7 +75,7 @@ struct olsr_header_v4
   olsr_u16_t seqno;
 };
 
-// serialized IPv6 OLSR header
+/* serialized IPv6 OLSR header */
 
 struct olsr_header_v6
 {
@@ -88,7 +88,7 @@ struct olsr_header_v6
   olsr_u16_t    seqno;
 };
 
-// deserialized LQ_HELLO
+/* deserialized LQ_HELLO */
 
 struct lq_hello_neighbor
 {
@@ -107,7 +107,7 @@ struct lq_hello_message
   struct lq_hello_neighbor *neigh;
 };
 
-// serialized LQ_HELLO
+/* serialized LQ_HELLO */
 
 struct lq_hello_info_header
 {
@@ -123,7 +123,7 @@ struct lq_hello_header
   olsr_u8_t  will;
 };
 
-// deserialized LQ_TC
+/* deserialized LQ_TC */
 struct lq_tc_message
 {
   struct olsr_common    comm;
@@ -132,7 +132,7 @@ struct lq_tc_message
   struct tc_mpr_addr    *neigh;
 };
 
-// serialized LQ_TC
+/* serialized LQ_TC */
 
 struct lq_tc_header
 {
index 263c1bb..b636c57 100644 (file)
@@ -270,7 +270,7 @@ main(int argc, char *argv[])
 #endif
 
   /*
-   *socket for icotl calls
+   * socket for ioctl calls
    */
   olsr_cnf->ioctl_s = socket(olsr_cnf->ip_version, SOCK_DGRAM, 0);
   if (olsr_cnf->ioctl_s < 0) {
@@ -287,6 +287,9 @@ main(int argc, char *argv[])
   fcntl(olsr_cnf->rtnl_s, F_SETFL, O_NONBLOCK);
 #endif
 
+/*
+ * create routing socket
+ */
 #if defined __FreeBSD__ || defined __MacOSX__ || defined __NetBSD__ || defined __OpenBSD__
   olsr_cnf->rts = socket(PF_ROUTE, SOCK_RAW, 0);
   if (olsr_cnf->rts < 0) {
index 91b8a52..67399d5 100644 (file)
@@ -100,10 +100,16 @@ net_set_disp_pack_out(olsr_bool val)
   disp_pack_out = val;
 }
 
+/*
+ * Converts each invalid IP-address from string to network byte order
+ * and adds it to the invalid list.
+ *
+ * TODO: rename function
+ */
 void
 init_net(void)
 {
-  const char * const *defaults = olsr_cnf->ip_version == AF_INET ? deny_ipv4_defaults : deny_ipv6_defaults;
+  const char * const *defaults = (olsr_cnf->ip_version == AF_INET) ? deny_ipv4_defaults : deny_ipv6_defaults;
   
   for (; *defaults != NULL; defaults++) {
     union olsr_ip_addr addr;
@@ -116,7 +122,7 @@ init_net(void)
 }
 
 /**
- * Create a outputbuffer for the given interface. This
+ * Create an outputbuffer for the given interface. This
  * function will allocate the needed storage according 
  * to the MTU of the interface.
  *
@@ -439,14 +445,19 @@ net_output(struct interface *ifp)
   
   ifp->netbuf.pending = 0;
 
-  // if we've just transmitted a TC message, let Dijkstra use the current
-  // link qualities for the links to our neighbours
+  /*
+   * if we've just transmitted a TC message, let Dijkstra use the current
+   * link qualities for the links to our neighbours
+   */
 
   lq_tc_pending = OLSR_FALSE;
 
   return retval;
 }
 
+/*
+ * Adds the given IP-address to the invalid list. 
+ */
 void
 olsr_add_invalid_address(const union olsr_ip_addr *adr)
 {
index dcacc63..b5dec7b 100644 (file)
@@ -126,7 +126,7 @@ register_pcf(int (*f)(int, int, int))
 
 /**
  *Process changes in neighborhood or/and topology.
- *Re-calculates the neighborhooh/topology if there
+ *Re-calculates the neighborhood/topology if there
  *are any updates - then calls the right functions to
  *update the routing table.
  *@return 0
index 6a664fe..0c41728 100644 (file)
@@ -121,14 +121,18 @@ process_message_neighbors(struct neighbor_entry *neighbor, const struct hello_me
                              two_hop_neighbor_yet, 0);
               two_hop_neighbor = two_hop_neighbor_yet->neighbor_2;
 
-              // For link quality OLSR, reset the path link quality here.
-              // The path link quality will be calculated in the second pass, below.
-              // Keep the saved_path_link_quality for reference.
+              /*
+               * For link quality OLSR, reset the path link quality here.
+               * The path link quality will be calculated in the second pass, below.
+               * Keep the saved_path_link_quality for reference.
+               */
 
               if (olsr_cnf->lq_level > 0)
                 {
-                  // loop through the one-hop neighbors that see this
-                  // 'two_hop_neighbor'
+                  /*
+                   * loop through the one-hop neighbors that see this
+                   * 'two_hop_neighbor'
+                   */
 
                   struct neighbor_list_entry *walker;
 
@@ -136,8 +140,10 @@ process_message_neighbors(struct neighbor_entry *neighbor, const struct hello_me
                        walker != &two_hop_neighbor->neighbor_2_nblist;
                        walker = walker->next)
                     {
-                      // have we found the one-hop neighbor that sent the
-                      // HELLO message that we're current processing?
+                      /*
+                       * have we found the one-hop neighbor that sent the
+                       * HELLO message that we're current processing?
+                       */
 
                       if (walker->neighbor == neighbor)
                         {
@@ -191,7 +197,8 @@ process_message_neighbors(struct neighbor_entry *neighbor, const struct hello_me
         }
     }
 
-  // Separate, second pass for link quality OLSR
+  /* Separate, second pass for link quality OLSR */
+  /* Separate, second and third pass for link quality OLSR */
 
   if (olsr_cnf->lq_level > 0)
     {
@@ -202,15 +209,16 @@ process_message_neighbors(struct neighbor_entry *neighbor, const struct hello_me
       if(!lnk)
        return;
 
-      // calculate first hop path quality
+      /* calculate first hop path quality */
       first_hop_pathcost = lnk->linkcost;
-      
-      // Second pass for link quality OLSR: calculate the best 2-hop
-      // path costs to all the 2-hop neighbors indicated in the
-      // HELLO message. Since the same 2-hop neighbor may be listed
-      // more than once in the same HELLO message (each at a possibly
-      // different quality) we want to select only the best one, not just
-      // the last one listed in the HELLO message.
+      /*
+       *  Second pass for link quality OLSR: calculate the best 2-hop
+       * path costs to all the 2-hop neighbors indicated in the
+       * HELLO message. Since the same 2-hop neighbor may be listed
+       * more than once in the same HELLO message (each at a possibly
+       * different quality) we want to select only the best one, not just
+       * the last one listed in the HELLO message.
+       */
 
       for(message_neighbors = message->neighbors;
           message_neighbors != NULL;
@@ -232,15 +240,19 @@ process_message_neighbors(struct neighbor_entry *neighbor, const struct hello_me
 
               two_hop_neighbor = two_hop_neighbor_yet->neighbor_2;
 
-              // loop through the one-hop neighbors that see this
-              // 'two_hop_neighbor'
+              /*
+               *  loop through the one-hop neighbors that see this
+               * 'two_hop_neighbor'
+               */
 
               for (walker = two_hop_neighbor->neighbor_2_nblist.next;
                    walker != &two_hop_neighbor->neighbor_2_nblist;
                    walker = walker->next)
                 {
-                  // have we found the one-hop neighbor that sent the
-                  // HELLO message that we're current processing?
+                  /*
+                   * have we found the one-hop neighbor that sent the
+                   * HELLO message that we're current processing?
+                   */
 
                   if (walker->neighbor == neighbor)
                     {
@@ -450,10 +462,10 @@ olsr_hello_tap(struct hello_message *message,
   if (olsr_cnf->lq_level > 0)
     {
       struct hello_neighbor *walker;
-      // just in case our neighbor has changed its HELLO interval
+      /* just in case our neighbor has changed its HELLO interval */
       olsr_update_packet_loss_hello_int(lnk, message->htime);
 
-      // find the input interface in the list of neighbor interfaces
+      /* find the input interface in the list of neighbor interfaces */
       for (walker = message->neighbors; walker != NULL; walker = walker->next)
         if (ipequal(&walker->address, &in_if->ip_addr))
           break;
@@ -462,7 +474,7 @@ olsr_hello_tap(struct hello_message *message,
       // know the link quality in both directions
       olsr_memorize_foreign_hello_lq(lnk, walker);
 
-      // update packet loss for link quality calculation
+      /* update packet loss for link quality calculation */
       olsr_update_packet_loss(lnk);
     }
   
@@ -474,7 +486,7 @@ olsr_hello_tap(struct hello_message *message,
   if(olsr_cnf->use_hysteresis)
     {
       /* Update HELLO timeout */
-      //printf("MESSAGE HTIME: %f\n", message->htime);
+      /* printf("MESSAGE HTIME: %f\n", message->htime);*/
       olsr_update_hysteresis_hello(lnk, message->htime);
     }
 
@@ -604,7 +616,6 @@ olsr_process_received_hna(union olsr_message *m,
   olsr_reltime       vtime;
   olsr_u16_t         olsr_msgsize;
   union olsr_ip_addr originator;
-  //olsr_u8_t          ttl; unused
   olsr_u8_t          hop_count;
   olsr_u16_t         packet_seq_number;
 
@@ -645,7 +656,7 @@ olsr_process_received_hna(union olsr_message *m,
 
   /* validate originator */
   pkt_get_ipaddress(&curr, &originator);
-  //printf("HNA from %s\n\n", olsr_ip_to_string(&buf, &originator));
+  /*printf("HNA from %s\n\n", olsr_ip_to_string(&buf, &originator));*/
 
   /* ttl */
   pkt_ignore_u8(&curr);
index 4983a7a..e78228c 100644 (file)
@@ -74,6 +74,7 @@ olsr_rt_flags(const struct rt_entry *rt)
   const struct rt_nexthop *nh;
   olsr_u8_t flags = RTF_UP;
 
+  /* destination is host */
   if (rt->rt_dst.prefix_len == olsr_cnf->maxplen) {
     flags |= RTF_HOST;
   }
@@ -184,7 +185,7 @@ olsr_add_kernel_route(struct rt_entry *rt)
 {
 
   if(!olsr_cnf->host_emul) {
-    olsr_16_t error = olsr_cnf->ip_version == AF_INET ?
+    olsr_16_t error = (olsr_cnf->ip_version == AF_INET) ?
       olsr_addroute_function(rt) : olsr_addroute6_function(rt);
 
     if(error < 0) {
index af159ec..8aa09b0 100644 (file)
@@ -79,7 +79,7 @@ mid_chgestruct(struct mid_message *mmsg, const union olsr_message *m)
        */
       no_aliases =  ((ntohs(m->v4.olsr_msgsize) - 12) / 4);
 
-      //printf("Aliases: %d\n", no_aliases);
+      /*printf("Aliases: %d\n", no_aliases); */
       mmsg->mid_origaddr.v4.s_addr = m->v4.originator;
       mmsg->addr.v4.s_addr = m->v4.originator;
       /*seq number*/
@@ -89,7 +89,7 @@ mid_chgestruct(struct mid_message *mmsg, const union olsr_message *m)
       /* Get vtime */
       mmsg->vtime = me_to_reltime(m->v4.olsr_vtime);
 
-      //printf("Sequencenuber of MID from %s is %d\n", ip_to_string(&mmsg->addr), mmsg->mid_seqno);
+      /*printf("Sequencenuber of MID from %s is %d\n", ip_to_string(&mmsg->addr), mmsg->mid_seqno); */
 
 
       for(i = 0; i < no_aliases; i++)
@@ -130,7 +130,7 @@ mid_chgestruct(struct mid_message *mmsg, const union olsr_message *m)
        */
       no_aliases =  ((ntohs(m->v6.olsr_msgsize) - 12) / 16); /* NB 16 */
 
-      //printf("Aliases: %d\n", no_aliases);
+      /*printf("Aliases: %d\n", no_aliases); */
       mmsg->mid_origaddr.v6 = m->v6.originator;
       mmsg->addr.v6 = m->v6.originator;
       /*seq number*/
@@ -140,13 +140,13 @@ mid_chgestruct(struct mid_message *mmsg, const union olsr_message *m)
       /* Get vtime */
       mmsg->vtime = me_to_reltime(m->v6.olsr_vtime);
 
-      //printf("Sequencenuber of MID from %s is %d\n", ip_to_string(&mmsg->addr), mmsg->mid_seqno);
+      /*printf("Sequencenuber of MID from %s is %d\n", ip_to_string(&mmsg->addr), mmsg->mid_seqno); */
 
       for(i = 0; i < no_aliases; i++)
        {
          alias = olsr_malloc(sizeof(struct mid_alias), "MID chgestruct 2");
          
-         //printf("Adding alias: %s\n", olsr_ip_to_string(&buf, (union olsr_ip_addr *)&maddr6->addr));
+         /*printf("Adding alias: %s\n", olsr_ip_to_string(&buf, (union olsr_ip_addr *)&maddr6->addr));*/
          alias->alias_addr.v6 = maddr6->addr;
          alias->next = mmsg->mid_addr;
          mmsg->mid_addr = alias;
index 9ec58b4..da21b7b 100644 (file)
@@ -157,7 +157,7 @@ olsr_poll_sockets(void)
 {
   int n;
   struct olsr_socket_entry *olsr_sockets;
-  /* Global buffer for times(2) calls. Do not remopve since at least OpenBSD needs it. */
+  /* Global buffer for times(2) calls. Do not remove since at least OpenBSD needs it. */
   struct tms tms_buf;
   fd_set ibits;
   struct timeval tvp = {0, 0};
index 78311e6..21c9c66 100644 (file)
@@ -146,7 +146,9 @@ olsr_insert_two_hop_neighbor_table(struct neighbor_2_entry *two_hop_neighbor)
 {
   olsr_u32_t hash = olsr_ip_hashing(&two_hop_neighbor->neighbor_2_addr);
 
-  //printf("Adding 2 hop neighbor %s\n", olsr_ip_to_string(&buf, &two_hop_neighbor->neighbor_2_addr));
+#if 0
+    printf("Adding 2 hop neighbor %s\n", olsr_ip_to_string(&buf, &two_hop_neighbor->neighbor_2_addr));
+#endif
 
   /* Queue */  
   QUEUE_ELEM(two_hop_neighbortable[hash], two_hop_neighbor);
@@ -168,14 +170,14 @@ olsr_lookup_two_hop_neighbor_table(const union olsr_ip_addr *dest)
   struct neighbor_2_entry  *neighbor_2;
   olsr_u32_t               hash = olsr_ip_hashing(dest);
 
-  //printf("LOOKING FOR %s\n", olsr_ip_to_string(&buf, dest));
+  /* printf("LOOKING FOR %s\n", olsr_ip_to_string(&buf, dest)); */
   for(neighbor_2 = two_hop_neighbortable[hash].next;
       neighbor_2 != &two_hop_neighbortable[hash];
       neighbor_2 = neighbor_2->next)
     {
       struct mid_address *adr;
 
-      //printf("Checking %s\n", olsr_ip_to_string(&buf, dest));
+      /* printf("Checking %s\n", olsr_ip_to_string(&buf, dest)); */
       if (ipequal(&neighbor_2->neighbor_2_addr, dest))
        return neighbor_2;
 
@@ -209,7 +211,7 @@ olsr_lookup_two_hop_neighbor_table_mid(const union olsr_ip_addr *dest)
   struct neighbor_2_entry  *neighbor_2;
   olsr_u32_t               hash;
 
-  //printf("LOOKING FOR %s\n", olsr_ip_to_string(&buf, dest));
+  /* printf("LOOKING FOR %s\n", olsr_ip_to_string(&buf, dest)); */
   hash = olsr_ip_hashing(dest);
   
   for(neighbor_2 = two_hop_neighbortable[hash].next;