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