1 /* 2 * include/net/devlink.h - Network physical device Netlink interface 3 * Copyright (c) 2016 Mellanox Technologies. All rights reserved. 4 * Copyright (c) 2016 Jiri Pirko <jiri@mellanox.com> 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation; either version 2 of the License, or 9 * (at your option) any later version. 10 */ 11 #ifndef _NET_DEVLINK_H_ 12 #define _NET_DEVLINK_H_ 13 14 #include <linux/device.h> 15 #include <linux/slab.h> 16 #include <linux/gfp.h> 17 #include <linux/list.h> 18 #include <linux/netdevice.h> 19 #include <net/net_namespace.h> 20 #include <uapi/linux/devlink.h> 21 22 struct devlink_ops; 23 24 struct devlink { 25 struct list_head list; 26 struct list_head port_list; 27 struct list_head sb_list; 28 struct list_head dpipe_table_list; 29 struct list_head resource_list; 30 struct devlink_dpipe_headers *dpipe_headers; 31 const struct devlink_ops *ops; 32 struct device *dev; 33 possible_net_t _net; 34 struct mutex lock; 35 char priv[0] __aligned(NETDEV_ALIGN); 36 }; 37 38 struct devlink_port { 39 struct list_head list; 40 struct devlink *devlink; 41 unsigned index; 42 bool registered; 43 enum devlink_port_type type; 44 enum devlink_port_type desired_type; 45 void *type_dev; 46 bool split; 47 u32 split_group; 48 }; 49 50 struct devlink_sb_pool_info { 51 enum devlink_sb_pool_type pool_type; 52 u32 size; 53 enum devlink_sb_threshold_type threshold_type; 54 }; 55 56 /** 57 * struct devlink_dpipe_field - dpipe field object 58 * @name: field name 59 * @id: index inside the headers field array 60 * @bitwidth: bitwidth 61 * @mapping_type: mapping type 62 */ 63 struct devlink_dpipe_field { 64 const char *name; 65 unsigned int id; 66 unsigned int bitwidth; 67 enum devlink_dpipe_field_mapping_type mapping_type; 68 }; 69 70 /** 71 * struct devlink_dpipe_header - dpipe header object 72 * @name: header name 73 * @id: index, global/local detrmined by global bit 74 * @fields: fields 75 * @fields_count: number of fields 76 * @global: indicates if header is shared like most protocol header 77 * or driver specific 78 */ 79 struct devlink_dpipe_header { 80 const char *name; 81 unsigned int id; 82 struct devlink_dpipe_field *fields; 83 unsigned int fields_count; 84 bool global; 85 }; 86 87 /** 88 * struct devlink_dpipe_match - represents match operation 89 * @type: type of match 90 * @header_index: header index (packets can have several headers of same 91 * type like in case of tunnels) 92 * @header: header 93 * @fieled_id: field index 94 */ 95 struct devlink_dpipe_match { 96 enum devlink_dpipe_match_type type; 97 unsigned int header_index; 98 struct devlink_dpipe_header *header; 99 unsigned int field_id; 100 }; 101 102 /** 103 * struct devlink_dpipe_action - represents action operation 104 * @type: type of action 105 * @header_index: header index (packets can have several headers of same 106 * type like in case of tunnels) 107 * @header: header 108 * @fieled_id: field index 109 */ 110 struct devlink_dpipe_action { 111 enum devlink_dpipe_action_type type; 112 unsigned int header_index; 113 struct devlink_dpipe_header *header; 114 unsigned int field_id; 115 }; 116 117 /** 118 * struct devlink_dpipe_value - represents value of match/action 119 * @action: action 120 * @match: match 121 * @mapping_value: in case the field has some mapping this value 122 * specified the mapping value 123 * @mapping_valid: specify if mapping value is valid 124 * @value_size: value size 125 * @value: value 126 * @mask: bit mask 127 */ 128 struct devlink_dpipe_value { 129 union { 130 struct devlink_dpipe_action *action; 131 struct devlink_dpipe_match *match; 132 }; 133 unsigned int mapping_value; 134 bool mapping_valid; 135 unsigned int value_size; 136 void *value; 137 void *mask; 138 }; 139 140 /** 141 * struct devlink_dpipe_entry - table entry object 142 * @index: index of the entry in the table 143 * @match_values: match values 144 * @matche_values_count: count of matches tuples 145 * @action_values: actions values 146 * @action_values_count: count of actions values 147 * @counter: value of counter 148 * @counter_valid: Specify if value is valid from hardware 149 */ 150 struct devlink_dpipe_entry { 151 u64 index; 152 struct devlink_dpipe_value *match_values; 153 unsigned int match_values_count; 154 struct devlink_dpipe_value *action_values; 155 unsigned int action_values_count; 156 u64 counter; 157 bool counter_valid; 158 }; 159 160 /** 161 * struct devlink_dpipe_dump_ctx - context provided to driver in order 162 * to dump 163 * @info: info 164 * @cmd: devlink command 165 * @skb: skb 166 * @nest: top attribute 167 * @hdr: hdr 168 */ 169 struct devlink_dpipe_dump_ctx { 170 struct genl_info *info; 171 enum devlink_command cmd; 172 struct sk_buff *skb; 173 struct nlattr *nest; 174 void *hdr; 175 }; 176 177 struct devlink_dpipe_table_ops; 178 179 /** 180 * struct devlink_dpipe_table - table object 181 * @priv: private 182 * @name: table name 183 * @counters_enabled: indicates if counters are active 184 * @counter_control_extern: indicates if counter control is in dpipe or 185 * external tool 186 * @resource_valid: Indicate that the resource id is valid 187 * @resource_id: relative resource this table is related to 188 * @resource_units: number of resource's unit consumed per table's entry 189 * @table_ops: table operations 190 * @rcu: rcu 191 */ 192 struct devlink_dpipe_table { 193 void *priv; 194 struct list_head list; 195 const char *name; 196 bool counters_enabled; 197 bool counter_control_extern; 198 bool resource_valid; 199 u64 resource_id; 200 u64 resource_units; 201 struct devlink_dpipe_table_ops *table_ops; 202 struct rcu_head rcu; 203 }; 204 205 /** 206 * struct devlink_dpipe_table_ops - dpipe_table ops 207 * @actions_dump - dumps all tables actions 208 * @matches_dump - dumps all tables matches 209 * @entries_dump - dumps all active entries in the table 210 * @counters_set_update - when changing the counter status hardware sync 211 * maybe needed to allocate/free counter related 212 * resources 213 * @size_get - get size 214 */ 215 struct devlink_dpipe_table_ops { 216 int (*actions_dump)(void *priv, struct sk_buff *skb); 217 int (*matches_dump)(void *priv, struct sk_buff *skb); 218 int (*entries_dump)(void *priv, bool counters_enabled, 219 struct devlink_dpipe_dump_ctx *dump_ctx); 220 int (*counters_set_update)(void *priv, bool enable); 221 u64 (*size_get)(void *priv); 222 }; 223 224 /** 225 * struct devlink_dpipe_headers - dpipe headers 226 * @headers - header array can be shared (global bit) or driver specific 227 * @headers_count - count of headers 228 */ 229 struct devlink_dpipe_headers { 230 struct devlink_dpipe_header **headers; 231 unsigned int headers_count; 232 }; 233 234 /** 235 * struct devlink_resource_ops - resource ops 236 * @occ_get: get the occupied size 237 */ 238 struct devlink_resource_ops { 239 u64 (*occ_get)(struct devlink *devlink); 240 }; 241 242 /** 243 * struct devlink_resource_size_params - resource's size parameters 244 * @size_min: minimum size which can be set 245 * @size_max: maximum size which can be set 246 * @size_granularity: size granularity 247 * @size_unit: resource's basic unit 248 */ 249 struct devlink_resource_size_params { 250 u64 size_min; 251 u64 size_max; 252 u64 size_granularity; 253 enum devlink_resource_unit unit; 254 }; 255 256 /** 257 * struct devlink_resource - devlink resource 258 * @name: name of the resource 259 * @id: id, per devlink instance 260 * @size: size of the resource 261 * @size_new: updated size of the resource, reload is needed 262 * @size_valid: valid in case the total size of the resource is valid 263 * including its children 264 * @parent: parent resource 265 * @size_params: size parameters 266 * @list: parent list 267 * @resource_list: list of child resources 268 * @resource_ops: resource ops 269 */ 270 struct devlink_resource { 271 const char *name; 272 u64 id; 273 u64 size; 274 u64 size_new; 275 bool size_valid; 276 struct devlink_resource *parent; 277 struct devlink_resource_size_params *size_params; 278 struct list_head list; 279 struct list_head resource_list; 280 const struct devlink_resource_ops *resource_ops; 281 }; 282 283 #define DEVLINK_RESOURCE_ID_PARENT_TOP 0 284 285 struct devlink_ops { 286 int (*reload)(struct devlink *devlink); 287 int (*port_type_set)(struct devlink_port *devlink_port, 288 enum devlink_port_type port_type); 289 int (*port_split)(struct devlink *devlink, unsigned int port_index, 290 unsigned int count); 291 int (*port_unsplit)(struct devlink *devlink, unsigned int port_index); 292 int (*sb_pool_get)(struct devlink *devlink, unsigned int sb_index, 293 u16 pool_index, 294 struct devlink_sb_pool_info *pool_info); 295 int (*sb_pool_set)(struct devlink *devlink, unsigned int sb_index, 296 u16 pool_index, u32 size, 297 enum devlink_sb_threshold_type threshold_type); 298 int (*sb_port_pool_get)(struct devlink_port *devlink_port, 299 unsigned int sb_index, u16 pool_index, 300 u32 *p_threshold); 301 int (*sb_port_pool_set)(struct devlink_port *devlink_port, 302 unsigned int sb_index, u16 pool_index, 303 u32 threshold); 304 int (*sb_tc_pool_bind_get)(struct devlink_port *devlink_port, 305 unsigned int sb_index, 306 u16 tc_index, 307 enum devlink_sb_pool_type pool_type, 308 u16 *p_pool_index, u32 *p_threshold); 309 int (*sb_tc_pool_bind_set)(struct devlink_port *devlink_port, 310 unsigned int sb_index, 311 u16 tc_index, 312 enum devlink_sb_pool_type pool_type, 313 u16 pool_index, u32 threshold); 314 int (*sb_occ_snapshot)(struct devlink *devlink, 315 unsigned int sb_index); 316 int (*sb_occ_max_clear)(struct devlink *devlink, 317 unsigned int sb_index); 318 int (*sb_occ_port_pool_get)(struct devlink_port *devlink_port, 319 unsigned int sb_index, u16 pool_index, 320 u32 *p_cur, u32 *p_max); 321 int (*sb_occ_tc_port_bind_get)(struct devlink_port *devlink_port, 322 unsigned int sb_index, 323 u16 tc_index, 324 enum devlink_sb_pool_type pool_type, 325 u32 *p_cur, u32 *p_max); 326 327 int (*eswitch_mode_get)(struct devlink *devlink, u16 *p_mode); 328 int (*eswitch_mode_set)(struct devlink *devlink, u16 mode); 329 int (*eswitch_inline_mode_get)(struct devlink *devlink, u8 *p_inline_mode); 330 int (*eswitch_inline_mode_set)(struct devlink *devlink, u8 inline_mode); 331 int (*eswitch_encap_mode_get)(struct devlink *devlink, u8 *p_encap_mode); 332 int (*eswitch_encap_mode_set)(struct devlink *devlink, u8 encap_mode); 333 }; 334 335 static inline void *devlink_priv(struct devlink *devlink) 336 { 337 BUG_ON(!devlink); 338 return &devlink->priv; 339 } 340 341 static inline struct devlink *priv_to_devlink(void *priv) 342 { 343 BUG_ON(!priv); 344 return container_of(priv, struct devlink, priv); 345 } 346 347 struct ib_device; 348 349 #if IS_ENABLED(CONFIG_NET_DEVLINK) 350 351 struct devlink *devlink_alloc(const struct devlink_ops *ops, size_t priv_size); 352 int devlink_register(struct devlink *devlink, struct device *dev); 353 void devlink_unregister(struct devlink *devlink); 354 void devlink_free(struct devlink *devlink); 355 int devlink_port_register(struct devlink *devlink, 356 struct devlink_port *devlink_port, 357 unsigned int port_index); 358 void devlink_port_unregister(struct devlink_port *devlink_port); 359 void devlink_port_type_eth_set(struct devlink_port *devlink_port, 360 struct net_device *netdev); 361 void devlink_port_type_ib_set(struct devlink_port *devlink_port, 362 struct ib_device *ibdev); 363 void devlink_port_type_clear(struct devlink_port *devlink_port); 364 void devlink_port_split_set(struct devlink_port *devlink_port, 365 u32 split_group); 366 int devlink_sb_register(struct devlink *devlink, unsigned int sb_index, 367 u32 size, u16 ingress_pools_count, 368 u16 egress_pools_count, u16 ingress_tc_count, 369 u16 egress_tc_count); 370 void devlink_sb_unregister(struct devlink *devlink, unsigned int sb_index); 371 int devlink_dpipe_table_register(struct devlink *devlink, 372 const char *table_name, 373 struct devlink_dpipe_table_ops *table_ops, 374 void *priv, bool counter_control_extern); 375 void devlink_dpipe_table_unregister(struct devlink *devlink, 376 const char *table_name); 377 int devlink_dpipe_headers_register(struct devlink *devlink, 378 struct devlink_dpipe_headers *dpipe_headers); 379 void devlink_dpipe_headers_unregister(struct devlink *devlink); 380 bool devlink_dpipe_table_counter_enabled(struct devlink *devlink, 381 const char *table_name); 382 int devlink_dpipe_entry_ctx_prepare(struct devlink_dpipe_dump_ctx *dump_ctx); 383 int devlink_dpipe_entry_ctx_append(struct devlink_dpipe_dump_ctx *dump_ctx, 384 struct devlink_dpipe_entry *entry); 385 int devlink_dpipe_entry_ctx_close(struct devlink_dpipe_dump_ctx *dump_ctx); 386 void devlink_dpipe_entry_clear(struct devlink_dpipe_entry *entry); 387 int devlink_dpipe_action_put(struct sk_buff *skb, 388 struct devlink_dpipe_action *action); 389 int devlink_dpipe_match_put(struct sk_buff *skb, 390 struct devlink_dpipe_match *match); 391 extern struct devlink_dpipe_header devlink_dpipe_header_ethernet; 392 extern struct devlink_dpipe_header devlink_dpipe_header_ipv4; 393 extern struct devlink_dpipe_header devlink_dpipe_header_ipv6; 394 395 int devlink_resource_register(struct devlink *devlink, 396 const char *resource_name, 397 bool top_hierarchy, 398 u64 resource_size, 399 u64 resource_id, 400 u64 parent_resource_id, 401 struct devlink_resource_size_params *size_params, 402 const struct devlink_resource_ops *resource_ops); 403 void devlink_resources_unregister(struct devlink *devlink, 404 struct devlink_resource *resource); 405 int devlink_resource_size_get(struct devlink *devlink, 406 u64 resource_id, 407 u64 *p_resource_size); 408 int devlink_dpipe_table_resource_set(struct devlink *devlink, 409 const char *table_name, u64 resource_id, 410 u64 resource_units); 411 412 #else 413 414 static inline struct devlink *devlink_alloc(const struct devlink_ops *ops, 415 size_t priv_size) 416 { 417 return kzalloc(sizeof(struct devlink) + priv_size, GFP_KERNEL); 418 } 419 420 static inline int devlink_register(struct devlink *devlink, struct device *dev) 421 { 422 return 0; 423 } 424 425 static inline void devlink_unregister(struct devlink *devlink) 426 { 427 } 428 429 static inline void devlink_free(struct devlink *devlink) 430 { 431 kfree(devlink); 432 } 433 434 static inline int devlink_port_register(struct devlink *devlink, 435 struct devlink_port *devlink_port, 436 unsigned int port_index) 437 { 438 return 0; 439 } 440 441 static inline void devlink_port_unregister(struct devlink_port *devlink_port) 442 { 443 } 444 445 static inline void devlink_port_type_eth_set(struct devlink_port *devlink_port, 446 struct net_device *netdev) 447 { 448 } 449 450 static inline void devlink_port_type_ib_set(struct devlink_port *devlink_port, 451 struct ib_device *ibdev) 452 { 453 } 454 455 static inline void devlink_port_type_clear(struct devlink_port *devlink_port) 456 { 457 } 458 459 static inline void devlink_port_split_set(struct devlink_port *devlink_port, 460 u32 split_group) 461 { 462 } 463 464 static inline int devlink_sb_register(struct devlink *devlink, 465 unsigned int sb_index, u32 size, 466 u16 ingress_pools_count, 467 u16 egress_pools_count, 468 u16 ingress_tc_count, 469 u16 egress_tc_count) 470 { 471 return 0; 472 } 473 474 static inline void devlink_sb_unregister(struct devlink *devlink, 475 unsigned int sb_index) 476 { 477 } 478 479 static inline int 480 devlink_dpipe_table_register(struct devlink *devlink, 481 const char *table_name, 482 struct devlink_dpipe_table_ops *table_ops, 483 void *priv, bool counter_control_extern) 484 { 485 return 0; 486 } 487 488 static inline void devlink_dpipe_table_unregister(struct devlink *devlink, 489 const char *table_name) 490 { 491 } 492 493 static inline int devlink_dpipe_headers_register(struct devlink *devlink, 494 struct devlink_dpipe_headers * 495 dpipe_headers) 496 { 497 return 0; 498 } 499 500 static inline void devlink_dpipe_headers_unregister(struct devlink *devlink) 501 { 502 } 503 504 static inline bool devlink_dpipe_table_counter_enabled(struct devlink *devlink, 505 const char *table_name) 506 { 507 return false; 508 } 509 510 static inline int 511 devlink_dpipe_entry_ctx_prepare(struct devlink_dpipe_dump_ctx *dump_ctx) 512 { 513 return 0; 514 } 515 516 static inline int 517 devlink_dpipe_entry_ctx_append(struct devlink_dpipe_dump_ctx *dump_ctx, 518 struct devlink_dpipe_entry *entry) 519 { 520 return 0; 521 } 522 523 static inline int 524 devlink_dpipe_entry_ctx_close(struct devlink_dpipe_dump_ctx *dump_ctx) 525 { 526 return 0; 527 } 528 529 static inline void 530 devlink_dpipe_entry_clear(struct devlink_dpipe_entry *entry) 531 { 532 } 533 534 static inline int 535 devlink_dpipe_action_put(struct sk_buff *skb, 536 struct devlink_dpipe_action *action) 537 { 538 return 0; 539 } 540 541 static inline int 542 devlink_dpipe_match_put(struct sk_buff *skb, 543 struct devlink_dpipe_match *match) 544 { 545 return 0; 546 } 547 548 static inline int 549 devlink_resource_register(struct devlink *devlink, 550 const char *resource_name, 551 bool top_hierarchy, 552 u64 resource_size, 553 u64 resource_id, 554 u64 parent_resource_id, 555 struct devlink_resource_size_params *size_params, 556 const struct devlink_resource_ops *resource_ops) 557 { 558 return 0; 559 } 560 561 static inline void 562 devlink_resources_unregister(struct devlink *devlink, 563 struct devlink_resource *resource) 564 { 565 } 566 567 static inline int 568 devlink_resource_size_get(struct devlink *devlink, u64 resource_id, 569 u64 *p_resource_size) 570 { 571 return -EOPNOTSUPP; 572 } 573 574 static inline int 575 devlink_dpipe_table_resource_set(struct devlink *devlink, 576 const char *table_name, u64 resource_id, 577 u64 resource_units) 578 { 579 return -EOPNOTSUPP; 580 } 581 582 #endif 583 584 #endif /* _NET_DEVLINK_H_ */ 585