Home | History | Annotate | Line # | Download | only in mrouted
prune.h revision 1.1 
      1 /*
      2  * The mrouted program is covered by the license in the accompanying file
      3  * named "LICENSE".  Use of the mrouted program represents acceptance of
      4  * the terms and conditions listed in that file.
      5  *
      6  * The mrouted program is COPYRIGHT 1989 by The Board of Trustees of
      7  * Leland Stanford Junior University.
      8  *
      9  *
     10  * $Id: prune.h,v 1.1 1995/06/01 02:26:03 mycroft Exp $
     11  */
     12 
     13 /*
     14  * Group table
     15  *
     16  * Each group entry is a member of two doubly-linked lists:
     17  *
     18  * a) A list hanging off of the routing table entry for this source (rt_groups)
     19  *	sorted by group address under the routing entry (gt_next, gt_prev)
     20  * b) An independent list pointed to by kernel_table, which is a list of
     21  *	active source,group's (gt_gnext, gt_gprev).
     22  *
     23  */
     24 struct gtable {
     25     struct gtable  *gt_next;		/* pointer to the next entry	    */
     26     struct gtable  *gt_prev;		/* back pointer for linked list	    */
     27     struct gtable  *gt_gnext;		/* fwd pointer for group list	    */
     28     struct gtable  *gt_gprev;		/* rev pointer for group list	    */
     29     u_int32_t	    gt_mcastgrp;	/* multicast group associated       */
     30     vifbitmap_t     gt_scope;		/* scoped interfaces                */
     31     u_char	    gt_ttls[MAXVIFS];	/* ttl vector for forwarding        */
     32     vifbitmap_t	    gt_grpmems;		/* forw. vifs for src, grp          */
     33     int		    gt_prsent_timer;	/* prune timer for this group	    */
     34     int  	    gt_timer;		/* timer for this group entry	    */
     35     time_t 	    gt_ctime;		/* time of entry creation         */
     36     u_char	    gt_grftsnt;		/* graft sent/retransmit timer	    */
     37     struct stable  *gt_srctbl;		/* source table			    */
     38     struct ptable  *gt_pruntbl;		/* prune table			    */
     39     struct rtentry *gt_route;		/* parent route			    */
     40 };
     41 
     42 /*
     43  * Source table
     44  *
     45  * When source-based prunes exist, there will be a struct ptable here as well.
     46  */
     47 struct stable
     48 {
     49     struct stable  *st_next;       	/* pointer to the next entry        */
     50     u_int32_t	    st_origin;		/* host origin of multicasts        */
     51     u_long	    st_pktcnt;		/* packet count for src-grp entry   */
     52 };
     53 
     54 /*
     55  * structure to store incoming prunes.  Can hang off of either group or source.
     56  */
     57 struct ptable
     58 {
     59     struct ptable  *pt_next;		/* pointer to the next entry	    */
     60     u_int32_t	    pt_router;		/* router that sent this prune	    */
     61     vifi_t	    pt_vifi;		/* vif prune received on	    */
     62     int		    pt_timer;		/* timer for prune		    */
     63 };
     64 
     65 /*
     66  * The packet format for a traceroute request.
     67  */
     68 struct tr_query {
     69     u_int32_t  tr_src;		/* traceroute source */
     70     u_int32_t  tr_dst;		/* traceroute destination */
     71     u_int32_t  tr_raddr;		/* traceroute response address */
     72 #if defined(BYTE_ORDER) && (BYTE_ORDER == LITTLE_ENDIAN)
     73     struct {
     74 	u_int	qid : 24;	/* traceroute query id */
     75 	u_int	ttl : 8;	/* traceroute response ttl */
     76     } q;
     77 #else
     78     struct {
     79 	u_int   ttl : 8;	/* traceroute response ttl */
     80 	u_int   qid : 24;	/* traceroute query id */
     81     } q;
     82 #endif /* BYTE_ORDER */
     83 };
     84 
     85 #define tr_rttl q.ttl
     86 #define tr_qid  q.qid
     87 
     88 /*
     89  * Traceroute response format.  A traceroute response has a tr_query at the
     90  * beginning, followed by one tr_resp for each hop taken.
     91  */
     92 struct tr_resp {
     93     u_int32_t tr_qarr;		/* query arrival time */
     94     u_int32_t tr_inaddr;		/* incoming interface address */
     95     u_int32_t tr_outaddr;		/* outgoing interface address */
     96     u_int32_t tr_rmtaddr;		/* parent address in source tree */
     97     u_int32_t tr_vifin;		/* input packet count on interface */
     98     u_int32_t tr_vifout;		/* output packet count on interface */
     99     u_int32_t tr_pktcnt;		/* total incoming packets for src-grp */
    100     u_char  tr_rproto;		/* routing protocol deployed on router */
    101     u_char  tr_fttl;		/* ttl required to forward on outvif */
    102     u_char  tr_smask;		/* subnet mask for src addr */
    103     u_char  tr_rflags;		/* forwarding error codes */
    104 };
    105 
    106 /* defs within mtrace */
    107 #define QUERY	1
    108 #define RESP	2
    109 #define QLEN	sizeof(struct tr_query)
    110 #define RLEN	sizeof(struct tr_resp)
    111 
    112 /* fields for tr_rflags (forwarding error codes) */
    113 #define TR_NO_ERR	0
    114 #define TR_WRONG_IF	1
    115 #define TR_PRUNED	2
    116 #define TR_OPRUNED	3
    117 #define TR_SCOPED	4
    118 #define TR_NO_RTE	5
    119 #define TR_NO_FWD	7
    120 #define TR_NO_SPACE	0x81
    121 #define TR_OLD_ROUTER	0x82
    122 
    123 /* fields for tr_rproto (routing protocol) */
    124 #define PROTO_DVMRP	1
    125 #define PROTO_MOSPF	2
    126 #define PROTO_PIM	3
    127 #define PROTO_CBT	4
    128 
    129 #define MASK_TO_VAL(x, i) { \
    130 			u_int32_t _x = ntohl(x); \
    131 			(i) = 0; \
    132 			while ((_x) << (i)) \
    133 				(i)++; \
    134 			};
    135 
    136 #define VAL_TO_MASK(x, i) { \
    137 			x = htonl(~((1 << (32 - (i))) - 1)); \
    138 			};
    139 
    140 #define NBR_VERS(n)	(((n)->al_pv << 8) + (n)->al_mv)
    141