1/* 2 * Copyright (c) 2014 Intel Corporation. All rights reserved. 3 * Copyright (c) 2014 Chelsio, Inc. All rights reserved. 4 * 5 * This software is available to you under a choice of one of two 6 * licenses. You may choose to be licensed under the terms of the GNU 7 * General Public License (GPL) Version 2, available from the file 8 * COPYING in the main directory of this source tree, or the 9 * OpenIB.org BSD license below: 10 * 11 * Redistribution and use in source and binary forms, with or 12 * without modification, are permitted provided that the following 13 * conditions are met: 14 * 15 * - Redistributions of source code must retain the above 16 * copyright notice, this list of conditions and the following 17 * disclaimer. 18 * 19 * - Redistributions in binary form must reproduce the above 20 * copyright notice, this list of conditions and the following 21 * disclaimer in the documentation and/or other materials 22 * provided with the distribution. 23 * 24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 31 * SOFTWARE. 32 */ 33#ifndef _IWPM_UTIL_H 34#define _IWPM_UTIL_H 35 36#include <linux/module.h> 37#include <linux/io.h> 38#include <linux/in.h> 39#include <linux/in6.h> 40#include <linux/spinlock.h> 41#include <linux/kernel.h> 42#include <linux/netdevice.h> 43#include <linux/delay.h> 44#include <linux/workqueue.h> 45#include <linux/mutex.h> 46#include <linux/jhash.h> 47#include <linux/kref.h> 48#include <net/netlink.h> 49#include <linux/errno.h> 50#include <rdma/iw_portmap.h> 51#include <rdma/rdma_netlink.h> 52 53 54#define IWPM_NL_RETRANS 3 55#define IWPM_NL_TIMEOUT (10*HZ) 56#define IWPM_MAPINFO_SKB_COUNT 20 57 58#define IWPM_PID_UNDEFINED -1 59#define IWPM_PID_UNAVAILABLE -2 60 61#define IWPM_REG_UNDEF 0x01 62#define IWPM_REG_VALID 0x02 63#define IWPM_REG_INCOMPL 0x04 64 65struct iwpm_nlmsg_request { 66 struct list_head inprocess_list; 67 __u32 nlmsg_seq; 68 void *req_buffer; 69 u8 nl_client; 70 u8 request_done; 71 u16 err_code; 72 struct semaphore sem; 73 struct kref kref; 74}; 75 76struct iwpm_mapping_info { 77 struct hlist_node hlist_node; 78 struct sockaddr_storage local_sockaddr; 79 struct sockaddr_storage mapped_sockaddr; 80 u8 nl_client; 81 u32 map_flags; 82}; 83 84struct iwpm_remote_info { 85 struct hlist_node hlist_node; 86 struct sockaddr_storage remote_sockaddr; 87 struct sockaddr_storage mapped_loc_sockaddr; 88 struct sockaddr_storage mapped_rem_sockaddr; 89 u8 nl_client; 90}; 91 92struct iwpm_admin_data { 93 atomic_t nlmsg_seq; 94 u32 reg_list[RDMA_NL_NUM_CLIENTS]; 95}; 96 97/** 98 * iwpm_get_nlmsg_request - Allocate and initialize netlink message request 99 * @nlmsg_seq: Sequence number of the netlink message 100 * @nl_client: The index of the netlink client 101 * @gfp: Indicates how the memory for the request should be allocated 102 * 103 * Returns the newly allocated netlink request object if successful, 104 * otherwise returns NULL 105 */ 106struct iwpm_nlmsg_request *iwpm_get_nlmsg_request(__u32 nlmsg_seq, 107 u8 nl_client, gfp_t gfp); 108 109/** 110 * iwpm_free_nlmsg_request - Deallocate netlink message request 111 * @kref: Holds reference of netlink message request 112 */ 113void iwpm_free_nlmsg_request(struct kref *kref); 114 115/** 116 * iwpm_find_nlmsg_request - Find netlink message request in the request list 117 * @echo_seq: Sequence number of the netlink request to find 118 * 119 * Returns the found netlink message request, 120 * if not found, returns NULL 121 */ 122struct iwpm_nlmsg_request *iwpm_find_nlmsg_request(__u32 echo_seq); 123 124/** 125 * iwpm_wait_complete_req - Block while servicing the netlink request 126 * @nlmsg_request: Netlink message request to service 127 * 128 * Wakes up, after the request is completed or expired 129 * Returns 0 if the request is complete without error 130 */ 131int iwpm_wait_complete_req(struct iwpm_nlmsg_request *nlmsg_request); 132 133/** 134 * iwpm_get_nlmsg_seq - Get the sequence number for a netlink 135 * message to send to the port mapper 136 * 137 * Returns the sequence number for the netlink message. 138 */ 139int iwpm_get_nlmsg_seq(void); 140 141/** 142 * iwpm_add_remote_info - Add remote address info of the connecting peer 143 * to the remote info hash table 144 * @reminfo: The remote info to be added 145 */ 146void iwpm_add_remote_info(struct iwpm_remote_info *reminfo); 147 148/** 149 * iwpm_check_registration - Check if the client registration 150 * matches the given one 151 * @nl_client: The index of the netlink client 152 * @reg: The given registration type to compare with 153 * 154 * Call iwpm_register_pid() to register a client 155 * Returns true if the client registration matches reg, 156 * otherwise returns false 157 */ 158u32 iwpm_check_registration(u8 nl_client, u32 reg); 159 160/** 161 * iwpm_set_registration - Set the client registration 162 * @nl_client: The index of the netlink client 163 * @reg: Registration type to set 164 */ 165void iwpm_set_registration(u8 nl_client, u32 reg); 166 167/** 168 * iwpm_get_registration - Get the client registration 169 * @nl_client: The index of the netlink client 170 * 171 * Returns the client registration type 172 */ 173u32 iwpm_get_registration(u8 nl_client); 174 175/** 176 * iwpm_send_mapinfo - Send local and mapped IPv4/IPv6 address info of 177 * a client to the user space port mapper 178 * @nl_client: The index of the netlink client 179 * @iwpm_pid: The pid of the user space port mapper 180 * 181 * If successful, returns the number of sent mapping info records 182 */ 183int iwpm_send_mapinfo(u8 nl_client, int iwpm_pid); 184 185/** 186 * iwpm_mapinfo_available - Check if any mapping info records is available 187 * in the hash table 188 * 189 * Returns 1 if mapping information is available, otherwise returns 0 190 */ 191int iwpm_mapinfo_available(void); 192 193/** 194 * iwpm_compare_sockaddr - Compare two sockaddr storage structs 195 * @a_sockaddr: first sockaddr to compare 196 * @b_sockaddr: second sockaddr to compare 197 * 198 * Return: 0 if they are holding the same ip/tcp address info, 199 * otherwise returns 1 200 */ 201int iwpm_compare_sockaddr(struct sockaddr_storage *a_sockaddr, 202 struct sockaddr_storage *b_sockaddr); 203 204/** 205 * iwpm_validate_nlmsg_attr - Check for NULL netlink attributes 206 * @nltb: Holds address of each netlink message attributes 207 * @nla_count: Number of netlink message attributes 208 * 209 * Returns error if any of the nla_count attributes is NULL 210 */ 211static inline int iwpm_validate_nlmsg_attr(struct nlattr *nltb[], 212 int nla_count) 213{ 214 int i; 215 for (i = 1; i < nla_count; i++) { 216 if (!nltb[i]) 217 return -EINVAL; 218 } 219 return 0; 220} 221 222/** 223 * iwpm_create_nlmsg - Allocate skb and form a netlink message 224 * @nl_op: Netlink message opcode 225 * @nlh: Holds address of the netlink message header in skb 226 * @nl_client: The index of the netlink client 227 * 228 * Returns the newly allcated skb, or NULL if the tailroom of the skb 229 * is insufficient to store the message header and payload 230 */ 231struct sk_buff *iwpm_create_nlmsg(u32 nl_op, struct nlmsghdr **nlh, 232 int nl_client); 233 234/** 235 * iwpm_parse_nlmsg - Validate and parse the received netlink message 236 * @cb: Netlink callback structure 237 * @policy_max: Maximum attribute type to be expected 238 * @nlmsg_policy: Validation policy 239 * @nltb: Array to store policy_max parsed elements 240 * @msg_type: Type of netlink message 241 * 242 * Returns 0 on success or a negative error code 243 */ 244int iwpm_parse_nlmsg(struct netlink_callback *cb, int policy_max, 245 const struct nla_policy *nlmsg_policy, 246 struct nlattr *nltb[], const char *msg_type); 247 248/** 249 * iwpm_print_sockaddr - Print IPv4/IPv6 address and TCP port 250 * @sockaddr: Socket address to print 251 * @msg: Message to print 252 */ 253void iwpm_print_sockaddr(struct sockaddr_storage *sockaddr, char *msg); 254 255/** 256 * iwpm_send_hello - Send hello response to iwpmd 257 * 258 * @nl_client: The index of the netlink client 259 * @iwpm_pid: The pid of the user space port mapper 260 * @abi_version: The kernel's abi_version 261 * 262 * Returns 0 on success or a negative error code 263 */ 264int iwpm_send_hello(u8 nl_client, int iwpm_pid, u16 abi_version); 265extern u16 iwpm_ulib_version; 266#endif 267