[OPENSM] add missing files form former check in
authorsleybo <sleybo@ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86>
Wed, 7 Feb 2007 10:47:10 +0000 (10:47 +0000)
committersleybo <sleybo@ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86>
Wed, 7 Feb 2007 10:47:10 +0000 (10:47 +0000)
git-svn-id: svn://openib.tc.cornell.edu/gen1/trunk@573 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86

ulp/opensm/user/include/opensm/osm_sa_mft_record.h [new file with mode: 0644]
ulp/opensm/user/include/opensm/osm_sa_mft_record_ctrl.h [new file with mode: 0644]

diff --git a/ulp/opensm/user/include/opensm/osm_sa_mft_record.h b/ulp/opensm/user/include/opensm/osm_sa_mft_record.h
new file mode 100644 (file)
index 0000000..a4e4248
--- /dev/null
@@ -0,0 +1,280 @@
+/*
+ * Copyright (c) 2004-2006 Voltaire, Inc. All rights reserved.
+ * Copyright (c) 2002-2006 Mellanox Technologies LTD. All rights reserved.
+ * Copyright (c) 1996-2003 Intel Corporation. All rights reserved.
+ *
+ * This software is available to you under the OpenIB.org BSD license
+ * below:
+ *
+ *     Redistribution and use in source and binary forms, with or
+ *     without modification, are permitted provided that the following
+ *     conditions are met:
+ *
+ *      - Redistributions of source code must retain the above
+ *        copyright notice, this list of conditions and the following
+ *        disclaimer.
+ *
+ *      - Redistributions in binary form must reproduce the above
+ *        copyright notice, this list of conditions and the following
+ *        disclaimer in the documentation and/or other materials
+ *        provided with the distribution.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * $Id$
+ */
+
+
+/*
+ * Abstract:
+ *     Declaration of osm_mftr_rcv_t.
+ *     This object represents the MulticastForwardingTable Receiver object.
+ *     attribute from a switch node.
+ *     This object is part of the OpenSM family of objects.
+ *
+ * Environment:
+ *     Linux User Mode
+ *
+ */
+
+#ifndef _OSM_MFTR_H_
+#define _OSM_MFTR_H_
+
+#include <complib/cl_passivelock.h>
+#include <complib/cl_qlist.h>
+#include <opensm/osm_base.h>
+#include <opensm/osm_madw.h>
+#include <opensm/osm_sa_response.h>
+#include <opensm/osm_subnet.h>
+#include <opensm/osm_stats.h>
+#include <opensm/osm_log.h>
+
+#ifdef __cplusplus
+#  define BEGIN_C_DECLS extern "C" {
+#  define END_C_DECLS   }
+#else /* !__cplusplus */
+#  define BEGIN_C_DECLS
+#  define END_C_DECLS
+#endif /* __cplusplus */
+
+BEGIN_C_DECLS
+
+/****h* OpenSM/Multicast Forwarding Table Receiver
+* NAME
+*      Multicast Forwarding Table Receiver
+*
+* DESCRIPTION
+*      The Multicast Forwarding Table Receiver object encapsulates the information
+*      needed to receive the MulticastForwardingTable attribute from a switch node.
+*
+*      The Multicast Forwarding Table Receiver object is thread safe.
+*
+*      This object should be treated as opaque and should be
+*      manipulated only through the provided functions.
+*
+* AUTHOR
+*      Hal Rosenstock, Voltaire
+*
+*********/
+
+/****s* OpenSM: Multicast Forwarding Table Receiver/osm_mftr_rcv_t
+* NAME
+*      osm_mftr_rcv_t
+*
+* DESCRIPTION
+*      Multicast Forwarding Table Receiver structure.
+*
+*      This object should be treated as opaque and should
+*      be manipulated only through the provided functions.
+*
+* SYNOPSIS
+*/
+typedef struct _osm_mft
+{
+  osm_subn_t*                                  p_subn;
+  osm_stats_t*                                 p_stats;
+  osm_sa_resp_t*                               p_resp;
+  osm_mad_pool_t*                              p_mad_pool;
+  osm_log_t*                                   p_log;
+  cl_plock_t*                                  p_lock;
+  cl_qlock_pool_t                              pool;
+} osm_mftr_rcv_t;
+/*
+* FIELDS
+*      p_subn
+*              Pointer to the Subnet object for this subnet.
+*
+*      p_stats
+*              Pointer to the statistics.
+*
+*      p_resp
+*              Pointer to the SA responder.
+*
+*      p_mad_pool
+*              Pointer to the mad pool.
+*
+*      p_log
+*              Pointer to the log object.
+*
+*      p_lock
+*              Pointer to the serializing lock.
+*
+*      pool
+*              Pool of linkable Multicast Forwarding Table Record objects used to
+*               generate the query response.
+*
+* SEE ALSO
+*      Multicast Forwarding Table Receiver object
+*********/
+
+/****f* OpenSM: Multicast Forwarding Table Receiver/osm_mftr_rcv_construct
+* NAME
+*      osm_mftr_rcv_construct
+*
+* DESCRIPTION
+*      This function constructs a Multicast Forwarding Table Receiver object.
+*
+* SYNOPSIS
+*/
+void osm_mftr_rcv_construct(
+       IN osm_mftr_rcv_t* const p_ctrl );
+/*
+* PARAMETERS
+*      p_ctrl
+*              [in] Pointer to a Multicast Forwarding Table Receiver object to construct.
+*
+* RETURN VALUE
+*      This function does not return a value.
+*
+* NOTES
+*      Allows calling osm_mftr_rcv_init, osm_mftr_rcv_destroy
+*
+*      Calling osm_mftr_rcv_construct is a prerequisite to calling any other
+*      method except osm_mftr_rcv_init.
+*
+* SEE ALSO
+*      Multicast Forwarding Table Receiver object, osm_mftr_rcv_init, 
+*  osm_mftr_rcv_destroy
+*********/
+
+/****f* OpenSM: Multicast Forwarding Table Receiver/osm_mftr_rcv_destroy
+* NAME
+*      osm_mftr_rcv_destroy
+*
+* DESCRIPTION
+*      The osm_mftr_rcv_destroy function destroys the object, releasing
+*      all resources.
+*
+* SYNOPSIS
+*/
+void osm_mftr_rcv_destroy(
+       IN osm_mftr_rcv_t* const p_ctrl );
+/*
+* PARAMETERS
+*      p_ctrl
+*              [in] Pointer to the object to destroy.
+*
+* RETURN VALUE
+*      This function does not return a value.
+*
+* NOTES
+*      Performs any necessary cleanup of the specified
+*      Multicast Forwarding Table Receiver object.
+*      Further operations should not be attempted on the destroyed object.
+*      This function should only be called after a call to
+*      osm_mftr_rcv_construct or osm_mftr_rcv_init.
+*
+* SEE ALSO
+*      Multicast Forwarding Table Receiver object, osm_mftr_rcv_construct,
+*      osm_mftr_rcv_init
+*********/
+
+/****f* OpenSM: Multicast Forwarding Table Receiver/osm_mftr_rcv_init
+* NAME
+*      osm_mftr_rcv_init
+*
+* DESCRIPTION
+*      The osm_mftr_rcv_init function initializes a
+*      Multicast Forwarding Table Receiver object for use.
+*
+* SYNOPSIS
+*/
+ib_api_status_t osm_mftr_rcv_init(
+       IN osm_mftr_rcv_t* const p_rcv,
+       IN osm_sa_resp_t* const p_resp,
+       IN osm_mad_pool_t* const p_mad_pool,
+       IN osm_subn_t* const p_subn,
+       IN osm_log_t* const p_log,
+       IN cl_plock_t* const p_lock );
+/*
+* PARAMETERS
+*      p_rcv
+*              [in] Pointer to an osm_mftr_rcv_t object to initialize.
+*
+*      p_req
+*              [in] Pointer to an osm_req_t object.
+*
+*      p_subn
+*              [in] Pointer to the Subnet object for this subnet.
+*
+*      p_log
+*              [in] Pointer to the log object.
+*
+*      p_lock
+*              [in] Pointer to the OpenSM serializing lock.
+*
+* RETURN VALUES
+*      CL_SUCCESS if the Multicast Forwarding Table Receiver object was initialized
+*      successfully.
+*
+* NOTES
+*      Allows calling other Multicast Forwarding Table Receiver methods.
+*
+* SEE ALSO
+*      Multicast Forwarding Table Receiver object, osm_mftr_rcv_construct, 
+*  osm_mftr_rcv_destroy
+*********/
+
+/****f* OpenSM: Multicast Forwarding Table Receiver/osm_mftr_rcv_process
+* NAME
+*      osm_mftr_rcv_process
+*
+* DESCRIPTION
+*      Process the MulticastForwardingTable attribute.
+*
+* SYNOPSIS
+*/
+void osm_mftr_rcv_process(
+       IN osm_mftr_rcv_t* const p_ctrl,
+       IN const osm_madw_t* const p_madw );
+/*
+* PARAMETERS
+*      p_ctrl
+*              [in] Pointer to an osm_mftr_rcv_t object.
+*
+*      p_madw
+*              [in] Pointer to the MAD Wrapper containing the MAD
+*              that contains the switch node's MulticastForwardingTable attribute.
+*
+* RETURN VALUES
+*      CL_SUCCESS if the MulticastForwardingTable processing was successful.
+*
+* NOTES
+*      This function processes a MulticastForwardingTable attribute.
+*
+* SEE ALSO
+*      Multicast Forwarding Table Receiver, Multicast Forwarding Table Response
+*  Controller
+*********/
+
+END_C_DECLS
+
+#endif /* _OSM_MFTR_H_ */
+
diff --git a/ulp/opensm/user/include/opensm/osm_sa_mft_record_ctrl.h b/ulp/opensm/user/include/opensm/osm_sa_mft_record_ctrl.h
new file mode 100644 (file)
index 0000000..8f815ff
--- /dev/null
@@ -0,0 +1,231 @@
+/*
+ * Copyright (c) 2004-2006 Voltaire, Inc. All rights reserved.
+ * Copyright (c) 2002-2006 Mellanox Technologies LTD. All rights reserved.
+ * Copyright (c) 1996-2003 Intel Corporation. All rights reserved.
+ *
+ * This software is available to you under the OpenIB.org BSD license
+ * below:
+ *
+ *     Redistribution and use in source and binary forms, with or
+ *     without modification, are permitted provided that the following
+ *     conditions are met:
+ *
+ *      - Redistributions of source code must retain the above
+ *        copyright notice, this list of conditions and the following
+ *        disclaimer.
+ *
+ *      - Redistributions in binary form must reproduce the above
+ *        copyright notice, this list of conditions and the following
+ *        disclaimer in the documentation and/or other materials
+ *        provided with the distribution.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * $Id$
+ */
+
+
+/*
+ * Abstract:
+ *     Declaration of osm_mftr_rcv_ctrl_t.
+ *     This object represents a controller that receives the IBA
+ *     MulticastForwardingTable attribute from a switch.
+ *     This object is part of the OpenSM family of objects.
+ *
+ * Environment:
+ *     Linux User Mode
+ *
+ */
+
+#ifndef _OSM_MFTR_RCV_CTRL_H_
+#define _OSM_MFTR_RCV_CTRL_H_
+
+#include <complib/cl_dispatcher.h>
+#include <opensm/osm_base.h>
+#include <opensm/osm_madw.h>
+#include <opensm/osm_log.h>
+#include <opensm/osm_sa_mft_record.h>
+
+#ifdef __cplusplus
+#  define BEGIN_C_DECLS extern "C" {
+#  define END_C_DECLS   }
+#else /* !__cplusplus */
+#  define BEGIN_C_DECLS
+#  define END_C_DECLS
+#endif /* __cplusplus */
+
+BEGIN_C_DECLS
+
+/****h* OpenSM/Multicast Forwarding Table Receive Controller
+* NAME
+*      Multicast Forwarding Table Record Receive Controller
+*
+* DESCRIPTION
+*      The Multicast Forwarding Table Receive Controller object encapsulates
+*      the information needed to receive the MulticastFowardingTable attribute
+*  from a switch node.
+*
+*      The Multicast Forwarding Table Receive Controller object is thread safe.
+*
+*      This object should be treated as opaque and should be
+*      manipulated only through the provided functions.
+*
+* AUTHOR
+*      Hal Rosenstock, Voltaire
+*
+*********/
+
+/****s* OpenSM: Multicast Forwarding Table Receive Controller/osm_mftr_rcv_ctrl_t
+* NAME
+*      osm_mftr_rcv_ctrl_t
+*
+* DESCRIPTION
+*      Multicast Forwarding Table Receive Controller structure.
+*
+*      This object should be treated as opaque and should
+*      be manipulated only through the provided functions.
+*
+* SYNOPSIS
+*/
+typedef struct _osm_mftr_rcv_ctrl
+{
+       osm_mftr_rcv_t                  *p_rcv;
+       osm_log_t                       *p_log;
+       cl_dispatcher_t                 *p_disp;
+       cl_disp_reg_handle_t            h_disp;
+} osm_mftr_rcv_ctrl_t;
+/*
+* FIELDS
+*      p_rcv
+*              Pointer to the Multicast Forwarding Table Receiver object.
+*
+*      p_log
+*              Pointer to the log object.
+*
+*      p_disp
+*              Pointer to the Dispatcher.
+*
+*      h_disp
+*              Handle returned from dispatcher registration.
+*
+* SEE ALSO
+*      Multicast Forwarding Table Receive Controller object
+*      Multicast Forwarding Table Receiver object
+*********/
+
+/****f* OpenSM: Multicast Forwarding Table Receive Controller/osm_mftr_rcv_ctrl_construct
+* NAME
+*      osm_mftr_rcv_ctrl_construct
+*
+* DESCRIPTION
+*      This function constructs a Multicast Forwarding Table Receive
+*  Controller object.
+*
+* SYNOPSIS
+*/
+void osm_mftr_rcv_ctrl_construct(
+       IN osm_mftr_rcv_ctrl_t* const p_ctrl );
+/*
+* PARAMETERS
+*      p_ctrl
+*              [in] Pointer to a Multicast Forwarding Table Receive Controller
+*              object to construct.
+*
+* RETURN VALUE
+*      This function does not return a value.
+*
+* NOTES
+*      Allows calling osm_mftr_rcv_ctrl_init, osm_mftr_rcv_ctrl_destroy
+*
+*      Calling osm_mftr_rcv_ctrl_construct is a prerequisite to calling any other
+*      method except osm_mftr_rcv_ctrl_init.
+*
+* SEE ALSO
+*      Multicast Forwarding Table Receive Controller object, osm_mftr_rcv_ctrl_init,
+*      osm_mftr_rcv_ctrl_destroy
+*********/
+
+/****f* OpenSM: Multicast Forwarding Table Receive Controller/osm_mftr_rcv_ctrl_destroy
+* NAME
+*      osm_mftr_rcv_ctrl_destroy
+*
+* DESCRIPTION
+*      The osm_mftr_rcv_ctrl_destroy function destroys the object, releasing
+*      all resources.
+*
+* SYNOPSIS
+*/
+void osm_mftr_rcv_ctrl_destroy(
+       IN osm_mftr_rcv_ctrl_t* const p_ctrl );
+/*
+* PARAMETERS
+*      p_ctrl
+*              [in] Pointer to the object to destroy.
+*
+* RETURN VALUE
+*      This function does not return a value.
+*
+* NOTES
+*      Performs any necessary cleanup of the specified
+*      Multicast Forwarding Table Receive Controller object.
+*      Further operations should not be attempted on the destroyed object.
+*      This function should only be called after a call to
+*      osm_mftr_rcv_ctrl_construct or osm_mftr_rcv_ctrl_init.
+*
+* SEE ALSO
+*      Multicast Forwarding Table Receive Controller object, osm_mftr_rcv_ctrl_construct,
+*      osm_mftr_rcv_ctrl_init
+*********/
+
+/****f* OpenSM: Multicast Forwarding Table Receive Controller/osm_mftr_rcv_ctrl_init
+* NAME
+*      osm_mftr_rcv_ctrl_init
+*
+* DESCRIPTION
+*      The osm_mftr_rcv_ctrl_init function initializes a
+*      Multicast Forwarding Table Receive Controller object for use.
+*
+* SYNOPSIS
+*/
+ib_api_status_t osm_mftr_rcv_ctrl_init(
+       IN osm_mftr_rcv_ctrl_t* const p_ctrl,
+       IN osm_mftr_rcv_t* const p_rcv,
+       IN osm_log_t* const p_log,
+       IN cl_dispatcher_t* const p_disp );
+/*
+* PARAMETERS
+*      p_ctrl
+*              [in] Pointer to an osm_mftr_rcv_ctrl_t object to initialize.
+*
+*      p_rcv
+*              [in] Pointer to an osm_mftr_t object.
+*
+*      p_log
+*              [in] Pointer to the log object.
+*
+*      p_disp
+*              [in] Pointer to the OpenSM central Dispatcher.
+*
+* RETURN VALUES
+*      CL_SUCCESS if the Multicast Forwarding Table Receive Controller object
+*  was initialized successfully.
+*
+* NOTES
+*      Allows calling other Multicast Forwarding Table Receive Controller methods.
+*
+* SEE ALSO
+*      Multicast Forwarding Table Receive Controller object, 
+*  osm_mftr_rcv_ctrl_construct, osm_mftr_rcv_ctrl_destroy
+*********/
+
+END_C_DECLS
+
+#endif /* _OSM_MFTR_RCV_CTRL_H_ */
+