2 * Copyright (c) 2004, 2005 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
4 * Copyright (c) 2004 Voltaire, Inc. All rights reserved.
6 * This software is available to you under a choice of one of two
7 * licenses. You may choose to be licensed under the terms of the GNU
8 * General Public License (GPL) Version 2, available from the file
9 * COPYING in the main directory of this source tree, or the
10 * OpenIB.org BSD license below:
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
16 * - Redistributions of source code must retain the above
17 * copyright notice, this list of conditions and the following
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials
23 * provided with the distribution.
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
34 * $Id: ipoib.h 1358 2004-12-17 22:00:11Z roland $
40 #include <linux/list.h>
41 #include <linux/skbuff.h>
42 #include <linux/netdevice.h>
43 #include <linux/workqueue.h>
44 #include <linux/kref.h>
45 #include <linux/if_infiniband.h>
46 #include <linux/mutex.h>
48 #include <net/neighbour.h>
50 #include <asm/atomic.h>
52 #include <rdma/ib_verbs.h>
53 #include <rdma/ib_pack.h>
54 #include <rdma/ib_sa.h>
61 IPOIB_UD_HEAD_SIZE = IB_GRH_BYTES + IPOIB_ENCAP_LEN,
62 IPOIB_UD_RX_SG = 2, /* max buffer needed for 4K mtu */
64 IPOIB_CM_MTU = 0x10000 - 0x10, /* padding to align header to 16 */
65 IPOIB_CM_BUF_SIZE = IPOIB_CM_MTU + IPOIB_ENCAP_LEN,
66 IPOIB_CM_HEAD_SIZE = IPOIB_CM_BUF_SIZE % PAGE_SIZE,
67 IPOIB_CM_RX_SG = ALIGN(IPOIB_CM_BUF_SIZE, PAGE_SIZE) / PAGE_SIZE,
68 IPOIB_RX_RING_SIZE = 128,
69 IPOIB_TX_RING_SIZE = 64,
70 IPOIB_MAX_QUEUE_SIZE = 8192,
71 IPOIB_MIN_QUEUE_SIZE = 2,
72 IPOIB_CM_MAX_CONN_QP = 4096,
76 IPOIB_MAX_PATH_REC_QUEUE = 3,
77 IPOIB_MAX_MCAST_QUEUE = 3,
79 IPOIB_FLAG_OPER_UP = 0,
80 IPOIB_FLAG_INITIALIZED = 1,
81 IPOIB_FLAG_ADMIN_UP = 2,
82 IPOIB_PKEY_ASSIGNED = 3,
84 IPOIB_FLAG_SUBINTERFACE = 5,
86 IPOIB_STOP_REAPER = 7,
87 IPOIB_MCAST_STARTED = 8,
88 IPOIB_FLAG_ADMIN_CM = 9,
89 IPOIB_FLAG_UMCAST = 10,
92 IPOIB_MAX_BACKOFF_SECONDS = 16,
94 IPOIB_MCAST_FLAG_FOUND = 0, /* used in set_multicast_list */
95 IPOIB_MCAST_FLAG_SENDONLY = 1,
96 IPOIB_MCAST_FLAG_BUSY = 2, /* joining or already joined */
97 IPOIB_MCAST_FLAG_ATTACHED = 3,
100 #define IPOIB_OP_RECV (1ul << 31)
101 #ifdef CONFIG_INFINIBAND_IPOIB_CM
102 #define IPOIB_OP_CM (1ul << 30)
104 #define IPOIB_OP_CM (0)
109 struct ipoib_header {
114 struct ipoib_pseudoheader {
115 u8 hwaddr[INFINIBAND_ALEN];
118 /* Used for all multicast joins (broadcast, IPv4 mcast and IPv6 mcast) */
120 struct ib_sa_mcmember_rec mcmember;
121 struct ib_sa_multicast *mc;
124 struct rb_node rb_node;
125 struct list_head list;
127 unsigned long created;
128 unsigned long backoff;
131 unsigned char logcount;
133 struct list_head neigh_list;
135 struct sk_buff_head pkt_queue;
137 struct net_device *dev;
140 struct ipoib_rx_buf {
142 u64 mapping[IPOIB_UD_RX_SG];
145 struct ipoib_tx_buf {
147 u64 mapping[MAX_SKB_FRAGS + 1];
152 struct ipoib_cm_data {
153 __be32 qpn; /* High byte MUST be ignored on receive */
158 * Quoting 10.3.1 Queue Pair and EE Context States:
160 * Note, for QPs that are associated with an SRQ, the Consumer should take the
161 * QP through the Error State before invoking a Destroy QP or a Modify QP to the
162 * Reset State. The Consumer may invoke the Destroy QP without first performing
163 * a Modify QP to the Error State and waiting for the Affiliated Asynchronous
164 * Last WQE Reached Event. However, if the Consumer does not wait for the
165 * Affiliated Asynchronous Last WQE Reached Event, then WQE and Data Segment
166 * leakage may occur. Therefore, it is good programming practice to tear down a
167 * QP that is associated with an SRQ by using the following process:
169 * - Put the QP in the Error State
170 * - Wait for the Affiliated Asynchronous Last WQE Reached Event;
172 * drain the CQ by invoking the Poll CQ verb and either wait for CQ
173 * to be empty or the number of Poll CQ operations has exceeded
176 * post another WR that completes on the same CQ and wait for this
177 * WR to return as a WC;
178 * - and then invoke a Destroy QP or Reset QP.
180 * We use the second option and wait for a completion on the
181 * same CQ before destroying QPs attached to our SRQ.
184 enum ipoib_cm_state {
186 IPOIB_CM_RX_ERROR, /* Ignored by stale task */
187 IPOIB_CM_RX_FLUSH /* Last WQE Reached event observed */
193 struct ipoib_cm_rx_buf *rx_ring;
194 struct list_head list;
195 struct net_device *dev;
196 unsigned long jiffies;
197 enum ipoib_cm_state state;
204 struct list_head list;
205 struct net_device *dev;
206 struct ipoib_neigh *neigh;
207 struct ipoib_path *path;
208 struct ipoib_tx_buf *tx_ring;
215 struct ipoib_cm_rx_buf {
217 u64 mapping[IPOIB_CM_RX_SG];
220 struct ipoib_cm_dev_priv {
222 struct ipoib_cm_rx_buf *srq_ring;
224 struct list_head passive_ids; /* state: LIVE */
225 struct list_head rx_error_list; /* state: ERROR */
226 struct list_head rx_flush_list; /* state: FLUSH, drain not started */
227 struct list_head rx_drain_list; /* state: FLUSH, drain started */
228 struct list_head rx_reap_list; /* state: FLUSH, drain done */
229 struct work_struct start_task;
230 struct work_struct reap_task;
231 struct work_struct skb_task;
232 struct work_struct rx_reap_task;
233 struct delayed_work stale_task;
234 struct sk_buff_head skb_queue;
235 struct list_head start_list;
236 struct list_head reap_list;
237 struct ib_wc ibwc[IPOIB_NUM_WC];
238 struct ib_sge rx_sge[IPOIB_CM_RX_SG];
239 struct ib_recv_wr rx_wr;
245 struct ipoib_ethtool_st {
247 u16 max_coalesced_frames;
251 * Device private locking: tx_lock protects members used in TX fast
252 * path (and we use LLTX so upper layers don't do extra locking).
253 * lock protects everything else. lock nests inside of tx_lock (ie
254 * tx_lock must be acquired first if needed).
256 struct ipoib_dev_priv {
259 struct net_device *dev;
261 struct napi_struct napi;
265 struct mutex mcast_mutex;
266 struct mutex vlan_mutex;
268 struct rb_root path_tree;
269 struct list_head path_list;
271 struct ipoib_mcast *broadcast;
272 struct list_head multicast_list;
273 struct rb_root multicast_tree;
275 struct delayed_work pkey_poll_task;
276 struct delayed_work mcast_task;
277 struct work_struct flush_task;
278 struct work_struct restart_task;
279 struct delayed_work ah_reap_task;
280 struct work_struct pkey_event_task;
282 struct ib_device *ca;
292 union ib_gid local_gid;
295 unsigned int admin_mtu;
296 unsigned int mcast_mtu;
297 unsigned int max_ib_mtu;
299 struct ipoib_rx_buf *rx_ring;
302 struct ipoib_tx_buf *tx_ring;
305 struct ib_sge tx_sge[MAX_SKB_FRAGS + 1];
306 struct ib_send_wr tx_wr;
307 unsigned tx_outstanding;
309 struct ib_recv_wr rx_wr;
310 struct ib_sge rx_sge[IPOIB_UD_RX_SG];
312 struct ib_wc ibwc[IPOIB_NUM_WC];
314 struct list_head dead_ahs;
316 struct ib_event_handler event_handler;
318 struct net_device *parent;
319 struct list_head child_intfs;
320 struct list_head list;
322 #ifdef CONFIG_INFINIBAND_IPOIB_CM
323 struct ipoib_cm_dev_priv cm;
326 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
327 struct list_head fs_list;
328 struct dentry *mcg_dentry;
329 struct dentry *path_dentry;
332 struct ipoib_ethtool_st ethtool;
336 struct net_device *dev;
338 struct list_head list;
344 struct net_device *dev;
345 struct ib_sa_path_rec pathrec;
347 struct sk_buff_head queue;
349 struct list_head neigh_list;
352 struct ib_sa_query *query;
353 struct completion done;
355 struct rb_node rb_node;
356 struct list_head list;
361 #ifdef CONFIG_INFINIBAND_IPOIB_CM
362 struct ipoib_cm_tx *cm;
365 struct sk_buff_head queue;
367 struct neighbour *neighbour;
368 struct net_device *dev;
370 struct list_head list;
373 #define IPOIB_UD_MTU(ib_mtu) (ib_mtu - IPOIB_ENCAP_LEN)
374 #define IPOIB_UD_BUF_SIZE(ib_mtu) (ib_mtu + IB_GRH_BYTES)
376 static inline int ipoib_ud_need_sg(unsigned int ib_mtu)
378 return IPOIB_UD_BUF_SIZE(ib_mtu) > PAGE_SIZE;
382 * We stash a pointer to our private neighbour information after our
383 * hardware address in neigh->ha. The ALIGN() expression here makes
384 * sure that this pointer is stored aligned so that an unaligned
385 * load is not needed to dereference it.
387 static inline struct ipoib_neigh **to_ipoib_neigh(struct neighbour *neigh)
389 return (void*) neigh + ALIGN(offsetof(struct neighbour, ha) +
390 INFINIBAND_ALEN, sizeof(void *));
393 struct ipoib_neigh *ipoib_neigh_alloc(struct neighbour *neigh,
394 struct net_device *dev);
395 void ipoib_neigh_free(struct net_device *dev, struct ipoib_neigh *neigh);
397 extern struct workqueue_struct *ipoib_workqueue;
401 int ipoib_poll(struct napi_struct *napi, int budget);
402 void ipoib_ib_completion(struct ib_cq *cq, void *dev_ptr);
404 struct ipoib_ah *ipoib_create_ah(struct net_device *dev,
405 struct ib_pd *pd, struct ib_ah_attr *attr);
406 void ipoib_free_ah(struct kref *kref);
407 static inline void ipoib_put_ah(struct ipoib_ah *ah)
409 kref_put(&ah->ref, ipoib_free_ah);
412 int ipoib_open(struct net_device *dev);
413 int ipoib_add_pkey_attr(struct net_device *dev);
414 int ipoib_add_umcast_attr(struct net_device *dev);
416 void ipoib_send(struct net_device *dev, struct sk_buff *skb,
417 struct ipoib_ah *address, u32 qpn);
418 void ipoib_reap_ah(struct work_struct *work);
420 void ipoib_flush_paths(struct net_device *dev);
421 struct ipoib_dev_priv *ipoib_intf_alloc(const char *format);
423 int ipoib_ib_dev_init(struct net_device *dev, struct ib_device *ca, int port);
424 void ipoib_ib_dev_flush(struct work_struct *work);
425 void ipoib_pkey_event(struct work_struct *work);
426 void ipoib_ib_dev_cleanup(struct net_device *dev);
428 int ipoib_ib_dev_open(struct net_device *dev);
429 int ipoib_ib_dev_up(struct net_device *dev);
430 int ipoib_ib_dev_down(struct net_device *dev, int flush);
431 int ipoib_ib_dev_stop(struct net_device *dev, int flush);
433 int ipoib_dev_init(struct net_device *dev, struct ib_device *ca, int port);
434 void ipoib_dev_cleanup(struct net_device *dev);
436 void ipoib_mcast_join_task(struct work_struct *work);
437 void ipoib_mcast_send(struct net_device *dev, void *mgid, struct sk_buff *skb);
439 void ipoib_mcast_restart_task(struct work_struct *work);
440 int ipoib_mcast_start_thread(struct net_device *dev);
441 int ipoib_mcast_stop_thread(struct net_device *dev, int flush);
443 void ipoib_mcast_dev_down(struct net_device *dev);
444 void ipoib_mcast_dev_flush(struct net_device *dev);
446 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
447 struct ipoib_mcast_iter *ipoib_mcast_iter_init(struct net_device *dev);
448 int ipoib_mcast_iter_next(struct ipoib_mcast_iter *iter);
449 void ipoib_mcast_iter_read(struct ipoib_mcast_iter *iter,
451 unsigned long *created,
452 unsigned int *queuelen,
453 unsigned int *complete,
454 unsigned int *send_only);
456 struct ipoib_path_iter *ipoib_path_iter_init(struct net_device *dev);
457 int ipoib_path_iter_next(struct ipoib_path_iter *iter);
458 void ipoib_path_iter_read(struct ipoib_path_iter *iter,
459 struct ipoib_path *path);
462 int ipoib_mcast_attach(struct net_device *dev, u16 mlid,
464 int ipoib_mcast_detach(struct net_device *dev, u16 mlid,
467 int ipoib_init_qp(struct net_device *dev);
468 int ipoib_transport_dev_init(struct net_device *dev, struct ib_device *ca);
469 void ipoib_transport_dev_cleanup(struct net_device *dev);
471 void ipoib_event(struct ib_event_handler *handler,
472 struct ib_event *record);
474 int ipoib_vlan_add(struct net_device *pdev, unsigned short pkey);
475 int ipoib_vlan_delete(struct net_device *pdev, unsigned short pkey);
477 void ipoib_pkey_poll(struct work_struct *work);
478 int ipoib_pkey_dev_delay_open(struct net_device *dev);
479 void ipoib_drain_cq(struct net_device *dev);
481 void ipoib_set_ethtool_ops(struct net_device *dev);
483 #ifdef CONFIG_INFINIBAND_IPOIB_CM
485 #define IPOIB_FLAGS_RC 0x80
486 #define IPOIB_FLAGS_UC 0x40
488 /* We don't support UC connections at the moment */
489 #define IPOIB_CM_SUPPORTED(ha) (ha[0] & (IPOIB_FLAGS_RC))
491 extern int ipoib_max_conn_qp;
493 static inline int ipoib_cm_admin_enabled(struct net_device *dev)
495 struct ipoib_dev_priv *priv = netdev_priv(dev);
496 return IPOIB_CM_SUPPORTED(dev->dev_addr) &&
497 test_bit(IPOIB_FLAG_ADMIN_CM, &priv->flags);
500 static inline int ipoib_cm_enabled(struct net_device *dev, struct neighbour *n)
502 struct ipoib_dev_priv *priv = netdev_priv(dev);
503 return IPOIB_CM_SUPPORTED(n->ha) &&
504 test_bit(IPOIB_FLAG_ADMIN_CM, &priv->flags);
507 static inline int ipoib_cm_up(struct ipoib_neigh *neigh)
510 return test_bit(IPOIB_FLAG_OPER_UP, &neigh->cm->flags);
513 static inline struct ipoib_cm_tx *ipoib_cm_get(struct ipoib_neigh *neigh)
518 static inline void ipoib_cm_set(struct ipoib_neigh *neigh, struct ipoib_cm_tx *tx)
523 static inline int ipoib_cm_has_srq(struct net_device *dev)
525 struct ipoib_dev_priv *priv = netdev_priv(dev);
526 return !!priv->cm.srq;
529 static inline unsigned int ipoib_cm_max_mtu(struct net_device *dev)
531 struct ipoib_dev_priv *priv = netdev_priv(dev);
532 return priv->cm.max_cm_mtu;
535 void ipoib_cm_send(struct net_device *dev, struct sk_buff *skb, struct ipoib_cm_tx *tx);
536 int ipoib_cm_dev_open(struct net_device *dev);
537 void ipoib_cm_dev_stop(struct net_device *dev);
538 int ipoib_cm_dev_init(struct net_device *dev);
539 int ipoib_cm_add_mode_attr(struct net_device *dev);
540 void ipoib_cm_dev_cleanup(struct net_device *dev);
541 struct ipoib_cm_tx *ipoib_cm_create_tx(struct net_device *dev, struct ipoib_path *path,
542 struct ipoib_neigh *neigh);
543 void ipoib_cm_destroy_tx(struct ipoib_cm_tx *tx);
544 void ipoib_cm_skb_too_long(struct net_device *dev, struct sk_buff *skb,
546 void ipoib_cm_handle_rx_wc(struct net_device *dev, struct ib_wc *wc);
547 void ipoib_cm_handle_tx_wc(struct net_device *dev, struct ib_wc *wc);
552 #define ipoib_max_conn_qp 0
554 static inline int ipoib_cm_admin_enabled(struct net_device *dev)
558 static inline int ipoib_cm_enabled(struct net_device *dev, struct neighbour *n)
564 static inline int ipoib_cm_up(struct ipoib_neigh *neigh)
570 static inline struct ipoib_cm_tx *ipoib_cm_get(struct ipoib_neigh *neigh)
575 static inline void ipoib_cm_set(struct ipoib_neigh *neigh, struct ipoib_cm_tx *tx)
579 static inline int ipoib_cm_has_srq(struct net_device *dev)
584 static inline unsigned int ipoib_cm_max_mtu(struct net_device *dev)
590 void ipoib_cm_send(struct net_device *dev, struct sk_buff *skb, struct ipoib_cm_tx *tx)
596 int ipoib_cm_dev_open(struct net_device *dev)
602 void ipoib_cm_dev_stop(struct net_device *dev)
608 int ipoib_cm_dev_init(struct net_device *dev)
614 void ipoib_cm_dev_cleanup(struct net_device *dev)
620 struct ipoib_cm_tx *ipoib_cm_create_tx(struct net_device *dev, struct ipoib_path *path,
621 struct ipoib_neigh *neigh)
627 void ipoib_cm_destroy_tx(struct ipoib_cm_tx *tx)
633 int ipoib_cm_add_mode_attr(struct net_device *dev)
638 static inline void ipoib_cm_skb_too_long(struct net_device *dev, struct sk_buff *skb,
641 dev_kfree_skb_any(skb);
644 static inline void ipoib_cm_handle_rx_wc(struct net_device *dev, struct ib_wc *wc)
648 static inline void ipoib_cm_handle_tx_wc(struct net_device *dev, struct ib_wc *wc)
653 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
654 void ipoib_create_debug_files(struct net_device *dev);
655 void ipoib_delete_debug_files(struct net_device *dev);
656 int ipoib_register_debugfs(void);
657 void ipoib_unregister_debugfs(void);
659 static inline void ipoib_create_debug_files(struct net_device *dev) { }
660 static inline void ipoib_delete_debug_files(struct net_device *dev) { }
661 static inline int ipoib_register_debugfs(void) { return 0; }
662 static inline void ipoib_unregister_debugfs(void) { }
666 #define ipoib_printk(level, priv, format, arg...) \
667 printk(level "%s: " format, ((struct ipoib_dev_priv *) priv)->dev->name , ## arg)
668 #define ipoib_warn(priv, format, arg...) \
669 ipoib_printk(KERN_WARNING, priv, format , ## arg)
671 extern int ipoib_sendq_size;
672 extern int ipoib_recvq_size;
674 extern struct ib_sa_client ipoib_sa_client;
676 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
677 extern int ipoib_debug_level;
679 #define ipoib_dbg(priv, format, arg...) \
681 if (ipoib_debug_level > 0) \
682 ipoib_printk(KERN_DEBUG, priv, format , ## arg); \
684 #define ipoib_dbg_mcast(priv, format, arg...) \
686 if (mcast_debug_level > 0) \
687 ipoib_printk(KERN_DEBUG, priv, format , ## arg); \
689 #else /* CONFIG_INFINIBAND_IPOIB_DEBUG */
690 #define ipoib_dbg(priv, format, arg...) \
691 do { (void) (priv); } while (0)
692 #define ipoib_dbg_mcast(priv, format, arg...) \
693 do { (void) (priv); } while (0)
694 #endif /* CONFIG_INFINIBAND_IPOIB_DEBUG */
696 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG_DATA
697 #define ipoib_dbg_data(priv, format, arg...) \
699 if (data_debug_level > 0) \
700 ipoib_printk(KERN_DEBUG, priv, format , ## arg); \
702 #else /* CONFIG_INFINIBAND_IPOIB_DEBUG_DATA */
703 #define ipoib_dbg_data(priv, format, arg...) \
704 do { (void) (priv); } while (0)
705 #endif /* CONFIG_INFINIBAND_IPOIB_DEBUG_DATA */
708 #define IPOIB_GID_FMT "%2.2x%2.2x:%2.2x%2.2x:%2.2x%2.2x:%2.2x%2.2x:" \
709 "%2.2x%2.2x:%2.2x%2.2x:%2.2x%2.2x:%2.2x%2.2x"
711 #define IPOIB_GID_RAW_ARG(gid) ((u8 *)(gid))[0], \
728 #define IPOIB_GID_ARG(gid) IPOIB_GID_RAW_ARG((gid).raw)
730 #define IPOIB_QPN(ha) (be32_to_cpup((__be32 *) ha) & 0xffffff)
732 #endif /* _IPOIB_H */