/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */ /* * Copyright (c) 2004 Topspin Communications. All rights reserved. * Copyright (c) 2005 Voltaire, Inc. All rights reserved. * Copyright (c) 2006 Intel Corporation. All rights reserved. */ #ifndef IB_SA_H #define IB_SA_H #include <linux/completion.h> #include <linux/compiler.h> #include <linux/atomic.h> #include <linux/netdevice.h> #include <rdma/ib_verbs.h> #include <rdma/ib_mad.h> #include <rdma/ib_addr.h> #include <rdma/opa_addr.h> enum { … }; #define OPA_SA_CLASS_VERSION … enum { … }; enum ib_sa_selector { … }; /* * There are 4 types of join states: * FullMember, NonMember, SendOnlyNonMember, SendOnlyFullMember. * The order corresponds to JoinState bits in MCMemberRecord. */ enum ib_sa_mc_join_states { … }; #define IB_SA_CAP_MASK2_SENDONLY_FULL_MEM_SUPPORT … /* * Structures for SA records are named "struct ib_sa_xxx_rec." No * attempt is made to pack structures to match the physical layout of * SA records in SA MADs; all packing and unpacking is handled by the * SA query code. * * For a record with structure ib_sa_xxx_rec, the naming convention * for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we * never use different abbreviations or otherwise change the spelling * of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY). * * Reserved rows are indicated with comments to help maintainability. */ #define IB_SA_PATH_REC_SERVICE_ID … #define IB_SA_PATH_REC_DGID … #define IB_SA_PATH_REC_SGID … #define IB_SA_PATH_REC_DLID … #define IB_SA_PATH_REC_SLID … #define IB_SA_PATH_REC_RAW_TRAFFIC … /* reserved: 7 */ #define IB_SA_PATH_REC_FLOW_LABEL … #define IB_SA_PATH_REC_HOP_LIMIT … #define IB_SA_PATH_REC_TRAFFIC_CLASS … #define IB_SA_PATH_REC_REVERSIBLE … #define IB_SA_PATH_REC_NUMB_PATH … #define IB_SA_PATH_REC_PKEY … #define IB_SA_PATH_REC_QOS_CLASS … #define IB_SA_PATH_REC_SL … #define IB_SA_PATH_REC_MTU_SELECTOR … #define IB_SA_PATH_REC_MTU … #define IB_SA_PATH_REC_RATE_SELECTOR … #define IB_SA_PATH_REC_RATE … #define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR … #define IB_SA_PATH_REC_PACKET_LIFE_TIME … #define IB_SA_PATH_REC_PREFERENCE … enum sa_path_rec_type { … }; struct sa_path_rec_ib { … }; /** * struct sa_path_rec_roce - RoCE specific portion of the path record entry * @route_resolved: When set, it indicates that this route is already * resolved for this path record entry. * @dmac: Destination mac address for the given DGID entry * of the path record entry. */ struct sa_path_rec_roce { … }; struct sa_path_rec_opa { … }; struct sa_path_rec { … }; static inline enum ib_gid_type sa_conv_pathrec_to_gid_type(struct sa_path_rec *rec) { … } static inline enum sa_path_rec_type sa_conv_gid_to_pathrec_type(enum ib_gid_type type) { … } static inline void path_conv_opa_to_ib(struct sa_path_rec *ib, struct sa_path_rec *opa) { … } static inline void path_conv_ib_to_opa(struct sa_path_rec *opa, struct sa_path_rec *ib) { … } /* Convert from OPA to IB path record */ static inline void sa_convert_path_opa_to_ib(struct sa_path_rec *dest, struct sa_path_rec *src) { … } /* Convert from IB to OPA path record */ static inline void sa_convert_path_ib_to_opa(struct sa_path_rec *dest, struct sa_path_rec *src) { … } #define IB_SA_MCMEMBER_REC_MGID … #define IB_SA_MCMEMBER_REC_PORT_GID … #define IB_SA_MCMEMBER_REC_QKEY … #define IB_SA_MCMEMBER_REC_MLID … #define IB_SA_MCMEMBER_REC_MTU_SELECTOR … #define IB_SA_MCMEMBER_REC_MTU … #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS … #define IB_SA_MCMEMBER_REC_PKEY … #define IB_SA_MCMEMBER_REC_RATE_SELECTOR … #define IB_SA_MCMEMBER_REC_RATE … #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR … #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME … #define IB_SA_MCMEMBER_REC_SL … #define IB_SA_MCMEMBER_REC_FLOW_LABEL … #define IB_SA_MCMEMBER_REC_HOP_LIMIT … #define IB_SA_MCMEMBER_REC_SCOPE … #define IB_SA_MCMEMBER_REC_JOIN_STATE … #define IB_SA_MCMEMBER_REC_PROXY_JOIN … struct ib_sa_mcmember_rec { … }; /* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */ #define IB_SA_SERVICE_REC_SERVICE_ID … #define IB_SA_SERVICE_REC_SERVICE_GID … #define IB_SA_SERVICE_REC_SERVICE_PKEY … /* reserved: 3 */ #define IB_SA_SERVICE_REC_SERVICE_LEASE … #define IB_SA_SERVICE_REC_SERVICE_KEY … #define IB_SA_SERVICE_REC_SERVICE_NAME … #define IB_SA_SERVICE_REC_SERVICE_DATA8_0 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_1 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_2 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_3 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_4 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_5 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_6 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_7 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_8 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_9 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_10 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_11 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_12 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_13 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_14 … #define IB_SA_SERVICE_REC_SERVICE_DATA8_15 … #define IB_SA_SERVICE_REC_SERVICE_DATA16_0 … #define IB_SA_SERVICE_REC_SERVICE_DATA16_1 … #define IB_SA_SERVICE_REC_SERVICE_DATA16_2 … #define IB_SA_SERVICE_REC_SERVICE_DATA16_3 … #define IB_SA_SERVICE_REC_SERVICE_DATA16_4 … #define IB_SA_SERVICE_REC_SERVICE_DATA16_5 … #define IB_SA_SERVICE_REC_SERVICE_DATA16_6 … #define IB_SA_SERVICE_REC_SERVICE_DATA16_7 … #define IB_SA_SERVICE_REC_SERVICE_DATA32_0 … #define IB_SA_SERVICE_REC_SERVICE_DATA32_1 … #define IB_SA_SERVICE_REC_SERVICE_DATA32_2 … #define IB_SA_SERVICE_REC_SERVICE_DATA32_3 … #define IB_SA_SERVICE_REC_SERVICE_DATA64_0 … #define IB_SA_SERVICE_REC_SERVICE_DATA64_1 … #define IB_DEFAULT_SERVICE_LEASE … #define IB_SA_GUIDINFO_REC_LID … #define IB_SA_GUIDINFO_REC_BLOCK_NUM … #define IB_SA_GUIDINFO_REC_RES1 … #define IB_SA_GUIDINFO_REC_RES2 … #define IB_SA_GUIDINFO_REC_GID0 … #define IB_SA_GUIDINFO_REC_GID1 … #define IB_SA_GUIDINFO_REC_GID2 … #define IB_SA_GUIDINFO_REC_GID3 … #define IB_SA_GUIDINFO_REC_GID4 … #define IB_SA_GUIDINFO_REC_GID5 … #define IB_SA_GUIDINFO_REC_GID6 … #define IB_SA_GUIDINFO_REC_GID7 … struct ib_sa_guidinfo_rec { … }; struct ib_sa_client { … }; /** * ib_sa_register_client - Register an SA client. */ void ib_sa_register_client(struct ib_sa_client *client); /** * ib_sa_unregister_client - Deregister an SA client. * @client: Client object to deregister. */ void ib_sa_unregister_client(struct ib_sa_client *client); struct ib_sa_query; void ib_sa_cancel_query(int id, struct ib_sa_query *query); int ib_sa_path_rec_get(struct ib_sa_client *client, struct ib_device *device, u32 port_num, struct sa_path_rec *rec, ib_sa_comp_mask comp_mask, unsigned long timeout_ms, gfp_t gfp_mask, void (*callback)(int status, struct sa_path_rec *resp, unsigned int num_prs, void *context), void *context, struct ib_sa_query **query); struct ib_sa_multicast { … }; /** * ib_sa_join_multicast - Initiates a join request to the specified multicast * group. * @client: SA client * @device: Device associated with the multicast group. * @port_num: Port on the specified device to associate with the multicast * group. * @rec: SA multicast member record specifying group attributes. * @comp_mask: Component mask indicating which group attributes of %rec are * valid. * @gfp_mask: GFP mask for memory allocations. * @callback: User callback invoked once the join operation completes. * @context: User specified context stored with the ib_sa_multicast structure. * * This call initiates a multicast join request with the SA for the specified * multicast group. If the join operation is started successfully, it returns * an ib_sa_multicast structure that is used to track the multicast operation. * Users must free this structure by calling ib_free_multicast, even if the * join operation later fails. (The callback status is non-zero.) * * If the join operation fails; status will be non-zero, with the following * failures possible: * -ETIMEDOUT: The request timed out. * -EIO: An error occurred sending the query. * -EINVAL: The MCMemberRecord values differed from the existing group's. * -ENETRESET: Indicates that an fatal error has occurred on the multicast * group, and the user must rejoin the group to continue using it. */ struct ib_sa_multicast *ib_sa_join_multicast(struct ib_sa_client *client, struct ib_device *device, u32 port_num, struct ib_sa_mcmember_rec *rec, ib_sa_comp_mask comp_mask, gfp_t gfp_mask, int (*callback)(int status, struct ib_sa_multicast *multicast), void *context); /** * ib_free_multicast - Frees the multicast tracking structure, and releases * any reference on the multicast group. * @multicast: Multicast tracking structure allocated by ib_join_multicast. * * This call blocks until the multicast identifier is destroyed. It may * not be called from within the multicast callback; however, returning a non- * zero value from the callback will result in destroying the multicast * tracking structure. */ void ib_sa_free_multicast(struct ib_sa_multicast *multicast); /** * ib_get_mcmember_rec - Looks up a multicast member record by its MGID and * returns it if found. * @device: Device associated with the multicast group. * @port_num: Port on the specified device to associate with the multicast * group. * @mgid: MGID of multicast group. * @rec: Location to copy SA multicast member record. */ int ib_sa_get_mcmember_rec(struct ib_device *device, u32 port_num, union ib_gid *mgid, struct ib_sa_mcmember_rec *rec); /** * ib_init_ah_from_mcmember - Initialize address handle attributes based on * an SA multicast member record. */ int ib_init_ah_from_mcmember(struct ib_device *device, u32 port_num, struct ib_sa_mcmember_rec *rec, struct net_device *ndev, enum ib_gid_type gid_type, struct rdma_ah_attr *ah_attr); int ib_init_ah_attr_from_path(struct ib_device *device, u32 port_num, struct sa_path_rec *rec, struct rdma_ah_attr *ah_attr, const struct ib_gid_attr *sgid_attr); /** * ib_sa_pack_path - Conert a path record from struct ib_sa_path_rec * to IB MAD wire format. */ void ib_sa_pack_path(struct sa_path_rec *rec, void *attribute); /** * ib_sa_unpack_path - Convert a path record from MAD format to struct * ib_sa_path_rec. */ void ib_sa_unpack_path(void *attribute, struct sa_path_rec *rec); /* Support GuidInfoRecord */ int ib_sa_guid_info_rec_query(struct ib_sa_client *client, struct ib_device *device, u32 port_num, struct ib_sa_guidinfo_rec *rec, ib_sa_comp_mask comp_mask, u8 method, unsigned long timeout_ms, gfp_t gfp_mask, void (*callback)(int status, struct ib_sa_guidinfo_rec *resp, void *context), void *context, struct ib_sa_query **sa_query); static inline bool sa_path_is_roce(struct sa_path_rec *rec) { … } static inline bool sa_path_is_opa(struct sa_path_rec *rec) { … } static inline void sa_path_set_slid(struct sa_path_rec *rec, u32 slid) { … } static inline void sa_path_set_dlid(struct sa_path_rec *rec, u32 dlid) { … } static inline void sa_path_set_raw_traffic(struct sa_path_rec *rec, u8 raw_traffic) { … } static inline __be32 sa_path_get_slid(struct sa_path_rec *rec) { … } static inline __be32 sa_path_get_dlid(struct sa_path_rec *rec) { … } static inline u8 sa_path_get_raw_traffic(struct sa_path_rec *rec) { … } static inline void sa_path_set_dmac(struct sa_path_rec *rec, u8 *dmac) { … } static inline void sa_path_set_dmac_zero(struct sa_path_rec *rec) { … } static inline u8 *sa_path_get_dmac(struct sa_path_rec *rec) { … } #endif /* IB_SA_H */
Codebase Browser
linux