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, 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 *TIPC_CONS, *TIPC_LOG;
  69 extern struct print_buf *TIPC_TEE(struct print_buf *, struct print_buf *);
  70 void tipc_msg_print(struct print_buf*,struct tipc_msg *,const char*);
  71 void tipc_printf(struct print_buf *, const char *fmt, ...);
  72 void tipc_dump(struct print_buf*,const char *fmt, ...);
  73
  74 #ifdef CONFIG_TIPC_DEBUG
  75
  76 /*
  77  * TIPC debug support included:
  78  * - system messages are printed to TIPC_OUTPUT print buffer
  79  * - debug messages are printed to DBG_OUTPUT print buffer
  80  */
  81
  82 #define err(fmt, arg...)  tipc_printf(TIPC_OUTPUT, KERN_ERR "TIPC: " fmt, ## arg)
  83 #define warn(fmt, arg...) tipc_printf(TIPC_OUTPUT, KERN_WARNING "TIPC: " fmt, ## arg)
  84 #define info(fmt, arg...) tipc_printf(TIPC_OUTPUT, KERN_NOTICE "TIPC: " fmt, ## arg)
  85
  86 #define dbg(fmt, arg...)  do {if (DBG_OUTPUT) tipc_printf(DBG_OUTPUT, fmt, ## arg);} while(0)
  87 #define msg_dbg(msg, txt) do {if (DBG_OUTPUT) tipc_msg_print(DBG_OUTPUT, msg, txt);} while(0)
  88 #define dump(fmt, arg...) do {if (DBG_OUTPUT) tipc_dump(DBG_OUTPUT, fmt, ##arg);} while(0)
  89
  90
  91 /*
  92  * By default, TIPC_OUTPUT is defined to be system console and TIPC log buffer,
  93  * while DBG_OUTPUT is the null print buffer.  These defaults can be changed
  94  * here, or on a per .c file basis, by redefining these symbols.  The following
  95  * print buffer options are available:
  96  *
  97  * NULL                         : Output to null print buffer (i.e. print nowhere)
  98  * TIPC_CONS                    : Output to system console
  99  * TIPC_LOG                     : Output to TIPC log buffer
 100  * &buf                         : Output to user-defined buffer (struct print_buf *)
 101  * TIPC_TEE(&buf_a,&buf_b)      : Output to two print buffers (eg. TIPC_TEE(TIPC_CONS,TIPC_LOG) )
 102  */
 103
 104 #ifndef TIPC_OUTPUT
 105 #define TIPC_OUTPUT TIPC_TEE(TIPC_CONS,TIPC_LOG)
 106 #endif
 107
 108 #ifndef DBG_OUTPUT
 109 #define DBG_OUTPUT NULL
 110 #endif
 111
 112 #else
 113
 114 #ifndef DBG_OUTPUT
 115 #define DBG_OUTPUT NULL
 116 #endif
 117
 118 /*
 119  * TIPC debug support not included:
 120  * - system messages are printed to system console
 121  * - debug messages are not printed
 122  */
 123
 124 #define err(fmt, arg...)  printk(KERN_ERR "TIPC: " fmt , ## arg)
 125 #define info(fmt, arg...) printk(KERN_INFO "TIPC: " fmt , ## arg)
 126 #define warn(fmt, arg...) printk(KERN_WARNING "TIPC: " fmt , ## arg)
 127
 128 #define dbg(fmt, arg...) do {} while (0)
 129 #define msg_dbg(msg,txt) do {} while (0)
 130 #define dump(fmt,arg...) do {} while (0)
 131
 132 #endif
 133
 134
 135 /*
 136  * TIPC-specific error codes
 137  */
 138
 139 #define ELINKCONG EAGAIN        /* link congestion <=> resource unavailable */
 140
 141 /*
 142  * Global configuration variables
 143  */
 144
 145 extern u32 tipc_own_addr;
 146 extern int tipc_max_zones;
 147 extern int tipc_max_clusters;
 148 extern int tipc_max_nodes;
 149 extern int tipc_max_slaves;
 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 extern atomic_t tipc_user_count;
 164
 165
 166 /*
 167  * Routines available to privileged subsystems
 168  */
 169
 170 extern int  tipc_core_start(void);
 171 extern void tipc_core_stop(void);
 172 extern int  tipc_core_start_net(void);
 173 extern void tipc_core_stop_net(void);
 174
 175 static inline int delimit(int val, int min, int max)
 176 {
 177         if (val > max)
 178                 return max;
 179         if (val < min)
 180                 return min;
 181         return val;
 182 }
 183
 184
 185 /*
 186  * TIPC timer and signal code
 187  */
 188
 189 typedef void (*Handler) (unsigned long);
 190
 191 u32 tipc_k_signal(Handler routine, unsigned long argument);
 192
 193 /**
 194  * k_init_timer - initialize a timer
 195  * @timer: pointer to timer structure
 196  * @routine: pointer to routine to invoke when timer expires
 197  * @argument: value to pass to routine when timer expires
 198  *
 199  * Timer must be initialized before use (and terminated when no longer needed).
 200  */
 201
 202 static inline void k_init_timer(struct timer_list *timer, Handler routine,
 203                                 unsigned long argument)
 204 {
 205         dbg("initializing timer %p\n", timer);
 206         init_timer(timer);
 207         timer->function = routine;
 208         timer->data = argument;
 209 }
 210
 211 /**
 212  * k_start_timer - start a timer
 213  * @timer: pointer to timer structure
 214  * @msec: time to delay (in ms)
 215  *
 216  * Schedules a previously initialized timer for later execution.
 217  * If timer is already running, the new timeout overrides the previous request.
 218  *
 219  * To ensure the timer doesn't expire before the specified delay elapses,
 220  * the amount of delay is rounded up when converting to the jiffies
 221  * then an additional jiffy is added to account for the fact that
 222  * the starting time may be in the middle of the current jiffy.
 223  */
 224
 225 static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
 226 {
 227         dbg("starting timer %p for %u\n", timer, msec);
 228         mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
 229 }
 230
 231 /**
 232  * k_cancel_timer - cancel a timer
 233  * @timer: pointer to timer structure
 234  *
 235  * Cancels a previously initialized timer.
 236  * Can be called safely even if the timer is already inactive.
 237  *
 238  * WARNING: Must not be called when holding locks required by the timer's
 239  *          timeout routine, otherwise deadlock can occur on SMP systems!
 240  */
 241
 242 static inline void k_cancel_timer(struct timer_list *timer)
 243 {
 244         dbg("cancelling timer %p\n", timer);
 245         del_timer_sync(timer);
 246 }
 247
 248 /**
 249  * k_term_timer - terminate a timer
 250  * @timer: pointer to timer structure
 251  *
 252  * Prevents further use of a previously initialized timer.
 253  *
 254  * WARNING: Caller must ensure timer isn't currently running.
 255  *
 256  * (Do not "enhance" this routine to automatically cancel an active timer,
 257  * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
 258  */
 259
 260 static inline void k_term_timer(struct timer_list *timer)
 261 {
 262         dbg("terminating timer %p\n", timer);
 263 }
 264
 265
 266 /*
 267  * TIPC message buffer code
 268  *
 269  * TIPC message buffer headroom leaves room for 14 byte Ethernet header,
 270  * while ensuring TIPC header is word aligned for quicker access
 271  */
 272
 273 #define BUF_HEADROOM 16u
 274
 275 struct tipc_skb_cb {
 276         void *handle;
 277 };
 278
 279 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
 280
 281
 282 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
 283 {
 284         return (struct tipc_msg *)skb->data;
 285 }
 286
 287 /**
 288  * buf_acquire - creates a TIPC message buffer
 289  * @size: message size (including TIPC header)
 290  *
 291  * Returns a new buffer.  Space is reserved for a data link header.
 292  */
 293
 294 static inline struct sk_buff *buf_acquire(u32 size)
 295 {
 296         struct sk_buff *skb;
 297         unsigned int buf_size = (BUF_HEADROOM + size + 3) & ~3u;
 298
 299         skb = alloc_skb(buf_size, GFP_ATOMIC);
 300         if (skb) {
 301                 skb_reserve(skb, BUF_HEADROOM);
 302                 skb_put(skb, size);
 303                 skb->next = NULL;
 304         }
 305         return skb;
 306 }
 307
 308 /**
 309  * buf_discard - frees a TIPC message buffer
 310  * @skb: message buffer
 311  *
 312  * Frees a new buffer.  If passed NULL, just returns.
 313  */
 314
 315 static inline void buf_discard(struct sk_buff *skb)
 316 {
 317         if (likely(skb != NULL))
 318                 kfree_skb(skb);
 319 }
 320
 321 #endif