1d07dcf9aSJohannes Berg // SPDX-License-Identifier: GPL-2.0 2d07dcf9aSJohannes Berg /* 3d07dcf9aSJohannes Berg * NETLINK Policy advertisement to userspace 4d07dcf9aSJohannes Berg * 5d07dcf9aSJohannes Berg * Authors: Johannes Berg <johannes@sipsolutions.net> 6d07dcf9aSJohannes Berg * 7d07dcf9aSJohannes Berg * Copyright 2019 Intel Corporation 8d07dcf9aSJohannes Berg */ 9d07dcf9aSJohannes Berg 10d07dcf9aSJohannes Berg #include <linux/kernel.h> 11d07dcf9aSJohannes Berg #include <linux/errno.h> 12d07dcf9aSJohannes Berg #include <linux/types.h> 13d07dcf9aSJohannes Berg #include <net/netlink.h> 14d07dcf9aSJohannes Berg 15d07dcf9aSJohannes Berg #define INITIAL_POLICIES_ALLOC 10 16d07dcf9aSJohannes Berg 17d07dcf9aSJohannes Berg struct nl_policy_dump { 18d07dcf9aSJohannes Berg unsigned int policy_idx; 19d07dcf9aSJohannes Berg unsigned int attr_idx; 20d07dcf9aSJohannes Berg unsigned int n_alloc; 21d07dcf9aSJohannes Berg struct { 22d07dcf9aSJohannes Berg const struct nla_policy *policy; 23d07dcf9aSJohannes Berg unsigned int maxtype; 24d07dcf9aSJohannes Berg } policies[]; 25d07dcf9aSJohannes Berg }; 26d07dcf9aSJohannes Berg 27d07dcf9aSJohannes Berg static int add_policy(struct nl_policy_dump **statep, 28d07dcf9aSJohannes Berg const struct nla_policy *policy, 29d07dcf9aSJohannes Berg unsigned int maxtype) 30d07dcf9aSJohannes Berg { 31d07dcf9aSJohannes Berg struct nl_policy_dump *state = *statep; 32d07dcf9aSJohannes Berg unsigned int n_alloc, i; 33d07dcf9aSJohannes Berg 34d07dcf9aSJohannes Berg if (!policy || !maxtype) 35d07dcf9aSJohannes Berg return 0; 36d07dcf9aSJohannes Berg 37d07dcf9aSJohannes Berg for (i = 0; i < state->n_alloc; i++) { 38d07dcf9aSJohannes Berg if (state->policies[i].policy == policy) 39d07dcf9aSJohannes Berg return 0; 40d07dcf9aSJohannes Berg 41d07dcf9aSJohannes Berg if (!state->policies[i].policy) { 42d07dcf9aSJohannes Berg state->policies[i].policy = policy; 43d07dcf9aSJohannes Berg state->policies[i].maxtype = maxtype; 44d07dcf9aSJohannes Berg return 0; 45d07dcf9aSJohannes Berg } 46d07dcf9aSJohannes Berg } 47d07dcf9aSJohannes Berg 48d07dcf9aSJohannes Berg n_alloc = state->n_alloc + INITIAL_POLICIES_ALLOC; 49d07dcf9aSJohannes Berg state = krealloc(state, struct_size(state, policies, n_alloc), 50d07dcf9aSJohannes Berg GFP_KERNEL); 51d07dcf9aSJohannes Berg if (!state) 52d07dcf9aSJohannes Berg return -ENOMEM; 53d07dcf9aSJohannes Berg 54d1fb5559SJohannes Berg memset(&state->policies[state->n_alloc], 0, 55d1fb5559SJohannes Berg flex_array_size(state, policies, n_alloc - state->n_alloc)); 56d1fb5559SJohannes Berg 57d07dcf9aSJohannes Berg state->policies[state->n_alloc].policy = policy; 58d07dcf9aSJohannes Berg state->policies[state->n_alloc].maxtype = maxtype; 59d07dcf9aSJohannes Berg state->n_alloc = n_alloc; 60d07dcf9aSJohannes Berg *statep = state; 61d07dcf9aSJohannes Berg 62d07dcf9aSJohannes Berg return 0; 63d07dcf9aSJohannes Berg } 64d07dcf9aSJohannes Berg 65d07dcf9aSJohannes Berg static unsigned int get_policy_idx(struct nl_policy_dump *state, 66d07dcf9aSJohannes Berg const struct nla_policy *policy) 67d07dcf9aSJohannes Berg { 68d07dcf9aSJohannes Berg unsigned int i; 69d07dcf9aSJohannes Berg 70d07dcf9aSJohannes Berg for (i = 0; i < state->n_alloc; i++) { 71d07dcf9aSJohannes Berg if (state->policies[i].policy == policy) 72d07dcf9aSJohannes Berg return i; 73d07dcf9aSJohannes Berg } 74d07dcf9aSJohannes Berg 75d07dcf9aSJohannes Berg WARN_ON_ONCE(1); 76d07dcf9aSJohannes Berg return -1; 77d07dcf9aSJohannes Berg } 78d07dcf9aSJohannes Berg 79d07dcf9aSJohannes Berg int netlink_policy_dump_start(const struct nla_policy *policy, 80d07dcf9aSJohannes Berg unsigned int maxtype, 81d07dcf9aSJohannes Berg unsigned long *_state) 82d07dcf9aSJohannes Berg { 83d07dcf9aSJohannes Berg struct nl_policy_dump *state; 84d07dcf9aSJohannes Berg unsigned int policy_idx; 85d07dcf9aSJohannes Berg int err; 86d07dcf9aSJohannes Berg 87d07dcf9aSJohannes Berg if (*_state) 88d07dcf9aSJohannes Berg return 0; 89d07dcf9aSJohannes Berg 90d07dcf9aSJohannes Berg /* 91d07dcf9aSJohannes Berg * walk the policies and nested ones first, and build 92d07dcf9aSJohannes Berg * a linear list of them. 93d07dcf9aSJohannes Berg */ 94d07dcf9aSJohannes Berg 95d07dcf9aSJohannes Berg state = kzalloc(struct_size(state, policies, INITIAL_POLICIES_ALLOC), 96d07dcf9aSJohannes Berg GFP_KERNEL); 97d07dcf9aSJohannes Berg if (!state) 98d07dcf9aSJohannes Berg return -ENOMEM; 99d07dcf9aSJohannes Berg state->n_alloc = INITIAL_POLICIES_ALLOC; 100d07dcf9aSJohannes Berg 101d07dcf9aSJohannes Berg err = add_policy(&state, policy, maxtype); 102d07dcf9aSJohannes Berg if (err) 103d07dcf9aSJohannes Berg return err; 104d07dcf9aSJohannes Berg 105d07dcf9aSJohannes Berg for (policy_idx = 0; 106d07dcf9aSJohannes Berg policy_idx < state->n_alloc && state->policies[policy_idx].policy; 107d07dcf9aSJohannes Berg policy_idx++) { 108d07dcf9aSJohannes Berg const struct nla_policy *policy; 109d07dcf9aSJohannes Berg unsigned int type; 110d07dcf9aSJohannes Berg 111d07dcf9aSJohannes Berg policy = state->policies[policy_idx].policy; 112d07dcf9aSJohannes Berg 113d07dcf9aSJohannes Berg for (type = 0; 114d07dcf9aSJohannes Berg type <= state->policies[policy_idx].maxtype; 115d07dcf9aSJohannes Berg type++) { 116d07dcf9aSJohannes Berg switch (policy[type].type) { 117d07dcf9aSJohannes Berg case NLA_NESTED: 118d07dcf9aSJohannes Berg case NLA_NESTED_ARRAY: 119d07dcf9aSJohannes Berg err = add_policy(&state, 120d07dcf9aSJohannes Berg policy[type].nested_policy, 121d07dcf9aSJohannes Berg policy[type].len); 122d07dcf9aSJohannes Berg if (err) 123d07dcf9aSJohannes Berg return err; 124d07dcf9aSJohannes Berg break; 125d07dcf9aSJohannes Berg default: 126d07dcf9aSJohannes Berg break; 127d07dcf9aSJohannes Berg } 128d07dcf9aSJohannes Berg } 129d07dcf9aSJohannes Berg } 130d07dcf9aSJohannes Berg 131d07dcf9aSJohannes Berg *_state = (unsigned long)state; 132d07dcf9aSJohannes Berg 133d07dcf9aSJohannes Berg return 0; 134d07dcf9aSJohannes Berg } 135d07dcf9aSJohannes Berg 136d07dcf9aSJohannes Berg static bool netlink_policy_dump_finished(struct nl_policy_dump *state) 137d07dcf9aSJohannes Berg { 138d07dcf9aSJohannes Berg return state->policy_idx >= state->n_alloc || 139d07dcf9aSJohannes Berg !state->policies[state->policy_idx].policy; 140d07dcf9aSJohannes Berg } 141d07dcf9aSJohannes Berg 142949ca6b8SJohannes Berg bool netlink_policy_dump_loop(unsigned long _state) 143d07dcf9aSJohannes Berg { 144949ca6b8SJohannes Berg struct nl_policy_dump *state = (void *)_state; 145d07dcf9aSJohannes Berg 146949ca6b8SJohannes Berg return !netlink_policy_dump_finished(state); 147d07dcf9aSJohannes Berg } 148d07dcf9aSJohannes Berg 149d07dcf9aSJohannes Berg int netlink_policy_dump_write(struct sk_buff *skb, unsigned long _state) 150d07dcf9aSJohannes Berg { 151d07dcf9aSJohannes Berg struct nl_policy_dump *state = (void *)_state; 152d07dcf9aSJohannes Berg const struct nla_policy *pt; 153d07dcf9aSJohannes Berg struct nlattr *policy, *attr; 154d07dcf9aSJohannes Berg enum netlink_attribute_type type; 155d07dcf9aSJohannes Berg bool again; 156d07dcf9aSJohannes Berg 157d07dcf9aSJohannes Berg send_attribute: 158d07dcf9aSJohannes Berg again = false; 159d07dcf9aSJohannes Berg 160d07dcf9aSJohannes Berg pt = &state->policies[state->policy_idx].policy[state->attr_idx]; 161d07dcf9aSJohannes Berg 162d07dcf9aSJohannes Berg policy = nla_nest_start(skb, state->policy_idx); 163d07dcf9aSJohannes Berg if (!policy) 164d07dcf9aSJohannes Berg return -ENOBUFS; 165d07dcf9aSJohannes Berg 166d07dcf9aSJohannes Berg attr = nla_nest_start(skb, state->attr_idx); 167d07dcf9aSJohannes Berg if (!attr) 168d07dcf9aSJohannes Berg goto nla_put_failure; 169d07dcf9aSJohannes Berg 170d07dcf9aSJohannes Berg switch (pt->type) { 171d07dcf9aSJohannes Berg default: 172d07dcf9aSJohannes Berg case NLA_UNSPEC: 173d07dcf9aSJohannes Berg case NLA_REJECT: 174d07dcf9aSJohannes Berg /* skip - use NLA_MIN_LEN to advertise such */ 175d07dcf9aSJohannes Berg nla_nest_cancel(skb, policy); 176d07dcf9aSJohannes Berg again = true; 177d07dcf9aSJohannes Berg goto next; 178d07dcf9aSJohannes Berg case NLA_NESTED: 179d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_NESTED; 180df561f66SGustavo A. R. Silva fallthrough; 181d07dcf9aSJohannes Berg case NLA_NESTED_ARRAY: 182d07dcf9aSJohannes Berg if (pt->type == NLA_NESTED_ARRAY) 183d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_NESTED_ARRAY; 184d07dcf9aSJohannes Berg if (pt->nested_policy && pt->len && 185d07dcf9aSJohannes Berg (nla_put_u32(skb, NL_POLICY_TYPE_ATTR_POLICY_IDX, 186d07dcf9aSJohannes Berg get_policy_idx(state, pt->nested_policy)) || 187d07dcf9aSJohannes Berg nla_put_u32(skb, NL_POLICY_TYPE_ATTR_POLICY_MAXTYPE, 188d07dcf9aSJohannes Berg pt->len))) 189d07dcf9aSJohannes Berg goto nla_put_failure; 190d07dcf9aSJohannes Berg break; 191d07dcf9aSJohannes Berg case NLA_U8: 192d07dcf9aSJohannes Berg case NLA_U16: 193d07dcf9aSJohannes Berg case NLA_U32: 194d07dcf9aSJohannes Berg case NLA_U64: 195d07dcf9aSJohannes Berg case NLA_MSECS: { 196d07dcf9aSJohannes Berg struct netlink_range_validation range; 197d07dcf9aSJohannes Berg 198d07dcf9aSJohannes Berg if (pt->type == NLA_U8) 199d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_U8; 200d07dcf9aSJohannes Berg else if (pt->type == NLA_U16) 201d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_U16; 202d07dcf9aSJohannes Berg else if (pt->type == NLA_U32) 203d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_U32; 204d07dcf9aSJohannes Berg else 205d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_U64; 206d07dcf9aSJohannes Berg 207d07dcf9aSJohannes Berg nla_get_range_unsigned(pt, &range); 208d07dcf9aSJohannes Berg 209d07dcf9aSJohannes Berg if (nla_put_u64_64bit(skb, NL_POLICY_TYPE_ATTR_MIN_VALUE_U, 210d07dcf9aSJohannes Berg range.min, NL_POLICY_TYPE_ATTR_PAD) || 211d07dcf9aSJohannes Berg nla_put_u64_64bit(skb, NL_POLICY_TYPE_ATTR_MAX_VALUE_U, 212d07dcf9aSJohannes Berg range.max, NL_POLICY_TYPE_ATTR_PAD)) 213d07dcf9aSJohannes Berg goto nla_put_failure; 214d07dcf9aSJohannes Berg break; 215d07dcf9aSJohannes Berg } 216d07dcf9aSJohannes Berg case NLA_S8: 217d07dcf9aSJohannes Berg case NLA_S16: 218d07dcf9aSJohannes Berg case NLA_S32: 219d07dcf9aSJohannes Berg case NLA_S64: { 220d07dcf9aSJohannes Berg struct netlink_range_validation_signed range; 221d07dcf9aSJohannes Berg 222d07dcf9aSJohannes Berg if (pt->type == NLA_S8) 223d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_S8; 224d07dcf9aSJohannes Berg else if (pt->type == NLA_S16) 225d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_S16; 226d07dcf9aSJohannes Berg else if (pt->type == NLA_S32) 227d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_S32; 228d07dcf9aSJohannes Berg else 229d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_S64; 230d07dcf9aSJohannes Berg 231d07dcf9aSJohannes Berg nla_get_range_signed(pt, &range); 232d07dcf9aSJohannes Berg 233d07dcf9aSJohannes Berg if (nla_put_s64(skb, NL_POLICY_TYPE_ATTR_MIN_VALUE_S, 234d07dcf9aSJohannes Berg range.min, NL_POLICY_TYPE_ATTR_PAD) || 235d07dcf9aSJohannes Berg nla_put_s64(skb, NL_POLICY_TYPE_ATTR_MAX_VALUE_S, 236d07dcf9aSJohannes Berg range.max, NL_POLICY_TYPE_ATTR_PAD)) 237d07dcf9aSJohannes Berg goto nla_put_failure; 238d07dcf9aSJohannes Berg break; 239d07dcf9aSJohannes Berg } 240d07dcf9aSJohannes Berg case NLA_BITFIELD32: 241d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_BITFIELD32; 242d07dcf9aSJohannes Berg if (nla_put_u32(skb, NL_POLICY_TYPE_ATTR_BITFIELD32_MASK, 243d07dcf9aSJohannes Berg pt->bitfield32_valid)) 244d07dcf9aSJohannes Berg goto nla_put_failure; 245d07dcf9aSJohannes Berg break; 246d07dcf9aSJohannes Berg case NLA_STRING: 247d07dcf9aSJohannes Berg case NLA_NUL_STRING: 248d07dcf9aSJohannes Berg case NLA_BINARY: 249d07dcf9aSJohannes Berg if (pt->type == NLA_STRING) 250d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_STRING; 251d07dcf9aSJohannes Berg else if (pt->type == NLA_NUL_STRING) 252d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_NUL_STRING; 253d07dcf9aSJohannes Berg else 254d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_BINARY; 2558aa26c57SJohannes Berg 256c30a3c95SJohannes Berg if (pt->validation_type == NLA_VALIDATE_RANGE || 257c30a3c95SJohannes Berg pt->validation_type == NLA_VALIDATE_RANGE_WARN_TOO_LONG) { 2588aa26c57SJohannes Berg struct netlink_range_validation range; 2598aa26c57SJohannes Berg 2608aa26c57SJohannes Berg nla_get_range_unsigned(pt, &range); 2618aa26c57SJohannes Berg 2628aa26c57SJohannes Berg if (range.min && 2638aa26c57SJohannes Berg nla_put_u32(skb, NL_POLICY_TYPE_ATTR_MIN_LENGTH, 2648aa26c57SJohannes Berg range.min)) 265d07dcf9aSJohannes Berg goto nla_put_failure; 2668aa26c57SJohannes Berg 2678aa26c57SJohannes Berg if (range.max < U16_MAX && 2688aa26c57SJohannes Berg nla_put_u32(skb, NL_POLICY_TYPE_ATTR_MAX_LENGTH, 2698aa26c57SJohannes Berg range.max)) 270d07dcf9aSJohannes Berg goto nla_put_failure; 2718aa26c57SJohannes Berg } else if (pt->len && 2728aa26c57SJohannes Berg nla_put_u32(skb, NL_POLICY_TYPE_ATTR_MAX_LENGTH, 2738aa26c57SJohannes Berg pt->len)) { 2748aa26c57SJohannes Berg goto nla_put_failure; 2758aa26c57SJohannes Berg } 276d07dcf9aSJohannes Berg break; 277d07dcf9aSJohannes Berg case NLA_FLAG: 278d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_FLAG; 279d07dcf9aSJohannes Berg break; 280d07dcf9aSJohannes Berg } 281d07dcf9aSJohannes Berg 282d07dcf9aSJohannes Berg if (nla_put_u32(skb, NL_POLICY_TYPE_ATTR_TYPE, type)) 283d07dcf9aSJohannes Berg goto nla_put_failure; 284d07dcf9aSJohannes Berg 285d07dcf9aSJohannes Berg /* finish and move state to next attribute */ 286d07dcf9aSJohannes Berg nla_nest_end(skb, attr); 287d07dcf9aSJohannes Berg nla_nest_end(skb, policy); 288d07dcf9aSJohannes Berg 289d07dcf9aSJohannes Berg next: 290d07dcf9aSJohannes Berg state->attr_idx += 1; 291d07dcf9aSJohannes Berg if (state->attr_idx > state->policies[state->policy_idx].maxtype) { 292d07dcf9aSJohannes Berg state->attr_idx = 0; 293d07dcf9aSJohannes Berg state->policy_idx++; 294d07dcf9aSJohannes Berg } 295d07dcf9aSJohannes Berg 296d07dcf9aSJohannes Berg if (again) { 297d07dcf9aSJohannes Berg if (netlink_policy_dump_finished(state)) 298d07dcf9aSJohannes Berg return -ENODATA; 299d07dcf9aSJohannes Berg goto send_attribute; 300d07dcf9aSJohannes Berg } 301d07dcf9aSJohannes Berg 302d07dcf9aSJohannes Berg return 0; 303d07dcf9aSJohannes Berg 304d07dcf9aSJohannes Berg nla_put_failure: 305d07dcf9aSJohannes Berg nla_nest_cancel(skb, policy); 306d07dcf9aSJohannes Berg return -ENOBUFS; 307d07dcf9aSJohannes Berg } 308949ca6b8SJohannes Berg 309949ca6b8SJohannes Berg void netlink_policy_dump_free(unsigned long _state) 310949ca6b8SJohannes Berg { 311949ca6b8SJohannes Berg struct nl_policy_dump *state = (void *)_state; 312949ca6b8SJohannes Berg 313949ca6b8SJohannes Berg kfree(state); 314949ca6b8SJohannes Berg } 315