blob: f773b148722f7e51195d525a55e2ae18577c3c3e [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/core.h: Include file for TIPC global declarations
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Ying Xuec5fa7b32013-06-17 10:54:39 -04004 * Copyright (c) 2005-2006, 2013 Ericsson AB
5 * Copyright (c) 2005-2007, 2010-2013, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_CORE_H
38#define _TIPC_CORE_H
39
Erik Hugne2cf8aa12012-06-29 00:16:37 -040040#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
41
Jon Maloy5f7c3ff2006-01-13 10:45:44 +000042#include <linux/tipc.h>
43#include <linux/tipc_config.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010044#include <linux/types.h>
45#include <linux/kernel.h>
46#include <linux/errno.h>
47#include <linux/mm.h>
48#include <linux/timer.h>
49#include <linux/string.h>
wangweidong776a74c2013-12-12 09:36:41 +080050#include <linux/uaccess.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010051#include <linux/interrupt.h>
Arun Sharma600634972011-07-26 16:09:06 -070052#include <linux/atomic.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010053#include <asm/hardirq.h>
54#include <linux/netdevice.h>
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090055#include <linux/in.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010056#include <linux/list.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090057#include <linux/slab.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010058#include <linux/vmalloc.h>
Ying Xueef13a262014-04-21 10:55:42 +080059#include <linux/rtnetlink.h>
Jon Paul Maloy38504c22014-05-14 05:39:13 -040060#include <linux/etherdevice.h>
Allan Stephens107e7be2010-05-11 14:30:08 +000061
62#define TIPC_MOD_VER "2.0.0"
63
Ying Xue34f256c2012-08-16 12:09:13 +000064#define ULTRA_STRING_MAX_LEN 32768
65#define TIPC_MAX_SUBSCRIPTIONS 65535
Ying Xuee6a04b12012-08-16 12:09:14 +000066#define TIPC_MAX_PUBLICATIONS 65535
Erik Hugnedc1aed32012-06-29 00:50:23 -040067
Allan Stephensd265fef2010-11-30 12:00:53 +000068struct tipc_msg; /* msg.h */
Allan Stephens6063da92008-05-05 01:23:34 -070069
Erik Hugnedc1aed32012-06-29 00:50:23 -040070int tipc_snprintf(char *buf, int len, const char *fmt, ...);
Allan Stephens6063da92008-05-05 01:23:34 -070071
72/*
Per Lidenb97bf3f2006-01-02 19:04:38 +010073 * TIPC-specific error codes
74 */
Per Lidenb97bf3f2006-01-02 19:04:38 +010075#define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
76
77/*
78 * Global configuration variables
79 */
Ying Xue61cdd4d2012-08-16 12:09:12 +000080extern u32 tipc_own_addr __read_mostly;
81extern int tipc_max_ports __read_mostly;
Ying Xue61cdd4d2012-08-16 12:09:12 +000082extern int tipc_net_id __read_mostly;
Ying Xuecc79dd12013-06-17 10:54:37 -040083extern int sysctl_tipc_rmem[3] __read_mostly;
Erik Hugnea5325ae2014-08-28 09:08:47 +020084extern int sysctl_tipc_named_timeout __read_mostly;
Per Lidenb97bf3f2006-01-02 19:04:38 +010085
86/*
87 * Other global variables
88 */
Ying Xue61cdd4d2012-08-16 12:09:12 +000089extern int tipc_random __read_mostly;
Per Lidenb97bf3f2006-01-02 19:04:38 +010090
91/*
92 * Routines available to privileged subsystems
93 */
Joe Perchesc1b12032013-10-18 13:48:25 -070094int tipc_netlink_start(void);
95void tipc_netlink_stop(void);
96int tipc_socket_init(void);
97void tipc_socket_stop(void);
98int tipc_sock_create_local(int type, struct socket **res);
99void tipc_sock_release_local(struct socket *sock);
100int tipc_sock_accept_local(struct socket *sock, struct socket **newsock,
101 int flags);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100102
Ying Xuecc79dd12013-06-17 10:54:37 -0400103#ifdef CONFIG_SYSCTL
Joe Perchesc1b12032013-10-18 13:48:25 -0700104int tipc_register_sysctl(void);
105void tipc_unregister_sysctl(void);
Ying Xuecc79dd12013-06-17 10:54:37 -0400106#else
107#define tipc_register_sysctl() 0
108#define tipc_unregister_sysctl()
109#endif
110
Per Lidenb97bf3f2006-01-02 19:04:38 +0100111/*
Ying Xue52ff8722014-05-05 08:56:18 +0800112 * TIPC timer code
Per Lidenb97bf3f2006-01-02 19:04:38 +0100113 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100114typedef void (*Handler) (unsigned long);
115
Per Lidenb97bf3f2006-01-02 19:04:38 +0100116/**
117 * k_init_timer - initialize a timer
118 * @timer: pointer to timer structure
119 * @routine: pointer to routine to invoke when timer expires
120 * @argument: value to pass to routine when timer expires
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900121 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100122 * Timer must be initialized before use (and terminated when no longer needed).
123 */
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900124static inline void k_init_timer(struct timer_list *timer, Handler routine,
Per Lidenb97bf3f2006-01-02 19:04:38 +0100125 unsigned long argument)
126{
Pavel Emelyanovb24b8a22008-01-23 21:20:07 -0800127 setup_timer(timer, routine, argument);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100128}
129
130/**
131 * k_start_timer - start a timer
132 * @timer: pointer to timer structure
133 * @msec: time to delay (in ms)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900134 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100135 * Schedules a previously initialized timer for later execution.
136 * If timer is already running, the new timeout overrides the previous request.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900137 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100138 * To ensure the timer doesn't expire before the specified delay elapses,
139 * the amount of delay is rounded up when converting to the jiffies
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900140 * then an additional jiffy is added to account for the fact that
Per Lidenb97bf3f2006-01-02 19:04:38 +0100141 * the starting time may be in the middle of the current jiffy.
142 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100143static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
144{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100145 mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
146}
147
148/**
149 * k_cancel_timer - cancel a timer
150 * @timer: pointer to timer structure
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900151 *
152 * Cancels a previously initialized timer.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100153 * Can be called safely even if the timer is already inactive.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900154 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100155 * WARNING: Must not be called when holding locks required by the timer's
156 * timeout routine, otherwise deadlock can occur on SMP systems!
157 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100158static inline void k_cancel_timer(struct timer_list *timer)
159{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100160 del_timer_sync(timer);
161}
162
163/**
164 * k_term_timer - terminate a timer
165 * @timer: pointer to timer structure
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900166 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100167 * Prevents further use of a previously initialized timer.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900168 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100169 * WARNING: Caller must ensure timer isn't currently running.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900170 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100171 * (Do not "enhance" this routine to automatically cancel an active timer,
172 * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
173 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100174static inline void k_term_timer(struct timer_list *timer)
175{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100176}
177
Per Lidenb97bf3f2006-01-02 19:04:38 +0100178/*
179 * TIPC message buffer code
180 *
Allan Stephensf08269d2008-05-08 21:38:24 -0700181 * TIPC message buffer headroom reserves space for the worst-case
182 * link-level device header (in case the message is sent off-node).
Allan Stephens3a8d1212006-10-16 21:50:20 -0700183 *
Allan Stephensf08269d2008-05-08 21:38:24 -0700184 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
185 * are word aligned for quicker access
Per Lidenb97bf3f2006-01-02 19:04:38 +0100186 */
Allan Stephensf08269d2008-05-08 21:38:24 -0700187#define BUF_HEADROOM LL_MAX_HEADER
Per Lidenb97bf3f2006-01-02 19:04:38 +0100188
189struct tipc_skb_cb {
190 void *handle;
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400191 struct sk_buff *tail;
Jon Paul Maloy50100a52014-08-22 18:09:07 -0400192 bool deferred;
193 bool wakeup_pending;
194 u16 chain_sz;
195 u16 chain_imp;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100196};
197
198#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
199
Per Lidenb97bf3f2006-01-02 19:04:38 +0100200static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
201{
202 return (struct tipc_msg *)skb->data;
203}
204
Joe Perchesc1b12032013-10-18 13:48:25 -0700205struct sk_buff *tipc_buf_acquire(u32 size);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100206
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900207#endif