core.h 9.6 KB

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