subscr.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. /*
  2. * net/tipc/subscr.h: Include file for TIPC network topology service
  3. *
  4. * Copyright (c) 2003-2017, Ericsson AB
  5. * Copyright (c) 2005-2007, 2012-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. #ifndef _TIPC_SUBSCR_H
  37. #define _TIPC_SUBSCR_H
  38. #include "topsrv.h"
  39. #define TIPC_MAX_SUBSCR 65535
  40. #define TIPC_MAX_PUBL 65535
  41. struct tipc_subscription;
  42. struct tipc_conn;
  43. /**
  44. * struct tipc_subscription - TIPC network topology subscription object
  45. * @subscriber: pointer to its subscriber
  46. * @seq: name sequence associated with subscription
  47. * @timer: timer governing subscription duration (optional)
  48. * @nameseq_list: adjacent subscriptions in name sequence's subscription list
  49. * @sub_list: adjacent subscriptions in subscriber's subscription list
  50. * @evt: template for events generated by subscription
  51. */
  52. struct tipc_subscription {
  53. struct kref kref;
  54. struct net *net;
  55. struct timer_list timer;
  56. struct list_head service_list;
  57. struct list_head sub_list;
  58. struct tipc_event evt;
  59. int conid;
  60. bool inactive;
  61. spinlock_t lock; /* serialize up/down and timer events */
  62. };
  63. struct tipc_subscription *tipc_sub_subscribe(struct net *net,
  64. struct tipc_subscr *s,
  65. int conid);
  66. void tipc_sub_unsubscribe(struct tipc_subscription *sub);
  67. int tipc_sub_check_overlap(struct tipc_name_seq *seq, u32 found_lower,
  68. u32 found_upper);
  69. void tipc_sub_report_overlap(struct tipc_subscription *sub,
  70. u32 found_lower, u32 found_upper,
  71. u32 event, u32 port, u32 node,
  72. u32 scope, int must);
  73. int __net_init tipc_topsrv_init_net(struct net *net);
  74. void __net_exit tipc_topsrv_exit_net(struct net *net);
  75. void tipc_sub_put(struct tipc_subscription *subscription);
  76. void tipc_sub_get(struct tipc_subscription *subscription);
  77. #define TIPC_FILTER_MASK (TIPC_SUB_PORTS | TIPC_SUB_SERVICE | TIPC_SUB_CANCEL)
  78. /* tipc_sub_read - return field_ of struct sub_ in host endian format
  79. */
  80. #define tipc_sub_read(sub_, field_) \
  81. ({ \
  82. struct tipc_subscr *sub__ = sub_; \
  83. u32 val__ = (sub__)->field_; \
  84. int swap_ = !((sub__)->filter & TIPC_FILTER_MASK); \
  85. (swap_ ? swab32(val__) : val__); \
  86. })
  87. /* tipc_sub_write - write val_ to field_ of struct sub_ in user endian format
  88. */
  89. #define tipc_sub_write(sub_, field_, val_) \
  90. ({ \
  91. struct tipc_subscr *sub__ = sub_; \
  92. u32 val__ = val_; \
  93. int swap_ = !((sub__)->filter & TIPC_FILTER_MASK); \
  94. (sub__)->field_ = swap_ ? swab32(val__) : val__; \
  95. })
  96. /* tipc_evt_write - write val_ to field_ of struct evt_ in user endian format
  97. */
  98. #define tipc_evt_write(evt_, field_, val_) \
  99. ({ \
  100. struct tipc_event *evt__ = evt_; \
  101. u32 val__ = val_; \
  102. int swap_ = !((evt__)->s.filter & (TIPC_FILTER_MASK)); \
  103. (evt__)->field_ = swap_ ? swab32(val__) : val__; \
  104. })
  105. #endif