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/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> 52 #include <linux/atomic.h> 53 #include <asm/hardirq.h> 54 #include <linux/netdevice.h> 55 #include <linux/in.h> 56 #include <linux/list.h> 57 #include <linux/slab.h> 58 #include <linux/vmalloc.h> 59 60 61 #define TIPC_MOD_VER "2.0.0" 62 63 #define ULTRA_STRING_MAX_LEN 32768 64 #define TIPC_MAX_SUBSCRIPTIONS 65535 65 #define TIPC_MAX_PUBLICATIONS 65535 66 67 struct tipc_msg; /* msg.h */ 68 69 int tipc_snprintf(char *buf, int len, const char *fmt, ...); 70 71 /* 72 * TIPC-specific error codes 73 */ 74 #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */ 75 76 /* 77 * Global configuration variables 78 */ 79 extern u32 tipc_own_addr __read_mostly; 80 extern int tipc_max_ports __read_mostly; 81 extern int tipc_net_id __read_mostly; 82 extern int tipc_remote_management __read_mostly; 83 extern int sysctl_tipc_rmem[3] __read_mostly; 84 85 /* 86 * Other global variables 87 */ 88 extern int tipc_random __read_mostly; 89 90 /* 91 * Routines available to privileged subsystems 92 */ 93 int tipc_core_start_net(unsigned long); 94 int tipc_handler_start(void); 95 void tipc_handler_stop(void); 96 int tipc_netlink_start(void); 97 void tipc_netlink_stop(void); 98 int tipc_socket_init(void); 99 void tipc_socket_stop(void); 100 int tipc_sock_create_local(int type, struct socket **res); 101 void tipc_sock_release_local(struct socket *sock); 102 int tipc_sock_accept_local(struct socket *sock, struct socket **newsock, 103 int flags); 104 105 #ifdef CONFIG_SYSCTL 106 int tipc_register_sysctl(void); 107 void tipc_unregister_sysctl(void); 108 #else 109 #define tipc_register_sysctl() 0 110 #define tipc_unregister_sysctl() 111 #endif 112 113 /* 114 * TIPC timer and signal code 115 */ 116 typedef void (*Handler) (unsigned long); 117 118 u32 tipc_k_signal(Handler routine, unsigned long argument); 119 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 125 * 126 * Timer must be initialized before use (and terminated when no longer needed). 127 */ 128 static inline void k_init_timer(struct timer_list *timer, Handler routine, 129 unsigned long argument) 130 { 131 setup_timer(timer, routine, argument); 132 } 133 134 /** 135 * k_start_timer - start a timer 136 * @timer: pointer to timer structure 137 * @msec: time to delay (in ms) 138 * 139 * Schedules a previously initialized timer for later execution. 140 * If timer is already running, the new timeout overrides the previous request. 141 * 142 * 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 144 * then an additional jiffy is added to account for the fact that 145 * the starting time may be in the middle of the current jiffy. 146 */ 147 static inline void k_start_timer(struct timer_list *timer, unsigned long msec) 148 { 149 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 155 * 156 * Cancels a previously initialized timer. 157 * Can be called safely even if the timer is already inactive. 158 * 159 * WARNING: Must not be called when holding locks required by the timer's 160 * timeout routine, otherwise deadlock can occur on SMP systems! 161 */ 162 static inline void k_cancel_timer(struct timer_list *timer) 163 { 164 del_timer_sync(timer); 165 } 166 167 /** 168 * k_term_timer - terminate a timer 169 * @timer: pointer to timer structure 170 * 171 * Prevents further use of a previously initialized timer. 172 * 173 * WARNING: Caller must ensure timer isn't currently running. 174 * 175 * (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 */ 178 static inline void k_term_timer(struct timer_list *timer) 179 { 180 } 181 182 /* 183 * TIPC message buffer code 184 * 185 * TIPC message buffer headroom reserves space for the worst-case 186 * link-level device header (in case the message is sent off-node). 187 * 188 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields 189 * are word aligned for quicker access 190 */ 191 #define BUF_HEADROOM LL_MAX_HEADER 192 193 struct tipc_skb_cb { 194 void *handle; 195 }; 196 197 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0])) 198 199 static inline struct tipc_msg *buf_msg(struct sk_buff *skb) 200 { 201 return (struct tipc_msg *)skb->data; 202 } 203 204 struct sk_buff *tipc_buf_acquire(u32 size); 205 206 #endif 207