Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * net/tipc/core.h: Include file for TIPC global declarations
3 *
4 * Copyright (c) 2005-2006, 2013 Ericsson AB
5 * Copyright (c) 2005-2007, 2010-2013, Wind River Systems
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the names of the copyright holders nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * Alternatively, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") version 2 as published by the Free
22 * Software Foundation.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_CORE_H
38#define _TIPC_CORE_H
39
40#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
41
42#include <linux/tipc.h>
43#include <linux/tipc_config.h>
44#include <linux/tipc_netlink.h>
45#include <linux/types.h>
46#include <linux/kernel.h>
47#include <linux/errno.h>
48#include <linux/mm.h>
49#include <linux/timer.h>
50#include <linux/string.h>
51#include <linux/uaccess.h>
52#include <linux/interrupt.h>
53#include <linux/atomic.h>
54#include <asm/hardirq.h>
55#include <linux/netdevice.h>
56#include <linux/in.h>
57#include <linux/list.h>
58#include <linux/slab.h>
59#include <linux/vmalloc.h>
60#include <linux/rtnetlink.h>
61#include <linux/etherdevice.h>
62
63#define TIPC_MOD_VER "2.0.0"
64
65#define ULTRA_STRING_MAX_LEN 32768
66#define TIPC_MAX_SUBSCRIPTIONS 65535
67#define TIPC_MAX_PUBLICATIONS 65535
68
69struct tipc_msg; /* msg.h */
70
71int tipc_snprintf(char *buf, int len, const char *fmt, ...);
72
73/*
74 * TIPC-specific error codes
75 */
76#define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
77
78/*
79 * Global configuration variables
80 */
81extern u32 tipc_own_addr __read_mostly;
82extern int tipc_max_ports __read_mostly;
83extern int tipc_net_id __read_mostly;
84extern int sysctl_tipc_rmem[3] __read_mostly;
85extern int sysctl_tipc_named_timeout __read_mostly;
86
87/*
88 * Other global variables
89 */
90extern int tipc_random __read_mostly;
91
92/*
93 * Routines available to privileged subsystems
94 */
95int tipc_netlink_start(void);
96void tipc_netlink_stop(void);
97int tipc_socket_init(void);
98void tipc_socket_stop(void);
99int tipc_sock_create_local(int type, struct socket **res);
100void tipc_sock_release_local(struct socket *sock);
101int tipc_sock_accept_local(struct socket *sock, struct socket **newsock,
102 int flags);
103
104#ifdef CONFIG_SYSCTL
105int tipc_register_sysctl(void);
106void tipc_unregister_sysctl(void);
107#else
108#define tipc_register_sysctl() 0
109#define tipc_unregister_sysctl()
110#endif
111
112/*
113 * TIPC timer code
114 */
115typedef void (*Handler) (unsigned long);
116
117/**
118 * k_init_timer - initialize a timer
119 * @timer: pointer to timer structure
120 * @routine: pointer to routine to invoke when timer expires
121 * @argument: value to pass to routine when timer expires
122 *
123 * Timer must be initialized before use (and terminated when no longer needed).
124 */
125static inline void k_init_timer(struct timer_list *timer, Handler routine,
126 unsigned long argument)
127{
128 setup_timer(timer, routine, argument);
129}
130
131/**
132 * k_start_timer - start a timer
133 * @timer: pointer to timer structure
134 * @msec: time to delay (in ms)
135 *
136 * Schedules a previously initialized timer for later execution.
137 * If timer is already running, the new timeout overrides the previous request.
138 *
139 * To ensure the timer doesn't expire before the specified delay elapses,
140 * the amount of delay is rounded up when converting to the jiffies
141 * then an additional jiffy is added to account for the fact that
142 * the starting time may be in the middle of the current jiffy.
143 */
144static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
145{
146 mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
147}
148
149/**
150 * k_cancel_timer - cancel a timer
151 * @timer: pointer to timer structure
152 *
153 * Cancels a previously initialized timer.
154 * Can be called safely even if the timer is already inactive.
155 *
156 * WARNING: Must not be called when holding locks required by the timer's
157 * timeout routine, otherwise deadlock can occur on SMP systems!
158 */
159static inline void k_cancel_timer(struct timer_list *timer)
160{
161 del_timer_sync(timer);
162}
163
164/**
165 * k_term_timer - terminate a timer
166 * @timer: pointer to timer structure
167 *
168 * Prevents further use of a previously initialized timer.
169 *
170 * WARNING: Caller must ensure timer isn't currently running.
171 *
172 * (Do not "enhance" this routine to automatically cancel an active timer,
173 * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
174 */
175static inline void k_term_timer(struct timer_list *timer)
176{
177}
178
179/*
180 * TIPC message buffer code
181 *
182 * TIPC message buffer headroom reserves space for the worst-case
183 * link-level device header (in case the message is sent off-node).
184 *
185 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
186 * are word aligned for quicker access
187 */
188#define BUF_HEADROOM LL_MAX_HEADER
189
190struct tipc_skb_cb {
191 void *handle;
192 struct sk_buff *tail;
193 bool deferred;
194 bool wakeup_pending;
195 bool bundling;
196 u16 chain_sz;
197 u16 chain_imp;
198};
199
200#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
201
202static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
203{
204 return (struct tipc_msg *)skb->data;
205}
206
207struct sk_buff *tipc_buf_acquire(u32 size);
208
209#endif