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