net/tipc/core.h

   1 /*
   2  * net/tipc/core.h: Include file for TIPC global declarations
   3  *
   4  * Copyright (c) 2005-2006, 2013 Ericsson AB
   5  * Copyright (c) 2005-2007, 2010-2013, 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 <linux/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 #include <linux/rtnetlink.h>
  60 #include <linux/etherdevice.h>
  61
  62 #define TIPC_MOD_VER "2.0.0"
  63
  64 #define ULTRA_STRING_MAX_LEN    32768
  65 #define TIPC_MAX_SUBSCRIPTIONS  65535
  66 #define TIPC_MAX_PUBLICATIONS   65535
  67
  68 struct tipc_msg;        /* msg.h */
  69
  70 int tipc_snprintf(char *buf, int len, const char *fmt, ...);
  71
  72 /*
  73  * TIPC-specific error codes
  74  */
  75 #define ELINKCONG EAGAIN        /* link congestion <=> resource unavailable */
  76
  77 /*
  78  * Global configuration variables
  79  */
  80 extern u32 tipc_own_addr __read_mostly;
  81 extern int tipc_max_ports __read_mostly;
  82 extern int tipc_net_id __read_mostly;
  83 extern int sysctl_tipc_rmem[3] __read_mostly;
  84 extern int sysctl_tipc_named_timeout __read_mostly;
  85
  86 /*
  87  * Other global variables
  88  */
  89 extern int tipc_random __read_mostly;
  90
  91 /*
  92  * Routines available to privileged subsystems
  93  */
  94 int tipc_netlink_start(void);
  95 void tipc_netlink_stop(void);
  96 int tipc_socket_init(void);
  97 void tipc_socket_stop(void);
  98 int tipc_sock_create_local(int type, struct socket **res);
  99 void tipc_sock_release_local(struct socket *sock);
 100 int tipc_sock_accept_local(struct socket *sock, struct socket **newsock,
 101                            int flags);
 102
 103 #ifdef CONFIG_SYSCTL
 104 int tipc_register_sysctl(void);
 105 void tipc_unregister_sysctl(void);
 106 #else
 107 #define tipc_register_sysctl() 0
 108 #define tipc_unregister_sysctl()
 109 #endif
 110
 111 /*
 112  * TIPC timer code
 113  */
 114 typedef void (*Handler) (unsigned long);
 115
 116 /**
 117  * k_init_timer - initialize a timer
 118  * @timer: pointer to timer structure
 119  * @routine: pointer to routine to invoke when timer expires
 120  * @argument: value to pass to routine when timer expires
 121  *
 122  * Timer must be initialized before use (and terminated when no longer needed).
 123  */
 124 static inline void k_init_timer(struct timer_list *timer, Handler routine,
 125                                 unsigned long argument)
 126 {
 127         setup_timer(timer, routine, argument);
 128 }
 129
 130 /**
 131  * k_start_timer - start a timer
 132  * @timer: pointer to timer structure
 133  * @msec: time to delay (in ms)
 134  *
 135  * Schedules a previously initialized timer for later execution.
 136  * If timer is already running, the new timeout overrides the previous request.
 137  *
 138  * To ensure the timer doesn't expire before the specified delay elapses,
 139  * the amount of delay is rounded up when converting to the jiffies
 140  * then an additional jiffy is added to account for the fact that
 141  * the starting time may be in the middle of the current jiffy.
 142  */
 143 static inline void k_start_timer(struct timer_list *timer, unsigned long msec)
 144 {
 145         mod_timer(timer, jiffies + msecs_to_jiffies(msec) + 1);
 146 }
 147
 148 /**
 149  * k_cancel_timer - cancel a timer
 150  * @timer: pointer to timer structure
 151  *
 152  * Cancels a previously initialized timer.
 153  * Can be called safely even if the timer is already inactive.
 154  *
 155  * WARNING: Must not be called when holding locks required by the timer's
 156  *          timeout routine, otherwise deadlock can occur on SMP systems!
 157  */
 158 static inline void k_cancel_timer(struct timer_list *timer)
 159 {
 160         del_timer_sync(timer);
 161 }
 162
 163 /**
 164  * k_term_timer - terminate a timer
 165  * @timer: pointer to timer structure
 166  *
 167  * Prevents further use of a previously initialized timer.
 168  *
 169  * WARNING: Caller must ensure timer isn't currently running.
 170  *
 171  * (Do not "enhance" this routine to automatically cancel an active timer,
 172  * otherwise deadlock can arise when a timeout routine calls k_term_timer.)
 173  */
 174 static inline void k_term_timer(struct timer_list *timer)
 175 {
 176 }
 177
 178 /*
 179  * TIPC message buffer code
 180  *
 181  * TIPC message buffer headroom reserves space for the worst-case
 182  * link-level device header (in case the message is sent off-node).
 183  *
 184  * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
 185  *       are word aligned for quicker access
 186  */
 187 #define BUF_HEADROOM LL_MAX_HEADER
 188
 189 struct tipc_skb_cb {
 190         void *handle;
 191         struct sk_buff *tail;
 192         bool deferred;
 193         bool wakeup_pending;
 194         u16 chain_sz;
 195         u16 chain_imp;
 196 };
 197
 198 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
 199
 200 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
 201 {
 202         return (struct tipc_msg *)skb->data;
 203 }
 204
 205 struct sk_buff *tipc_buf_acquire(u32 size);
 206
 207 #endif