net/tipc/core.h

   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 #include <linux/tipc.h>
  41 #include <linux/tipc_config.h>
  42 #include <linux/types.h>
  43 #include <linux/kernel.h>
  44 #include <linux/errno.h>
  45 #include <linux/mm.h>
  46 #include <linux/timer.h>
  47 #include <linux/string.h>
  48 #include <asm/uaccess.h>
  49 #include <linux/interrupt.h>
  50 #include <asm/atomic.h>
  51 #include <asm/hardirq.h>
  52 #include <linux/netdevice.h>
  53 #include <linux/in.h>
  54 #include <linux/list.h>
  55 #include <linux/slab.h>
  56 #include <linux/vmalloc.h>
  57
  58
  59 #define TIPC_MOD_VER "2.0.0"
  60
  61 struct tipc_msg;        /* msg.h */
  62 struct print_buf;       /* log.h */
  63
  64 /*
  65  * TIPC sanity test macros
  66  */
  67
  68 #define assert(i)  BUG_ON(!(i))
  69
  70 /*
  71  * TIPC system monitoring code
  72  */
  73
  74 /*
  75  * TIPC's print buffer subsystem supports the following print buffers:
  76  *
  77  * TIPC_NULL : null buffer (i.e. print nowhere)
  78  * TIPC_CONS : system console
  79  * TIPC_LOG  : TIPC log buffer
  80  * &buf      : user-defined buffer (struct print_buf *)
  81  *
  82  * Note: TIPC_LOG is configured to echo its output to the system console;
  83  *       user-defined buffers can be configured to do the same thing.
  84  */
  85 extern struct print_buf *const TIPC_NULL;
  86 extern struct print_buf *const TIPC_CONS;
  87 extern struct print_buf *const TIPC_LOG;
  88
  89 void tipc_printf(struct print_buf *, const char *fmt, ...);
  90
  91 /*
  92  * TIPC_OUTPUT is the destination print buffer for system messages.
  93  */
  94
  95 #ifndef TIPC_OUTPUT
  96 #define TIPC_OUTPUT TIPC_LOG
  97 #endif
  98
  99 #define err(fmt, arg...)  tipc_printf(TIPC_OUTPUT, \
 100                                       KERN_ERR "TIPC: " fmt, ## arg)
 101 #define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
 102                                       KERN_WARNING "TIPC: " fmt, ## arg)
 103 #define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
 104                                       KERN_NOTICE "TIPC: " fmt, ## arg)
 105
 106 #ifdef CONFIG_TIPC_DEBUG
 107
 108 /*
 109  * DBG_OUTPUT is the destination print buffer for debug messages.
 110  */
 111
 112 #ifndef DBG_OUTPUT
 113 #define DBG_OUTPUT TIPC_LOG
 114 #endif
 115
 116 #define dbg(fmt, arg...)  tipc_printf(DBG_OUTPUT, KERN_DEBUG fmt, ## arg);
 117
 118 #define msg_dbg(msg, txt) tipc_msg_dbg(DBG_OUTPUT, msg, txt);
 119
 120 void tipc_msg_dbg(struct print_buf *, struct tipc_msg *, const char *);
 121
 122 #else
 123
 124 #define dbg(fmt, arg...)        do {} while (0)
 125 #define msg_dbg(msg, txt)       do {} while (0)
 126
 127 #define tipc_msg_dbg(buf, msg, txt) do {} while (0)
 128
 129 #endif
 130
 131
 132 /*
 133  * TIPC-specific error codes
 134  */
 135
 136 #define ELINKCONG EAGAIN        /* link congestion <=> resource unavailable */
 137
 138 /*
 139  * TIPC operating mode routines
 140  */
 141 #define TIPC_NOT_RUNNING  0
 142 #define TIPC_NODE_MODE    1
 143 #define TIPC_NET_MODE     2
 144
 145 /*
 146  * Global configuration variables
 147  */
 148
 149 extern u32 tipc_own_addr;
 150 extern int tipc_max_ports;
 151 extern int tipc_max_subscriptions;
 152 extern int tipc_max_publications;
 153 extern int tipc_net_id;
 154 extern int tipc_remote_management;
 155
 156 /*
 157  * Other global variables
 158  */
 159
 160 extern int tipc_mode;
 161 extern int tipc_random;
 162 extern const char tipc_alphabet[];
 163
 164
 165 /*
 166  * Routines available to privileged subsystems
 167  */
 168
 169 extern int tipc_core_start_net(unsigned long);
 170 extern int  tipc_handler_start(void);
 171 extern void tipc_handler_stop(void);
 172 extern int  tipc_netlink_start(void);
 173 extern void tipc_netlink_stop(void);
 174 extern int  tipc_socket_init(void);
 175 extern void tipc_socket_stop(void);
 176
 177 static inline int delimit(int val, int min, int max)
 178 {
 179         if (val > max)
 180                 return max;
 181         if (val < min)
 182                 return min;
 183         return val;
 184 }
 185
 186
 187 /*
 188  * TIPC timer and signal code
 189  */
 190
 191 typedef void (*Handler) (unsigned long);
 192
 193 u32 tipc_k_signal(Handler routine, unsigned long argument);
 194
 195 /**
 196  * k_init_timer - initialize a timer
 197  * @timer: pointer to timer structure
 198  * @routine: pointer to routine to invoke when timer expires
 199  * @argument: value to pass to routine when timer expires
 200  *
 201  * Timer must be initialized before use (and terminated when no longer needed).
 202  */
 203
 204 static inline void k_init_timer(struct timer_list *timer, Handler routine,
 205                                 unsigned long argument)
 206 {
 207         setup_timer(timer, routine, argument);
 208 }
 209
 210 /**
 211  * k_start_timer - start a timer
 212  * @timer: pointer to timer structure
 213  * @msec: time to delay (in ms)
 214  *
 215  * Schedules a previously initialized timer for later execution.
 216  * If timer is already running, the new timeout overrides the previous request.
 217  *
 218  * To ensure the timer doesn't expire before the specified delay elapses,
 219  * the amount of delay is rounded up when converting to the jiffies
 220  * then an additional jiffy is added to account for the fact that
 221  * the starting time may be in the middle of the current jiffy.
 222  */
 223
 224 static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
 225 {
 226         mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
 227 }
 228
 229 /**
 230  * k_cancel_timer - cancel a timer
 231  * @timer: pointer to timer structure
 232  *
 233  * Cancels a previously initialized timer.
 234  * Can be called safely even if the timer is already inactive.
 235  *
 236  * WARNING: Must not be called when holding locks required by the timer's
 237  *          timeout routine, otherwise deadlock can occur on SMP systems!
 238  */
 239
 240 static inline void k_cancel_timer(struct timer_list *timer)
 241 {
 242         del_timer_sync(timer);
 243 }
 244
 245 /**
 246  * k_term_timer - terminate a timer
 247  * @timer: pointer to timer structure
 248  *
 249  * Prevents further use of a previously initialized timer.
 250  *
 251  * WARNING: Caller must ensure timer isn't currently running.
 252  *
 253  * (Do not "enhance" this routine to automatically cancel an active timer,
 254  * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
 255  */
 256
 257 static inline void k_term_timer(struct timer_list *timer)
 258 {
 259 }
 260
 261
 262 /*
 263  * TIPC message buffer code
 264  *
 265  * TIPC message buffer headroom reserves space for the worst-case
 266  * link-level device header (in case the message is sent off-node).
 267  *
 268  * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
 269  *       are word aligned for quicker access
 270  */
 271
 272 #define BUF_HEADROOM LL_MAX_HEADER
 273
 274 struct tipc_skb_cb {
 275         void *handle;
 276 };
 277
 278 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
 279
 280
 281 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
 282 {
 283         return (struct tipc_msg *)skb->data;
 284 }
 285
 286 extern struct sk_buff *tipc_buf_acquire(u32 size);
 287
 288 /**
 289  * buf_discard - frees a TIPC message buffer
 290  * @skb: message buffer
 291  *
 292  * Frees a message buffer.  If passed NULL, just returns.
 293  */
 294
 295 static inline void buf_discard(struct sk_buff *skb)
 296 {
 297         kfree_skb(skb);
 298 }
 299
 300 /**
 301  * buf_linearize - convert a TIPC message buffer into a single contiguous piece
 302  * @skb: message buffer
 303  *
 304  * Returns 0 on success.
 305  */
 306
 307 static inline int buf_linearize(struct sk_buff *skb)
 308 {
 309         return skb_linearize(skb);
 310 }
 311
 312 #endif