SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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, 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 <net/tipc/tipc_msg.h>
  43 #include <net/tipc/tipc_port.h>
  44 #include <net/tipc/tipc_bearer.h>
  45 #include <net/tipc/tipc.h>
  46 #include <linux/types.h>
  47 #include <linux/kernel.h>
  48 #include <linux/errno.h>
  49 #include <linux/mm.h>
  50 #include <linux/timer.h>
  51 #include <linux/string.h>
  52 #include <asm/uaccess.h>
  53 #include <linux/interrupt.h>
  54 #include <asm/atomic.h>
  55 #include <asm/hardirq.h>
  56 #include <linux/netdevice.h>
  57 #include <linux/in.h>
  58 #include <linux/list.h>
  59 #include <linux/vmalloc.h>
  60
  61 /*
  62  * TIPC sanity test macros
  63  */
  64
  65 #define assert(i)  BUG_ON(!(i))
  66
  67 /*
  68  * TIPC system monitoring code
  69  */
  70
  71 /*
  72  * TIPC's print buffer subsystem supports the following print buffers:
  73  *
  74  * TIPC_NULL : null buffer (i.e. print nowhere)
  75  * TIPC_CONS : system console
  76  * TIPC_LOG  : TIPC log buffer
  77  * &buf      : user-defined buffer (struct print_buf *)
  78  *
  79  * Note: TIPC_LOG is configured to echo its output to the system console;
  80  *       user-defined buffers can be configured to do the same thing.
  81  */
  82
  83 extern struct print_buf *const TIPC_NULL;
  84 extern struct print_buf *const TIPC_CONS;
  85 extern struct print_buf *const TIPC_LOG;
  86
  87 void tipc_printf(struct print_buf *, const char *fmt, ...);
  88 void tipc_msg_print(struct print_buf *, struct tipc_msg *, const char *);
  89 void tipc_dump(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 /*
 100  * TIPC can be configured to send system messages to TIPC_OUTPUT
 101  * or to the system console only.
 102  */
 103
 104 #ifdef CONFIG_TIPC_DEBUG
 105
 106 #define err(fmt, arg...)  tipc_printf(TIPC_OUTPUT, \
 107                                         KERN_ERR "TIPC: " fmt, ## arg)
 108 #define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
 109                                         KERN_WARNING "TIPC: " fmt, ## arg)
 110 #define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, \
 111                                         KERN_NOTICE "TIPC: " fmt, ## arg)
 112
 113 #else
 114
 115 #define err(fmt, arg...)  printk(KERN_ERR "TIPC: " fmt , ## arg)
 116 #define info(fmt, arg...) printk(KERN_INFO "TIPC: " fmt , ## arg)
 117 #define warn(fmt, arg...) printk(KERN_WARNING "TIPC: " fmt , ## arg)
 118
 119 #endif
 120
 121 /*
 122  * DBG_OUTPUT is the destination print buffer for debug messages.
 123  * It defaults to the the null print buffer, but can be redefined
 124  * (typically in the individual .c files being debugged) to allow
 125  * selected debug messages to be generated where needed.
 126  */
 127
 128 #ifndef DBG_OUTPUT
 129 #define DBG_OUTPUT TIPC_NULL
 130 #endif
 131
 132 /*
 133  * TIPC can be configured to send debug messages to the specified print buffer
 134  * (typically DBG_OUTPUT) or to suppress them entirely.
 135  */
 136
 137 #ifdef CONFIG_TIPC_DEBUG
 138
 139 #define dbg(fmt, arg...)  \
 140         do { \
 141                 if (DBG_OUTPUT != TIPC_NULL) \
 142                         tipc_printf(DBG_OUTPUT, fmt, ## arg); \
 143         } while (0)
 144 #define msg_dbg(msg, txt) \
 145         do { \
 146                 if (DBG_OUTPUT != TIPC_NULL) \
 147                         tipc_msg_print(DBG_OUTPUT, msg, txt); \
 148         } while (0)
 149 #define dump(fmt, arg...) \
 150         do { \
 151                 if (DBG_OUTPUT != TIPC_NULL) \
 152                         tipc_dump(DBG_OUTPUT, fmt, ##arg); \
 153         } while (0)
 154
 155 #else
 156
 157 #define dbg(fmt, arg...)        do {} while (0)
 158 #define msg_dbg(msg, txt)       do {} while (0)
 159 #define dump(fmt, arg...)       do {} while (0)
 160
 161 #endif
 162
 163
 164 /*
 165  * TIPC-specific error codes
 166  */
 167
 168 #define ELINKCONG EAGAIN        /* link congestion <=> resource unavailable */
 169
 170 /*
 171  * Global configuration variables
 172  */
 173
 174 extern u32 tipc_own_addr;
 175 extern int tipc_max_zones;
 176 extern int tipc_max_clusters;
 177 extern int tipc_max_nodes;
 178 extern int tipc_max_slaves;
 179 extern int tipc_max_ports;
 180 extern int tipc_max_subscriptions;
 181 extern int tipc_max_publications;
 182 extern int tipc_net_id;
 183 extern int tipc_remote_management;
 184
 185 /*
 186  * Other global variables
 187  */
 188
 189 extern int tipc_mode;
 190 extern int tipc_random;
 191 extern const char tipc_alphabet[];
 192 extern atomic_t tipc_user_count;
 193
 194
 195 /*
 196  * Routines available to privileged subsystems
 197  */
 198
 199 extern int  tipc_core_start(void);
 200 extern void tipc_core_stop(void);
 201 extern int  tipc_core_start_net(void);
 202 extern void tipc_core_stop_net(void);
 203 extern int  tipc_handler_start(void);
 204 extern void tipc_handler_stop(void);
 205 extern int  tipc_netlink_start(void);
 206 extern void tipc_netlink_stop(void);
 207 extern int  tipc_socket_init(void);
 208 extern void tipc_socket_stop(void);
 209
 210 static inline int delimit(int val, int min, int max)
 211 {
 212         if (val > max)
 213                 return max;
 214         if (val < min)
 215                 return min;
 216         return val;
 217 }
 218
 219
 220 /*
 221  * TIPC timer and signal code
 222  */
 223
 224 typedef void (*Handler) (unsigned long);
 225
 226 u32 tipc_k_signal(Handler routine, unsigned long argument);
 227
 228 /**
 229  * k_init_timer - initialize a timer
 230  * @timer: pointer to timer structure
 231  * @routine: pointer to routine to invoke when timer expires
 232  * @argument: value to pass to routine when timer expires
 233  *
 234  * Timer must be initialized before use (and terminated when no longer needed).
 235  */
 236
 237 static inline void k_init_timer(struct timer_list *timer, Handler routine,
 238                                 unsigned long argument)
 239 {
 240         dbg("initializing timer %p\n", timer);
 241         setup_timer(timer, routine, argument);
 242 }
 243
 244 /**
 245  * k_start_timer - start a timer
 246  * @timer: pointer to timer structure
 247  * @msec: time to delay (in ms)
 248  *
 249  * Schedules a previously initialized timer for later execution.
 250  * If timer is already running, the new timeout overrides the previous request.
 251  *
 252  * To ensure the timer doesn't expire before the specified delay elapses,
 253  * the amount of delay is rounded up when converting to the jiffies
 254  * then an additional jiffy is added to account for the fact that
 255  * the starting time may be in the middle of the current jiffy.
 256  */
 257
 258 static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
 259 {
 260         dbg("starting timer %p for %u\n", timer, msec);
 261         mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
 262 }
 263
 264 /**
 265  * k_cancel_timer - cancel a timer
 266  * @timer: pointer to timer structure
 267  *
 268  * Cancels a previously initialized timer.
 269  * Can be called safely even if the timer is already inactive.
 270  *
 271  * WARNING: Must not be called when holding locks required by the timer's
 272  *          timeout routine, otherwise deadlock can occur on SMP systems!
 273  */
 274
 275 static inline void k_cancel_timer(struct timer_list *timer)
 276 {
 277         dbg("cancelling timer %p\n", timer);
 278         del_timer_sync(timer);
 279 }
 280
 281 /**
 282  * k_term_timer - terminate a timer
 283  * @timer: pointer to timer structure
 284  *
 285  * Prevents further use of a previously initialized timer.
 286  *
 287  * WARNING: Caller must ensure timer isn't currently running.
 288  *
 289  * (Do not "enhance" this routine to automatically cancel an active timer,
 290  * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
 291  */
 292
 293 static inline void k_term_timer(struct timer_list *timer)
 294 {
 295         dbg("terminating timer %p\n", timer);
 296 }
 297
 298
 299 /*
 300  * TIPC message buffer code
 301  *
 302  * TIPC message buffer headroom reserves space for a link-level header
 303  * (in case the message is sent off-node),
 304  * while ensuring TIPC header is word aligned for quicker access
 305  *
 306  * The largest header currently supported is 18 bytes, which is used when
 307  * the standard 14 byte Ethernet header has 4 added bytes for VLAN info
 308  */
 309
 310 #define BUF_HEADROOM 20u
 311
 312 struct tipc_skb_cb {
 313         void *handle;
 314 };
 315
 316 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
 317
 318
 319 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
 320 {
 321         return (struct tipc_msg *)skb->data;
 322 }
 323
 324 /**
 325  * buf_acquire - creates a TIPC message buffer
 326  * @size: message size (including TIPC header)
 327  *
 328  * Returns a new buffer with data pointers set to the specified size.
 329  *
 330  * NOTE: Headroom is reserved to allow prepending of a data link header.
 331  *       There may also be unrequested tailroom present at the buffer's end.
 332  */
 333
 334 static inline struct sk_buff *buf_acquire(u32 size)
 335 {
 336         struct sk_buff *skb;
 337         unsigned int buf_size = (BUF_HEADROOM + size + 3) & ~3u;
 338
 339         skb = alloc_skb_fclone(buf_size, GFP_ATOMIC);
 340         if (skb) {
 341                 skb_reserve(skb, BUF_HEADROOM);
 342                 skb_put(skb, size);
 343                 skb->next = NULL;
 344         }
 345         return skb;
 346 }
 347
 348 /**
 349  * buf_discard - frees a TIPC message buffer
 350  * @skb: message buffer
 351  *
 352  * Frees a message buffer.  If passed NULL, just returns.
 353  */
 354
 355 static inline void buf_discard(struct sk_buff *skb)
 356 {
 357         kfree_skb(skb);
 358 }
 359
 360 /**
 361  * buf_linearize - convert a TIPC message buffer into a single contiguous piece
 362  * @skb: message buffer
 363  *
 364  * Returns 0 on success.
 365  */
 366
 367 static inline int buf_linearize(struct sk_buff *skb)
 368 {
 369         return skb_linearize(skb);
 370 }
 371
 372 #endif