1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2020 Intel Corporation
4 #ifndef __INCLUDE_RTE_SWX_PIPELINE_H__
5 #define __INCLUDE_RTE_SWX_PIPELINE_H__
20 #include <rte_compat.h>
22 #include "rte_swx_port.h"
23 #include "rte_swx_table.h"
24 #include "rte_swx_extern.h"
27 #ifndef RTE_SWX_NAME_SIZE
28 #define RTE_SWX_NAME_SIZE 64
31 /** Instruction size. */
32 #ifndef RTE_SWX_INSTRUCTION_SIZE
33 #define RTE_SWX_INSTRUCTION_SIZE 256
36 /** Instruction tokens. */
37 #ifndef RTE_SWX_INSTRUCTION_TOKENS_MAX
38 #define RTE_SWX_INSTRUCTION_TOKENS_MAX 16
42 * Pipeline setup and operation
45 /** Pipeline opaque data structure. */
46 struct rte_swx_pipeline;
52 * Pipeline handle. Must point to valid memory. Contains valid pipeline handle
53 * when the function returns successfully.
54 * @param[in] numa_node
55 * Non-Uniform Memory Access (NUMA) node.
57 * 0 on success or the following error codes otherwise:
58 * -EINVAL: Invalid argument;
59 * -ENOMEM: Not enough space/cannot allocate memory.
63 rte_swx_pipeline_config(struct rte_swx_pipeline **p,
67 * Pipeline input ports
71 * Pipeline input port type register
76 * Input port type name.
78 * Input port type operations.
80 * 0 on success or the following error codes otherwise:
81 * -EINVAL: Invalid argument;
82 * -ENOMEM: Not enough space/cannot allocate memory;
83 * -EEXIST: Input port type with this name already exists.
87 rte_swx_pipeline_port_in_type_register(struct rte_swx_pipeline *p,
89 struct rte_swx_port_in_ops *ops);
92 * Pipeline input port configure
98 * @param[in] port_type_name
99 * Existing input port type name.
101 * Input port creation arguments.
103 * 0 on success or the following error codes otherwise:
104 * -EINVAL: Invalid argument;
105 * -ENOMEM: Not enough space/cannot allocate memory;
106 * -ENODEV: Input port object creation error.
110 rte_swx_pipeline_port_in_config(struct rte_swx_pipeline *p,
112 const char *port_type_name,
116 * Pipeline output ports
120 * Pipeline output port type register
125 * Output port type name.
127 * Output port type operations.
129 * 0 on success or the following error codes otherwise:
130 * -EINVAL: Invalid argument;
131 * -ENOMEM: Not enough space/cannot allocate memory;
132 * -EEXIST: Output port type with this name already exists.
136 rte_swx_pipeline_port_out_type_register(struct rte_swx_pipeline *p,
138 struct rte_swx_port_out_ops *ops);
141 * Pipeline output port configure
147 * @param[in] port_type_name
148 * Existing output port type name.
150 * Output port creation arguments.
152 * 0 on success or the following error codes otherwise:
153 * -EINVAL: Invalid argument;
154 * -ENOMEM: Not enough space/cannot allocate memory;
155 * -ENODEV: Output port object creation error.
159 rte_swx_pipeline_port_out_config(struct rte_swx_pipeline *p,
161 const char *port_type_name,
165 * Extern objects and functions
169 * Pipeline extern type register
175 * @param[in] mailbox_struct_type_name
176 * Name of existing struct type used to define the mailbox size and layout for
177 * the extern objects that are instances of this type. Each extern object gets
178 * its own mailbox, which is used to pass the input arguments to the member
179 * functions and retrieve the output results.
180 * @param[in] constructor
181 * Function used to create the extern objects that are instances of this type.
182 * @param[in] destructor
183 * Function used to free the extern objects that are instances of this type.
185 * 0 on success or the following error codes otherwise:
186 * -EINVAL: Invalid argument;
187 * -ENOMEM: Not enough space/cannot allocate memory;
188 * -EEXIST: Extern type with this name already exists.
192 rte_swx_pipeline_extern_type_register(struct rte_swx_pipeline *p,
194 const char *mailbox_struct_type_name,
195 rte_swx_extern_type_constructor_t constructor,
196 rte_swx_extern_type_destructor_t destructor);
199 * Pipeline extern type member function register
203 * @param[in] extern_type_name
204 * Existing extern type name.
206 * Name for the new member function to be added to the extern type.
207 * @param[in] member_func
208 * The new member function.
210 * 0 on success or the following error codes otherwise:
211 * -EINVAL: Invalid argument;
212 * -ENOMEM: Not enough space/cannot allocate memory;
213 * -EEXIST: Member function with this name already exists for this type;
214 * -ENOSPC: Maximum number of member functions reached for this type.
218 rte_swx_pipeline_extern_type_member_func_register(struct rte_swx_pipeline *p,
219 const char *extern_type_name,
221 rte_swx_extern_type_member_func_t member_func);
224 * Pipeline extern object configure
226 * Instantiate a given extern type to create new extern object.
230 * @param[in] extern_type_name
231 * Existing extern type name.
233 * Name for the new object instantiating the extern type.
235 * Extern object constructor arguments.
237 * 0 on success or the following error codes otherwise:
238 * -EINVAL: Invalid argument;
239 * -ENOMEM: Not enough space/cannot allocate memory;
240 * -EEXIST: Extern object with this name already exists;
241 * -ENODEV: Extern object constructor error.
245 rte_swx_pipeline_extern_object_config(struct rte_swx_pipeline *p,
246 const char *extern_type_name,
251 * Pipeline extern function register
256 * Extern function name.
257 * @param[in] mailbox_struct_type_name
258 * Name of existing struct type used to define the mailbox size and layout for
259 * this extern function. The mailbox is used to pass the input arguments to
260 * the extern function and retrieve the output results.
262 * The extern function.
264 * 0 on success or the following error codes otherwise:
265 * -EINVAL: Invalid argument;
266 * -ENOMEM: Not enough space/cannot allocate memory;
267 * -EEXIST: Extern function with this name already exists.
271 rte_swx_pipeline_extern_func_register(struct rte_swx_pipeline *p,
273 const char *mailbox_struct_type_name,
274 rte_swx_extern_func_t func);
277 * Packet headers and meta-data
280 /** Structure (struct) field. */
281 struct rte_swx_field_params {
282 /** Struct field name. */
285 /** Struct field size (in bits).
286 * Restriction: All struct fields must be a multiple of 8 bits.
287 * Restriction: All struct fields must be no greater than 64 bits.
293 * Pipeline struct type register
295 * Structs are used extensively in many part of the pipeline to define the size
296 * and layout of a specific memory piece such as: headers, meta-data, action
297 * data stored in a table entry, mailboxes for extern objects and functions.
298 * Similar to C language structs, they are a well defined sequence of fields,
299 * with each field having a unique name and a constant size.
306 * The sequence of struct fields.
307 * @param[in] n_fields
308 * The number of struct fields.
310 * 0 on success or the following error codes otherwise:
311 * -EINVAL: Invalid argument;
312 * -ENOMEM: Not enough space/cannot allocate memory;
313 * -EEXIST: Struct type with this name already exists.
317 rte_swx_pipeline_struct_type_register(struct rte_swx_pipeline *p,
319 struct rte_swx_field_params *fields,
323 * Pipeline packet header register
329 * @param[in] struct_type_name
330 * The struct type instantiated by this packet header.
332 * 0 on success or the following error codes otherwise:
333 * -EINVAL: Invalid argument;
334 * -ENOMEM: Not enough space/cannot allocate memory;
335 * -EEXIST: Header with this name already exists;
336 * -ENOSPC: Maximum number of headers reached for the pipeline.
340 rte_swx_pipeline_packet_header_register(struct rte_swx_pipeline *p,
342 const char *struct_type_name);
345 * Pipeline packet meta-data register
349 * @param[in] struct_type_name
350 * The struct type instantiated by the packet meta-data.
352 * 0 on success or the following error codes otherwise:
353 * -EINVAL: Invalid argument.
357 rte_swx_pipeline_packet_metadata_register(struct rte_swx_pipeline *p,
358 const char *struct_type_name);
365 * Instruction operands:
367 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
368 *<pre>| | Description | Format | DST | SRC |</pre>
369 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
370 *<pre>| hdr | Header | h.header | | |</pre>
371 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
372 *<pre>| act | Action | ACTION | | |</pre>
373 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
374 *<pre>| tbl | Table | TABLE | | |</pre>
375 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
376 *<pre>| H | Header field | h.header.field | YES | YES |</pre>
377 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
378 *<pre>| M | Meta-data field | m.field | YES | YES |</pre>
379 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
380 *<pre>| E | Extern obj mailbox field | e.ext_obj.field | YES | YES |</pre>
381 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
382 *<pre>| F | Extern func mailbox field | f.ext_func.field | YES | YES |</pre>
383 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
384 *<pre>| T | Table action data field | t.header.field | NO | YES |</pre>
385 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
386 *<pre>| I | Immediate value (64-bit) | h.header.field | NO | YES |</pre>
387 *<pre>+-----+---------------------------+------------------+-----+-----+</pre>
391 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
392 *<pre>| Instr. | Instruction | Instruction | 1st | 2nd |</pre>
393 *<pre>| Name | Description | Format | opnd.| opnd. |</pre>
394 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
395 *<pre>| rx | Receive one pkt | rx m.port_in | M | |</pre>
396 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
397 *<pre>| tx | Transmit one pkt | tx m.port_out | M | |</pre>
398 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
399 *<pre>| extract | Extract one hdr | extract h.hdr | hdr | |</pre>
400 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
401 *<pre>| emit | Emit one hdr | emit h.hdr | hdr | |</pre>
402 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
403 *<pre>| validate | Validate one hdr | validate h.hdr | hdr | |</pre>
404 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
405 *<pre>| invalidate | Invalidate one hdr | invalidate h.hdr | hdr | |</pre>
406 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
407 *<pre>| mov | dst = src | mov dst src | HMEF | HMEFTI |</pre>
408 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
409 *<pre>| add | dst += src | add dst src | HMEF | HMEFTI |</pre>
410 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
411 *<pre>| sub | dst -= src | add dst src | HMEF | HMEFTI |</pre>
412 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
413 *<pre>| ckadd | Checksum add: dst = | add dst src | HMEF | HMEFTI |</pre>
414 *<pre>| | dst '+ src[0:1] '+ | | | or hdr |</pre>
415 *<pre>| | src[2:3] '+ ... | | | |</pre>
416 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
417 *<pre>| cksub | Checksum subtract: | add dst src | HMEF | HMEFTI |</pre>
418 *<pre>| | dst = dst '- src | | | |</pre>
419 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
420 *<pre>| and | dst &= src | and dst src | HMEF | HMEFTI |</pre>
421 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
422 *<pre>| or | dst |= src | or dst src | HMEF | HMEFTI |</pre>
423 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
424 *<pre>| xor | dst ^= src | xor dst src | HMEF | HMEFTI |</pre>
425 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
426 *<pre>| shl | dst <<= src | shl dst src | HMEF | HMEFTI |</pre>
427 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
428 *<pre>| shr | dst >>= src | shr dst src | HMEF | HMEFTI |</pre>
429 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
430 *<pre>| table | Table lookup | table TABLE | tbl | |</pre>
431 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
432 *<pre>| extern | Ext obj member func | extern e.obj.mfunc| ext | |</pre>
433 *<pre>| | call or ext func call| extern f.func | | |</pre>
434 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
435 *<pre>| jmp | Unconditional jump | jmp LABEL | | |</pre>
436 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
437 *<pre>| jmpv | Jump if hdr is valid | jmpv LABEL h.hdr | hdr | |</pre>
438 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
439 *<pre>| jmpnv | Jump if hdr is inval | jmpnv LABEL h.hdr | hdr | |</pre>
440 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
441 *<pre>| jmph | Jump if tbl lkp hit | jmph LABEL | | |</pre>
442 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
443 *<pre>| jmpnh | Jump if tbl lkp miss | jmpnh LABEL | | |</pre>
444 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
445 *<pre>| jmpa | Jump if action run | jmpa LABEL ACTION | act | |</pre>
446 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
447 *<pre>| jmpna | Jump if act not run | jmpna LABEL ACTION| act | |</pre>
448 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
449 *<pre>| jmpeq | Jump if (a == b) | jmpeq LABEL a b | HMEFT| HMEFTI |</pre>
450 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
451 *<pre>| jmpneq | Jump if (a != b) | jmpneq LABEL a b | HMEFT| HMEFTI |</pre>
452 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
453 *<pre>| jmplt | Jump if (a < b) | jmplt LABEL a b | HMEFT| HMEFTI |</pre>
454 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
455 *<pre>| jmpgt | Jump if (a > b) | jmpgt LABEL a b | HMEFT| HMEFTI |</pre>
456 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
457 *<pre>| return | Return from action | return | | |</pre>
458 *<pre>+------------+----------------------+-------------------+------+--------+</pre>
460 * At initialization time, the pipeline and action instructions (including the
461 * symbolic name operands) are translated to internal data structures that are
470 * Pipeline action configure
476 * @param[in] args_struct_type_name
477 * The struct type instantiated by the action data. The action data represent
478 * the action arguments that are stored in the table entry together with the
479 * action ID. Set to NULL when the action does not have any arguments.
480 * @param[in] instructions
481 * Action instructions.
482 * @param[in] n_instructions
483 * Number of action instructions.
485 * 0 on success or the following error codes otherwise:
486 * -EINVAL: Invalid argument;
487 * -ENOMEM: Not enough space/cannot allocate memory;
488 * -EEXIST: Action with this name already exists.
492 rte_swx_pipeline_action_config(struct rte_swx_pipeline *p,
494 const char *args_struct_type_name,
495 const char **instructions,
496 uint32_t n_instructions);
503 * Pipeline table type register
509 * @param[in] match_type
510 * Match type implemented by the new table type.
512 * Table type operations.
514 * 0 on success or the following error codes otherwise:
515 * -EINVAL: Invalid argument;
516 * -ENOMEM: Not enough space/cannot allocate memory;
517 * -EEXIST: Table type with this name already exists.
521 rte_swx_pipeline_table_type_register(struct rte_swx_pipeline *p,
523 enum rte_swx_table_match_type match_type,
524 struct rte_swx_table_ops *ops);
526 /** Match field parameters. */
527 struct rte_swx_match_field_params {
528 /** Match field name. Must be either a field of one of the registered
529 * packet headers ("h.header.field") or a field of the registered
530 * meta-data ("m.field").
534 /** Match type of the field. */
535 enum rte_swx_table_match_type match_type;
538 /** Pipeline table parameters. */
539 struct rte_swx_pipeline_table_params {
540 /** The set of match fields for the current table.
541 * Restriction: All the match fields of the current table need to be
542 * part of the same struct, i.e. either all the match fields are part of
543 * the same header or all the match fields are part of the meta-data.
545 struct rte_swx_match_field_params *fields;
547 /** The number of match fields for the current table. If set to zero, no
548 * "regular" entries (i.e. entries other than the default entry) can be
549 * added to the current table and the match process always results in
554 /** The set of actions for the current table. */
555 const char **action_names;
557 /** The number of actions for the current table. Must be at least one.
561 /** The default table action that gets executed on lookup miss. Must be
562 * one of the table actions included in the *action_names*.
564 const char *default_action_name;
566 /** Default action data. The size of this array is the action data size
567 * of the default action. Must be NULL if the default action data size
570 uint8_t *default_action_data;
572 /** If non-zero (true), then the default action of the current table
573 * cannot be changed. If zero (false), then the default action can be
574 * changed in the future with another action from the *action_names*
577 int default_action_is_const;
581 * Pipeline table configure
589 * @param[in] recommended_table_type_name
590 * Recommended table type. Typically set to NULL. Useful as guidance when
591 * there are multiple table types registered for the match type of the table,
592 * as determined from the table match fields specification. Silently ignored
593 * if the recommended table type does not exist or it serves a different match
596 * Table creation arguments.
598 * Guideline on maximum number of table entries.
600 * 0 on success or the following error codes otherwise:
601 * -EINVAL: Invalid argument;
602 * -ENOMEM: Not enough space/cannot allocate memory;
603 * -EEXIST: Table with this name already exists;
604 * -ENODEV: Table creation error.
608 rte_swx_pipeline_table_config(struct rte_swx_pipeline *p,
610 struct rte_swx_pipeline_table_params *params,
611 const char *recommended_table_type_name,
616 * Pipeline register array configure
621 * Register array name.
623 * Number of registers in the array. Each register is 64-bit in size.
624 * @param[in] init_val
625 * Initial value for every register in the array. The recommended value is 0.
627 * 0 on success or the following error codes otherwise:
628 * -EINVAL: Invalid argument;
629 * -ENOMEM: Not enough space/cannot allocate memory;
630 * -EEXIST: Register array with this name already exists.
634 rte_swx_pipeline_regarray_config(struct rte_swx_pipeline *p,
640 * Pipeline meter array configure
647 * Number of meters in the array. Each meter in the array implements the Two
648 * Rate Three Color Marker (trTCM) algorithm, as specified by RFC 2698.
650 * 0 on success or the following error codes otherwise:
651 * -EINVAL: Invalid argument;
652 * -ENOMEM: Not enough space/cannot allocate memory;
653 * -EEXIST: Meter array with this name already exists.
657 rte_swx_pipeline_metarray_config(struct rte_swx_pipeline *p,
662 * Pipeline instructions configure
666 * @param[in] instructions
667 * Pipeline instructions.
668 * @param[in] n_instructions
669 * Number of pipeline instructions.
671 * 0 on success or the following error codes otherwise:
672 * -EINVAL: Invalid argument;
673 * -ENOMEM: Not enough space/cannot allocate memory.
677 rte_swx_pipeline_instructions_config(struct rte_swx_pipeline *p,
678 const char **instructions,
679 uint32_t n_instructions);
684 * Once called, the pipeline build operation marks the end of pipeline
685 * configuration. At this point, all the internal data structures needed to run
686 * the pipeline are built.
691 * 0 on success or the following error codes otherwise:
692 * -EINVAL: Invalid argument;
693 * -ENOMEM: Not enough space/cannot allocate memory;
694 * -EEXIST: Pipeline was already built successfully.
698 rte_swx_pipeline_build(struct rte_swx_pipeline *p);
701 * Pipeline build from specification file
706 * Pipeline specification file.
707 * @param[out] err_line
708 * In case of error and non-NULL, the line number within the *spec* file where
709 * the error occurred. The first line number in the file is 1.
710 * @param[out] err_msg
711 * In case of error and non-NULL, the error message.
713 * 0 on success or the following error codes otherwise:
714 * -EINVAL: Invalid argument;
715 * -ENOMEM: Not enough space/cannot allocate memory;
716 * -EEXIST: Resource with the same name already exists;
717 * -ENODEV: Extern object or table creation error.
721 rte_swx_pipeline_build_from_spec(struct rte_swx_pipeline *p,
724 const char **err_msg);
731 * @param[in] n_instructions
732 * Number of instructions to execute.
736 rte_swx_pipeline_run(struct rte_swx_pipeline *p,
737 uint32_t n_instructions);
742 * Flush all output ports of the pipeline.
749 rte_swx_pipeline_flush(struct rte_swx_pipeline *p);
759 rte_swx_pipeline_free(struct rte_swx_pipeline *p);