vport.h 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2007-2012 Nicira, Inc.
  4. */
  5. #ifndef VPORT_H
  6. #define VPORT_H 1
  7. #include <linux/if_tunnel.h>
  8. #include <linux/list.h>
  9. #include <linux/netlink.h>
  10. #include <linux/openvswitch.h>
  11. #include <linux/reciprocal_div.h>
  12. #include <linux/skbuff.h>
  13. #include <linux/spinlock.h>
  14. #include <linux/u64_stats_sync.h>
  15. #include "datapath.h"
  16. struct vport;
  17. struct vport_parms;
  18. /* The following definitions are for users of the vport subsytem: */
  19. int ovs_vport_init(void);
  20. void ovs_vport_exit(void);
  21. struct vport *ovs_vport_add(const struct vport_parms *);
  22. void ovs_vport_del(struct vport *);
  23. struct vport *ovs_vport_locate(const struct net *net, const char *name);
  24. void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
  25. int ovs_vport_set_options(struct vport *, struct nlattr *options);
  26. int ovs_vport_get_options(const struct vport *, struct sk_buff *);
  27. int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids);
  28. int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *);
  29. u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *);
  30. /**
  31. * struct vport_portids - array of netlink portids of a vport.
  32. * must be protected by rcu.
  33. * @rn_ids: The reciprocal value of @n_ids.
  34. * @rcu: RCU callback head for deferred destruction.
  35. * @n_ids: Size of @ids array.
  36. * @ids: Array storing the Netlink socket pids to be used for packets received
  37. * on this port that miss the flow table.
  38. */
  39. struct vport_portids {
  40. struct reciprocal_value rn_ids;
  41. struct rcu_head rcu;
  42. u32 n_ids;
  43. u32 ids[];
  44. };
  45. /**
  46. * struct vport - one port within a datapath
  47. * @dev: Pointer to net_device.
  48. * @dp: Datapath to which this port belongs.
  49. * @upcall_portids: RCU protected 'struct vport_portids'.
  50. * @port_no: Index into @dp's @ports array.
  51. * @hash_node: Element in @dev_table hash table in vport.c.
  52. * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
  53. * @ops: Class structure.
  54. * @detach_list: list used for detaching vport in net-exit call.
  55. * @rcu: RCU callback head for deferred destruction.
  56. */
  57. struct vport {
  58. struct net_device *dev;
  59. struct datapath *dp;
  60. struct vport_portids __rcu *upcall_portids;
  61. u16 port_no;
  62. struct hlist_node hash_node;
  63. struct hlist_node dp_hash_node;
  64. const struct vport_ops *ops;
  65. struct list_head detach_list;
  66. struct rcu_head rcu;
  67. };
  68. /**
  69. * struct vport_parms - parameters for creating a new vport
  70. *
  71. * @name: New vport's name.
  72. * @type: New vport's type.
  73. * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
  74. * none was supplied.
  75. * @dp: New vport's datapath.
  76. * @port_no: New vport's port number.
  77. */
  78. struct vport_parms {
  79. const char *name;
  80. enum ovs_vport_type type;
  81. struct nlattr *options;
  82. /* For ovs_vport_alloc(). */
  83. struct datapath *dp;
  84. u16 port_no;
  85. struct nlattr *upcall_portids;
  86. };
  87. /**
  88. * struct vport_ops - definition of a type of virtual port
  89. *
  90. * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
  91. * @create: Create a new vport configured as specified. On success returns
  92. * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
  93. * @destroy: Destroys a vport. Must call vport_free() on the vport but not
  94. * before an RCU grace period has elapsed.
  95. * @set_options: Modify the configuration of an existing vport. May be %NULL
  96. * if modification is not supported.
  97. * @get_options: Appends vport-specific attributes for the configuration of an
  98. * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
  99. * have any configuration.
  100. * @send: Send a packet on the device.
  101. * zero for dropped packets or negative for error.
  102. */
  103. struct vport_ops {
  104. enum ovs_vport_type type;
  105. /* Called with ovs_mutex. */
  106. struct vport *(*create)(const struct vport_parms *);
  107. void (*destroy)(struct vport *);
  108. int (*set_options)(struct vport *, struct nlattr *);
  109. int (*get_options)(const struct vport *, struct sk_buff *);
  110. netdev_tx_t (*send) (struct sk_buff *skb);
  111. struct module *owner;
  112. struct list_head list;
  113. };
  114. struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
  115. const struct vport_parms *);
  116. void ovs_vport_free(struct vport *);
  117. #define VPORT_ALIGN 8
  118. /**
  119. * vport_priv - access private data area of vport
  120. *
  121. * @vport: vport to access
  122. *
  123. * If a nonzero size was passed in priv_size of vport_alloc() a private data
  124. * area was allocated on creation. This allows that area to be accessed and
  125. * used for any purpose needed by the vport implementer.
  126. */
  127. static inline void *vport_priv(const struct vport *vport)
  128. {
  129. return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
  130. }
  131. /**
  132. * vport_from_priv - lookup vport from private data pointer
  133. *
  134. * @priv: Start of private data area.
  135. *
  136. * It is sometimes useful to translate from a pointer to the private data
  137. * area to the vport, such as in the case where the private data pointer is
  138. * the result of a hash table lookup. @priv must point to the start of the
  139. * private data area.
  140. */
  141. static inline struct vport *vport_from_priv(void *priv)
  142. {
  143. return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
  144. }
  145. int ovs_vport_receive(struct vport *, struct sk_buff *,
  146. const struct ip_tunnel_info *);
  147. static inline const char *ovs_vport_name(struct vport *vport)
  148. {
  149. return vport->dev->name;
  150. }
  151. int __ovs_vport_ops_register(struct vport_ops *ops);
  152. #define ovs_vport_ops_register(ops) \
  153. ({ \
  154. (ops)->owner = THIS_MODULE; \
  155. __ovs_vport_ops_register(ops); \
  156. })
  157. void ovs_vport_ops_unregister(struct vport_ops *ops);
  158. void ovs_vport_send(struct vport *vport, struct sk_buff *skb, u8 mac_proto);
  159. #endif /* vport.h */