treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 500
[linux-2.6-microblaze.git] / include / linux / netfilter / ipset / ip_set_timeout.h
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef _IP_SET_TIMEOUT_H
3 #define _IP_SET_TIMEOUT_H
4
5 /* Copyright (C) 2003-2013 Jozsef Kadlecsik <kadlec@blackhole.kfki.hu>
6  */
7
8 #ifdef __KERNEL__
9
10 /* How often should the gc be run by default */
11 #define IPSET_GC_TIME                   (3 * 60)
12
13 /* Timeout period depending on the timeout value of the given set */
14 #define IPSET_GC_PERIOD(timeout) \
15         ((timeout/3) ? min_t(u32, (timeout)/3, IPSET_GC_TIME) : 1)
16
17 /* Entry is set with no timeout value */
18 #define IPSET_ELEM_PERMANENT    0
19
20 /* Set is defined with timeout support: timeout value may be 0 */
21 #define IPSET_NO_TIMEOUT        UINT_MAX
22
23 /* Max timeout value, see msecs_to_jiffies() in jiffies.h */
24 #define IPSET_MAX_TIMEOUT       (UINT_MAX >> 1)/MSEC_PER_SEC
25
26 #define ip_set_adt_opt_timeout(opt, set)        \
27 ((opt)->ext.timeout != IPSET_NO_TIMEOUT ? (opt)->ext.timeout : (set)->timeout)
28
29 static inline unsigned int
30 ip_set_timeout_uget(struct nlattr *tb)
31 {
32         unsigned int timeout = ip_set_get_h32(tb);
33
34         /* Normalize to fit into jiffies */
35         if (timeout > IPSET_MAX_TIMEOUT)
36                 timeout = IPSET_MAX_TIMEOUT;
37
38         return timeout;
39 }
40
41 static inline bool
42 ip_set_timeout_expired(const unsigned long *t)
43 {
44         return *t != IPSET_ELEM_PERMANENT && time_is_before_jiffies(*t);
45 }
46
47 static inline void
48 ip_set_timeout_set(unsigned long *timeout, u32 value)
49 {
50         unsigned long t;
51
52         if (!value) {
53                 *timeout = IPSET_ELEM_PERMANENT;
54                 return;
55         }
56
57         t = msecs_to_jiffies(value * MSEC_PER_SEC) + jiffies;
58         if (t == IPSET_ELEM_PERMANENT)
59                 /* Bingo! :-) */
60                 t--;
61         *timeout = t;
62 }
63
64 static inline u32
65 ip_set_timeout_get(const unsigned long *timeout)
66 {
67         u32 t;
68
69         if (*timeout == IPSET_ELEM_PERMANENT)
70                 return 0;
71
72         t = jiffies_to_msecs(*timeout - jiffies)/MSEC_PER_SEC;
73         /* Zero value in userspace means no timeout */
74         return t == 0 ? 1 : t;
75 }
76
77 #endif  /* __KERNEL__ */
78 #endif /* _IP_SET_TIMEOUT_H */