2 * ip6_flowlabel.c IPv6 flowlabel manager.
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 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
12 #include <linux/capability.h>
13 #include <linux/errno.h>
14 #include <linux/types.h>
15 #include <linux/socket.h>
16 #include <linux/net.h>
17 #include <linux/netdevice.h>
18 #include <linux/in6.h>
19 #include <linux/proc_fs.h>
20 #include <linux/seq_file.h>
21 #include <linux/slab.h>
22 #include <linux/export.h>
23 #include <linux/pid_namespace.h>
25 #include <net/net_namespace.h>
29 #include <net/rawv6.h>
30 #include <net/transp_v6.h>
32 #include <asm/uaccess.h>
34 #define FL_MIN_LINGER 6 /* Minimal linger. It is set to 6sec specified
35 in old IPv6 RFC. Well, it was reasonable value.
37 #define FL_MAX_LINGER 150 /* Maximal linger timeout */
41 #define FL_MAX_PER_SOCK 32
42 #define FL_MAX_SIZE 4096
43 #define FL_HASH_MASK 255
44 #define FL_HASH(l) (ntohl(l)&FL_HASH_MASK)
46 static atomic_t fl_size = ATOMIC_INIT(0);
47 static struct ip6_flowlabel __rcu *fl_ht[FL_HASH_MASK+1];
49 static void ip6_fl_gc(unsigned long dummy);
50 static DEFINE_TIMER(ip6_fl_gc_timer, ip6_fl_gc, 0, 0);
52 /* FL hash table lock: it protects only of GC */
54 static DEFINE_SPINLOCK(ip6_fl_lock);
58 static DEFINE_SPINLOCK(ip6_sk_fl_lock);
60 #define for_each_fl_rcu(hash, fl) \
61 for (fl = rcu_dereference_bh(fl_ht[(hash)]); \
63 fl = rcu_dereference_bh(fl->next))
64 #define for_each_fl_continue_rcu(fl) \
65 for (fl = rcu_dereference_bh(fl->next); \
67 fl = rcu_dereference_bh(fl->next))
69 #define for_each_sk_fl_rcu(np, sfl) \
70 for (sfl = rcu_dereference_bh(np->ipv6_fl_list); \
72 sfl = rcu_dereference_bh(sfl->next))
74 static inline struct ip6_flowlabel *__fl_lookup(struct net *net, __be32 label)
76 struct ip6_flowlabel *fl;
78 for_each_fl_rcu(FL_HASH(label), fl) {
79 if (fl->label == label && net_eq(fl->fl_net, net))
85 static struct ip6_flowlabel *fl_lookup(struct net *net, __be32 label)
87 struct ip6_flowlabel *fl;
90 fl = __fl_lookup(net, label);
91 if (fl && !atomic_inc_not_zero(&fl->users))
98 static void fl_free(struct ip6_flowlabel *fl)
101 if (fl->share == IPV6_FL_S_PROCESS)
102 put_pid(fl->owner.pid);
108 static void fl_release(struct ip6_flowlabel *fl)
110 spin_lock_bh(&ip6_fl_lock);
112 fl->lastuse = jiffies;
113 if (atomic_dec_and_test(&fl->users)) {
114 unsigned long ttd = fl->lastuse + fl->linger;
115 if (time_after(ttd, fl->expires))
118 if (fl->opt && fl->share == IPV6_FL_S_EXCL) {
119 struct ipv6_txoptions *opt = fl->opt;
123 if (!timer_pending(&ip6_fl_gc_timer) ||
124 time_after(ip6_fl_gc_timer.expires, ttd))
125 mod_timer(&ip6_fl_gc_timer, ttd);
127 spin_unlock_bh(&ip6_fl_lock);
130 static void ip6_fl_gc(unsigned long dummy)
133 unsigned long now = jiffies;
134 unsigned long sched = 0;
136 spin_lock(&ip6_fl_lock);
138 for (i = 0; i <= FL_HASH_MASK; i++) {
139 struct ip6_flowlabel *fl;
140 struct ip6_flowlabel __rcu **flp;
143 while ((fl = rcu_dereference_protected(*flp,
144 lockdep_is_held(&ip6_fl_lock))) != NULL) {
145 if (atomic_read(&fl->users) == 0) {
146 unsigned long ttd = fl->lastuse + fl->linger;
147 if (time_after(ttd, fl->expires))
150 if (time_after_eq(now, ttd)) {
153 atomic_dec(&fl_size);
156 if (!sched || time_before(ttd, sched))
162 if (!sched && atomic_read(&fl_size))
163 sched = now + FL_MAX_LINGER;
165 mod_timer(&ip6_fl_gc_timer, sched);
167 spin_unlock(&ip6_fl_lock);
170 static void __net_exit ip6_fl_purge(struct net *net)
174 spin_lock_bh(&ip6_fl_lock);
175 for (i = 0; i <= FL_HASH_MASK; i++) {
176 struct ip6_flowlabel *fl;
177 struct ip6_flowlabel __rcu **flp;
180 while ((fl = rcu_dereference_protected(*flp,
181 lockdep_is_held(&ip6_fl_lock))) != NULL) {
182 if (net_eq(fl->fl_net, net) &&
183 atomic_read(&fl->users) == 0) {
186 atomic_dec(&fl_size);
192 spin_unlock_bh(&ip6_fl_lock);
195 static struct ip6_flowlabel *fl_intern(struct net *net,
196 struct ip6_flowlabel *fl, __be32 label)
198 struct ip6_flowlabel *lfl;
200 fl->label = label & IPV6_FLOWLABEL_MASK;
202 spin_lock_bh(&ip6_fl_lock);
205 fl->label = htonl(prandom_u32())&IPV6_FLOWLABEL_MASK;
207 lfl = __fl_lookup(net, fl->label);
214 * we dropper the ip6_fl_lock, so this entry could reappear
215 * and we need to recheck with it.
217 * OTOH no need to search the active socket first, like it is
218 * done in ipv6_flowlabel_opt - sock is locked, so new entry
219 * with the same label can only appear on another sock
221 lfl = __fl_lookup(net, fl->label);
223 atomic_inc(&lfl->users);
224 spin_unlock_bh(&ip6_fl_lock);
229 fl->lastuse = jiffies;
230 fl->next = fl_ht[FL_HASH(fl->label)];
231 rcu_assign_pointer(fl_ht[FL_HASH(fl->label)], fl);
232 atomic_inc(&fl_size);
233 spin_unlock_bh(&ip6_fl_lock);
239 /* Socket flowlabel lists */
241 struct ip6_flowlabel *fl6_sock_lookup(struct sock *sk, __be32 label)
243 struct ipv6_fl_socklist *sfl;
244 struct ipv6_pinfo *np = inet6_sk(sk);
246 label &= IPV6_FLOWLABEL_MASK;
249 for_each_sk_fl_rcu(np, sfl) {
250 struct ip6_flowlabel *fl = sfl->fl;
251 if (fl->label == label) {
252 fl->lastuse = jiffies;
253 atomic_inc(&fl->users);
254 rcu_read_unlock_bh();
258 rcu_read_unlock_bh();
261 EXPORT_SYMBOL_GPL(fl6_sock_lookup);
263 void fl6_free_socklist(struct sock *sk)
265 struct ipv6_pinfo *np = inet6_sk(sk);
266 struct ipv6_fl_socklist *sfl;
268 if (!rcu_access_pointer(np->ipv6_fl_list))
271 spin_lock_bh(&ip6_sk_fl_lock);
272 while ((sfl = rcu_dereference_protected(np->ipv6_fl_list,
273 lockdep_is_held(&ip6_sk_fl_lock))) != NULL) {
274 np->ipv6_fl_list = sfl->next;
275 spin_unlock_bh(&ip6_sk_fl_lock);
280 spin_lock_bh(&ip6_sk_fl_lock);
282 spin_unlock_bh(&ip6_sk_fl_lock);
285 /* Service routines */
289 It is the only difficult place. flowlabel enforces equal headers
290 before and including routing header, however user may supply options
294 struct ipv6_txoptions *fl6_merge_options(struct ipv6_txoptions *opt_space,
295 struct ip6_flowlabel *fl,
296 struct ipv6_txoptions *fopt)
298 struct ipv6_txoptions *fl_opt = fl->opt;
300 if (!fopt || fopt->opt_flen == 0)
304 opt_space->hopopt = fl_opt->hopopt;
305 opt_space->dst0opt = fl_opt->dst0opt;
306 opt_space->srcrt = fl_opt->srcrt;
307 opt_space->opt_nflen = fl_opt->opt_nflen;
309 if (fopt->opt_nflen == 0)
311 opt_space->hopopt = NULL;
312 opt_space->dst0opt = NULL;
313 opt_space->srcrt = NULL;
314 opt_space->opt_nflen = 0;
316 opt_space->dst1opt = fopt->dst1opt;
317 opt_space->opt_flen = fopt->opt_flen;
320 EXPORT_SYMBOL_GPL(fl6_merge_options);
322 static unsigned long check_linger(unsigned long ttl)
324 if (ttl < FL_MIN_LINGER)
325 return FL_MIN_LINGER*HZ;
326 if (ttl > FL_MAX_LINGER && !capable(CAP_NET_ADMIN))
331 static int fl6_renew(struct ip6_flowlabel *fl, unsigned long linger, unsigned long expires)
333 linger = check_linger(linger);
336 expires = check_linger(expires);
340 spin_lock_bh(&ip6_fl_lock);
341 fl->lastuse = jiffies;
342 if (time_before(fl->linger, linger))
344 if (time_before(expires, fl->linger))
345 expires = fl->linger;
346 if (time_before(fl->expires, fl->lastuse + expires))
347 fl->expires = fl->lastuse + expires;
348 spin_unlock_bh(&ip6_fl_lock);
353 static struct ip6_flowlabel *
354 fl_create(struct net *net, struct sock *sk, struct in6_flowlabel_req *freq,
355 char __user *optval, int optlen, int *err_p)
357 struct ip6_flowlabel *fl = NULL;
362 olen = optlen - CMSG_ALIGN(sizeof(*freq));
364 if (olen > 64 * 1024)
368 fl = kzalloc(sizeof(*fl), GFP_KERNEL);
374 struct flowi6 flowi6;
378 fl->opt = kmalloc(sizeof(*fl->opt) + olen, GFP_KERNEL);
382 memset(fl->opt, 0, sizeof(*fl->opt));
383 fl->opt->tot_len = sizeof(*fl->opt) + olen;
385 if (copy_from_user(fl->opt+1, optval+CMSG_ALIGN(sizeof(*freq)), olen))
388 msg.msg_controllen = olen;
389 msg.msg_control = (void *)(fl->opt+1);
390 memset(&flowi6, 0, sizeof(flowi6));
392 err = ip6_datagram_send_ctl(net, sk, &msg, &flowi6, fl->opt,
393 &junk, &junk, &junk);
397 if (fl->opt->opt_flen)
399 if (fl->opt->opt_nflen == 0) {
406 fl->expires = jiffies;
407 err = fl6_renew(fl, freq->flr_linger, freq->flr_expires);
410 fl->share = freq->flr_share;
411 addr_type = ipv6_addr_type(&freq->flr_dst);
412 if ((addr_type & IPV6_ADDR_MAPPED) ||
413 addr_type == IPV6_ADDR_ANY) {
417 fl->dst = freq->flr_dst;
418 atomic_set(&fl->users, 1);
423 case IPV6_FL_S_PROCESS:
424 fl->owner.pid = get_task_pid(current, PIDTYPE_PID);
427 fl->owner.uid = current_euid();
441 static int mem_check(struct sock *sk)
443 struct ipv6_pinfo *np = inet6_sk(sk);
444 struct ipv6_fl_socklist *sfl;
445 int room = FL_MAX_SIZE - atomic_read(&fl_size);
448 if (room > FL_MAX_SIZE - FL_MAX_PER_SOCK)
452 for_each_sk_fl_rcu(np, sfl)
454 rcu_read_unlock_bh();
457 ((count >= FL_MAX_PER_SOCK ||
458 (count > 0 && room < FL_MAX_SIZE/2) || room < FL_MAX_SIZE/4) &&
459 !capable(CAP_NET_ADMIN)))
465 static inline void fl_link(struct ipv6_pinfo *np, struct ipv6_fl_socklist *sfl,
466 struct ip6_flowlabel *fl)
468 spin_lock_bh(&ip6_sk_fl_lock);
470 sfl->next = np->ipv6_fl_list;
471 rcu_assign_pointer(np->ipv6_fl_list, sfl);
472 spin_unlock_bh(&ip6_sk_fl_lock);
475 int ipv6_flowlabel_opt_get(struct sock *sk, struct in6_flowlabel_req *freq,
478 struct ipv6_pinfo *np = inet6_sk(sk);
479 struct ipv6_fl_socklist *sfl;
481 if (flags & IPV6_FL_F_REMOTE) {
482 freq->flr_label = np->rcv_flowinfo & IPV6_FLOWLABEL_MASK;
487 freq->flr_label = np->flow_label;
493 for_each_sk_fl_rcu(np, sfl) {
494 if (sfl->fl->label == (np->flow_label & IPV6_FLOWLABEL_MASK)) {
495 spin_lock_bh(&ip6_fl_lock);
496 freq->flr_label = sfl->fl->label;
497 freq->flr_dst = sfl->fl->dst;
498 freq->flr_share = sfl->fl->share;
499 freq->flr_expires = (sfl->fl->expires - jiffies) / HZ;
500 freq->flr_linger = sfl->fl->linger / HZ;
502 spin_unlock_bh(&ip6_fl_lock);
503 rcu_read_unlock_bh();
507 rcu_read_unlock_bh();
512 int ipv6_flowlabel_opt(struct sock *sk, char __user *optval, int optlen)
514 int uninitialized_var(err);
515 struct net *net = sock_net(sk);
516 struct ipv6_pinfo *np = inet6_sk(sk);
517 struct in6_flowlabel_req freq;
518 struct ipv6_fl_socklist *sfl1 = NULL;
519 struct ipv6_fl_socklist *sfl;
520 struct ipv6_fl_socklist __rcu **sflp;
521 struct ip6_flowlabel *fl, *fl1 = NULL;
524 if (optlen < sizeof(freq))
527 if (copy_from_user(&freq, optval, sizeof(freq)))
530 switch (freq.flr_action) {
532 if (freq.flr_flags & IPV6_FL_F_REFLECT) {
533 if (sk->sk_protocol != IPPROTO_TCP)
541 spin_lock_bh(&ip6_sk_fl_lock);
542 for (sflp = &np->ipv6_fl_list;
543 (sfl = rcu_dereference_protected(*sflp,
544 lockdep_is_held(&ip6_sk_fl_lock))) != NULL;
546 if (sfl->fl->label == freq.flr_label) {
547 if (freq.flr_label == (np->flow_label&IPV6_FLOWLABEL_MASK))
548 np->flow_label &= ~IPV6_FLOWLABEL_MASK;
550 spin_unlock_bh(&ip6_sk_fl_lock);
556 spin_unlock_bh(&ip6_sk_fl_lock);
559 case IPV6_FL_A_RENEW:
561 for_each_sk_fl_rcu(np, sfl) {
562 if (sfl->fl->label == freq.flr_label) {
563 err = fl6_renew(sfl->fl, freq.flr_linger, freq.flr_expires);
564 rcu_read_unlock_bh();
568 rcu_read_unlock_bh();
570 if (freq.flr_share == IPV6_FL_S_NONE &&
571 ns_capable(net->user_ns, CAP_NET_ADMIN)) {
572 fl = fl_lookup(net, freq.flr_label);
574 err = fl6_renew(fl, freq.flr_linger, freq.flr_expires);
582 if (freq.flr_flags & IPV6_FL_F_REFLECT) {
583 struct net *net = sock_net(sk);
584 if (net->ipv6.sysctl.flowlabel_consistency) {
585 net_info_ratelimited("Can not set IPV6_FL_F_REFLECT if flowlabel_consistency sysctl is enable\n");
589 if (sk->sk_protocol != IPPROTO_TCP)
596 if (freq.flr_label & ~IPV6_FLOWLABEL_MASK)
599 if (net->ipv6.sysctl.flowlabel_state_ranges &&
600 (freq.flr_label & IPV6_FLOWLABEL_STATELESS_FLAG))
603 fl = fl_create(net, sk, &freq, optval, optlen, &err);
606 sfl1 = kmalloc(sizeof(*sfl1), GFP_KERNEL);
608 if (freq.flr_label) {
611 for_each_sk_fl_rcu(np, sfl) {
612 if (sfl->fl->label == freq.flr_label) {
613 if (freq.flr_flags&IPV6_FL_F_EXCL) {
614 rcu_read_unlock_bh();
618 atomic_inc(&fl1->users);
622 rcu_read_unlock_bh();
625 fl1 = fl_lookup(net, freq.flr_label);
629 if (freq.flr_flags&IPV6_FL_F_EXCL)
632 if (fl1->share == IPV6_FL_S_EXCL ||
633 fl1->share != fl->share ||
634 ((fl1->share == IPV6_FL_S_PROCESS) &&
635 (fl1->owner.pid == fl->owner.pid)) ||
636 ((fl1->share == IPV6_FL_S_USER) &&
637 uid_eq(fl1->owner.uid, fl->owner.uid)))
643 if (fl->linger > fl1->linger)
644 fl1->linger = fl->linger;
645 if ((long)(fl->expires - fl1->expires) > 0)
646 fl1->expires = fl->expires;
647 fl_link(np, sfl1, fl1);
657 if (!(freq.flr_flags&IPV6_FL_F_CREATE))
668 fl1 = fl_intern(net, fl, freq.flr_label);
672 if (!freq.flr_label) {
673 if (copy_to_user(&((struct in6_flowlabel_req __user *) optval)->flr_label,
674 &fl->label, sizeof(fl->label))) {
675 /* Intentionally ignore fault. */
679 fl_link(np, sfl1, fl);
692 #ifdef CONFIG_PROC_FS
694 struct ip6fl_iter_state {
695 struct seq_net_private p;
696 struct pid_namespace *pid_ns;
700 #define ip6fl_seq_private(seq) ((struct ip6fl_iter_state *)(seq)->private)
702 static struct ip6_flowlabel *ip6fl_get_first(struct seq_file *seq)
704 struct ip6_flowlabel *fl = NULL;
705 struct ip6fl_iter_state *state = ip6fl_seq_private(seq);
706 struct net *net = seq_file_net(seq);
708 for (state->bucket = 0; state->bucket <= FL_HASH_MASK; ++state->bucket) {
709 for_each_fl_rcu(state->bucket, fl) {
710 if (net_eq(fl->fl_net, net))
719 static struct ip6_flowlabel *ip6fl_get_next(struct seq_file *seq, struct ip6_flowlabel *fl)
721 struct ip6fl_iter_state *state = ip6fl_seq_private(seq);
722 struct net *net = seq_file_net(seq);
724 for_each_fl_continue_rcu(fl) {
725 if (net_eq(fl->fl_net, net))
730 if (++state->bucket <= FL_HASH_MASK) {
731 for_each_fl_rcu(state->bucket, fl) {
732 if (net_eq(fl->fl_net, net))
743 static struct ip6_flowlabel *ip6fl_get_idx(struct seq_file *seq, loff_t pos)
745 struct ip6_flowlabel *fl = ip6fl_get_first(seq);
747 while (pos && (fl = ip6fl_get_next(seq, fl)) != NULL)
749 return pos ? NULL : fl;
752 static void *ip6fl_seq_start(struct seq_file *seq, loff_t *pos)
756 return *pos ? ip6fl_get_idx(seq, *pos - 1) : SEQ_START_TOKEN;
759 static void *ip6fl_seq_next(struct seq_file *seq, void *v, loff_t *pos)
761 struct ip6_flowlabel *fl;
763 if (v == SEQ_START_TOKEN)
764 fl = ip6fl_get_first(seq);
766 fl = ip6fl_get_next(seq, v);
771 static void ip6fl_seq_stop(struct seq_file *seq, void *v)
774 rcu_read_unlock_bh();
777 static int ip6fl_seq_show(struct seq_file *seq, void *v)
779 struct ip6fl_iter_state *state = ip6fl_seq_private(seq);
780 if (v == SEQ_START_TOKEN) {
781 seq_puts(seq, "Label S Owner Users Linger Expires Dst Opt\n");
783 struct ip6_flowlabel *fl = v;
785 "%05X %-1d %-6d %-6d %-6ld %-8ld %pi6 %-4d\n",
786 (unsigned int)ntohl(fl->label),
788 ((fl->share == IPV6_FL_S_PROCESS) ?
789 pid_nr_ns(fl->owner.pid, state->pid_ns) :
790 ((fl->share == IPV6_FL_S_USER) ?
791 from_kuid_munged(seq_user_ns(seq), fl->owner.uid) :
793 atomic_read(&fl->users),
795 (long)(fl->expires - jiffies)/HZ,
797 fl->opt ? fl->opt->opt_nflen : 0);
802 static const struct seq_operations ip6fl_seq_ops = {
803 .start = ip6fl_seq_start,
804 .next = ip6fl_seq_next,
805 .stop = ip6fl_seq_stop,
806 .show = ip6fl_seq_show,
809 static int ip6fl_seq_open(struct inode *inode, struct file *file)
811 struct seq_file *seq;
812 struct ip6fl_iter_state *state;
815 err = seq_open_net(inode, file, &ip6fl_seq_ops,
816 sizeof(struct ip6fl_iter_state));
819 seq = file->private_data;
820 state = ip6fl_seq_private(seq);
822 state->pid_ns = get_pid_ns(task_active_pid_ns(current));
828 static int ip6fl_seq_release(struct inode *inode, struct file *file)
830 struct seq_file *seq = file->private_data;
831 struct ip6fl_iter_state *state = ip6fl_seq_private(seq);
832 put_pid_ns(state->pid_ns);
833 return seq_release_net(inode, file);
836 static const struct file_operations ip6fl_seq_fops = {
837 .owner = THIS_MODULE,
838 .open = ip6fl_seq_open,
841 .release = ip6fl_seq_release,
844 static int __net_init ip6_flowlabel_proc_init(struct net *net)
846 if (!proc_create("ip6_flowlabel", S_IRUGO, net->proc_net,
852 static void __net_exit ip6_flowlabel_proc_fini(struct net *net)
854 remove_proc_entry("ip6_flowlabel", net->proc_net);
857 static inline int ip6_flowlabel_proc_init(struct net *net)
861 static inline void ip6_flowlabel_proc_fini(struct net *net)
866 static void __net_exit ip6_flowlabel_net_exit(struct net *net)
869 ip6_flowlabel_proc_fini(net);
872 static struct pernet_operations ip6_flowlabel_net_ops = {
873 .init = ip6_flowlabel_proc_init,
874 .exit = ip6_flowlabel_net_exit,
877 int ip6_flowlabel_init(void)
879 return register_pernet_subsys(&ip6_flowlabel_net_ops);
882 void ip6_flowlabel_cleanup(void)
884 del_timer(&ip6_fl_gc_timer);
885 unregister_pernet_subsys(&ip6_flowlabel_net_ops);