IB/mad: Change SMI to use enums rather than magic return codes

Clarify code by changing return values from SMI functions to named
enum values instead of magic 0/1 values.

Signed-off-by: Hal Rosenstock <halr@voltaire.com>
Signed-off-by: Roland Dreier <rolandd@cisco.com>

3 files changed, 82 insertions, 72 deletions

diff --git a/drivers/infiniband/core/mad.c b/drivers/infiniband/core/mad.c
index 13efd4170349..6edfecf1be72 100644
--- a/drivers/infiniband/core/mad.c
+++ b/drivers/infiniband/core/mad.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2004, 2005 Voltaire, Inc. All rights reserved.
+ * Copyright (c) 2004-2007 Voltaire, Inc. All rights reserved.
  * Copyright (c) 2005 Intel Corporation.  All rights reserved.
  * Copyright (c) 2005 Mellanox Technologies Ltd.  All rights reserved.
  *
@@ -31,7 +31,6 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  *
- * $Id: mad.c 5596 2006-03-03 01:00:07Z sean.hefty $
  */
 #include <linux/dma-mapping.h>
 #include <rdma/ib_cache.h>
@@ -668,7 +667,7 @@ static void build_smp_wc(struct ib_qp *qp,
 static int handle_outgoing_dr_smp(struct ib_mad_agent_private *mad_agent_priv,
                                   struct ib_mad_send_wr_private *mad_send_wr)
 {
-        int ret;
+        int ret = 0;
         struct ib_smp *smp = mad_send_wr->send_buf.mad;
         unsigned long flags;
         struct ib_mad_local_private *local;
@@ -688,14 +687,15 @@ static int handle_outgoing_dr_smp(struct ib_mad_agent_private *mad_agent_priv,
          */
         if ((ib_get_smp_direction(smp) ? smp->dr_dlid : smp->dr_slid) ==
              IB_LID_PERMISSIVE &&
-            !smi_handle_dr_smp_send(smp, device->node_type, port_num)) {
+             smi_handle_dr_smp_send(smp, device->node_type, port_num) ==
+             IB_SMI_DISCARD) {
                 ret = -EINVAL;
                 printk(KERN_ERR PFX "Invalid directed route\n");
                 goto out;
         }
+
         /* Check to post send on QP or process locally */
-        ret = smi_check_local_smp(smp, device);
-        if (!ret)
+        if (smi_check_local_smp(smp, device) == IB_SMI_DISCARD)
                 goto out;
 
         local = kmalloc(sizeof *local, GFP_ATOMIC);
@@ -1874,18 +1874,22 @@ static void ib_mad_recv_done_handler(struct ib_mad_port_private *port_priv,
 
         if (recv->mad.mad.mad_hdr.mgmt_class ==
             IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE) {
-                if (!smi_handle_dr_smp_recv(&recv->mad.smp,
-                                            port_priv->device->node_type,
-                                            port_priv->port_num,
-                                            port_priv->device->phys_port_cnt))
+                if (smi_handle_dr_smp_recv(&recv->mad.smp,
+                                           port_priv->device->node_type,
+                                           port_priv->port_num,
+                                           port_priv->device->phys_port_cnt) ==
+                                           IB_SMI_DISCARD)
                         goto out;
-                if (!smi_check_forward_dr_smp(&recv->mad.smp))
+
+                if (smi_check_forward_dr_smp(&recv->mad.smp) == IB_SMI_LOCAL)
                         goto local;
-                if (!smi_handle_dr_smp_send(&recv->mad.smp,
-                                            port_priv->device->node_type,
-                                            port_priv->port_num))
+
+                if (smi_handle_dr_smp_send(&recv->mad.smp,
+                                           port_priv->device->node_type,
+                                           port_priv->port_num) == IB_SMI_DISCARD)
                         goto out;
-                if (!smi_check_local_smp(&recv->mad.smp, port_priv->device))
+
+                if (smi_check_local_smp(&recv->mad.smp, port_priv->device) == IB_SMI_DISCARD)
                         goto out;
         }
 
diff --git a/drivers/infiniband/core/smi.c b/drivers/infiniband/core/smi.c
index 54b81e17ad50..2bca753eb622 100644
--- a/drivers/infiniband/core/smi.c
+++ b/drivers/infiniband/core/smi.c
@@ -3,7 +3,7 @@
  * Copyright (c) 2004, 2005 Infinicon Corporation.  All rights reserved.
  * Copyright (c) 2004, 2005 Intel Corporation.  All rights reserved.
  * Copyright (c) 2004, 2005 Topspin Corporation.  All rights reserved.
- * Copyright (c) 2004, 2005 Voltaire Corporation.  All rights reserved.
+ * Copyright (c) 2004-2007 Voltaire Corporation.  All rights reserved.
  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
  *
  * This software is available to you under a choice of one of two
@@ -34,7 +34,6 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  *
- * $Id: smi.c 1389 2004-12-27 22:56:47Z roland $
  */
 
 #include <rdma/ib_smi.h>
@@ -44,9 +43,8 @@
  * Fixup a directed route SMP for sending
  * Return 0 if the SMP should be discarded
  */
-int smi_handle_dr_smp_send(struct ib_smp *smp,
-                           u8 node_type,
-                           int port_num)
+enum smi_action smi_handle_dr_smp_send(struct ib_smp *smp,
+                                       u8 node_type, int port_num)
 {
         u8 hop_ptr, hop_cnt;
 
@@ -59,18 +57,18 @@ int smi_handle_dr_smp_send(struct ib_smp *smp,
                 if (hop_cnt && hop_ptr == 0) {
                         smp->hop_ptr++;
                         return (smp->initial_path[smp->hop_ptr] ==
-                                port_num);
+                                port_num ? IB_SMI_HANDLE : IB_SMI_DISCARD);
                 }
 
                 /* C14-9:2 */
                 if (hop_ptr && hop_ptr < hop_cnt) {
                         if (node_type != RDMA_NODE_IB_SWITCH)
-                                return 0;
+                                return IB_SMI_DISCARD;
 
                         /* smp->return_path set when received */
                         smp->hop_ptr++;
                         return (smp->initial_path[smp->hop_ptr] ==
-                                port_num);
+                                port_num ? IB_SMI_HANDLE : IB_SMI_DISCARD);
                 }
 
                 /* C14-9:3 -- We're at the end of the DR segment of path */
@@ -78,29 +76,30 @@ int smi_handle_dr_smp_send(struct ib_smp *smp,
                         /* smp->return_path set when received */
                         smp->hop_ptr++;
                         return (node_type == RDMA_NODE_IB_SWITCH ||
-                                smp->dr_dlid == IB_LID_PERMISSIVE);
+                                smp->dr_dlid == IB_LID_PERMISSIVE ?
+                                IB_SMI_HANDLE : IB_SMI_DISCARD);
                 }
 
                 /* C14-9:4 -- hop_ptr = hop_cnt + 1 -> give to SMA/SM */
                 /* C14-9:5 -- Fail unreasonable hop pointer */
-                return (hop_ptr == hop_cnt + 1);
+                return (hop_ptr == hop_cnt + 1 ? IB_SMI_HANDLE : IB_SMI_DISCARD);
 
         } else {
                 /* C14-13:1 */
                 if (hop_cnt && hop_ptr == hop_cnt + 1) {
                         smp->hop_ptr--;
                         return (smp->return_path[smp->hop_ptr] ==
-                                port_num);
+                                port_num ? IB_SMI_HANDLE : IB_SMI_DISCARD);
                 }
 
                 /* C14-13:2 */
                 if (2 <= hop_ptr && hop_ptr <= hop_cnt) {
                         if (node_type != RDMA_NODE_IB_SWITCH)
-                                return 0;
+                                return IB_SMI_DISCARD;
 
                         smp->hop_ptr--;
                         return (smp->return_path[smp->hop_ptr] ==
-                                port_num);
+                                port_num ? IB_SMI_HANDLE : IB_SMI_DISCARD);
                 }
 
                 /* C14-13:3 -- at the end of the DR segment of path */
@@ -108,15 +107,16 @@ int smi_handle_dr_smp_send(struct ib_smp *smp,
                         smp->hop_ptr--;
                         /* C14-13:3 -- SMPs destined for SM shouldn't be here */
                         return (node_type == RDMA_NODE_IB_SWITCH ||
-                                smp->dr_slid == IB_LID_PERMISSIVE);
+                                smp->dr_slid == IB_LID_PERMISSIVE ?
+                                IB_SMI_HANDLE : IB_SMI_DISCARD);
                 }
 
                 /* C14-13:4 -- hop_ptr = 0 -> should have gone to SM */
                 if (hop_ptr == 0)
