1 /* 2 * net/tipc/core.h: Include file for TIPC global declarations 3 * 4 * Copyright (c) 2005-2006, Ericsson AB 5 * Copyright (c) 2005-2007, 2010-2011, 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 65 struct tipc_msg; /* msg.h */ 66 67 int tipc_snprintf(char *buf, int len, const char *fmt, ...); 68 69 /* 70 * TIPC-specific error codes 71 */ 72 #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */ 73 74 /* 75 * Global configuration variables 76 */ 77 extern u32 tipc_own_addr; 78 extern int tipc_max_ports; 79 extern int tipc_max_subscriptions; 80 extern int tipc_max_publications; 81 extern int tipc_net_id; 82 extern int tipc_remote_management; 83 84 /* 85 * Other global variables 86 */ 87 extern int tipc_random; 88 extern const char tipc_alphabet[]; 89 90 91 /* 92 * Routines available to privileged subsystems 93 */ 94 extern int tipc_core_start_net(unsigned long); 95 extern int tipc_handler_start(void); 96 extern void tipc_handler_stop(void); 97 extern int tipc_netlink_start(void); 98 extern void tipc_netlink_stop(void); 99 extern int tipc_socket_init(void); 100 extern void tipc_socket_stop(void); 101 102 /* 103 * TIPC timer and signal code 104 */ 105 typedef void (*Handler) (unsigned long); 106 107 u32 tipc_k_signal(Handler routine, unsigned long argument); 108 109 /** 110 * k_init_timer - initialize a timer 111 * @timer: pointer to timer structure 112 * @routine: pointer to routine to invoke when timer expires 113 * @argument: value to pass to routine when timer expires 114 * 115 * Timer must be initialized before use (and terminated when no longer needed). 116 */ 117 static inline void k_init_timer(struct timer_list *timer, Handler routine, 118 unsigned long argument) 119 { 120 setup_timer(timer, routine, argument); 121 } 122 123 /** 124 * k_start_timer - start a timer 125 * @timer: pointer to timer structure 126 * @msec: time to delay (in ms) 127 * 128 * Schedules a previously initialized timer for later execution. 129 * If timer is already running, the new timeout overrides the previous request. 130 * 131 * To ensure the timer doesn't expire before the specified delay elapses, 132 * the amount of delay is rounded up when converting to the jiffies 133 * then an additional jiffy is added to account for the fact that 134 * the starting time may be in the middle of the current jiffy. 135 */ 136 static inline void k_start_timer(struct timer_list *timer, unsigned long msec) 137 { 138 mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1); 139 } 140 141 /** 142 * k_cancel_timer - cancel a timer 143 * @timer: pointer to timer structure 144 * 145 * Cancels a previously initialized timer. 146 * Can be called safely even if the timer is already inactive. 147 * 148 * WARNING: Must not be called when holding locks required by the timer's 149 * timeout routine, otherwise deadlock can occur on SMP systems! 150 */ 151 static inline void k_cancel_timer(struct timer_list *timer) 152 { 153 del_timer_sync(timer); 154 } 155 156 /** 157 * k_term_timer - terminate a timer 158 * @timer: pointer to timer structure 159 * 160 * Prevents further use of a previously initialized timer. 161 * 162 * WARNING: Caller must ensure timer isn't currently running. 163 * 164 * (Do not "enhance" this routine to automatically cancel an active timer, 165 * otherwise deadlock can arise when a timeout routine calls k_term_timer.) 166 */ 167 static inline void k_term_timer(struct timer_list *timer) 168 { 169 } 170 171 /* 172 * TIPC message buffer code 173 * 174 * TIPC message buffer headroom reserves space for the worst-case 175 * link-level device header (in case the message is sent off-node). 176 * 177 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields 178 * are word aligned for quicker access 179 */ 180 #define BUF_HEADROOM LL_MAX_HEADER 181 182 struct tipc_skb_cb { 183 void *handle; 184 }; 185 186 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0])) 187 188 static inline struct tipc_msg *buf_msg(struct sk_buff *skb) 189 { 190 return (struct tipc_msg *)skb->data; 191 } 192 193 extern struct sk_buff *tipc_buf_acquire(u32 size); 194 195 #endif 196