This commit was manufactured by cvs2svn to create tag
[linux-2.6.git] / net / 802 / tr.c
1 /*
2  * NET3:        Token ring device handling subroutines
3  * 
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.
8  *
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.
15  *        
16  */
17
18 #include <asm/uaccess.h>
19 #include <asm/system.h>
20 #include <linux/config.h>
21 #include <linux/module.h>
22 #include <linux/types.h>
23 #include <linux/kernel.h>
24 #include <linux/jiffies.h>
25 #include <linux/string.h>
26 #include <linux/mm.h>
27 #include <linux/socket.h>
28 #include <linux/in.h>
29 #include <linux/inet.h>
30 #include <linux/netdevice.h>
31 #include <linux/trdevice.h>
32 #include <linux/skbuff.h>
33 #include <linux/errno.h>
34 #include <linux/timer.h>
35 #include <linux/net.h>
36 #include <linux/proc_fs.h>
37 #include <linux/seq_file.h>
38 #include <linux/init.h>
39 #include <net/arp.h>
40
41 static void tr_add_rif_info(struct trh_hdr *trh, struct net_device *dev);
42 static void rif_check_expire(unsigned long dummy);
43
44 #define TR_SR_DEBUG 0
45
46 /*
47  *      Each RIF entry we learn is kept this way
48  */
49  
50 struct rif_cache_s {    
51         unsigned char addr[TR_ALEN];
52         int iface;
53         __u16 rcf;
54         __u16 rseg[8];
55         struct rif_cache_s *next;
56         unsigned long last_used;
57         unsigned char local_ring;
58 };
59
60 #define RIF_TABLE_SIZE 32
61
62 /*
63  *      We hash the RIF cache 32 ways. We do after all have to look it
64  *      up a lot.
65  */
66  
67 static struct rif_cache_s *rif_table[RIF_TABLE_SIZE];
68
69 static spinlock_t rif_lock = SPIN_LOCK_UNLOCKED;
70
71
72 /*
73  *      Garbage disposal timer.
74  */
75  
76 static struct timer_list rif_timer;
77
78 int sysctl_tr_rif_timeout = 60*10*HZ;
79
80 static inline unsigned long rif_hash(const unsigned char *addr)
81 {
82         unsigned long x;
83
84         x = addr[0];
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];
90
91         x ^= x >> 8;
92
93         return x & (RIF_TABLE_SIZE - 1);
94 }
95
96 /*
97  *      Put the headers on a token ring packet. Token ring source routing
98  *      makes this a little more exciting than on ethernet.
99  */
100  
101 int tr_header(struct sk_buff *skb, struct net_device *dev, unsigned short type,
102               void *daddr, void *saddr, unsigned len) 
103 {
104         struct trh_hdr *trh;
105         int hdr_len;
106
107         /* 
108          * Add the 802.2 SNAP header if IP as the IPv4/IPv6 code calls  
109          * dev->hard_header directly.
110          */
111         if (type == ETH_P_IP || type == ETH_P_IPV6 || type == ETH_P_ARP)
112         {
113                 struct trllc *trllc;
114
115                 hdr_len = sizeof(struct trh_hdr) + sizeof(struct trllc);
116                 trh = (struct trh_hdr *)skb_push(skb, hdr_len);
117                 trllc = (struct trllc *)(trh+1);
118                 trllc->dsap = trllc->ssap = EXTENDED_SAP;
119                 trllc->llc = UI_CMD;
120                 trllc->protid[0] = trllc->protid[1] = trllc->protid[2] = 0x00;
121                 trllc->ethertype = htons(type);
122         }
123         else
124         {
125                 hdr_len = sizeof(struct trh_hdr);
126                 trh = (struct trh_hdr *)skb_push(skb, hdr_len); 
127         }
128
129         trh->ac=AC;
130         trh->fc=LLC_FRAME;
131
132         if(saddr)
133                 memcpy(trh->saddr,saddr,dev->addr_len);
134         else
135                 memcpy(trh->saddr,dev->dev_addr,dev->addr_len);
136
137         /*
138          *      Build the destination and then source route the frame
139          */
140          
141         if(daddr) 
142         {
143                 memcpy(trh->daddr,daddr,dev->addr_len);
144                 tr_source_route(skb,trh,dev);
145                 return(hdr_len);
146         }
147
148         return -hdr_len;
149 }
150         
151 /*
152  *      A neighbour discovery of some species (eg arp) has completed. We
153  *      can now send the packet.
154  */
155  
156 int tr_rebuild_header(struct sk_buff *skb) 
157 {
158         struct trh_hdr *trh=(struct trh_hdr *)skb->data;
159         struct trllc *trllc=(struct trllc *)(skb->data+sizeof(struct trh_hdr));
160         struct net_device *dev = skb->dev;
161
162         /*
163          *      FIXME: We don't yet support IPv6 over token rings
164          */
165          
166         if(trllc->ethertype != htons(ETH_P_IP)) {
167                 printk("tr_rebuild_header: Don't know how to resolve type %04X addresses ?\n",(unsigned int)htons(trllc->ethertype));
168                 return 0;
169         }
170
171 #ifdef CONFIG_INET
172         if(arp_find(trh->daddr, skb)) {
173                         return 1;
174         }
175         else 
176 #endif  
177         {       
178                 tr_source_route(skb,trh,dev); 
179                 return 0;
180         }
181 }
182         
183 /*
184  *      Some of this is a bit hackish. We intercept RIF information
185  *      used for source routing. We also grab IP directly and don't feed
186  *      it via SNAP.
187  */
188  
189 unsigned short tr_type_trans(struct sk_buff *skb, struct net_device *dev) 
190 {
191
192         struct trh_hdr *trh=(struct trh_hdr *)skb->data;
193         struct trllc *trllc;
194         unsigned riflen=0;
195         
196         skb->mac.raw = skb->data;
197         
198         if(trh->saddr[0] & TR_RII)
199                 riflen = (ntohs(trh->rcf) & TR_RCF_LEN_MASK) >> 8;
200
201         trllc = (struct trllc *)(skb->data+sizeof(struct trh_hdr)-TR_MAXRIFLEN+riflen);
202
203         skb_pull(skb,sizeof(struct trh_hdr)-TR_MAXRIFLEN+riflen);
204
205         if(*trh->daddr & 0x80) 
206         {
207                 if(!memcmp(trh->daddr,dev->broadcast,TR_ALEN))  
208                         skb->pkt_type=PACKET_BROADCAST;
209                 else
210                         skb->pkt_type=PACKET_MULTICAST;
211         }
212         else if ( (trh->daddr[0] & 0x01) && (trh->daddr[1] & 0x00) && (trh->daddr[2] & 0x5E))
213         {
214                 skb->pkt_type=PACKET_MULTICAST;
215         }
216         else if(dev->flags & IFF_PROMISC) 
217         {
218                 if(memcmp(trh->daddr, dev->dev_addr, TR_ALEN))
219                         skb->pkt_type=PACKET_OTHERHOST;
220         }
221
222         if ((skb->pkt_type != PACKET_BROADCAST) &&
223             (skb->pkt_type != PACKET_MULTICAST))
224                 tr_add_rif_info(trh,dev) ; 
225
226         /*
227          * Strip the SNAP header from ARP packets since we don't 
228          * pass them through to the 802.2/SNAP layers.
229          */
230
231         if (trllc->dsap == EXTENDED_SAP &&
232             (trllc->ethertype == ntohs(ETH_P_IP) ||
233              trllc->ethertype == ntohs(ETH_P_IPV6) ||
234              trllc->ethertype == ntohs(ETH_P_ARP)))
235         {
236                 skb_pull(skb, sizeof(struct trllc));
237                 return trllc->ethertype;
238         }
239
240         return ntohs(ETH_P_802_2);
241 }
242
243 /*
244  *      We try to do source routing... 
245  */
246
247 void tr_source_route(struct sk_buff *skb,struct trh_hdr *trh,struct net_device *dev) 
248 {
249         int slack;
250         unsigned int hash;
251         struct rif_cache_s *entry;
252         unsigned char *olddata;
253         unsigned long flags;
254         static const unsigned char mcast_func_addr[] 
255                 = {0xC0,0x00,0x00,0x04,0x00,0x00};
256         
257         spin_lock_irqsave(&rif_lock, flags);
258
259         /*
260          *      Broadcasts are single route as stated in RFC 1042 
261          */
262         if( (!memcmp(&(trh->daddr[0]),&(dev->broadcast[0]),TR_ALEN)) ||
263             (!memcmp(&(trh->daddr[0]),&(mcast_func_addr[0]), TR_ALEN))  )
264         {
265                 trh->rcf=htons((((sizeof(trh->rcf)) << 8) & TR_RCF_LEN_MASK)  
266                                | TR_RCF_FRAME2K | TR_RCF_LIMITED_BROADCAST);
267                 trh->saddr[0]|=TR_RII;
268         }
269         else 
270         {
271                 hash = rif_hash(trh->daddr);
272                 /*
273                  *      Walk the hash table and look for an entry
274                  */
275                 for(entry=rif_table[hash];entry && memcmp(&(entry->addr[0]),&(trh->daddr[0]),TR_ALEN);entry=entry->next);
276
277                 /*
278                  *      If we found an entry we can route the frame.
279                  */
280                 if(entry) 
281                 {
282 #if TR_SR_DEBUG
283 printk("source routing for %02X:%02X:%02X:%02X:%02X:%02X\n",trh->daddr[0],
284                   trh->daddr[1],trh->daddr[2],trh->daddr[3],trh->daddr[4],trh->daddr[5]);
285 #endif
286                         if(!entry->local_ring && (ntohs(entry->rcf) & TR_RCF_LEN_MASK) >> 8)
287                         {
288                                 trh->rcf=entry->rcf;
289                                 memcpy(&trh->rseg[0],&entry->rseg[0],8*sizeof(unsigned short));
290                                 trh->rcf^=htons(TR_RCF_DIR_BIT);        
291                                 trh->rcf&=htons(0x1fff);        /* Issam Chehab <ichehab@madge1.demon.co.uk> */
292
293                                 trh->saddr[0]|=TR_RII;
294 #if TR_SR_DEBUG
295                                 printk("entry found with rcf %04x\n", entry->rcf);
296                         }
297                         else
298                         {
299                                 printk("entry found but without rcf length, local=%02x\n", entry->local_ring);
300 #endif
301                         }
302                         entry->last_used=jiffies;
303                 }
304                 else 
305                 {
306                         /*
307                          *      Without the information we simply have to shout
308                          *      on the wire. The replies should rapidly clean this
309                          *      situation up.
310                          */
311                         trh->rcf=htons((((sizeof(trh->rcf)) << 8) & TR_RCF_LEN_MASK)  
312                                        | TR_RCF_FRAME2K | TR_RCF_LIMITED_BROADCAST);
313                         trh->saddr[0]|=TR_RII;
314 #if TR_SR_DEBUG
315                         printk("no entry in rif table found - broadcasting frame\n");
316 #endif
317                 }
318         }
319
320         /* Compress the RIF here so we don't have to do it in the driver(s) */
321         if (!(trh->saddr[0] & 0x80))
322                 slack = 18;
323         else 
324                 slack = 18 - ((ntohs(trh->rcf) & TR_RCF_LEN_MASK)>>8);
325         olddata = skb->data;
326         spin_unlock_irqrestore(&rif_lock, flags);
327
328         skb_pull(skb, slack);
329         memmove(skb->data, olddata, sizeof(struct trh_hdr) - slack);
330 }
331
332 /*
333  *      We have learned some new RIF information for our source
334  *      routing.
335  */
336  
337 static void tr_add_rif_info(struct trh_hdr *trh, struct net_device *dev)
338 {
339         unsigned int hash, rii_p = 0;
340         unsigned long flags;
341         struct rif_cache_s *entry;
342
343
344         spin_lock_irqsave(&rif_lock, flags);
345         
346         /*
347          *      Firstly see if the entry exists
348          */
349
350         if(trh->saddr[0] & TR_RII)
351         {
352                 trh->saddr[0]&=0x7f;
353                 if (((ntohs(trh->rcf) & TR_RCF_LEN_MASK) >> 8) > 2)
354                 {
355                         rii_p = 1;
356                 }
357         }
358
359         hash = rif_hash(trh->saddr);
360         for(entry=rif_table[hash];entry && memcmp(&(entry->addr[0]),&(trh->saddr[0]),TR_ALEN);entry=entry->next);
361
362         if(entry==NULL) 
363         {
364 #if TR_SR_DEBUG
365 printk("adding rif_entry: addr:%02X:%02X:%02X:%02X:%02X:%02X rcf:%04X\n",
366                 trh->saddr[0],trh->saddr[1],trh->saddr[2],
367                 trh->saddr[3],trh->saddr[4],trh->saddr[5],
368                 ntohs(trh->rcf));
369 #endif
370                 /*
371                  *      Allocate our new entry. A failure to allocate loses
372                  *      use the information. This is harmless.
373                  *
374                  *      FIXME: We ought to keep some kind of cache size
375                  *      limiting and adjust the timers to suit.
376                  */
377                 entry=kmalloc(sizeof(struct rif_cache_s),GFP_ATOMIC);
378
379                 if(!entry) 
380                 {
381                         printk(KERN_DEBUG "tr.c: Couldn't malloc rif cache entry !\n");
382                         spin_unlock_irqrestore(&rif_lock, flags);
383                         return;
384                 }
385
386                 memcpy(&(entry->addr[0]),&(trh->saddr[0]),TR_ALEN);
387                 entry->iface = dev->ifindex;
388                 entry->next=rif_table[hash];
389                 entry->last_used=jiffies;
390                 rif_table[hash]=entry;
391
392                 if (rii_p)
393                 {
394                         entry->rcf = trh->rcf & htons((unsigned short)~TR_RCF_BROADCAST_MASK);
395                         memcpy(&(entry->rseg[0]),&(trh->rseg[0]),8*sizeof(unsigned short));
396                         entry->local_ring = 0;
397                         trh->saddr[0]|=TR_RII; /* put the routing indicator back for tcpdump */
398                 }
399                 else
400                 {
401                         entry->local_ring = 1;
402                 }
403         }       
404         else    /* Y. Tahara added */
405         { 
406                 /*
407                  *      Update existing entries
408                  */
409                 if (!entry->local_ring) 
410                     if (entry->rcf != (trh->rcf & htons((unsigned short)~TR_RCF_BROADCAST_MASK)) &&
411                          !(trh->rcf & htons(TR_RCF_BROADCAST_MASK)))
412                     {
413 #if TR_SR_DEBUG
414 printk("updating rif_entry: addr:%02X:%02X:%02X:%02X:%02X:%02X rcf:%04X\n",
415                 trh->saddr[0],trh->saddr[1],trh->saddr[2],
416                 trh->saddr[3],trh->saddr[4],trh->saddr[5],
417                 ntohs(trh->rcf));
418 #endif
419                             entry->rcf = trh->rcf & htons((unsigned short)~TR_RCF_BROADCAST_MASK);
420                             memcpy(&(entry->rseg[0]),&(trh->rseg[0]),8*sizeof(unsigned short));
421                     }                                         
422                 entry->last_used=jiffies;               
423         }
424         spin_unlock_irqrestore(&rif_lock, flags);
425 }
426
427 /*
428  *      Scan the cache with a timer and see what we need to throw out.
429  */
430
431 static void rif_check_expire(unsigned long dummy) 
432 {
433         int i;
434         unsigned long flags, next_interval = jiffies + sysctl_tr_rif_timeout/2;
435
436         spin_lock_irqsave(&rif_lock, flags);
437         
438         for(i =0; i < RIF_TABLE_SIZE; i++) {
439                 struct rif_cache_s *entry, **pentry;
440                 
441                 pentry = rif_table+i;
442                 while((entry=*pentry) != NULL) {
443                         unsigned long expires
444                                 = entry->last_used + sysctl_tr_rif_timeout;
445
446                         if (time_before_eq(expires, jiffies)) {
447                                 *pentry = entry->next;
448                                 kfree(entry);
449                         } else {
450                                 pentry = &entry->next;
451
452                                 if (time_before(expires, next_interval))
453                                         next_interval = expires;
454                         }
455                 }
456         }
457         
458         spin_unlock_irqrestore(&rif_lock, flags);
459
460         mod_timer(&rif_timer, next_interval);
461
462 }
463
464 /*
465  *      Generate the /proc/net information for the token ring RIF
466  *      routing.
467  */
468  
469 #ifdef CONFIG_PROC_FS
470
471 static struct rif_cache_s *rif_get_idx(loff_t pos)
472 {
473         int i;
474         struct rif_cache_s *entry;
475         loff_t off = 0;
476
477         for(i = 0; i < RIF_TABLE_SIZE; i++) 
478                 for(entry = rif_table[i]; entry; entry = entry->next) {
479                         if (off == pos)
480                                 return entry;
481                         ++off;
482                 }
483
484         return NULL;
485 }
486
487 static void *rif_seq_start(struct seq_file *seq, loff_t *pos)
488 {
489         spin_lock_irq(&rif_lock);
490
491         return *pos ? rif_get_idx(*pos - 1) : SEQ_START_TOKEN;
492 }
493
494 static void *rif_seq_next(struct seq_file *seq, void *v, loff_t *pos)
495 {
496         int i;
497         struct rif_cache_s *ent = v;
498
499         ++*pos;
500
501         if (v == SEQ_START_TOKEN) {
502                 i = -1;
503                 goto scan;
504         }
505
506         if (ent->next) 
507                 return ent->next;
508
509         i = rif_hash(ent->addr);
510  scan:
511         while (++i < RIF_TABLE_SIZE) {
512                 if ((ent = rif_table[i]) != NULL)
513                         return ent;
514         }
515         return NULL;
516 }
517
518 static void rif_seq_stop(struct seq_file *seq, void *v)
519 {
520         spin_unlock_irq(&rif_lock);
521 }
522
523 static int rif_seq_show(struct seq_file *seq, void *v)
524 {
525         int j, rcf_len, segment, brdgnmb;
526         struct rif_cache_s *entry = v;
527
528         if (v == SEQ_START_TOKEN)
529                 seq_puts(seq,
530                      "if     TR address       TTL   rcf   routing segments\n");
531         else {
532                 struct net_device *dev = dev_get_by_index(entry->iface);
533                 long ttl = (long) (entry->last_used + sysctl_tr_rif_timeout)
534                                 - (long) jiffies;
535
536                 seq_printf(seq, "%s %02X:%02X:%02X:%02X:%02X:%02X %7li ",
537                            dev?dev->name:"?",
538                            entry->addr[0],entry->addr[1],entry->addr[2],
539                            entry->addr[3],entry->addr[4],entry->addr[5],
540                            ttl/HZ);
541
542                         if (entry->local_ring)
543                                 seq_puts(seq, "local\n");
544                         else {
545
546                                 seq_printf(seq, "%04X", ntohs(entry->rcf));
547                                 rcf_len = ((ntohs(entry->rcf) & TR_RCF_LEN_MASK)>>8)-2; 
548                                 if (rcf_len)
549                                         rcf_len >>= 1;
550                                 for(j = 1; j < rcf_len; j++) {
551                                         if(j==1) {
552                                                 segment=ntohs(entry->rseg[j-1])>>4;
553                                                 seq_printf(seq,"  %03X",segment);
554                                         };
555                                         segment=ntohs(entry->rseg[j])>>4;
556                                         brdgnmb=ntohs(entry->rseg[j-1])&0x00f;
557                                         seq_printf(seq,"-%01X-%03X",brdgnmb,segment);
558                                 }
559                                 seq_putc(seq, '\n');
560                         }
561                 }
562         return 0;
563 }
564
565
566 static struct seq_operations rif_seq_ops = {
567         .start = rif_seq_start,
568         .next  = rif_seq_next,
569         .stop  = rif_seq_stop,
570         .show  = rif_seq_show,
571 };
572
573 static int rif_seq_open(struct inode *inode, struct file *file)
574 {
575         return seq_open(file, &rif_seq_ops);
576 }
577
578 static struct file_operations rif_seq_fops = {
579         .owner   = THIS_MODULE,
580         .open    = rif_seq_open,
581         .read    = seq_read,
582         .llseek  = seq_lseek,
583         .release = seq_release,
584 };
585
586 #endif
587
588 /*
589  *      Called during bootup.  We don't actually have to initialise
590  *      too much for this.
591  */
592
593 static int __init rif_init(void)
594 {
595         init_timer(&rif_timer);
596         rif_timer.expires  = sysctl_tr_rif_timeout;
597         rif_timer.data     = 0L;
598         rif_timer.function = rif_check_expire;
599         add_timer(&rif_timer);
600
601         proc_net_fops_create("tr_rif", S_IRUGO, &rif_seq_fops);
602         return 0;
603 }
604
605 module_init(rif_init);
606
607 EXPORT_SYMBOL(tr_source_route);
608 EXPORT_SYMBOL(tr_type_trans);