-                        return 1;
+                        return IB_SMI_HANDLE;
 
                 /* C14-13:5 -- Check for unreasonable hop pointer */
-                return 0;
+                return IB_SMI_DISCARD;
         }
 }
 
@@ -124,10 +124,8 @@ int smi_handle_dr_smp_send(struct ib_smp *smp,
  * Adjust information for a received SMP
  * Return 0 if the SMP should be dropped
  */
-int smi_handle_dr_smp_recv(struct ib_smp *smp,
-                           u8 node_type,
-                           int port_num,
-                           int phys_port_cnt)
+enum smi_action smi_handle_dr_smp_recv(struct ib_smp *smp, u8 node_type,
+                                       int port_num, int phys_port_cnt)
 {
         u8 hop_ptr, hop_cnt;
 
@@ -138,16 +136,17 @@ int smi_handle_dr_smp_recv(struct ib_smp *smp,
         if (!ib_get_smp_direction(smp)) {
                 /* C14-9:1 -- sender should have incremented hop_ptr */
                 if (hop_cnt && hop_ptr == 0)
-                        return 0;
+                        return IB_SMI_DISCARD;
 
                 /* C14-9:2 -- intermediate hop */
                 if (hop_ptr && hop_ptr < hop_cnt) {
                         if (node_type != RDMA_NODE_IB_SWITCH)
-                                return 0;
+                                return IB_SMI_DISCARD;
 
                         smp->return_path[hop_ptr] = port_num;
                         /* smp->hop_ptr updated when sending */
-                        return (smp->initial_path[hop_ptr+1] <= phys_port_cnt);
+                        return (smp->initial_path[hop_ptr+1] <= phys_port_cnt ?
+                                IB_SMI_HANDLE : IB_SMI_DISCARD);
                 }
 
                 /* C14-9:3 -- We're at the end of the DR segment of path */
@@ -157,12 +156,13 @@ int smi_handle_dr_smp_recv(struct ib_smp *smp,
                         /* smp->hop_ptr updated when sending */
 
                         return (node_type == RDMA_NODE_IB_SWITCH ||
-                                smp->dr_dlid == IB_LID_PERMISSIVE);
+                                smp->dr_dlid == IB_LID_PERMISSIVE ?
+                                IB_SMI_HANDLE : IB_SMI_DISCARD);
                 }
 
                 /* C14-9:4 -- hop_ptr = hop_cnt + 1 -> give to SMA/SM */
                 /* C14-9:5 -- fail unreasonable hop pointer */
-                return (hop_ptr == hop_cnt + 1);
+                return (hop_ptr == hop_cnt + 1 ? IB_SMI_HANDLE : IB_SMI_DISCARD);
 
         } else {
 
@@ -170,16 +170,17 @@ int smi_handle_dr_smp_recv(struct ib_smp *smp,
                 if (hop_cnt && hop_ptr == hop_cnt + 1) {
                         smp->hop_ptr--;
                         return (smp->return_path[smp->hop_ptr] ==
-                                port_num);
+                                port_num ? IB_SMI_HANDLE : IB_SMI_DISCARD);
                 }
 
                 /* C14-13:2 */
                 if (2 <= hop_ptr && hop_ptr <= hop_cnt) {
                         if (node_type != RDMA_NODE_IB_SWITCH)
-                                return 0;
+                                return IB_SMI_DISCARD;
 
                         /* smp->hop_ptr updated when sending */
-                        return (smp->return_path[hop_ptr-1] <= phys_port_cnt);
+                        return (smp->return_path[hop_ptr-1] <= phys_port_cnt ?
+                                IB_SMI_HANDLE : IB_SMI_DISCARD);
                 }
 
                 /* C14-13:3 -- We're at the end of the DR segment of path */
@@ -187,23 +188,20 @@ int smi_handle_dr_smp_recv(struct ib_smp *smp,
                         if (smp->dr_slid == IB_LID_PERMISSIVE) {
                                 /* giving SMP to SM - update hop_ptr */
                                 smp->hop_ptr--;
-                                return 1;
+                                return IB_SMI_HANDLE;
                         }
                         /* smp->hop_ptr updated when sending */
-                        return (node_type == RDMA_NODE_IB_SWITCH);
+                        return (node_type == RDMA_NODE_IB_SWITCH ?
+                                IB_SMI_HANDLE: IB_SMI_DISCARD);
                 }
 
                 /* C14-13:4 -- hop_ptr = 0 -> give to SM */
                 /* C14-13:5 -- Check for unreasonable hop pointer */
-                return (hop_ptr == 0);
+                return (hop_ptr == 0 ? IB_SMI_HANDLE : IB_SMI_DISCARD);
         }
 }
 
-/*
- * Return 1 if the received DR SMP should be forwarded to the send queue
- * Return 0 if the SMP should be completed up the stack
- */
-int smi_check_forward_dr_smp(struct ib_smp *smp)
+enum smi_forward_action smi_check_forward_dr_smp(struct ib_smp *smp)
 {
         u8 hop_ptr, hop_cnt;
 
@@ -213,23 +211,25 @@ int smi_check_forward_dr_smp(struct ib_smp *smp)
         if (!ib_get_smp_direction(smp)) {
                 /* C14-9:2 -- intermediate hop */
                 if (hop_ptr && hop_ptr < hop_cnt)
-                        return 1;
+                        return IB_SMI_SEND;
 
                 /* C14-9:3 -- at the end of the DR segment of path */
                 if (hop_ptr == hop_cnt)
-                        return (smp->dr_dlid == IB_LID_PERMISSIVE);
+                        return (smp->dr_dlid == IB_LID_PERMISSIVE ?
+                                IB_SMI_SEND : IB_SMI_LOCAL);
 
                 /* C14-9:4 -- hop_ptr = hop_cnt + 1 -> give to SMA/SM */
                 if (hop_ptr == hop_cnt + 1)
-                        return 1;
+                        return IB_SMI_SEND;
         } else {
-                /* C14-13:2 */
+                /* C14-13:2  -- intermediate hop */
                 if (2 <= hop_ptr && hop_ptr <= hop_cnt)
-                        return 1;
+                        return IB_SMI_SEND;
 
                 /* C14-13:3 -- at the end of the DR segment of path */
                 if (hop_ptr == 1)
-                        return (smp->dr_slid != IB_LID_PERMISSIVE);
+                        return (smp->dr_slid != IB_LID_PERMISSIVE ?
+                                IB_SMI_SEND : IB_SMI_LOCAL);
         }
-        return 0;
+        return IB_SMI_LOCAL;
 }
diff --git a/drivers/infiniband/core/smi.h b/drivers/infiniband/core/smi.h
index 3011bfd86dc5..9a4b349efc30 100644
--- a/drivers/infiniband/core/smi.h
+++ b/drivers/infiniband/core/smi.h
@@ -3,7 +3,7 @@
  * Copyright (c) 2004 Infinicon Corporation.  All rights reserved.
  * Copyright (c) 2004 Intel Corporation.  All rights reserved.
  * Copyright (c) 2004 Topspin Corporation.  All rights reserved.
- * Copyright (c) 2004 Voltaire Corporation.  All rights reserved.
+ * Copyright (c) 2004-2007 Voltaire Corporation.  All rights reserved.
  *
  * This software is available to you under a choice of one of two
  * licenses.  You may choose to be licensed under the terms of the GNU
@@ -33,7 +33,6 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  *
- * $Id: smi.h 1389 2004-12-27 22:56:47Z roland $
  */
 
 #ifndef __SMI_H_
@@ -41,26 +40,33 @@
 
 #include <rdma/ib_smi.h>
 
-int smi_handle_dr_smp_recv(struct ib_smp *smp,
-                           u8 node_type,
-                           int port_num,
-                           int phys_port_cnt);
-extern int smi_check_forward_dr_smp(struct ib_smp *smp);
-extern int smi_handle_dr_smp_send(struct ib_smp *smp,
-                                  u8 node_type,
-                                  int port_num);
+enum smi_action {
+        IB_SMI_DISCARD,
+        IB_SMI_HANDLE
+};
+
+enum smi_forward_action {
+        IB_SMI_LOCAL,   /* SMP should be completed up the stack */
+        IB_SMI_SEND,    /* received DR SMP should be forwarded to the send queue */
+};
+
+enum smi_action smi_handle_dr_smp_recv(struct ib_smp *smp, u8 node_type,
+                                       int port_num, int phys_port_cnt);
+extern enum smi_forward_action smi_check_forward_dr_smp(struct ib_smp *smp);
+extern enum smi_action smi_handle_dr_smp_send(struct ib_smp *smp,
+                                              u8 node_type, int port_num);
 
 /*
  * Return 1 if the SMP should be handled by the local SMA/SM via process_mad
  */
-static inline int smi_check_local_smp(struct ib_smp *smp,
-                                      struct ib_device *device)
+static inline enum smi_action smi_check_local_smp(struct ib_smp *smp,
+                                                  struct ib_device *device)
 {
         /* C14-9:3 -- We're at the end of the DR segment of path */
         /* C14-9:4 -- Hop Pointer = Hop Count + 1 -> give to SMA/SM */
         return ((device->process_mad &&
                 !ib_get_smp_direction(smp) &&
-                (smp->hop_ptr == smp->hop_cnt + 1)));
+                (smp->hop_ptr == smp->hop_cnt + 1)) ?
+                IB_SMI_HANDLE : IB_SMI_DISCARD);
 }
-
 #endif  /* __SMI_H_ */