[INET]: Consolidate the xxx_put
[safe/jmp/linux-2.6] / net / ipv4 / ip_fragment.c
1 /*
2  * INET         An implementation of the TCP/IP protocol suite for the LINUX
3  *              operating system.  INET is implemented using the  BSD Socket
4  *              interface as the means of communication with the user level.
5  *
6  *              The IP fragmentation functionality.
7  *
8  * Version:     $Id: ip_fragment.c,v 1.59 2002/01/12 07:54:56 davem Exp $
9  *
10  * Authors:     Fred N. van Kempen <waltje@uWalt.NL.Mugnet.ORG>
11  *              Alan Cox <Alan.Cox@linux.org>
12  *
13  * Fixes:
14  *              Alan Cox        :       Split from ip.c , see ip_input.c for history.
15  *              David S. Miller :       Begin massive cleanup...
16  *              Andi Kleen      :       Add sysctls.
17  *              xxxx            :       Overlapfrag bug.
18  *              Ultima          :       ip_expire() kernel panic.
19  *              Bill Hawes      :       Frag accounting and evictor fixes.
20  *              John McDonald   :       0 length frag bug.
21  *              Alexey Kuznetsov:       SMP races, threading, cleanup.
22  *              Patrick McHardy :       LRU queue of frag heads for evictor.
23  */
24
25 #include <linux/compiler.h>
26 #include <linux/module.h>
27 #include <linux/types.h>
28 #include <linux/mm.h>
29 #include <linux/jiffies.h>
30 #include <linux/skbuff.h>
31 #include <linux/list.h>
32 #include <linux/ip.h>
33 #include <linux/icmp.h>
34 #include <linux/netdevice.h>
35 #include <linux/jhash.h>
36 #include <linux/random.h>
37 #include <net/sock.h>
38 #include <net/ip.h>
39 #include <net/icmp.h>
40 #include <net/checksum.h>
41 #include <net/inetpeer.h>
42 #include <net/inet_frag.h>
43 #include <linux/tcp.h>
44 #include <linux/udp.h>
45 #include <linux/inet.h>
46 #include <linux/netfilter_ipv4.h>
47
48 /* NOTE. Logic of IP defragmentation is parallel to corresponding IPv6
49  * code now. If you change something here, _PLEASE_ update ipv6/reassembly.c
50  * as well. Or notify me, at least. --ANK
51  */
52
53 int sysctl_ipfrag_max_dist __read_mostly = 64;
54
55 struct ipfrag_skb_cb
56 {
57         struct inet_skb_parm    h;
58         int                     offset;
59 };
60
61 #define FRAG_CB(skb)    ((struct ipfrag_skb_cb*)((skb)->cb))
62
63 /* Describe an entry in the "incomplete datagrams" queue. */
64 struct ipq {
65         struct inet_frag_queue q;
66
67         u32             user;
68         __be32          saddr;
69         __be32          daddr;
70         __be16          id;
71         u8              protocol;
72         int             iif;
73         unsigned int    rid;
74         struct inet_peer *peer;
75 };
76
77 struct inet_frags_ctl ip4_frags_ctl __read_mostly = {
78         /*
79          * Fragment cache limits. We will commit 256K at one time. Should we
80          * cross that limit we will prune down to 192K. This should cope with
81          * even the most extreme cases without allowing an attacker to
82          * measurably harm machine performance.
83          */
84         .high_thresh     = 256 * 1024,
85         .low_thresh      = 192 * 1024,
86
87         /*
88          * Important NOTE! Fragment queue must be destroyed before MSL expires.
89          * RFC791 is wrong proposing to prolongate timer each fragment arrival
90          * by TTL.
91          */
92         .timeout         = IP_FRAG_TIME,
93         .secret_interval = 10 * 60 * HZ,
94 };
95
96 static struct inet_frags ip4_frags;
97
98 int ip_frag_nqueues(void)
99 {
100         return ip4_frags.nqueues;
101 }
102
103 int ip_frag_mem(void)
104 {
105         return atomic_read(&ip4_frags.mem);
106 }
107
108 static int ip_frag_reasm(struct ipq *qp, struct sk_buff *prev,
109                          struct net_device *dev);
110
111 static unsigned int ipqhashfn(__be16 id, __be32 saddr, __be32 daddr, u8 prot)
112 {
113         return jhash_3words((__force u32)id << 16 | prot,
114                             (__force u32)saddr, (__force u32)daddr,
115                             ip4_frags.rnd) & (INETFRAGS_HASHSZ - 1);
116 }
117
118 static unsigned int ip4_hashfn(struct inet_frag_queue *q)
119 {
120         struct ipq *ipq;
121
122         ipq = container_of(q, struct ipq, q);
123         return ipqhashfn(ipq->id, ipq->saddr, ipq->daddr, ipq->protocol);
124 }
125
126 /* Memory Tracking Functions. */
127 static __inline__ void frag_kfree_skb(struct sk_buff *skb, int *work)
128 {
129         if (work)
130                 *work -= skb->truesize;
131         atomic_sub(skb->truesize, &ip4_frags.mem);
132         kfree_skb(skb);
133 }
134
135 static __inline__ void ip4_frag_free(struct inet_frag_queue *q)
136 {
137         struct ipq *qp;
138
139         qp = container_of(q, struct ipq, q);
140         if (qp->peer)
141                 inet_putpeer(qp->peer);
142         kfree(qp);
143 }
144
145 static __inline__ struct ipq *frag_alloc_queue(void)
146 {
147         struct ipq *qp = kmalloc(sizeof(struct ipq), GFP_ATOMIC);
148
149         if (!qp)
150                 return NULL;
151         atomic_add(sizeof(struct ipq), &ip4_frags.mem);
152         return qp;
153 }
154
155
156 /* Destruction primitives. */
157
158 static __inline__ void ipq_put(struct ipq *ipq)
159 {
160         inet_frag_put(&ipq->q, &ip4_frags);
161 }
162
163 /* Kill ipq entry. It is not destroyed immediately,
164  * because caller (and someone more) holds reference count.
165  */
166 static void ipq_kill(struct ipq *ipq)
167 {
168         inet_frag_kill(&ipq->q, &ip4_frags);
169 }
170
171 /* Memory limiting on fragments.  Evictor trashes the oldest
172  * fragment queue until we are back under the threshold.
173  */
174 static void ip_evictor(void)
175 {
176         int evicted;
177
178         evicted = inet_frag_evictor(&ip4_frags);
179         if (evicted)
180                 IP_ADD_STATS_BH(IPSTATS_MIB_REASMFAILS, evicted);
181 }
182
183 /*
184  * Oops, a fragment queue timed out.  Kill it and send an ICMP reply.
185  */
186 static void ip_expire(unsigned long arg)
187 {
188         struct ipq *qp = (struct ipq *) arg;
189
190         spin_lock(&qp->q.lock);
191
192         if (qp->q.last_in & COMPLETE)
193                 goto out;
194
195         ipq_kill(qp);
196
197         IP_INC_STATS_BH(IPSTATS_MIB_REASMTIMEOUT);
198         IP_INC_STATS_BH(IPSTATS_MIB_REASMFAILS);
199
200         if ((qp->q.last_in&FIRST_IN) && qp->q.fragments != NULL) {
201                 struct sk_buff *head = qp->q.fragments;
202                 /* Send an ICMP "Fragment Reassembly Timeout" message. */
203                 if ((head->dev = dev_get_by_index(&init_net, qp->iif)) != NULL) {
204                         icmp_send(head, ICMP_TIME_EXCEEDED, ICMP_EXC_FRAGTIME, 0);
205                         dev_put(head->dev);
206                 }
207         }
208 out:
209         spin_unlock(&qp->q.lock);
210         ipq_put(qp);
211 }
212
213 /* Creation primitives. */
214
215 static struct ipq *ip_frag_intern(struct ipq *qp_in)
216 {
217         struct ipq *qp;
218 #ifdef CONFIG_SMP
219         struct hlist_node *n;
220 #endif
221         unsigned int hash;
222
223         write_lock(&ip4_frags.lock);
224         hash = ipqhashfn(qp_in->id, qp_in->saddr, qp_in->daddr,
225                          qp_in->protocol);
226 #ifdef CONFIG_SMP
227         /* With SMP race we have to recheck hash table, because
228          * such entry could be created on other cpu, while we
229          * promoted read lock to write lock.
230          */
231         hlist_for_each_entry(qp, n, &ip4_frags.hash[hash], q.list) {
232                 if (qp->id == qp_in->id         &&
233                     qp->saddr == qp_in->saddr   &&
234                     qp->daddr == qp_in->daddr   &&
235                     qp->protocol == qp_in->protocol &&
236                     qp->user == qp_in->user) {
237                         atomic_inc(&qp->q.refcnt);
238                         write_unlock(&ip4_frags.lock);
239                         qp_in->q.last_in |= COMPLETE;
240                         ipq_put(qp_in);
241                         return qp;
242                 }
243         }
244 #endif
245         qp = qp_in;
246
247         if (!mod_timer(&qp->q.timer, jiffies + ip4_frags_ctl.timeout))
248                 atomic_inc(&qp->q.refcnt);
249
250         atomic_inc(&qp->q.refcnt);
251         hlist_add_head(&qp->q.list, &ip4_frags.hash[hash]);
252         INIT_LIST_HEAD(&qp->q.lru_list);
253         list_add_tail(&qp->q.lru_list, &ip4_frags.lru_list);
254         ip4_frags.nqueues++;
255         write_unlock(&ip4_frags.lock);
256         return qp;
257 }
258
259 /* Add an entry to the 'ipq' queue for a newly received IP datagram. */
260 static struct ipq *ip_frag_create(struct iphdr *iph, u32 user)
261 {
262         struct ipq *qp;
263
264         if ((qp = frag_alloc_queue()) == NULL)
265                 goto out_nomem;
266
267         qp->protocol = iph->protocol;
268         qp->q.last_in = 0;
269         qp->id = iph->id;
270         qp->saddr = iph->saddr;
271         qp->daddr = iph->daddr;
272         qp->user = user;
273         qp->q.len = 0;
274         qp->q.meat = 0;
275         qp->q.fragments = NULL;
276         qp->iif = 0;
277         qp->peer = sysctl_ipfrag_max_dist ? inet_getpeer(iph->saddr, 1) : NULL;
278
279         /* Initialize a timer for this entry. */
280         init_timer(&qp->q.timer);
281         qp->q.timer.data = (unsigned long) qp;  /* pointer to queue     */
282         qp->q.timer.function = ip_expire;               /* expire function      */
283         spin_lock_init(&qp->q.lock);
284         atomic_set(&qp->q.refcnt, 1);
285
286         return ip_frag_intern(qp);
287
288 out_nomem:
289         LIMIT_NETDEBUG(KERN_ERR "ip_frag_create: no memory left !\n");
290         return NULL;
291 }
292
293 /* Find the correct entry in the "incomplete datagrams" queue for
294  * this IP datagram, and create new one, if nothing is found.
295  */
296 static inline struct ipq *ip_find(struct iphdr *iph, u32 user)
297 {
298         __be16 id = iph->id;
299         __be32 saddr = iph->saddr;
300         __be32 daddr = iph->daddr;
301         __u8 protocol = iph->protocol;
302         unsigned int hash;
303         struct ipq *qp;
304         struct hlist_node *n;
305
306         read_lock(&ip4_frags.lock);
307         hash = ipqhashfn(id, saddr, daddr, protocol);
308         hlist_for_each_entry(qp, n, &ip4_frags.hash[hash], q.list) {
309                 if (qp->id == id                &&
310                     qp->saddr == saddr  &&
311                     qp->daddr == daddr  &&
312                     qp->protocol == protocol &&
313                     qp->user == user) {
314                         atomic_inc(&qp->q.refcnt);
315                         read_unlock(&ip4_frags.lock);
316                         return qp;
317                 }
318         }
319         read_unlock(&ip4_frags.lock);
320
321         return ip_frag_create(iph, user);
322 }
323
324 /* Is the fragment too far ahead to be part of ipq? */
325 static inline int ip_frag_too_far(struct ipq *qp)
326 {
327         struct inet_peer *peer = qp->peer;
328         unsigned int max = sysctl_ipfrag_max_dist;
329         unsigned int start, end;
330
331         int rc;
332
333         if (!peer || !max)
334                 return 0;
335
336         start = qp->rid;
337         end = atomic_inc_return(&peer->rid);
338         qp->rid = end;
339
340         rc = qp->q.fragments && (end - start) > max;
341
342         if (rc) {
343                 IP_INC_STATS_BH(IPSTATS_MIB_REASMFAILS);
344         }
345
346         return rc;
347 }
348
349 static int ip_frag_reinit(struct ipq *qp)
350 {
351         struct sk_buff *fp;
352
353         if (!mod_timer(&qp->q.timer, jiffies + ip4_frags_ctl.timeout)) {
354                 atomic_inc(&qp->q.refcnt);
355                 return -ETIMEDOUT;
356         }
357
358         fp = qp->q.fragments;
359         do {
360                 struct sk_buff *xp = fp->next;
361                 frag_kfree_skb(fp, NULL);
362                 fp = xp;
363         } while (fp);
364
365         qp->q.last_in = 0;
366         qp->q.len = 0;
367         qp->q.meat = 0;
368         qp->q.fragments = NULL;
369         qp->iif = 0;
370
371         return 0;
372 }
373
374 /* Add new segment to existing queue. */
375 static int ip_frag_queue(struct ipq *qp, struct sk_buff *skb)
376 {
377         struct sk_buff *prev, *next;
378         struct net_device *dev;
379         int flags, offset;
380         int ihl, end;
381         int err = -ENOENT;
382
383         if (qp->q.last_in & COMPLETE)
384                 goto err;
385
386         if (!(IPCB(skb)->flags & IPSKB_FRAG_COMPLETE) &&
387             unlikely(ip_frag_too_far(qp)) &&
388             unlikely(err = ip_frag_reinit(qp))) {
389                 ipq_kill(qp);
390                 goto err;
391         }
392
393         offset = ntohs(ip_hdr(skb)->frag_off);
394         flags = offset & ~IP_OFFSET;
395         offset &= IP_OFFSET;
396         offset <<= 3;           /* offset is in 8-byte chunks */
397         ihl = ip_hdrlen(skb);
398
399         /* Determine the position of this fragment. */
400         end = offset + skb->len - ihl;
401         err = -EINVAL;
402
403         /* Is this the final fragment? */
404         if ((flags & IP_MF) == 0) {
405                 /* If we already have some bits beyond end
406                  * or have different end, the segment is corrrupted.
407                  */
408                 if (end < qp->q.len ||
409                     ((qp->q.last_in & LAST_IN) && end != qp->q.len))
410                         goto err;
411                 qp->q.last_in |= LAST_IN;
412                 qp->q.len = end;
413         } else {
414                 if (end&7) {
415                         end &= ~7;
416                         if (skb->ip_summed != CHECKSUM_UNNECESSARY)
417                                 skb->ip_summed = CHECKSUM_NONE;
418                 }
419                 if (end > qp->q.len) {
420                         /* Some bits beyond end -> corruption. */
421                         if (qp->q.last_in & LAST_IN)
422                                 goto err;
423                         qp->q.len = end;
424                 }
425         }
426         if (end == offset)
427                 goto err;
428
429         err = -ENOMEM;
430         if (pskb_pull(skb, ihl) == NULL)
431                 goto err;
432
433         err = pskb_trim_rcsum(skb, end - offset);
434         if (err)
435                 goto err;
436
437         /* Find out which fragments are in front and at the back of us
438          * in the chain of fragments so far.  We must know where to put
439          * this fragment, right?
440          */
441         prev = NULL;
442         for (next = qp->q.fragments; next != NULL; next = next->next) {
443                 if (FRAG_CB(next)->offset >= offset)
444                         break;  /* bingo! */
445                 prev = next;
446         }
447
448         /* We found where to put this one.  Check for overlap with
449          * preceding fragment, and, if needed, align things so that
450          * any overlaps are eliminated.
451          */
452         if (prev) {
453                 int i = (FRAG_CB(prev)->offset + prev->len) - offset;
454
455                 if (i > 0) {
456                         offset += i;
457                         err = -EINVAL;
458                         if (end <= offset)
459                                 goto err;
460                         err = -ENOMEM;
461                         if (!pskb_pull(skb, i))
462                                 goto err;
463                         if (skb->ip_summed != CHECKSUM_UNNECESSARY)
464                                 skb->ip_summed = CHECKSUM_NONE;
465                 }
466         }
467
468         err = -ENOMEM;
469
470         while (next && FRAG_CB(next)->offset < end) {
471                 int i = end - FRAG_CB(next)->offset; /* overlap is 'i' bytes */
472
473                 if (i < next->len) {
474                         /* Eat head of the next overlapped fragment
475                          * and leave the loop. The next ones cannot overlap.
476                          */
477                         if (!pskb_pull(next, i))
478                                 goto err;
479                         FRAG_CB(next)->offset += i;
480                         qp->q.meat -= i;
481                         if (next->ip_summed != CHECKSUM_UNNECESSARY)
482                                 next->ip_summed = CHECKSUM_NONE;
483                         break;
484                 } else {
485                         struct sk_buff *free_it = next;
486
487                         /* Old fragment is completely overridden with
488                          * new one drop it.
489                          */
490                         next = next->next;
491
492                         if (prev)
493                                 prev->next = next;
494                         else
495                                 qp->q.fragments = next;
496
497                         qp->q.meat -= free_it->len;
498                         frag_kfree_skb(free_it, NULL);
499                 }
500         }
501
502         FRAG_CB(skb)->offset = offset;
503
504         /* Insert this fragment in the chain of fragments. */
505         skb->next = next;
506         if (prev)
507                 prev->next = skb;
508         else
509                 qp->q.fragments = skb;
510
511         dev = skb->dev;
512         if (dev) {
513                 qp->iif = dev->ifindex;
514                 skb->dev = NULL;
515         }
516         qp->q.stamp = skb->tstamp;
517         qp->q.meat += skb->len;
518         atomic_add(skb->truesize, &ip4_frags.mem);
519         if (offset == 0)
520                 qp->q.last_in |= FIRST_IN;
521
522         if (qp->q.last_in == (FIRST_IN | LAST_IN) && qp->q.meat == qp->q.len)
523                 return ip_frag_reasm(qp, prev, dev);
524
525         write_lock(&ip4_frags.lock);
526         list_move_tail(&qp->q.lru_list, &ip4_frags.lru_list);
527         write_unlock(&ip4_frags.lock);
528         return -EINPROGRESS;
529
530 err:
531         kfree_skb(skb);
532         return err;
533 }
534
535
536 /* Build a new IP datagram from all its fragments. */
537
538 static int ip_frag_reasm(struct ipq *qp, struct sk_buff *prev,
539                          struct net_device *dev)
540 {
541         struct iphdr *iph;
542         struct sk_buff *fp, *head = qp->q.fragments;
543         int len;
544         int ihlen;
545         int err;
546
547         ipq_kill(qp);
548
549         /* Make the one we just received the head. */
550         if (prev) {
551                 head = prev->next;
552                 fp = skb_clone(head, GFP_ATOMIC);
553
554                 if (!fp)
555                         goto out_nomem;
556
557                 fp->next = head->next;
558                 prev->next = fp;
559
560                 skb_morph(head, qp->q.fragments);
561                 head->next = qp->q.fragments->next;
562
563                 kfree_skb(qp->q.fragments);
564                 qp->q.fragments = head;
565         }
566
567         BUG_TRAP(head != NULL);
568         BUG_TRAP(FRAG_CB(head)->offset == 0);
569
570         /* Allocate a new buffer for the datagram. */
571         ihlen = ip_hdrlen(head);
572         len = ihlen + qp->q.len;
573
574         err = -E2BIG;
575         if (len > 65535)
576                 goto out_oversize;
577
578         /* Head of list must not be cloned. */
579         err = -ENOMEM;
580         if (skb_cloned(head) && pskb_expand_head(head, 0, 0, GFP_ATOMIC))
581                 goto out_nomem;
582
583         /* If the first fragment is fragmented itself, we split
584          * it to two chunks: the first with data and paged part
585          * and the second, holding only fragments. */
586         if (skb_shinfo(head)->frag_list) {
587                 struct sk_buff *clone;
588                 int i, plen = 0;
589
590                 if ((clone = alloc_skb(0, GFP_ATOMIC)) == NULL)
591                         goto out_nomem;
592                 clone->next = head->next;
593                 head->next = clone;
594                 skb_shinfo(clone)->frag_list = skb_shinfo(head)->frag_list;
595                 skb_shinfo(head)->frag_list = NULL;
596                 for (i=0; i<skb_shinfo(head)->nr_frags; i++)
597                         plen += skb_shinfo(head)->frags[i].size;
598                 clone->len = clone->data_len = head->data_len - plen;
599                 head->data_len -= clone->len;
600                 head->len -= clone->len;
601                 clone->csum = 0;
602                 clone->ip_summed = head->ip_summed;
603                 atomic_add(clone->truesize, &ip4_frags.mem);
604         }
605
606         skb_shinfo(head)->frag_list = head->next;
607         skb_push(head, head->data - skb_network_header(head));
608         atomic_sub(head->truesize, &ip4_frags.mem);
609
610         for (fp=head->next; fp; fp = fp->next) {
611                 head->data_len += fp->len;
612                 head->len += fp->len;
613                 if (head->ip_summed != fp->ip_summed)
614                         head->ip_summed = CHECKSUM_NONE;
615                 else if (head->ip_summed == CHECKSUM_COMPLETE)
616                         head->csum = csum_add(head->csum, fp->csum);
617                 head->truesize += fp->truesize;
618                 atomic_sub(fp->truesize, &ip4_frags.mem);
619         }
620
621         head->next = NULL;
622         head->dev = dev;
623         head->tstamp = qp->q.stamp;
624
625         iph = ip_hdr(head);
626         iph->frag_off = 0;
627         iph->tot_len = htons(len);
628         IP_INC_STATS_BH(IPSTATS_MIB_REASMOKS);
629         qp->q.fragments = NULL;
630         return 0;
631
632 out_nomem:
633         LIMIT_NETDEBUG(KERN_ERR "IP: queue_glue: no memory for gluing "
634                               "queue %p\n", qp);
635         goto out_fail;
636 out_oversize:
637         if (net_ratelimit())
638                 printk(KERN_INFO
639                         "Oversized IP packet from %d.%d.%d.%d.\n",
640                         NIPQUAD(qp->saddr));
641 out_fail:
642         IP_INC_STATS_BH(IPSTATS_MIB_REASMFAILS);
643         return err;
644 }
645
646 /* Process an incoming IP datagram fragment. */
647 int ip_defrag(struct sk_buff *skb, u32 user)
648 {
649         struct ipq *qp;
650
651         IP_INC_STATS_BH(IPSTATS_MIB_REASMREQDS);
652
653         /* Start by cleaning up the memory. */
654         if (atomic_read(&ip4_frags.mem) > ip4_frags_ctl.high_thresh)
655                 ip_evictor();
656
657         /* Lookup (or create) queue header */
658         if ((qp = ip_find(ip_hdr(skb), user)) != NULL) {
659                 int ret;
660
661                 spin_lock(&qp->q.lock);
662
663                 ret = ip_frag_queue(qp, skb);
664
665                 spin_unlock(&qp->q.lock);
666                 ipq_put(qp);
667                 return ret;
668         }
669
670         IP_INC_STATS_BH(IPSTATS_MIB_REASMFAILS);
671         kfree_skb(skb);
672         return -ENOMEM;
673 }
674
675 void __init ipfrag_init(void)
676 {
677         ip4_frags.ctl = &ip4_frags_ctl;
678         ip4_frags.hashfn = ip4_hashfn;
679         ip4_frags.destructor = ip4_frag_free;
680         ip4_frags.skb_free = NULL;
681         ip4_frags.qsize = sizeof(struct ipq);
682         inet_frags_init(&ip4_frags);
683 }
684
685 EXPORT_SYMBOL(ip_defrag);