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 17adc84845SJakub Kicinski struct netlink_policy_dump_state { 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 27adc84845SJakub Kicinski static int add_policy(struct netlink_policy_dump_state **statep, 28d07dcf9aSJohannes Berg const struct nla_policy *policy, 29d07dcf9aSJohannes Berg unsigned int maxtype) 30d07dcf9aSJohannes Berg { 31adc84845SJakub Kicinski struct netlink_policy_dump_state *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++) { 38899b07c5SJohannes Berg if (state->policies[i].policy == policy && 39899b07c5SJohannes Berg state->policies[i].maxtype == maxtype) 40d07dcf9aSJohannes Berg return 0; 41d07dcf9aSJohannes Berg 42d07dcf9aSJohannes Berg if (!state->policies[i].policy) { 43d07dcf9aSJohannes Berg state->policies[i].policy = policy; 44d07dcf9aSJohannes Berg state->policies[i].maxtype = maxtype; 45d07dcf9aSJohannes Berg return 0; 46d07dcf9aSJohannes Berg } 47d07dcf9aSJohannes Berg } 48d07dcf9aSJohannes Berg 49d07dcf9aSJohannes Berg n_alloc = state->n_alloc + INITIAL_POLICIES_ALLOC; 50d07dcf9aSJohannes Berg state = krealloc(state, struct_size(state, policies, n_alloc), 51d07dcf9aSJohannes Berg GFP_KERNEL); 52d07dcf9aSJohannes Berg if (!state) 53d07dcf9aSJohannes Berg return -ENOMEM; 54d07dcf9aSJohannes Berg 55d1fb5559SJohannes Berg memset(&state->policies[state->n_alloc], 0, 56d1fb5559SJohannes Berg flex_array_size(state, policies, n_alloc - state->n_alloc)); 57d1fb5559SJohannes Berg 58d07dcf9aSJohannes Berg state->policies[state->n_alloc].policy = policy; 59d07dcf9aSJohannes Berg state->policies[state->n_alloc].maxtype = maxtype; 60d07dcf9aSJohannes Berg state->n_alloc = n_alloc; 61d07dcf9aSJohannes Berg *statep = state; 62d07dcf9aSJohannes Berg 63d07dcf9aSJohannes Berg return 0; 64d07dcf9aSJohannes Berg } 65d07dcf9aSJohannes Berg 66adc84845SJakub Kicinski static unsigned int get_policy_idx(struct netlink_policy_dump_state *state, 67899b07c5SJohannes Berg const struct nla_policy *policy, 68899b07c5SJohannes Berg unsigned int maxtype) 69d07dcf9aSJohannes Berg { 70d07dcf9aSJohannes Berg unsigned int i; 71d07dcf9aSJohannes Berg 72d07dcf9aSJohannes Berg for (i = 0; i < state->n_alloc; i++) { 73899b07c5SJohannes Berg if (state->policies[i].policy == policy && 74899b07c5SJohannes Berg state->policies[i].maxtype == maxtype) 75d07dcf9aSJohannes Berg return i; 76d07dcf9aSJohannes Berg } 77d07dcf9aSJohannes Berg 78d07dcf9aSJohannes Berg WARN_ON_ONCE(1); 79d07dcf9aSJohannes Berg return -1; 80d07dcf9aSJohannes Berg } 81d07dcf9aSJohannes Berg 82d07dcf9aSJohannes Berg int netlink_policy_dump_start(const struct nla_policy *policy, 83d07dcf9aSJohannes Berg unsigned int maxtype, 84adc84845SJakub Kicinski struct netlink_policy_dump_state **statep) 85d07dcf9aSJohannes Berg { 86adc84845SJakub Kicinski struct netlink_policy_dump_state *state; 87d07dcf9aSJohannes Berg unsigned int policy_idx; 88d07dcf9aSJohannes Berg int err; 89d07dcf9aSJohannes Berg 90adc84845SJakub Kicinski if (*statep) 91d07dcf9aSJohannes Berg return 0; 92d07dcf9aSJohannes Berg 93d07dcf9aSJohannes Berg /* 94d07dcf9aSJohannes Berg * walk the policies and nested ones first, and build 95d07dcf9aSJohannes Berg * a linear list of them. 96d07dcf9aSJohannes Berg */ 97d07dcf9aSJohannes Berg 98d07dcf9aSJohannes Berg state = kzalloc(struct_size(state, policies, INITIAL_POLICIES_ALLOC), 99d07dcf9aSJohannes Berg GFP_KERNEL); 100d07dcf9aSJohannes Berg if (!state) 101d07dcf9aSJohannes Berg return -ENOMEM; 102d07dcf9aSJohannes Berg state->n_alloc = INITIAL_POLICIES_ALLOC; 103d07dcf9aSJohannes Berg 104d07dcf9aSJohannes Berg err = add_policy(&state, policy, maxtype); 105d07dcf9aSJohannes Berg if (err) 106d07dcf9aSJohannes Berg return err; 107d07dcf9aSJohannes Berg 108d07dcf9aSJohannes Berg for (policy_idx = 0; 109d07dcf9aSJohannes Berg policy_idx < state->n_alloc && state->policies[policy_idx].policy; 110d07dcf9aSJohannes Berg policy_idx++) { 111d07dcf9aSJohannes Berg const struct nla_policy *policy; 112d07dcf9aSJohannes Berg unsigned int type; 113d07dcf9aSJohannes Berg 114d07dcf9aSJohannes Berg policy = state->policies[policy_idx].policy; 115d07dcf9aSJohannes Berg 116d07dcf9aSJohannes Berg for (type = 0; 117d07dcf9aSJohannes Berg type <= state->policies[policy_idx].maxtype; 118d07dcf9aSJohannes Berg type++) { 119d07dcf9aSJohannes Berg switch (policy[type].type) { 120d07dcf9aSJohannes Berg case NLA_NESTED: 121d07dcf9aSJohannes Berg case NLA_NESTED_ARRAY: 122d07dcf9aSJohannes Berg err = add_policy(&state, 123d07dcf9aSJohannes Berg policy[type].nested_policy, 124d07dcf9aSJohannes Berg policy[type].len); 125d07dcf9aSJohannes Berg if (err) 126d07dcf9aSJohannes Berg return err; 127d07dcf9aSJohannes Berg break; 128d07dcf9aSJohannes Berg default: 129d07dcf9aSJohannes Berg break; 130d07dcf9aSJohannes Berg } 131d07dcf9aSJohannes Berg } 132d07dcf9aSJohannes Berg } 133d07dcf9aSJohannes Berg 134adc84845SJakub Kicinski *statep = state; 135d07dcf9aSJohannes Berg 136d07dcf9aSJohannes Berg return 0; 137d07dcf9aSJohannes Berg } 138d07dcf9aSJohannes Berg 139adc84845SJakub Kicinski static bool 140adc84845SJakub Kicinski netlink_policy_dump_finished(struct netlink_policy_dump_state *state) 141d07dcf9aSJohannes Berg { 142d07dcf9aSJohannes Berg return state->policy_idx >= state->n_alloc || 143d07dcf9aSJohannes Berg !state->policies[state->policy_idx].policy; 144d07dcf9aSJohannes Berg } 145d07dcf9aSJohannes Berg 146adc84845SJakub Kicinski bool netlink_policy_dump_loop(struct netlink_policy_dump_state *state) 147d07dcf9aSJohannes Berg { 148949ca6b8SJohannes Berg return !netlink_policy_dump_finished(state); 149d07dcf9aSJohannes Berg } 150d07dcf9aSJohannes Berg 151adc84845SJakub Kicinski int netlink_policy_dump_write(struct sk_buff *skb, 152adc84845SJakub Kicinski struct netlink_policy_dump_state *state) 153d07dcf9aSJohannes Berg { 154d07dcf9aSJohannes Berg const struct nla_policy *pt; 155d07dcf9aSJohannes Berg struct nlattr *policy, *attr; 156d07dcf9aSJohannes Berg enum netlink_attribute_type type; 157d07dcf9aSJohannes Berg bool again; 158d07dcf9aSJohannes Berg 159d07dcf9aSJohannes Berg send_attribute: 160d07dcf9aSJohannes Berg again = false; 161d07dcf9aSJohannes Berg 162d07dcf9aSJohannes Berg pt = &state->policies[state->policy_idx].policy[state->attr_idx]; 163d07dcf9aSJohannes Berg 164d07dcf9aSJohannes Berg policy = nla_nest_start(skb, state->policy_idx); 165d07dcf9aSJohannes Berg if (!policy) 166d07dcf9aSJohannes Berg return -ENOBUFS; 167d07dcf9aSJohannes Berg 168d07dcf9aSJohannes Berg attr = nla_nest_start(skb, state->attr_idx); 169d07dcf9aSJohannes Berg if (!attr) 170d07dcf9aSJohannes Berg goto nla_put_failure; 171d07dcf9aSJohannes Berg 172d07dcf9aSJohannes Berg switch (pt->type) { 173d07dcf9aSJohannes Berg default: 174d07dcf9aSJohannes Berg case NLA_UNSPEC: 175d07dcf9aSJohannes Berg case NLA_REJECT: 176d07dcf9aSJohannes Berg /* skip - use NLA_MIN_LEN to advertise such */ 177d07dcf9aSJohannes Berg nla_nest_cancel(skb, policy); 178d07dcf9aSJohannes Berg again = true; 179d07dcf9aSJohannes Berg goto next; 180d07dcf9aSJohannes Berg case NLA_NESTED: 181d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_NESTED; 182df561f66SGustavo A. R. Silva fallthrough; 183d07dcf9aSJohannes Berg case NLA_NESTED_ARRAY: 184d07dcf9aSJohannes Berg if (pt->type == NLA_NESTED_ARRAY) 185d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_NESTED_ARRAY; 186d07dcf9aSJohannes Berg if (pt->nested_policy && pt->len && 187d07dcf9aSJohannes Berg (nla_put_u32(skb, NL_POLICY_TYPE_ATTR_POLICY_IDX, 188899b07c5SJohannes Berg get_policy_idx(state, pt->nested_policy, 189899b07c5SJohannes Berg pt->len)) || 190d07dcf9aSJohannes Berg nla_put_u32(skb, NL_POLICY_TYPE_ATTR_POLICY_MAXTYPE, 191d07dcf9aSJohannes Berg pt->len))) 192d07dcf9aSJohannes Berg goto nla_put_failure; 193d07dcf9aSJohannes Berg break; 194d07dcf9aSJohannes Berg case NLA_U8: 195d07dcf9aSJohannes Berg case NLA_U16: 196d07dcf9aSJohannes Berg case NLA_U32: 197d07dcf9aSJohannes Berg case NLA_U64: 198d07dcf9aSJohannes Berg case NLA_MSECS: { 199d07dcf9aSJohannes Berg struct netlink_range_validation range; 200d07dcf9aSJohannes Berg 201d07dcf9aSJohannes Berg if (pt->type == NLA_U8) 202d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_U8; 203d07dcf9aSJohannes Berg else if (pt->type == NLA_U16) 204d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_U16; 205d07dcf9aSJohannes Berg else if (pt->type == NLA_U32) 206d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_U32; 207d07dcf9aSJohannes Berg else 208d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_U64; 209d07dcf9aSJohannes Berg 210d07dcf9aSJohannes Berg nla_get_range_unsigned(pt, &range); 211d07dcf9aSJohannes Berg 212d07dcf9aSJohannes Berg if (nla_put_u64_64bit(skb, NL_POLICY_TYPE_ATTR_MIN_VALUE_U, 213d07dcf9aSJohannes Berg range.min, NL_POLICY_TYPE_ATTR_PAD) || 214d07dcf9aSJohannes Berg nla_put_u64_64bit(skb, NL_POLICY_TYPE_ATTR_MAX_VALUE_U, 215d07dcf9aSJohannes Berg range.max, NL_POLICY_TYPE_ATTR_PAD)) 216d07dcf9aSJohannes Berg goto nla_put_failure; 217d07dcf9aSJohannes Berg break; 218d07dcf9aSJohannes Berg } 219d07dcf9aSJohannes Berg case NLA_S8: 220d07dcf9aSJohannes Berg case NLA_S16: 221d07dcf9aSJohannes Berg case NLA_S32: 222d07dcf9aSJohannes Berg case NLA_S64: { 223d07dcf9aSJohannes Berg struct netlink_range_validation_signed range; 224d07dcf9aSJohannes Berg 225d07dcf9aSJohannes Berg if (pt->type == NLA_S8) 226d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_S8; 227d07dcf9aSJohannes Berg else if (pt->type == NLA_S16) 228d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_S16; 229d07dcf9aSJohannes Berg else if (pt->type == NLA_S32) 230d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_S32; 231d07dcf9aSJohannes Berg else 232d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_S64; 233d07dcf9aSJohannes Berg 234d07dcf9aSJohannes Berg nla_get_range_signed(pt, &range); 235d07dcf9aSJohannes Berg 236d07dcf9aSJohannes Berg if (nla_put_s64(skb, NL_POLICY_TYPE_ATTR_MIN_VALUE_S, 237d07dcf9aSJohannes Berg range.min, NL_POLICY_TYPE_ATTR_PAD) || 238d07dcf9aSJohannes Berg nla_put_s64(skb, NL_POLICY_TYPE_ATTR_MAX_VALUE_S, 239d07dcf9aSJohannes Berg range.max, NL_POLICY_TYPE_ATTR_PAD)) 240d07dcf9aSJohannes Berg goto nla_put_failure; 241d07dcf9aSJohannes Berg break; 242d07dcf9aSJohannes Berg } 243d07dcf9aSJohannes Berg case NLA_BITFIELD32: 244d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_BITFIELD32; 245d07dcf9aSJohannes Berg if (nla_put_u32(skb, NL_POLICY_TYPE_ATTR_BITFIELD32_MASK, 246d07dcf9aSJohannes Berg pt->bitfield32_valid)) 247d07dcf9aSJohannes Berg goto nla_put_failure; 248d07dcf9aSJohannes Berg break; 249d07dcf9aSJohannes Berg case NLA_STRING: 250d07dcf9aSJohannes Berg case NLA_NUL_STRING: 251d07dcf9aSJohannes Berg case NLA_BINARY: 252d07dcf9aSJohannes Berg if (pt->type == NLA_STRING) 253d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_STRING; 254d07dcf9aSJohannes Berg else if (pt->type == NLA_NUL_STRING) 255d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_NUL_STRING; 256d07dcf9aSJohannes Berg else 257d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_BINARY; 2588aa26c57SJohannes Berg 259c30a3c95SJohannes Berg if (pt->validation_type == NLA_VALIDATE_RANGE || 260c30a3c95SJohannes Berg pt->validation_type == NLA_VALIDATE_RANGE_WARN_TOO_LONG) { 2618aa26c57SJohannes Berg struct netlink_range_validation range; 2628aa26c57SJohannes Berg 2638aa26c57SJohannes Berg nla_get_range_unsigned(pt, &range); 2648aa26c57SJohannes Berg 2658aa26c57SJohannes Berg if (range.min && 2668aa26c57SJohannes Berg nla_put_u32(skb, NL_POLICY_TYPE_ATTR_MIN_LENGTH, 2678aa26c57SJohannes Berg range.min)) 268d07dcf9aSJohannes Berg goto nla_put_failure; 2698aa26c57SJohannes Berg 2708aa26c57SJohannes Berg if (range.max < U16_MAX && 2718aa26c57SJohannes Berg nla_put_u32(skb, NL_POLICY_TYPE_ATTR_MAX_LENGTH, 2728aa26c57SJohannes Berg range.max)) 273d07dcf9aSJohannes Berg goto nla_put_failure; 2748aa26c57SJohannes Berg } else if (pt->len && 2758aa26c57SJohannes Berg nla_put_u32(skb, NL_POLICY_TYPE_ATTR_MAX_LENGTH, 2768aa26c57SJohannes Berg pt->len)) { 2778aa26c57SJohannes Berg goto nla_put_failure; 2788aa26c57SJohannes Berg } 279d07dcf9aSJohannes Berg break; 280d07dcf9aSJohannes Berg case NLA_FLAG: 281d07dcf9aSJohannes Berg type = NL_ATTR_TYPE_FLAG; 282d07dcf9aSJohannes Berg break; 283d07dcf9aSJohannes Berg } 284d07dcf9aSJohannes Berg 285d07dcf9aSJohannes Berg if (nla_put_u32(skb, NL_POLICY_TYPE_ATTR_TYPE, type)) 286d07dcf9aSJohannes Berg goto nla_put_failure; 287d07dcf9aSJohannes Berg 288d07dcf9aSJohannes Berg /* finish and move state to next attribute */ 289d07dcf9aSJohannes Berg nla_nest_end(skb, attr); 290d07dcf9aSJohannes Berg nla_nest_end(skb, policy); 291d07dcf9aSJohannes Berg 292d07dcf9aSJohannes Berg next: 293d07dcf9aSJohannes Berg state->attr_idx += 1; 294d07dcf9aSJohannes Berg if (state->attr_idx > state->policies[state->policy_idx].maxtype) { 295d07dcf9aSJohannes Berg state->attr_idx = 0; 296d07dcf9aSJohannes Berg state->policy_idx++; 297d07dcf9aSJohannes Berg } 298d07dcf9aSJohannes Berg 299d07dcf9aSJohannes Berg if (again) { 300d07dcf9aSJohannes Berg if (netlink_policy_dump_finished(state)) 301d07dcf9aSJohannes Berg return -ENODATA; 302d07dcf9aSJohannes Berg goto send_attribute; 303d07dcf9aSJohannes Berg } 304d07dcf9aSJohannes Berg 305d07dcf9aSJohannes Berg return 0; 306d07dcf9aSJohannes Berg 307d07dcf9aSJohannes Berg nla_put_failure: 308d07dcf9aSJohannes Berg nla_nest_cancel(skb, policy); 309d07dcf9aSJohannes Berg return -ENOBUFS; 310d07dcf9aSJohannes Berg } 311949ca6b8SJohannes Berg 312adc84845SJakub Kicinski void netlink_policy_dump_free(struct netlink_policy_dump_state *state) 313949ca6b8SJohannes Berg { 314949ca6b8SJohannes Berg kfree(state); 315949ca6b8SJohannes Berg } 316