ZFCP HBA API Library 1
|
Auxiliary functions used in the library. More...
#include "vlib.h"
Go to the source code of this file.
Functions | |
struct vlib_adapter * | getAdapterByIndex (uint32_t) |
Get an adapter by its index. | |
struct vlib_adapter * | getAdapterByHandle (HBA_HANDLE, HBA_STATUS *) |
Get an adapter by its handle. | |
struct vlib_adapter * | getAdapterByDevid (devid_t) |
Get an adapter by its devid. | |
struct vlib_adapter * | getAdapterByHostNo (unsigned short) |
Get an adapter by SCSI Host number as in sysfs. | |
struct vlib_port * | getPortByIndex (const struct vlib_adapter *, const uint32_t) |
Get a port by its index. | |
struct vlib_port * | getPortByWWPN (const struct vlib_adapter *, const wwn_t) |
Get a port by its WWPN. | |
struct vlib_unit * | getUnitByIndex (const struct vlib_port *, const uint32_t) |
Get an unit by its index. | |
struct vlib_unit * | getUnitByFcLun (const struct vlib_port *, uint64_t) |
Get an unit by its fclun. | |
int | addAdapterToRepos (struct vlib_adapter *) |
Add an adapter to the repository. | |
int | addPortToRepos (struct vlib_adapter *, struct vlib_port *) |
Add a port from to the repository. | |
int | addUnitToRepos (struct vlib_port *, struct vlib_unit *) |
Add a unit to the repository. | |
int | findIndexByName (char *) |
Find an adapter index by name. | |
HBA_HANDLE | openAdapterByIndex (HBA_UINT32) |
Open an adapter by index. | |
char * | getSgDevFromPort (struct vlib_port *) |
Get the first sg device from an adapter. | |
char * | getAttachedWLUN (struct vlib_adapter *, struct vlib_port *) |
Try to attach the report luns wlun and return its name as in "/dev". | |
void | detachWLUN (struct vlib_adapter *, struct vlib_port *) |
Try to detach lun 0. | |
int | revalidateAdapters (void) |
Revalidate adapters in the repository. | |
int | updateAdapter (struct vlib_adapter *adapter) |
Update information about ports and units of an adapter. | |
void | doCloseAdapter (struct vlib_adapter *) |
Close an adapter in the repository. | |
void | closeAllAdapters (void) |
Close all adapters in the repository. | |
HBA_PORTTYPE | vlibCharToIntPortType (char *) |
Map the result of a port type string from sysfs to an int. | |
HBA_PORTSTATE | vlibCharToIntPortState (char *) |
Map the result of a port state string from sysfs to an int. | |
HBA_PORTSPEED | vlibCharToIntPortSpeed (char *) |
Map the result of a port speed string to the HBA_PORTSPEED int. | |
HBA_COS | vlibCharToIntCOS (char *) |
Map the result of a class of service string to an int. | |
static void | vlib_wwn_to_HBA_WWN (uint64_t wwn, HBA_WWN *hba) |
Convert uint64_t to HBA_WWN – hide ill-favoured type cast. | |
static void | vlib_HBA_WWN_to_wwn (HBA_WWN *hba, uint64_t *wwn) |
Convert HBA_WWN to uint64_t – hide ill-favoured type cast. | |
static uint32_t | vlib_FCID_to_hbaFCID (uint32_t fcid) |
Convert a FC DID to a FC-HBA PortFcId. | |
static uint32_t | vlib_hbaFCID_to_FCID (uint32_t fcid) |
Convert a FC-HBA PortFcId to a FC DID. | |
static void | invalidateAllAdapters (void) |
Mark all adapters in repository as invalid. | |
static void | markRepositoryInvalid (void) |
Mark repositroy of library as invalid. This is appropriate if a loss of events is detected. |
Auxiliary functions used in the library.
int addAdapterToRepos | ( | struct vlib_adapter * | adapter | ) |
Add an adapter to the repository.
*adapter | adapter |
If the adapter specified in the event is already stored in the repository it is marked as valid.
References vlib_data::adapters, block_addItem(), vlib_adapter_ident::bus_dev_name, vlib_adapter_ident::class_dev_name, vlib_adapter_ident::devid, getAdapterFromRepos(), vlib_adapter::handle, vlib_adapter_ident::host, vlib_adapter::ident, vlib_adapter::isInvalid, vlib_adapter_ident::sysfsPath, VLIB_INVALID_HANDLE, vlib_adapter_ident::wwnn, and vlib_adapter_ident::wwpn.
Referenced by addAdapterByDevPath().
int addPortToRepos | ( | struct vlib_adapter * | adapter, |
struct vlib_port * | port ) |
Add a port from to the repository.
*adapter | to which the port data should be added, if NULL is passed the adapter should be identified by the data in the event |
*port | port to be added |
If the port specified in the event is already stored in the repository it is marked as valid.
References block_addItem(), vlib_port::channel, vlib_port::did, getPortFromRepos(), vlib_port::host, vlib_port::isInvalid, vlib_port::name, vlib_adapter::ports, vlib_port::target, vlib_port::wwnn, and vlib_port::wwpn.
Referenced by addPortByName().
Add a unit to the repository.
*port | to which the unit data should be added, if NULL is passed the port should be identified by the data in the event |
*unit | unit to be aded |
If the unit specified in the event is already stored in the repository it is marked as valid.
References block_addItem(), getUnitFromRepos(), vlib_unit::isInvalid, and vlib_port::units.
Referenced by sysfs_getUnitsFromPort().
void closeAllAdapters | ( | void | ) |
Close all adapters in the repository.
This function frees all allocated memory for the adapters.
References vlib_data::adapters, block_free(), doCloseAdapter(), getAdapterByIndex(), and block::used.
Referenced by HBA_FreeLibrary().
void detachWLUN | ( | struct vlib_adapter * | adapter, |
struct vlib_port * | port ) |
Try to detach lun 0.
adapter* | Pointer to an adapter |
port* | Pointer to a port |
References vlib_adapter_ident::bus_dev_name, vlib_unit::channel, getUnitByIndex(), vlib_unit::host, vlib_adapter::ident, REPORTLUNS_WLUN, revalidateUnits(), vlib_unit::target, and vlib_port::wwpn.
Referenced by _HBA_SendReportLUNs().
void doCloseAdapter | ( | struct vlib_adapter * | adapter | ) |
Close an adapter in the repository.
*adapter | pointer to the adapter to be closed |
This function frees all allocated memory for the ports and units of this adapter and invalidates the adapter handle.
References block_free(), getPortByIndex(), vlib_adapter::handle, vlib_adapter::ports, vlib_port::units, block::used, and VLIB_INVALID_HANDLE.
Referenced by closeAllAdapters(), HBA_CloseAdapter(), and revalidateAdapters().
int findIndexByName | ( | char * | name | ) |
Find an adapter index by name.
name | the name of the adapter |
References vlib_data::adapters, getAdapterByIndex(), vlib_adapter::isInvalid, block::used, VLIB_ADAPTERNAME_LEN, and VLIB_ADAPTERNAME_PREFIX.
Referenced by HBA_OpenAdapter().
struct vlib_adapter * getAdapterByDevid | ( | devid_t | devid | ) |
Get an adapter by its devid.
devid | of the adapter |
References vlib_data::adapters, vlib_adapter_ident::devid, getAdapterByIndex(), vlib_adapter::ident, and block::used.
struct vlib_adapter * getAdapterByHandle | ( | HBA_HANDLE | handle, |
HBA_STATUS * | status ) |
Get an adapter by its handle.
handle | of the adapter |
*status | pointer to return error status code |
If NULL is returned *status contains an error status code which should be checked by the calling function. If non-NULL is returned *status is HBA_STATUS_OK. Possible error status codes are:
References getAdapterByIndex(), vlib_adapter::handle, vlib_adapter::isInvalid, and VLIB_INVALID_HANDLE.
Referenced by _HBA_SendReadCapacity(), _HBA_SendReportLUNs(), _HBA_SendScsiInquiry(), HBA_CloseAdapter(), HBA_GetAdapterAttributes(), HBA_GetAdapterPortAttributes(), HBA_GetDiscoveredPortAttributes(), HBA_GetEventBuffer(), HBA_GetFcpTargetMapping(), HBA_GetFcpTargetMappingV2(), HBA_GetPortStatistics(), HBA_GetRNIDMgmtInfo(), HBA_RefreshInformation(), HBA_SendCTPassThru(), and HBA_SendRNID().
struct vlib_adapter * getAdapterByHostNo | ( | unsigned short | host | ) |
Get an adapter by SCSI Host number as in sysfs.
SCSI | host number of the adapter |
References vlib_data::adapters, getAdapterByIndex(), vlib_adapter_ident::host, vlib_adapter::ident, and block::used.
Referenced by sysfs_getUnitsFromPort().
struct vlib_adapter * getAdapterByIndex | ( | uint32_t | index | ) |
Get an adapter by its index.
index | of the adapter |
References vlib_data::adapters, block::data, and block::used.
Referenced by closeAllAdapters(), findIndexByName(), getAdapterByDevid(), getAdapterByHandle(), getAdapterByHostNo(), getAdapterFromRepos(), HBA_GetAdapterName(), invalidateAllAdapters(), openAdapterByIndex(), and revalidateAdapters().
char * getAttachedWLUN | ( | struct vlib_adapter * | adapter, |
struct vlib_port * | port ) |
Try to attach the report luns wlun and return its name as in "/dev".
adapter* | Pointer to an adapter |
port* | Pointer to a port |
References vlib_adapter_ident::bus_dev_name, getSgDevFromPort(), vlib_adapter::ident, REPORTLUNS_WLUN, and vlib_port::wwpn.
Referenced by _HBA_SendReportLUNs().
struct vlib_port * getPortByIndex | ( | const struct vlib_adapter * | adapter, |
const uint32_t | index ) |
Get a port by its index.
*adapter | to which the port belongs |
index | of the port |
References block::data, vlib_adapter::ports, and block::used.
Referenced by doCloseAdapter(), getPortByWWPN(), getPortFromRepos(), HBA_GetDiscoveredPortAttributes(), HBA_GetFcpTargetMapping(), and updateAdapter().
struct vlib_port * getPortByWWPN | ( | const struct vlib_adapter * | adapter, |
const wwn_t | wwpn ) |
Get a port by its WWPN.
*adapter | to which the port belongs |
wwpn | of the port |
References getPortByIndex(), vlib_adapter::ports, block::used, and vlib_port::wwpn.
Referenced by _HBA_SendReadCapacity(), _HBA_SendReportLUNs(), and _HBA_SendScsiInquiry().
char * getSgDevFromPort | ( | struct vlib_port * | port | ) |
Get the first sg device from an adapter.
port* | Pointer to a port |
References getUnitByIndex(), revalidateUnits(), and vlib_unit::sg_dev.
Referenced by _HBA_SendReportLUNs(), and getAttachedWLUN().
Get an unit by its fclun.
*port | to which the unit belongs |
index | of the unit |
References vlib_unit::fcLun, getUnitByIndex(), vlib_port::units, and block::used.
Referenced by _HBA_SendReadCapacity(), and _HBA_SendScsiInquiry().
Get an unit by its index.
*port | to which the unit belongs |
index | of the unit |
References block::data, vlib_port::units, and block::used.
Referenced by detachWLUN(), getSgDevFromPort(), getUnitByFcLun(), getUnitFromRepos(), and HBA_GetFcpTargetMapping().
|
inlinestatic |
Mark all adapters in repository as invalid.
References vlib_data::adapters, getAdapterByIndex(), vlib_adapter::isInvalid, and block::used.
|
inlinestatic |
Mark repositroy of library as invalid. This is appropriate if a loss of events is detected.
References vlib_data::isValid, vlib_data::mutex, VLIB_MUTEX_LOCK, and VLIB_MUTEX_UNLOCK.
HBA_HANDLE openAdapterByIndex | ( | HBA_UINT32 | index | ) |
Open an adapter by index.
index | of the adapter |
If compiled as a vendor library, we shall only use the lower 16 Bit of the handle.
References getAdapterByIndex(), vlib_adapter::handle, and VLIB_INVALID_HANDLE.
Referenced by HBA_OpenAdapter().
int revalidateAdapters | ( | void | ) |
Revalidate adapters in the repository.
Port and unit configuration data is only updated if it was already generated before. Generation of port and unit configuration information is triggered in HBA_GetAdapterPortAttributes() and HBA_GetFcpTargetMapping(), resp.
References vlib_data::adapters, block::allocated, doCloseAdapter(), getAdapterByIndex(), vlib_adapter::isInvalid, vlib_adapter::ports, updateAdapter(), and block::used.
Referenced by sysfs_createAndReadConfigAdapter().
int updateAdapter | ( | struct vlib_adapter * | adapter | ) |
Update information about ports and units of an adapter.
*adapter | to be updated |
References getPortByIndex(), vlib_adapter::isInvalid, vlib_adapter::ports, sysfs_createAndReadConfigPorts(), sysfs_getUnitsFromPort(), and block::used.
Referenced by HBA_RefreshInformation(), and revalidateAdapters().
|
inlinestatic |
Convert a FC DID to a FC-HBA PortFcId.
fcid | a FC DID (uses 3 least significant bytes) |
Referenced by HBA_GetFcpTargetMapping().
|
inlinestatic |
Convert HBA_WWN to uint64_t – hide ill-favoured type cast.
*hba | pointer WWN of type HBA_WWN (to be converted) |
*wwn | pointer to return WWN as uint64_t |
Referenced by _HBA_SendReadCapacity(), _HBA_SendReportLUNs(), _HBA_SendScsiInquiry(), HBA_GetFcpTargetMappingV2(), and HBA_SendRNID().
|
inlinestatic |
Convert a FC-HBA PortFcId to a FC DID.
fcid | PortFcId as specified in FC-HBA (uses 3 most significant bytes) |
|
inlinestatic |
Convert uint64_t to HBA_WWN – hide ill-favoured type cast.
wwn | WWN stored as uint64_t (to be converted) |
*hba | pointer to return WWN of type HBA_WWN |
Referenced by getPortAttributes(), HBA_GetFcpTargetMapping(), HBA_GetRNIDMgmtInfo(), and sysfs_getAdapterAttributes().
HBA_COS vlibCharToIntCOS | ( | char * | s | ) |
Map the result of a class of service string to an int.
char* | containing the class of service string |
References vlibCOStoFlag().
Referenced by getPortAttributes().
HBA_PORTSPEED vlibCharToIntPortSpeed | ( | char * | pS | ) |
Map the result of a port speed string to the HBA_PORTSPEED int.
char* | containing the port speed string |
References vlibIntToSymbolPortSpeed().
Referenced by getPortAttributes().
HBA_PORTSTATE vlibCharToIntPortState | ( | char * | portState | ) |
Map the result of a port state string from sysfs to an int.
char* | containing the port state |
Referenced by getPortAttributes().
HBA_PORTTYPE vlibCharToIntPortType | ( | char * | portType | ) |
Map the result of a port type string from sysfs to an int.
char* | containing the port type |
Referenced by getPortAttributes().