blob: 94895d4e86abe249f4ef954d527e119647665c92 [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>
50#include <asm/uaccess.h>
51#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>
59
Allan Stephens107e7be2010-05-11 14:30:08 +000060
61#define TIPC_MOD_VER "2.0.0"
62
Ying Xue34f256c2012-08-16 12:09:13 +000063#define ULTRA_STRING_MAX_LEN 32768
64#define TIPC_MAX_SUBSCRIPTIONS 65535
Ying Xuee6a04b12012-08-16 12:09:14 +000065#define TIPC_MAX_PUBLICATIONS 65535
Erik Hugnedc1aed32012-06-29 00:50:23 -040066
Allan Stephensd265fef2010-11-30 12:00:53 +000067struct tipc_msg; /* msg.h */
Allan Stephens6063da92008-05-05 01:23:34 -070068
Erik Hugnedc1aed32012-06-29 00:50:23 -040069int tipc_snprintf(char *buf, int len, const char *fmt, ...);
Allan Stephens6063da92008-05-05 01:23:34 -070070
71/*
Per Lidenb97bf3f2006-01-02 19:04:38 +010072 * TIPC-specific error codes
73 */
Per Lidenb97bf3f2006-01-02 19:04:38 +010074#define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
75
76/*
77 * Global configuration variables
78 */
Ying Xue61cdd4d2012-08-16 12:09:12 +000079extern u32 tipc_own_addr __read_mostly;
80extern int tipc_max_ports __read_mostly;
Ying Xue61cdd4d2012-08-16 12:09:12 +000081extern int tipc_net_id __read_mostly;
82extern int tipc_remote_management __read_mostly;
Ying Xuecc79dd12013-06-17 10:54:37 -040083extern int sysctl_tipc_rmem[3] __read_mostly;
Per Lidenb97bf3f2006-01-02 19:04:38 +010084
85/*
86 * Other global variables
87 */
Ying Xue61cdd4d2012-08-16 12:09:12 +000088extern int tipc_random __read_mostly;
Per Lidenb97bf3f2006-01-02 19:04:38 +010089
90/*
91 * Routines available to privileged subsystems
92 */
Joe Perchesc1b12032013-10-18 13:48:25 -070093int tipc_core_start_net(unsigned long);
94int tipc_handler_start(void);
95void tipc_handler_stop(void);
96int tipc_netlink_start(void);
97void tipc_netlink_stop(void);
98int tipc_socket_init(void);
99void tipc_socket_stop(void);
100int tipc_sock_create_local(int type, struct socket **res);
101void tipc_sock_release_local(struct socket *sock);
102int tipc_sock_accept_local(struct socket *sock, struct socket **newsock,
103 int flags);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100104
Ying Xuecc79dd12013-06-17 10:54:37 -0400105#ifdef CONFIG_SYSCTL
Joe Perchesc1b12032013-10-18 13:48:25 -0700106int tipc_register_sysctl(void);
107void tipc_unregister_sysctl(void);
Ying Xuecc79dd12013-06-17 10:54:37 -0400108#else
109#define tipc_register_sysctl() 0
110#define tipc_unregister_sysctl()
111#endif
112
Per Lidenb97bf3f2006-01-02 19:04:38 +0100113/*
114 * TIPC timer and signal code
115 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100116typedef void (*Handler) (unsigned long);
117
Per Liden4323add2006-01-18 00:38:21 +0100118u32 tipc_k_signal(Handler routine, unsigned long argument);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100119
120/**
121 * k_init_timer - initialize a timer
122 * @timer: pointer to timer structure
123 * @routine: pointer to routine to invoke when timer expires
124 * @argument: value to pass to routine when timer expires
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900125 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100126 * Timer must be initialized before use (and terminated when no longer needed).
127 */
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900128static inline void k_init_timer(struct timer_list *timer, Handler routine,
Per Lidenb97bf3f2006-01-02 19:04:38 +0100129 unsigned long argument)
130{
Pavel Emelyanovb24b8a22008-01-23 21:20:07 -0800131 setup_timer(timer, routine, argument);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100132}
133
134/**
135 * k_start_timer - start a timer
136 * @timer: pointer to timer structure
137 * @msec: time to delay (in ms)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900138 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100139 * Schedules a previously initialized timer for later execution.
140 * If timer is already running, the new timeout overrides the previous request.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900141 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100142 * To ensure the timer doesn't expire before the specified delay elapses,
143 * the amount of delay is rounded up when converting to the jiffies
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900144 * then an additional jiffy is added to account for the fact that
Per Lidenb97bf3f2006-01-02 19:04:38 +0100145 * the starting time may be in the middle of the current jiffy.
146 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100147static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
148{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100149 mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
150}
151
152/**
153 * k_cancel_timer - cancel a timer
154 * @timer: pointer to timer structure
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900155 *
156 * Cancels a previously initialized timer.
Per Lidenb97bf3f2006-01-02 19:04:38 +0100157 * Can be called safely even if the timer is already inactive.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900158 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100159 * WARNING: Must not be called when holding locks required by the timer's
160 * timeout routine, otherwise deadlock can occur on SMP systems!
161 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100162static inline void k_cancel_timer(struct timer_list *timer)
163{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100164 del_timer_sync(timer);
165}
166
167/**
168 * k_term_timer - terminate a timer
169 * @timer: pointer to timer structure
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900170 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100171 * Prevents further use of a previously initialized timer.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900172 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100173 * WARNING: Caller must ensure timer isn't currently running.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900174 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100175 * (Do not "enhance" this routine to automatically cancel an active timer,
176 * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
177 */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100178static inline void k_term_timer(struct timer_list *timer)
179{
Per Lidenb97bf3f2006-01-02 19:04:38 +0100180}
181
Per Lidenb97bf3f2006-01-02 19:04:38 +0100182/*
183 * TIPC message buffer code
184 *
Allan Stephensf08269d2008-05-08 21:38:24 -0700185 * TIPC message buffer headroom reserves space for the worst-case
186 * link-level device header (in case the message is sent off-node).
Allan Stephens3a8d1212006-10-16 21:50:20 -0700187 *
Allan Stephensf08269d2008-05-08 21:38:24 -0700188 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
189 * are word aligned for quicker access
Per Lidenb97bf3f2006-01-02 19:04:38 +0100190 */
Allan Stephensf08269d2008-05-08 21:38:24 -0700191#define BUF_HEADROOM LL_MAX_HEADER
Per Lidenb97bf3f2006-01-02 19:04:38 +0100192
193struct tipc_skb_cb {
194 void *handle;
195};
196
197#define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
198
Per Lidenb97bf3f2006-01-02 19:04:38 +0100199static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
200{
201 return (struct tipc_msg *)skb->data;
202}
203
Joe Perchesc1b12032013-10-18 13:48:25 -0700204struct sk_buff *tipc_buf_acquire(u32 size);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100205
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900206#endif