/* * Copyright (c) 2004-2009 Voltaire, Inc. All rights reserved. * Copyright (c) 2002-2005 Mellanox Technologies LTD. All rights reserved. * Copyright (c) 1996-2003 Intel 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 * General Public License (GPL) Version 2, available from the file * COPYING in the main directory of this source tree, or 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. * */ /* * Abstract: * Declaration of osm_sm_mad_ctrl_t. * This object represents a controller that receives the IBA NodeInfo * attribute from a node. * This object is part of the OpenSM family of objects. */ #ifndef _OSM_SM_MAD_CTRL_H_ #define _OSM_SM_MAD_CTRL_H_ #include #include #include #include #include #include #include #include #include #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/SM MAD Controller * NAME * SM MAD Controller * * DESCRIPTION * The SM MAD Controller object encapsulates * the information needed to receive MADs from the transport layer. * * The SM MAD Controller object is thread safe. * * This object should be treated as opaque and should be * manipulated only through the provided functions. * * AUTHOR * Steve King, Intel * *********/ /****s* OpenSM: SM MAD Controller/osm_sm_mad_ctrl_t * NAME * osm_sm_mad_ctrl_t * * DESCRIPTION * SM MAD Controller structure. * * This object should be treated as opaque and should * be manipulated only through the provided functions. * * SYNOPSIS */ typedef struct osm_sm_mad_ctrl { osm_log_t *p_log; osm_subn_t *p_subn; osm_mad_pool_t *p_mad_pool; osm_vl15_t *p_vl15; osm_vendor_t *p_vendor; osm_bind_handle_t h_bind; cl_plock_t *p_lock; cl_dispatcher_t *p_disp; cl_disp_reg_handle_t h_disp; osm_stats_t *p_stats; } osm_sm_mad_ctrl_t; /* * FIELDS * p_log * Pointer to the log object. * * p_subn * Pointer to the subnet object. * * p_mad_pool * Pointer to the MAD pool. * * p_vl15 * Pointer to the VL15 interface object. * * p_vendor * Pointer to the vendor specific interfaces object. * * h_bind * Bind handle returned by the transport layer. * * p_lock * Pointer to the serializing lock. * * p_disp * Pointer to the Dispatcher. * * h_disp * Handle returned from dispatcher registration. * * p_stats * Pointer to the OpenSM statistics block. * * SEE ALSO * SM MAD Controller object *********/ /****f* OpenSM: SM MAD Controller/osm_sm_mad_ctrl_construct * NAME * osm_sm_mad_ctrl_construct * * DESCRIPTION * This function constructs a SM MAD Controller object. * * SYNOPSIS */ void osm_sm_mad_ctrl_construct(IN osm_sm_mad_ctrl_t * p_ctrl); /* * PARAMETERS * p_ctrl * [in] Pointer to a SM MAD Controller * object to construct. * * RETURN VALUE * This function does not return a value. * * NOTES * Allows calling osm_sm_mad_ctrl_init, and osm_sm_mad_ctrl_destroy. * * Calling osm_sm_mad_ctrl_construct is a prerequisite to calling any other * method except osm_sm_mad_ctrl_init. * * SEE ALSO * SM MAD Controller object, osm_sm_mad_ctrl_init, * osm_sm_mad_ctrl_destroy *********/ /****f* OpenSM: SM MAD Controller/osm_sm_mad_ctrl_destroy * NAME * osm_sm_mad_ctrl_destroy * * DESCRIPTION * The osm_sm_mad_ctrl_destroy function destroys the object, releasing * all resources. * * SYNOPSIS */ void osm_sm_mad_ctrl_destroy(IN osm_sm_mad_ctrl_t * 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 * SM MAD Controller object. * Further operations should not be attempted on the destroyed object. * This function should only be called after a call to * osm_sm_mad_ctrl_construct or osm_sm_mad_ctrl_init. * * SEE ALSO * SM MAD Controller object, osm_sm_mad_ctrl_construct, * osm_sm_mad_ctrl_init *********/ /****f* OpenSM: SM MAD Controller/osm_sm_mad_ctrl_init * NAME * osm_sm_mad_ctrl_init * * DESCRIPTION * The osm_sm_mad_ctrl_init function initializes a * SM MAD Controller object for use. * * SYNOPSIS */ ib_api_status_t osm_sm_mad_ctrl_init(IN osm_sm_mad_ctrl_t * p_ctrl, IN osm_subn_t * p_subn, IN osm_mad_pool_t * p_mad_pool, IN osm_vl15_t * p_vl15, IN osm_vendor_t * p_vendor, IN osm_log_t * p_log, IN osm_stats_t * p_stats, IN cl_plock_t * p_lock, IN cl_dispatcher_t * p_disp); /* * PARAMETERS * p_ctrl * [in] Pointer to an osm_sm_mad_ctrl_t object to initialize. * * p_subn * [in] Pointer to the subnet object. * * p_mad_pool * [in] Pointer to the MAD pool. * * p_vl15 * [in] Pointer to the VL15 interface object. * * p_vendor * [in] Pointer to the vendor specific interfaces object. * * p_log * [in] Pointer to the log object. * * p_stats * [in] Pointer to the OpenSM stastics block. * * p_lock * [in] Pointer to the OpenSM serializing lock. * * p_disp * [in] Pointer to the OpenSM central Dispatcher. * * RETURN VALUES * IB_SUCCESS if the SM MAD Controller object was initialized * successfully. * * NOTES * Allows calling other SM MAD Controller methods. * * SEE ALSO * SM MAD Controller object, osm_sm_mad_ctrl_construct, * osm_sm_mad_ctrl_destroy *********/ /****f* OpenSM: SM/osm_sm_mad_ctrl_bind * NAME * osm_sm_mad_ctrl_bind * * DESCRIPTION * Binds the SM MAD Controller object to a port guid. * * SYNOPSIS */ ib_api_status_t osm_sm_mad_ctrl_bind(IN osm_sm_mad_ctrl_t * p_ctrl, IN ib_net64_t port_guid); /* * PARAMETERS * p_ctrl * [in] Pointer to an osm_sm_mad_ctrl_t object to initialize. * * port_guid * [in] Local port GUID with which to bind. * * * RETURN VALUES * None * * NOTES * A given SM MAD Controller object can only be bound to one * port at a time. * * SEE ALSO *********/ /****f* OpenSM: SM/osm_sm_mad_ctrl_get_bind_handle * NAME * osm_sm_mad_ctrl_get_bind_handle * * DESCRIPTION * Returns the bind handle. * * SYNOPSIS */ static inline osm_bind_handle_t osm_sm_mad_ctrl_get_bind_handle(IN const osm_sm_mad_ctrl_t * p_ctrl) { return p_ctrl->h_bind; } /* * PARAMETERS * p_ctrl * [in] Pointer to an osm_sm_mad_ctrl_t object. * * RETURN VALUES * Returns the bind handle, which may be OSM_BIND_INVALID_HANDLE * if no port has been bound. * * NOTES * A given SM MAD Controller object can only be bound to one * port at a time. * * SEE ALSO *********/ END_C_DECLS #endif /* _OSM_SM_MAD_CTRL_H_ */