2 * NET3: Token ring device handling subroutines
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
9 * Fixes: 3 Feb 97 Paul Norton <pnorton@cts.com> Minor routing fixes.
10 * Added rif table to /proc/net/tr_rif and rif timeout to
11 * /proc/sys/net/token-ring/rif_timeout.
12 * 22 Jun 98 Paul Norton <p.norton@computer.org> Rearranged
13 * tr_header and tr_type_trans to handle passing IPX SNAP and
14 * 802.2 through the correct layers. Eliminated tr_reformat.
18 #include <asm/uaccess.h>
19 #include <asm/system.h>
20 #include <linux/module.h>
21 #include <linux/types.h>
22 #include <linux/kernel.h>
23 #include <linux/jiffies.h>
24 #include <linux/string.h>
26 #include <linux/socket.h>
28 #include <linux/inet.h>
29 #include <linux/netdevice.h>
30 #include <linux/trdevice.h>
31 #include <linux/skbuff.h>
32 #include <linux/errno.h>
33 #include <linux/timer.h>
34 #include <linux/net.h>
35 #include <linux/proc_fs.h>
36 #include <linux/seq_file.h>
37 #include <linux/init.h>
39 #include <net/net_namespace.h>
41 static void tr_add_rif_info(struct trh_hdr *trh, struct net_device *dev);
42 static void rif_check_expire(unsigned long dummy);
47 * Each RIF entry we learn is kept this way
51 unsigned char addr[TR_ALEN];
55 struct rif_cache *next;
56 unsigned long last_used;
57 unsigned char local_ring;
60 #define RIF_TABLE_SIZE 32
63 * We hash the RIF cache 32 ways. We do after all have to look it
67 static struct rif_cache *rif_table[RIF_TABLE_SIZE];
69 static DEFINE_SPINLOCK(rif_lock);
73 * Garbage disposal timer.
76 static struct timer_list rif_timer;
78 int sysctl_tr_rif_timeout = 60*10*HZ;
80 static inline unsigned long rif_hash(const unsigned char *addr)
85 x = (x << 2) ^ addr[1];
86 x = (x << 2) ^ addr[2];
87 x = (x << 2) ^ addr[3];
88 x = (x << 2) ^ addr[4];
89 x = (x << 2) ^ addr[5];
93 return x & (RIF_TABLE_SIZE - 1);
97 * Put the headers on a token ring packet. Token ring source routing
98 * makes this a little more exciting than on ethernet.
101 static int tr_header(struct sk_buff *skb, struct net_device *dev,
103 const void *daddr, const void *saddr, unsigned len)
109 * Add the 802.2 SNAP header if IP as the IPv4/IPv6 code calls
110 * dev->hard_header directly.
112 if (type == ETH_P_IP || type == ETH_P_IPV6 || type == ETH_P_ARP)
116 hdr_len = sizeof(struct trh_hdr) + sizeof(struct trllc);
117 trh = (struct trh_hdr *)skb_push(skb, hdr_len);
118 trllc = (struct trllc *)(trh+1);
119 trllc->dsap = trllc->ssap = EXTENDED_SAP;
121 trllc->protid[0] = trllc->protid[1] = trllc->protid[2] = 0x00;
122 trllc->ethertype = htons(type);
126 hdr_len = sizeof(struct trh_hdr);
127 trh = (struct trh_hdr *)skb_push(skb, hdr_len);
134 memcpy(trh->saddr,saddr,dev->addr_len);
136 memcpy(trh->saddr,dev->dev_addr,dev->addr_len);
139 * Build the destination and then source route the frame
144 memcpy(trh->daddr,daddr,dev->addr_len);
145 tr_source_route(skb, trh, dev);
153 * A neighbour discovery of some species (eg arp) has completed. We
154 * can now send the packet.
157 static int tr_rebuild_header(struct sk_buff *skb)
159 struct trh_hdr *trh=(struct trh_hdr *)skb->data;
160 struct trllc *trllc=(struct trllc *)(skb->data+sizeof(struct trh_hdr));
161 struct net_device *dev = skb->dev;
164 * FIXME: We don't yet support IPv6 over token rings
167 if(trllc->ethertype != htons(ETH_P_IP)) {
168 printk("tr_rebuild_header: Don't know how to resolve type %04X addresses ?\n", ntohs(trllc->ethertype));
173 if(arp_find(trh->daddr, skb)) {
179 tr_source_route(skb,trh,dev);
185 * Some of this is a bit hackish. We intercept RIF information
186 * used for source routing. We also grab IP directly and don't feed
190 __be16 tr_type_trans(struct sk_buff *skb, struct net_device *dev)
198 skb_reset_mac_header(skb);
201 if(trh->saddr[0] & TR_RII)
202 riflen = (ntohs(trh->rcf) & TR_RCF_LEN_MASK) >> 8;
204 trllc = (struct trllc *)(skb->data+sizeof(struct trh_hdr)-TR_MAXRIFLEN+riflen);
206 skb_pull(skb,sizeof(struct trh_hdr)-TR_MAXRIFLEN+riflen);
208 if(*trh->daddr & 0x80)
210 if(!memcmp(trh->daddr,dev->broadcast,TR_ALEN))
211 skb->pkt_type=PACKET_BROADCAST;
213 skb->pkt_type=PACKET_MULTICAST;
215 else if ( (trh->daddr[0] & 0x01) && (trh->daddr[1] & 0x00) && (trh->daddr[2] & 0x5E))
217 skb->pkt_type=PACKET_MULTICAST;
219 else if(dev->flags & IFF_PROMISC)
221 if(memcmp(trh->daddr, dev->dev_addr, TR_ALEN))
222 skb->pkt_type=PACKET_OTHERHOST;
225 if ((skb->pkt_type != PACKET_BROADCAST) &&
226 (skb->pkt_type != PACKET_MULTICAST))
227 tr_add_rif_info(trh,dev) ;
230 * Strip the SNAP header from ARP packets since we don't
231 * pass them through to the 802.2/SNAP layers.
234 if (trllc->dsap == EXTENDED_SAP &&
235 (trllc->ethertype == htons(ETH_P_IP) ||
236 trllc->ethertype == htons(ETH_P_IPV6) ||
237 trllc->ethertype == htons(ETH_P_ARP)))
239 skb_pull(skb, sizeof(struct trllc));
240 return trllc->ethertype;
243 return htons(ETH_P_TR_802_2);
247 * We try to do source routing...
250 void tr_source_route(struct sk_buff *skb,struct trh_hdr *trh,
251 struct net_device *dev)
255 struct rif_cache *entry;
256 unsigned char *olddata;
258 static const unsigned char mcast_func_addr[]
259 = {0xC0,0x00,0x00,0x04,0x00,0x00};
261 spin_lock_irqsave(&rif_lock, flags);
264 * Broadcasts are single route as stated in RFC 1042
266 if( (!memcmp(&(trh->daddr[0]),&(dev->broadcast[0]),TR_ALEN)) ||
267 (!memcmp(&(trh->daddr[0]),&(mcast_func_addr[0]), TR_ALEN)) )
269 trh->rcf=htons((((sizeof(trh->rcf)) << 8) & TR_RCF_LEN_MASK)
270 | TR_RCF_FRAME2K | TR_RCF_LIMITED_BROADCAST);
271 trh->saddr[0]|=TR_RII;
275 hash = rif_hash(trh->daddr);
277 * Walk the hash table and look for an entry
279 for(entry=rif_table[hash];entry && memcmp(&(entry->addr[0]),&(trh->daddr[0]),TR_ALEN);entry=entry->next);
282 * If we found an entry we can route the frame.
288 DECLARE_MAC_BUF(mac);
289 printk("source routing for %s\n",print_mac(mac, trh->daddr));
292 if(!entry->local_ring && (ntohs(entry->rcf) & TR_RCF_LEN_MASK) >> 8)
295 memcpy(&trh->rseg[0],&entry->rseg[0],8*sizeof(unsigned short));
296 trh->rcf^=htons(TR_RCF_DIR_BIT);
297 trh->rcf&=htons(0x1fff); /* Issam Chehab <ichehab@madge1.demon.co.uk> */
299 trh->saddr[0]|=TR_RII;
301 printk("entry found with rcf %04x\n", entry->rcf);
305 printk("entry found but without rcf length, local=%02x\n", entry->local_ring);
308 entry->last_used=jiffies;
313 * Without the information we simply have to shout
314 * on the wire. The replies should rapidly clean this
317 trh->rcf=htons((((sizeof(trh->rcf)) << 8) & TR_RCF_LEN_MASK)
318 | TR_RCF_FRAME2K | TR_RCF_LIMITED_BROADCAST);
319 trh->saddr[0]|=TR_RII;
321 printk("no entry in rif table found - broadcasting frame\n");
326 /* Compress the RIF here so we don't have to do it in the driver(s) */
327 if (!(trh->saddr[0] & 0x80))
330 slack = 18 - ((ntohs(trh->rcf) & TR_RCF_LEN_MASK)>>8);
332 spin_unlock_irqrestore(&rif_lock, flags);
334 skb_pull(skb, slack);
335 memmove(skb->data, olddata, sizeof(struct trh_hdr) - slack);
339 * We have learned some new RIF information for our source
343 static void tr_add_rif_info(struct trh_hdr *trh, struct net_device *dev)
345 unsigned int hash, rii_p = 0;
347 struct rif_cache *entry;
348 unsigned char saddr0;
350 spin_lock_irqsave(&rif_lock, flags);
351 saddr0 = trh->saddr[0];
354 * Firstly see if the entry exists
357 if(trh->saddr[0] & TR_RII)
360 if (((ntohs(trh->rcf) & TR_RCF_LEN_MASK) >> 8) > 2)
366 hash = rif_hash(trh->saddr);
367 for(entry=rif_table[hash];entry && memcmp(&(entry->addr[0]),&(trh->saddr[0]),TR_ALEN);entry=entry->next);
372 DECLARE_MAC_BUF(mac);
373 printk("adding rif_entry: addr:%s rcf:%04X\n",
374 print_mac(mac, trh->saddr), ntohs(trh->rcf));
377 * Allocate our new entry. A failure to allocate loses
378 * use the information. This is harmless.
380 * FIXME: We ought to keep some kind of cache size
381 * limiting and adjust the timers to suit.
383 entry=kmalloc(sizeof(struct rif_cache),GFP_ATOMIC);
387 printk(KERN_DEBUG "tr.c: Couldn't malloc rif cache entry !\n");
388 spin_unlock_irqrestore(&rif_lock, flags);
392 memcpy(&(entry->addr[0]),&(trh->saddr[0]),TR_ALEN);
393 entry->iface = dev->ifindex;
394 entry->next=rif_table[hash];
395 entry->last_used=jiffies;
396 rif_table[hash]=entry;
400 entry->rcf = trh->rcf & htons((unsigned short)~TR_RCF_BROADCAST_MASK);
401 memcpy(&(entry->rseg[0]),&(trh->rseg[0]),8*sizeof(unsigned short));
402 entry->local_ring = 0;
406 entry->local_ring = 1;
409 else /* Y. Tahara added */
412 * Update existing entries
414 if (!entry->local_ring)
415 if (entry->rcf != (trh->rcf & htons((unsigned short)~TR_RCF_BROADCAST_MASK)) &&
416 !(trh->rcf & htons(TR_RCF_BROADCAST_MASK)))
420 DECLARE_MAC_BUF(mac);
421 printk("updating rif_entry: addr:%s rcf:%04X\n",
422 print_mac(mac, trh->saddr), ntohs(trh->rcf));
425 entry->rcf = trh->rcf & htons((unsigned short)~TR_RCF_BROADCAST_MASK);
426 memcpy(&(entry->rseg[0]),&(trh->rseg[0]),8*sizeof(unsigned short));
428 entry->last_used=jiffies;
430 trh->saddr[0]=saddr0; /* put the routing indicator back for tcpdump */
431 spin_unlock_irqrestore(&rif_lock, flags);
435 * Scan the cache with a timer and see what we need to throw out.
438 static void rif_check_expire(unsigned long dummy)
441 unsigned long flags, next_interval = jiffies + sysctl_tr_rif_timeout/2;
443 spin_lock_irqsave(&rif_lock, flags);
445 for(i =0; i < RIF_TABLE_SIZE; i++) {
446 struct rif_cache *entry, **pentry;
448 pentry = rif_table+i;
449 while((entry=*pentry) != NULL) {
450 unsigned long expires
451 = entry->last_used + sysctl_tr_rif_timeout;
453 if (time_before_eq(expires, jiffies)) {
454 *pentry = entry->next;
457 pentry = &entry->next;
459 if (time_before(expires, next_interval))
460 next_interval = expires;
465 spin_unlock_irqrestore(&rif_lock, flags);
467 mod_timer(&rif_timer, next_interval);
472 * Generate the /proc/net information for the token ring RIF
476 #ifdef CONFIG_PROC_FS
478 static struct rif_cache *rif_get_idx(loff_t pos)
481 struct rif_cache *entry;
484 for(i = 0; i < RIF_TABLE_SIZE; i++)
485 for(entry = rif_table[i]; entry; entry = entry->next) {
494 static void *rif_seq_start(struct seq_file *seq, loff_t *pos)
496 spin_lock_irq(&rif_lock);
498 return *pos ? rif_get_idx(*pos - 1) : SEQ_START_TOKEN;
501 static void *rif_seq_next(struct seq_file *seq, void *v, loff_t *pos)
504 struct rif_cache *ent = v;
508 if (v == SEQ_START_TOKEN) {
516 i = rif_hash(ent->addr);
518 while (++i < RIF_TABLE_SIZE) {
519 if ((ent = rif_table[i]) != NULL)
525 static void rif_seq_stop(struct seq_file *seq, void *v)
527 spin_unlock_irq(&rif_lock);
530 static int rif_seq_show(struct seq_file *seq, void *v)
532 int j, rcf_len, segment, brdgnmb;
533 struct rif_cache *entry = v;
534 DECLARE_MAC_BUF(mac);
536 if (v == SEQ_START_TOKEN)
538 "if TR address TTL rcf routing segments\n");
540 struct net_device *dev = dev_get_by_index(&init_net, entry->iface);
541 long ttl = (long) (entry->last_used + sysctl_tr_rif_timeout)
544 seq_printf(seq, "%s %s %7li ",
546 print_mac(mac, entry->addr),
549 if (entry->local_ring)
550 seq_puts(seq, "local\n");
553 seq_printf(seq, "%04X", ntohs(entry->rcf));
554 rcf_len = ((ntohs(entry->rcf) & TR_RCF_LEN_MASK)>>8)-2;
557 for(j = 1; j < rcf_len; j++) {
559 segment=ntohs(entry->rseg[j-1])>>4;
560 seq_printf(seq," %03X",segment);
563 segment=ntohs(entry->rseg[j])>>4;
564 brdgnmb=ntohs(entry->rseg[j-1])&0x00f;
565 seq_printf(seq,"-%01X-%03X",brdgnmb,segment);
574 static const struct seq_operations rif_seq_ops = {
575 .start = rif_seq_start,
576 .next = rif_seq_next,
577 .stop = rif_seq_stop,
578 .show = rif_seq_show,
581 static int rif_seq_open(struct inode *inode, struct file *file)
583 return seq_open(file, &rif_seq_ops);
586 static const struct file_operations rif_seq_fops = {
587 .owner = THIS_MODULE,
588 .open = rif_seq_open,
591 .release = seq_release,
596 static const struct header_ops tr_header_ops = {
598 .rebuild= tr_rebuild_header,
601 static void tr_setup(struct net_device *dev)
604 * Configure and register
607 dev->header_ops = &tr_header_ops;
609 dev->type = ARPHRD_IEEE802_TR;
610 dev->hard_header_len = TR_HLEN;
612 dev->addr_len = TR_ALEN;
613 dev->tx_queue_len = 100; /* Long queues on tr */
615 memset(dev->broadcast,0xFF, TR_ALEN);
617 /* New-style flags. */
618 dev->flags = IFF_BROADCAST | IFF_MULTICAST ;
622 * alloc_trdev - Register token ring device
623 * @sizeof_priv: Size of additional driver-private structure to be allocated
624 * for this token ring device
626 * Fill in the fields of the device structure with token ring-generic values.
628 * Constructs a new net device, complete with a private data area of
629 * size @sizeof_priv. A 32-byte (not bit) alignment is enforced for
630 * this private data area.
632 struct net_device *alloc_trdev(int sizeof_priv)
634 return alloc_netdev(sizeof_priv, "tr%d", tr_setup);
638 * Called during bootup. We don't actually have to initialise
642 static int __init rif_init(void)
644 rif_timer.expires = jiffies + sysctl_tr_rif_timeout;
645 setup_timer(&rif_timer, rif_check_expire, 0);
646 add_timer(&rif_timer);
648 proc_net_fops_create(&init_net, "tr_rif", S_IRUGO, &rif_seq_fops);
652 module_init(rif_init);
654 EXPORT_SYMBOL(tr_type_trans);
655 EXPORT_SYMBOL(alloc_trdev);