1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(C) 2019 Marvell International Ltd.
3 * Copyright 2020 Mellanox Technologies, Ltd
4 * Copyright(c) 2020 Intel Corporation
7 #ifndef _RTE_REGEXDEV_H_
8 #define _RTE_REGEXDEV_H_
13 * RTE RegEx Device API
15 * Defines RTE RegEx Device APIs for RegEx operations and its provisioning.
17 * The RegEx Device API is composed of two parts:
19 * - The application-oriented RegEx API that includes functions to setup
20 * a RegEx device (configure it, setup its queue pairs and start it),
21 * update the rule database and so on.
23 * - The driver-oriented RegEx API that exports a function allowing
24 * a RegEx poll Mode Driver (PMD) to simultaneously register itself as
25 * a RegEx device driver.
27 * RegEx device components and definitions:
31 * | o---------+ rte_regexdev_[en|de]queue_burst()
32 * | PCRE based o------+ | |
33 * | RegEx pattern | | | +--------+ |
34 * | matching engine o------+--+--o | | +------+
35 * | | | | | queue |<==o===>|Core 0|
36 * | o----+ | | | pair 0 | | |
37 * | | | | | +--------+ +------+
38 * +-----------------+ | | |
40 * | | | | | | +------+
41 * | | +--+--o queue |<======>|Core 1|
42 * Rule|Database | | | pair 1 | | |
43 * +------+----------+ | | +--------+ +------+
45 * | +-------------+ | | | +--------+ +------+
46 * | | Rules 0..n | | | | | | |Core 2|
47 * | +-------------+ | | +--o queue |<======>| |
48 * | Group 1 | | | pair 2 | +------+
49 * | +-------------+ | | +--------+
50 * | | Rules 0..n | | |
51 * | +-------------+ | | +--------+
52 * | Group 2 | | | | +------+
53 * | +-------------+ | | | queue |<======>|Core n|
54 * | | Rules 0..n | | +-------o pair n | | |
55 * | +-------------+ | +--------+ +------+
57 * | +-------------+ |<-------rte_regexdev_rule_db_update()
58 * | | | |<-------rte_regexdev_rule_db_compile_activate()
59 * | | Rules 0..n | |<-------rte_regexdev_rule_db_import()
60 * | +-------------+ |------->rte_regexdev_rule_db_export()
63 * RegEx: A regular expression is a concise and flexible means for matching
64 * strings of text, such as particular characters, words, or patterns of
65 * characters. A common abbreviation for this is “RegEx”.
67 * RegEx device: A hardware or software-based implementation of RegEx
68 * device API for PCRE based pattern matching syntax and semantics.
70 * PCRE RegEx syntax and semantics specification:
71 * http://regexkit.sourceforge.net/Documentation/pcre/pcrepattern.html
73 * RegEx queue pair: Each RegEx device should have one or more queue pair to
74 * transmit a burst of pattern matching request and receive a burst of
75 * receive the pattern matching response. The pattern matching request/response
76 * embedded in *rte_regex_ops* structure.
78 * Rule: A pattern matching rule expressed in PCRE RegEx syntax along with
79 * Match ID and Group ID to identify the rule upon the match.
81 * Rule database: The RegEx device accepts regular expressions and converts them
82 * into a compiled rule database that can then be used to scan data.
83 * Compilation allows the device to analyze the given pattern(s) and
84 * pre-determine how to scan for these patterns in an optimized fashion that
85 * would be far too expensive to compute at run-time. A rule database contains
86 * a set of rules that compiled in device specific binary form.
88 * Match ID or Rule ID: A unique identifier provided at the time of rule
89 * creation for the application to identify the rule upon match.
91 * Group ID: Group of rules can be grouped under one group ID to enable
92 * rule isolation and effective pattern matching. A unique group identifier
93 * provided at the time of rule creation for the application to identify the
96 * Scan: A pattern matching request through *enqueue* API.
98 * It may possible that a given RegEx device may not support all the features
99 * of PCRE. The application may probe unsupported features through
100 * struct rte_regexdev_info::pcre_unsup_flags
102 * By default, all the functions of the RegEx Device API exported by a PMD
103 * are lock-free functions which assume to not be invoked in parallel on
104 * different logical cores to work on the same target object. For instance,
105 * the dequeue function of a PMD cannot be invoked in parallel on two logical
106 * cores to operates on same RegEx queue pair. Of course, this function
107 * can be invoked in parallel by different logical core on different queue pair.
108 * It is the responsibility of the upper level application to enforce this rule.
110 * In all functions of the RegEx API, the RegEx device is
111 * designated by an integer >= 0 named the device identifier *dev_id*
113 * At the RegEx driver level, RegEx devices are represented by a generic
114 * data structure of type *rte_regexdev*.
116 * RegEx devices are dynamically registered during the PCI/SoC device probing
117 * phase performed at EAL initialization time.
118 * When a RegEx device is being probed, a *rte_regexdev* structure and
119 * a new device identifier are allocated for that device. Then, the
120 * regexdev_init() function supplied by the RegEx driver matching the probed
121 * device is invoked to properly initialize the device.
123 * The role of the device init function consists of resetting the hardware or
124 * software RegEx driver implementations.
126 * If the device init operation is successful, the correspondence between
127 * the device identifier assigned to the new device and its associated
128 * *rte_regexdev* structure is effectively registered.
129 * Otherwise, both the *rte_regexdev* structure and the device identifier are
132 * The functions exported by the application RegEx API to setup a device
133 * designated by its device identifier must be invoked in the following order:
134 * - rte_regexdev_configure()
135 * - rte_regexdev_queue_pair_setup()
136 * - rte_regexdev_start()
138 * Then, the application can invoke, in any order, the functions
139 * exported by the RegEx API to enqueue pattern matching job, dequeue pattern
140 * matching response, get the stats, update the rule database,
141 * get/set device attributes and so on
143 * If the application wants to change the configuration (i.e. call
144 * rte_regexdev_configure() or rte_regexdev_queue_pair_setup()), it must call
145 * rte_regexdev_stop() first to stop the device and then do the reconfiguration
146 * before calling rte_regexdev_start() again. The enqueue and dequeue
147 * functions should not be invoked when the device is stopped.
149 * Finally, an application can close a RegEx device by invoking the
150 * rte_regexdev_close() function.
152 * Each function of the application RegEx API invokes a specific function
153 * of the PMD that controls the target device designated by its device
156 * For this purpose, all device-specific functions of a RegEx driver are
157 * supplied through a set of pointers contained in a generic structure of type
159 * The address of the *regexdev_ops* structure is stored in the *rte_regexdev*
160 * structure by the device init function of the RegEx driver, which is
161 * invoked during the PCI/SoC device probing phase, as explained earlier.
163 * In other words, each function of the RegEx API simply retrieves the
164 * *rte_regexdev* structure associated with the device identifier and
165 * performs an indirect invocation of the corresponding driver function
166 * supplied in the *regexdev_ops* structure of the *rte_regexdev* structure.
168 * For performance reasons, the address of the fast-path functions of the
169 * RegEx driver is not contained in the *regexdev_ops* structure.
170 * Instead, they are directly stored at the beginning of the *rte_regexdev*
171 * structure to avoid an extra indirect memory access during their invocation.
173 * RTE RegEx device drivers do not use interrupts for enqueue or dequeue
174 * operation. Instead, RegEx drivers export Poll-Mode enqueue and dequeue
175 * functions to applications.
177 * The *enqueue* operation submits a burst of RegEx pattern matching request
178 * to the RegEx device and the *dequeue* operation gets a burst of pattern
179 * matching response for the ones submitted through *enqueue* operation.
181 * Typical application utilisation of the RegEx device API will follow the
182 * following programming flow.
184 * - rte_regexdev_configure()
185 * - rte_regexdev_queue_pair_setup()
186 * - rte_regexdev_rule_db_update() Needs to invoke if precompiled rule database
187 * not provided in rte_regexdev_config::rule_db for rte_regexdev_configure()
188 * and/or application needs to update rule database.
189 * - rte_regexdev_rule_db_compile_activate() Needs to invoke if
190 * rte_regexdev_rule_db_update function was used.
191 * - Create or reuse exiting mempool for *rte_regex_ops* objects.
192 * - rte_regexdev_start()
193 * - rte_regexdev_enqueue_burst()
194 * - rte_regexdev_dequeue_burst()
201 #include <rte_common.h>
202 #include <rte_config.h>
204 #include <rte_errno.h>
205 #include <rte_mbuf.h>
206 #include <rte_memory.h>
210 * @b EXPERIMENTAL: this API may change without prior notice.
212 * Get the total number of RegEx devices that have been successfully
216 * The total number of usable RegEx devices.
220 rte_regexdev_count(void);
224 * @b EXPERIMENTAL: this API may change without prior notice.
226 * Get the device identifier for the named RegEx device.
229 * RegEx device name to select the RegEx device identifier.
232 * Returns RegEx device identifier on success.
233 * - <0: Failure to find named RegEx device.
237 rte_regexdev_get_dev_id(const char *name);
239 /* Enumerates RegEx device capabilities */
240 #define RTE_REGEXDEV_CAPA_RUNTIME_COMPILATION_F (1ULL << 0)
241 /**< RegEx device does support compiling the rules at runtime unlike
242 * loading only the pre-built rule database using
243 * struct rte_regexdev_config::rule_db in rte_regexdev_configure()
245 * @see struct rte_regexdev_config::rule_db, rte_regexdev_configure()
246 * @see struct rte_regexdev_info::regexdev_capa
249 #define RTE_REGEXDEV_CAPA_SUPP_PCRE_START_ANCHOR_F (1ULL << 1)
250 /**< RegEx device support PCRE Anchor to start of match flag.
251 * Example RegEx is `/\Gfoo\d/`. Here `\G` asserts position at the end of the
252 * previous match or the start of the string for the first match.
253 * This position will change each time the RegEx is applied to the subject
254 * string. If the RegEx is applied to `foo1foo2Zfoo3` the first two matches will
255 * be successful for `foo1foo2` and fail for `Zfoo3`.
257 * @see struct rte_regexdev_info::regexdev_capa
260 #define RTE_REGEXDEV_CAPA_SUPP_PCRE_ATOMIC_GROUPING_F (1ULL << 2)
261 /**< RegEx device support PCRE Atomic grouping.
262 * Atomic groups are represented by `(?>)`. An atomic group is a group that,
263 * when the RegEx engine exits from it, automatically throws away all
264 * backtracking positions remembered by any tokens inside the group.
265 * Example RegEx is `a(?>bc|b)c` if the given patterns are `abc` and `abcc` then
266 * `a(bc|b)c` matches both where as `a(?>bc|b)c` matches only abcc because
267 * atomic groups don't allow backtracing back to `b`.
269 * @see struct rte_regexdev_info::regexdev_capa
272 #define RTE_REGEXDEV_SUPP_PCRE_BACKTRACKING_CTRL_F (1ULL << 3)
273 /**< RegEx device support PCRE backtracking control verbs.
274 * Some examples of backtracing verbs are (*COMMIT), (*ACCEPT), (*FAIL),
277 * @see struct rte_regexdev_info::regexdev_capa
280 #define RTE_REGEXDEV_SUPP_PCRE_CALLOUTS_F (1ULL << 4)
281 /**< RegEx device support PCRE callouts.
282 * PCRE supports calling external function in between matches by using `(?C)`.
283 * Example RegEx `ABC(?C)D` if a given patter is `ABCD` then the RegEx engine
284 * will parse ABC perform a userdefined callout and return a successful match at
287 * @see struct rte_regexdev_info::regexdev_capa
290 #define RTE_REGEXDEV_SUPP_PCRE_BACKREFERENCE_F (1ULL << 5)
291 /**< RegEx device support PCRE backreference.
292 * Example RegEx is `(\2ABC|(GHI))+` `\2` matches the same text as most recently
293 * matched by the 2nd capturing group i.e. `GHI`.
295 * @see struct rte_regexdev_info::regexdev_capa
298 #define RTE_REGEXDEV_SUPP_PCRE_GREEDY_F (1ULL << 6)
299 /**< RegEx device support PCRE Greedy mode.
300 * For example if the RegEx is `AB\d*?` then `*?` represents zero or unlimited
301 * matches. In greedy mode the pattern `AB12345` will be matched completely
302 * where as the ungreedy mode `AB` will be returned as the match.
304 * @see struct rte_regexdev_info::regexdev_capa
307 #define RTE_REGEXDEV_SUPP_PCRE_MATCH_ALL_F (1ULL << 7)
308 /**< RegEx device support match all mode.
309 * For example if the RegEx is `AB\d*?` then `*?` represents zero or unlimited
310 * matches. In match all mode the pattern `AB12345` will return 6 matches.
311 * AB, AB1, AB12, AB123, AB1234, AB12345.
313 * @see struct rte_regexdev_info::regexdev_capa
316 #define RTE_REGEXDEV_SUPP_PCRE_LOOKAROUND_ASRT_F (1ULL << 8)
317 /**< RegEx device support PCRE Lookaround assertions
318 * (Zero-width assertions). Example RegEx is `[a-z]+\d+(?=!{3,})` if
319 * the given pattern is `dwad1234!` the RegEx engine doesn't report any matches
320 * because the assert `(?=!{3,})` fails. The pattern `dwad123!!!` would return a
323 * @see struct rte_regexdev_info::regexdev_capa
326 #define RTE_REGEXDEV_SUPP_PCRE_MATCH_POINT_RST_F (1ULL << 9)
327 /**< RegEx device doesn't support PCRE match point reset directive.
328 * Example RegEx is `[a-z]+\K\d+` if the pattern is `dwad123`
329 * then even though the entire pattern matches only `123`
330 * is reported as a match.
332 * @see struct rte_regexdev_info::regexdev_capa
335 #define RTE_REGEXDEV_SUPP_NEWLINE_CONVENTIONS_F (1ULL << 10)
336 /**< RegEx support PCRE newline convention.
337 * Newline conventions are represented as follows:
338 * (*CR) carriage return
340 * (*CRLF) carriage return, followed by linefeed
341 * (*ANYCRLF) any of the three above
342 * (*ANY) all Unicode newline sequences
344 * @see struct rte_regexdev_info::regexdev_capa
347 #define RTE_REGEXDEV_SUPP_PCRE_NEWLINE_SEQ_F (1ULL << 11)
348 /**< RegEx device support PCRE newline sequence.
349 * The escape sequence `\R` will match any newline sequence.
350 * It is equivalent to: `(?>\r\n|\n|\x0b|\f|\r|\x85)`.
352 * @see struct rte_regexdev_info::regexdev_capa
355 #define RTE_REGEXDEV_SUPP_PCRE_POSSESSIVE_QUALIFIERS_F (1ULL << 12)
356 /**< RegEx device support PCRE possessive qualifiers.
357 * Example RegEx possessive qualifiers `*+`, `++`, `?+`, `{m,n}+`.
358 * Possessive quantifier repeats the token as many times as possible and it does
359 * not give up matches as the engine backtracks. With a possessive quantifier,
360 * the deal is all or nothing.
362 * @see struct rte_regexdev_info::regexdev_capa
365 #define RTE_REGEXDEV_SUPP_PCRE_SUBROUTINE_REFERENCES_F (1ULL << 13)
366 /**< RegEx device support PCRE Subroutine references.
367 * PCRE Subroutine references allow for sub patterns to be assessed
368 * as part of the RegEx. Example RegEx is `(foo|fuzz)\g<1>+bar` matches the
369 * pattern `foofoofuzzfoofuzzbar`.
371 * @see struct rte_regexdev_info::regexdev_capa
374 #define RTE_REGEXDEV_SUPP_PCRE_UTF_8_F (1ULL << 14)
375 /**< RegEx device support UTF-8 character encoding.
377 * @see struct rte_regexdev_info::pcre_unsup_flags
380 #define RTE_REGEXDEV_SUPP_PCRE_UTF_16_F (1ULL << 15)
381 /**< RegEx device support UTF-16 character encoding.
383 * @see struct rte_regexdev_info::regexdev_capa
386 #define RTE_REGEXDEV_SUPP_PCRE_UTF_32_F (1ULL << 16)
387 /**< RegEx device support UTF-32 character encoding.
389 * @see struct rte_regexdev_info::regexdev_capa
392 #define RTE_REGEXDEV_SUPP_PCRE_WORD_BOUNDARY_F (1ULL << 17)
393 /**< RegEx device support word boundaries.
394 * The meta character `\b` represents word boundary anchor.
396 * @see struct rte_regexdev_info::regexdev_capa
399 #define RTE_REGEXDEV_SUPP_PCRE_FORWARD_REFERENCES_F (1ULL << 18)
400 /**< RegEx device support Forward references.
401 * Forward references allow you to use a back reference to a group that appears
402 * later in the RegEx. Example RegEx is `(\3ABC|(DEF|(GHI)))+` matches the
403 * following string `GHIGHIABCDEF`.
405 * @see struct rte_regexdev_info::regexdev_capa
408 #define RTE_REGEXDEV_SUPP_MATCH_AS_END_F (1ULL << 19)
409 /**< RegEx device support match as end.
410 * Match as end means that the match result holds the end offset of the
411 * detected match. No len value is set.
412 * If the device doesn't support this feature it means the match
413 * result holds the starting position of match and the length of the match.
415 * @see struct rte_regexdev_info::regexdev_capa
418 #define RTE_REGEXDEV_SUPP_CROSS_BUFFER_F (1ULL << 20)
419 /**< RegEx device support cross buffer match.
420 * Cross buffer matching means that the match can be detected even if the
421 * string was started in previous buffer.
422 * In case the device is configured as RTE_REGEXDEV_CFG_MATCH_AS_END
423 * the end offset will be relative for the first packet.
424 * For example RegEx is ABC the first buffer is xxxx second buffer yyyA and
425 * the last buffer BCzz.
426 * In case the match as end is configured the end offset will be 10.
428 * @see RTE_REGEXDEV_CFG_MATCH_AS_END_F
429 * @see RTE_REGEXDEV_CFG_CROSS_BUFFER_SCAN_F
430 * @see RTE_REGEX_OPS_RSP_PMI_SOJ_F
431 * @see RTE_REGEX_OPS_RSP_PMI_EOJ_F
434 #define RTE_REGEXDEV_SUPP_MATCH_ALL_F (1ULL << 21)
435 /**< RegEx device support match all.
436 * Match all means that the RegEx engine will return all possible matches.
437 * For example, assume the RegEx is `A+b`, given the input AAAb the
438 * returned matches will be: Ab, AAb and AAAb.
440 * @see RTE_REGEXDEV_CFG_MATCH_ALL_F
443 /* Enumerates PCRE rule flags */
444 #define RTE_REGEX_PCRE_RULE_ALLOW_EMPTY_F (1ULL << 0)
445 /**< When this flag is set, the pattern that can match against an empty string,
446 * such as `.*` are allowed.
448 * @see struct rte_regexdev_info::rule_flags
449 * @see struct rte_regexdev_rule::rule_flags
452 #define RTE_REGEX_PCRE_RULE_ANCHORED_F (1ULL << 1)
453 /**< When this flag is set, the pattern is forced to be "anchored", that is, it
454 * is constrained to match only at the first matching point in the string that
455 * is being searched. Similar to `^` and represented by `\A`.
457 * @see struct rte_regexdev_info::rule_flags
458 * @see struct rte_regexdev_rule::rule_flags
461 #define RTE_REGEX_PCRE_RULE_CASELESS_F (1ULL << 2)
462 /**< When this flag is set, letters in the pattern match both upper and lower
463 * case letters in the subject.
465 * @see struct rte_regexdev_info::rule_flags
466 * @see struct rte_regexdev_rule::rule_flags
469 #define RTE_REGEX_PCRE_RULE_DOTALL_F (1ULL << 3)
470 /**< When this flag is set, a dot metacharacter in the pattern matches any
471 * character, including one that indicates a newline.
473 * @see struct rte_regexdev_info::rule_flags
474 * @see struct rte_regexdev_rule::rule_flags
477 #define RTE_REGEX_PCRE_RULE_DUPNAMES_F (1ULL << 4)
478 /**< When this flag is set, names used to identify capture groups need not be
481 * @see struct rte_regexdev_info::rule_flags
482 * @see struct rte_regexdev_rule::rule_flags
485 #define RTE_REGEX_PCRE_RULE_EXTENDED_F (1ULL << 5)
486 /**< When this flag is set, most white space characters in the pattern are
487 * totally ignored except when escaped or inside a character class.
489 * @see struct rte_regexdev_info::rule_flags
490 * @see struct rte_regexdev_rule::rule_flags
493 #define RTE_REGEX_PCRE_RULE_MATCH_UNSET_BACKREF_F (1ULL << 6)
494 /**< When this flag is set, a backreference to an unset capture group matches an
497 * @see struct rte_regexdev_info::rule_flags
498 * @see struct rte_regexdev_rule::rule_flags
501 #define RTE_REGEX_PCRE_RULE_MULTILINE_F (1ULL << 7)
502 /**< When this flag is set, the `^` and `$` constructs match immediately
503 * following or immediately before internal newlines in the subject string,
504 * respectively, as well as at the very start and end.
506 * @see struct rte_regexdev_info::rule_flags
507 * @see struct rte_regexdev_rule::rule_flags
510 #define RTE_REGEX_PCRE_RULE_NO_AUTO_CAPTURE_F (1ULL << 8)
511 /**< When this Flag is set, it disables the use of numbered capturing
512 * parentheses in the pattern. References to capture groups (backreferences or
513 * recursion/subroutine calls) may only refer to named groups, though the
514 * reference can be by name or by number.
516 * @see struct rte_regexdev_info::rule_flags
517 * @see struct rte_regexdev_rule::rule_flags
520 #define RTE_REGEX_PCRE_RULE_UCP_F (1ULL << 9)
521 /**< By default, only ASCII characters are recognized, When this flag is set,
522 * Unicode properties are used instead to classify characters.
524 * @see struct rte_regexdev_info::rule_flags
525 * @see struct rte_regexdev_rule::rule_flags
528 #define RTE_REGEX_PCRE_RULE_UNGREEDY_F (1ULL << 10)
529 /**< When this flag is set, the "greediness" of the quantifiers is inverted
530 * so that they are not greedy by default, but become greedy if followed by
533 * @see struct rte_regexdev_info::rule_flags
534 * @see struct rte_regexdev_rule::rule_flags
537 #define RTE_REGEX_PCRE_RULE_UTF_F (1ULL << 11)
538 /**< When this flag is set, RegEx engine has to regard both the pattern and the
539 * subject strings that are subsequently processed as strings of UTF characters
540 * instead of single-code-unit strings.
542 * @see struct rte_regexdev_info::rule_flags
543 * @see struct rte_regexdev_rule::rule_flags
546 #define RTE_REGEX_PCRE_RULE_NEVER_BACKSLASH_C_F (1ULL << 12)
547 /**< This flag locks out the use of `\C` in the pattern that is being compiled.
548 * This escape matches one data unit, even in UTF mode which can cause
549 * unpredictable behavior in UTF-8 or UTF-16 modes, because it may leave the
550 * current matching point in the mi:set hlsearchddle of a multi-code-unit
553 * @see struct rte_regexdev_info::rule_flags
554 * @see struct rte_regexdev_rule::rule_flags
558 * RegEx device information
560 struct rte_regexdev_info {
561 const char *driver_name; /**< RegEx driver name. */
562 struct rte_device *dev; /**< Device information. */
563 uint16_t max_matches;
564 /**< Maximum matches per scan supported by this device. */
565 uint16_t max_queue_pairs;
566 /**< Maximum queue pairs supported by this device. */
567 uint16_t max_payload_size;
568 /**< Maximum payload size for a pattern match request or scan.
569 * @see RTE_REGEXDEV_CFG_CROSS_BUFFER_SCAN_F
571 uint32_t max_rules_per_group;
572 /**< Maximum rules supported per group by this device. */
574 /**< Maximum groups supported by this device. */
575 uint32_t regexdev_capa;
576 /**< RegEx device capabilities. @see RTE_REGEXDEV_CAPA_* */
578 /**< Supported compiler rule flags.
579 * @see RTE_REGEX_PCRE_RULE_*, struct rte_regexdev_rule::rule_flags
585 * @b EXPERIMENTAL: this API may change without prior notice.
587 * Retrieve the contextual information of a RegEx device.
590 * The identifier of the device.
592 * @param[out] dev_info
593 * A pointer to a structure of type *rte_regexdev_info* to be filled with the
594 * contextual information of the device.
597 * - 0: Success, driver updates the contextual information of the RegEx device
598 * - <0: Error code returned by the driver info get function.
602 rte_regexdev_info_get(uint8_t dev_id, struct rte_regexdev_info *dev_info);
604 /* Enumerates RegEx device configuration flags */
605 #define RTE_REGEXDEV_CFG_CROSS_BUFFER_SCAN_F (1ULL << 0)
606 /**< Cross buffer scan refers to the ability to be able to detect
607 * matches that occur across buffer boundaries, where the buffers are related
608 * to each other in some way. Enable this flag when to scan payload size
609 * greater than struct rte_regexdev_info::max_payload_size and/or
610 * matches can present across scan buffer boundaries.
612 * @see struct rte_regexdev_info::max_payload_size
613 * @see struct rte_regexdev_config::dev_cfg_flags, rte_regexdev_configure()
614 * @see RTE_REGEX_OPS_RSP_PMI_SOJ_F
615 * @see RTE_REGEX_OPS_RSP_PMI_EOJ_F
618 #define RTE_REGEXDEV_CFG_MATCH_AS_END_F (1ULL << 1)
619 /**< Match as end is the ability to return the result as ending offset.
620 * When this flag is set, the result for each match will hold the ending
621 * offset of the match in end_offset.
622 * If this flag is not set, then the match result will hold the starting offset
623 * in start_offset, and the length of the match in len.
625 * @see RTE_REGEXDEV_SUPP_MATCH_AS_END_F
628 #define RTE_REGEXDEV_CFG_MATCH_ALL_F (1ULL << 2)
629 /**< Match all is the ability to return all possible results.
631 * @see RTE_REGEXDEV_SUPP_MATCH_ALL_F
634 /** RegEx device configuration structure */
635 struct rte_regexdev_config {
636 uint16_t nb_max_matches;
637 /**< Maximum matches per scan configured on this device.
638 * This value cannot exceed the *max_matches*
639 * which previously provided in rte_regexdev_info_get().
640 * The value 0 is allowed, in which case, value 1 used.
641 * @see struct rte_regexdev_info::max_matches
643 uint16_t nb_queue_pairs;
644 /**< Number of RegEx queue pairs to configure on this device.
645 * This value cannot exceed the *max_queue_pairs* which previously
646 * provided in rte_regexdev_info_get().
647 * @see struct rte_regexdev_info::max_queue_pairs
649 uint32_t nb_rules_per_group;
650 /**< Number of rules per group to configure on this device.
651 * This value cannot exceed the *max_rules_per_group*
652 * which previously provided in rte_regexdev_info_get().
653 * The value 0 is allowed, in which case,
654 * struct rte_regexdev_info::max_rules_per_group used.
655 * @see struct rte_regexdev_info::max_rules_per_group
658 /**< Number of groups to configure on this device.
659 * This value cannot exceed the *max_groups*
660 * which previously provided in rte_regexdev_info_get().
661 * @see struct rte_regexdev_info::max_groups
664 /**< Import initial set of prebuilt rule database on this device.
665 * The value NULL is allowed, in which case, the device will not
666 * be configured prebuilt rule database. Application may use
667 * rte_regexdev_rule_db_update() or rte_regexdev_rule_db_import() API
668 * to update or import rule database after the
669 * rte_regexdev_configure().
670 * @see rte_regexdev_rule_db_update(), rte_regexdev_rule_db_import()
672 uint32_t rule_db_len;
673 /**< Length of *rule_db* buffer. */
674 uint32_t dev_cfg_flags;
675 /**< RegEx device configuration flags, See RTE_REGEXDEV_CFG_* */
680 * @b EXPERIMENTAL: this API may change without prior notice.
682 * Configure a RegEx device.
684 * This function must be invoked first before any other function in the
685 * API. This function can also be re-invoked when a device is in the
688 * The caller may use rte_regexdev_info_get() to get the capability of each
689 * resources available for this regex device.
692 * The identifier of the device to configure.
694 * The RegEx device configuration structure.
697 * - 0: Success, device configured. Otherwise negative errno is returned.
701 rte_regexdev_configure(uint8_t dev_id, const struct rte_regexdev_config *cfg);
703 /* Enumerates RegEx queue pair configuration flags */
704 #define RTE_REGEX_QUEUE_PAIR_CFG_OOS_F (1ULL << 0)
705 /**< Out of order scan, If not set, a scan must retire after previously issued
706 * in-order scans to this queue pair. If set, this scan can be retired as soon
707 * as device returns completion. Application should not set out of order scan
708 * flag if it needs to maintain the ingress order of scan request.
710 * @see struct rte_regexdev_qp_conf::qp_conf_flags
711 * @see rte_regexdev_queue_pair_setup()
714 struct rte_regex_ops;
715 typedef void (*regexdev_stop_flush_t)(uint8_t dev_id, uint16_t qp_id,
716 struct rte_regex_ops *op);
717 /**< Callback function called during rte_regexdev_stop(), invoked once per
721 /** RegEx queue pair configuration structure */
722 struct rte_regexdev_qp_conf {
723 uint32_t qp_conf_flags;
724 /**< Queue pair config flags, See RTE_REGEX_QUEUE_PAIR_CFG_* */
726 /**< The number of descriptors to allocate for this queue pair. */
727 regexdev_stop_flush_t cb;
728 /**< Callback function called during rte_regexdev_stop(), invoked
729 * once per flushed regex op. Value NULL is allowed, in which case
730 * callback will not be invoked. This function can be used to properly
731 * dispose of outstanding regex ops from response queue,
732 * for example ops containing memory pointers.
733 * @see rte_regexdev_stop()
739 * @b EXPERIMENTAL: this API may change without prior notice.
741 * Allocate and set up a RegEx queue pair for a RegEx device.
744 * The identifier of the device.
745 * @param queue_pair_id
746 * The index of the RegEx queue pair to setup. The value must be in the range
747 * [0, nb_queue_pairs - 1] previously supplied to rte_regexdev_configure().
749 * The pointer to the configuration data to be used for the RegEx queue pair.
750 * NULL value is allowed, in which case default configuration used.
753 * 0 on success. Otherwise negative errno is returned.
757 rte_regexdev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
758 const struct rte_regexdev_qp_conf *qp_conf);
762 * @b EXPERIMENTAL: this API may change without prior notice.
764 * Start a RegEx device.
766 * The device start step is the last one and consists of setting the RegEx
767 * queues to start accepting the pattern matching scan requests.
769 * On success, all basic functions exported by the API (RegEx enqueue,
770 * RegEx dequeue and so on) can be invoked.
773 * RegEx device identifier.
776 * 0 on success. Otherwise negative errno is returned.
780 rte_regexdev_start(uint8_t dev_id);
784 * @b EXPERIMENTAL: this API may change without prior notice.
786 * Stop a RegEx device.
788 * Stop a RegEx device. The device can be restarted with a call to
789 * rte_regexdev_start().
791 * This function causes all queued response regex ops to be drained in the
792 * response queue. While draining ops out of the device,
793 * struct rte_regexdev_qp_conf::cb will be invoked for each ops.
796 * RegEx device identifier.
799 * 0 on success. Otherwise negative errno is returned.
803 rte_regexdev_stop(uint8_t dev_id);
807 * @b EXPERIMENTAL: this API may change without prior notice.
809 * Close a RegEx device. The device cannot be restarted!
812 * RegEx device identifier
815 * 0 on success. Otherwise negative errno is returned.
819 rte_regexdev_close(uint8_t dev_id);
821 /* Device get/set attributes */
823 /** Enumerates RegEx device attribute identifier */
824 enum rte_regexdev_attr_id {
825 RTE_REGEXDEV_ATTR_SOCKET_ID,
826 /**< The NUMA socket id to which the device is connected or
827 * a default of zero if the socket could not be determined.
831 RTE_REGEXDEV_ATTR_MAX_MATCHES,
832 /**< Maximum number of matches per scan.
833 * datatype: *uint8_t*
834 * operation: *get* and *set*
835 * @see RTE_REGEX_OPS_RSP_MAX_MATCH_F
837 RTE_REGEXDEV_ATTR_MAX_SCAN_TIMEOUT,
838 /**< Upper bound scan time in ns.
839 * datatype: *uint16_t*
840 * operation: *get* and *set*
841 * @see RTE_REGEX_OPS_RSP_MAX_SCAN_TIMEOUT_F
843 RTE_REGEXDEV_ATTR_MAX_PREFIX,
844 /**< Maximum number of prefix detected per scan.
845 * This would be useful for denial of service detection.
846 * datatype: *uint16_t*
847 * operation: *get* and *set*
848 * @see RTE_REGEX_OPS_RSP_MAX_PREFIX_F
854 * @b EXPERIMENTAL: this API may change without prior notice.
856 * Get an attribute from a RegEx device.
859 * RegEx device identifier.
861 * The attribute ID to retrieve.
863 * A pointer that will be filled in with the attribute
864 * value if successful.
867 * - 0: Successfully retrieved attribute value.
868 * - -EINVAL: Invalid device or *attr_id* provided, or *attr_value* is NULL.
869 * - -ENOTSUP: if the device doesn't support specific *attr_id*.
873 rte_regexdev_attr_get(uint8_t dev_id, enum rte_regexdev_attr_id attr_id,
878 * @b EXPERIMENTAL: this API may change without prior notice.
880 * Set an attribute to a RegEx device.
883 * RegEx device identifier.
885 * The attribute ID to retrieve.
887 * Pointer that will be filled in with the attribute value
888 * by the application.
891 * - 0: Successfully applied the attribute value.
892 * - -EINVAL: Invalid device or *attr_id* provided, or *attr_value* is NULL.
893 * - -ENOTSUP: if the device doesn't support specific *attr_id*.
897 rte_regexdev_attr_set(uint8_t dev_id, enum rte_regexdev_attr_id attr_id,
898 const void *attr_value);
900 /* Rule related APIs */
901 /** Enumerates RegEx rule operation. */
902 enum rte_regexdev_rule_op {
903 RTE_REGEX_RULE_OP_ADD,
904 /**< Add RegEx rule to rule database. */
905 RTE_REGEX_RULE_OP_REMOVE
906 /**< Remove RegEx rule from rule database. */
909 /** Structure to hold a RegEx rule attributes. */
910 struct rte_regexdev_rule {
911 enum rte_regexdev_rule_op op;
912 /**< OP type of the rule either a OP_ADD or OP_DELETE. */
914 /**< Group identifier to which the rule belongs to. */
916 /**< Rule identifier which is returned on successful match. */
917 const char *pcre_rule;
918 /**< Buffer to hold the PCRE rule. */
919 uint16_t pcre_rule_len;
920 /**< Length of the PCRE rule. */
922 /* PCRE rule flags. Supported device specific PCRE rules enumerated
923 * in struct rte_regexdev_info::rule_flags. For successful rule
924 * database update, application needs to provide only supported
926 * @See RTE_REGEX_PCRE_RULE_*, struct rte_regexdev_info::rule_flags
932 * @b EXPERIMENTAL: this API may change without prior notice.
934 * Update the local rule set.
935 * This functions only modify the rule set in memory.
936 * In order for the changes to take effect, the function
937 * rte_regexdev_rule_db_compile_active must be called.
940 * RegEx device identifier.
942 * Points to an array of *nb_rules* objects of type *rte_regexdev_rule*
943 * structure which contain the regex rules attributes to be updated
946 * The number of PCRE rules to update the rule database.
949 * The number of regex rules actually updated on the regex device's rule
950 * database. The return value can be less than the value of the *nb_rules*
951 * parameter when the regex devices fails to update the rule database or
952 * if invalid parameters are specified in a *rte_regexdev_rule*.
953 * If the return value is less than *nb_rules*, the remaining PCRE rules
954 * at the end of *rules* are not consumed and the caller has to take
955 * care of them and rte_errno is set accordingly.
956 * Possible errno values include:
957 * - -EINVAL: Invalid device ID or rules is NULL
958 * - -ENOTSUP: The last processed rule is not supported on this device.
959 * - -ENOSPC: No space available in rule database.
961 * @see rte_regexdev_rule_db_import(), rte_regexdev_rule_db_export(),
962 * rte_regexdev_rule_db_compile_activate()
966 rte_regexdev_rule_db_update(uint8_t dev_id,
967 const struct rte_regexdev_rule *rules,
972 * @b EXPERIMENTAL: this API may change without prior notice.
974 * Compile local rule set and burn the complied result to the
978 * RegEx device identifier.
981 * 0 on success, otherwise negative errno.
983 * @see rte_regexdev_rule_db_import(), rte_regexdev_rule_db_export(),
984 * rte_regexdev_rule_db_update()
988 rte_regexdev_rule_db_compile_activate(uint8_t dev_id);
992 * @b EXPERIMENTAL: this API may change without prior notice.
994 * Import a prebuilt rule database from a buffer to a RegEx device.
997 * RegEx device identifier.
999 * Points to prebuilt rule database.
1000 * @param rule_db_len
1001 * Length of the rule database.
1004 * - 0: Successfully updated the prebuilt rule database.
1005 * - -EINVAL: Invalid device ID or rule_db is NULL
1006 * - -ENOTSUP: Rule database import is not supported on this device.
1007 * - -ENOSPC: No space available in rule database.
1009 * @see rte_regexdev_rule_db_update(), rte_regexdev_rule_db_export()
1013 rte_regexdev_rule_db_import(uint8_t dev_id, const char *rule_db,
1014 uint32_t rule_db_len);
1018 * @b EXPERIMENTAL: this API may change without prior notice.
1020 * Export the prebuilt rule database from a RegEx device to the buffer.
1023 * RegEx device identifier.
1024 * @param[out] rule_db
1025 * Block of memory to insert the rule database. Must be at least size in
1026 * capacity. If set to NULL, function returns required capacity.
1029 * - 0: Successfully exported the prebuilt rule database.
1030 * - size: If rule_db set to NULL then required capacity for *rule_db*
1031 * - -EINVAL: Invalid device ID
1032 * - -ENOTSUP: Rule database export is not supported on this device.
1034 * @see rte_regexdev_rule_db_update(), rte_regexdev_rule_db_import()
1038 rte_regexdev_rule_db_export(uint8_t dev_id, char *rule_db);
1040 /* Extended statistics */
1041 /** Maximum name length for extended statistics counters */
1042 #define RTE_REGEXDEV_XSTATS_NAME_SIZE 64
1045 * A name-key lookup element for extended statistics.
1047 * This structure is used to map between names and ID numbers
1048 * for extended RegEx device statistics.
1050 struct rte_regexdev_xstats_map {
1052 /**< xstat identifier */
1053 char name[RTE_REGEXDEV_XSTATS_NAME_SIZE];
1059 * @b EXPERIMENTAL: this API may change without prior notice.
1061 * Retrieve names of extended statistics of a regex device.
1064 * The identifier of the regex device.
1065 * @param[out] xstats_map
1066 * Block of memory to insert id and names into. Must be at least size in
1067 * capacity. If set to NULL, function returns required capacity.
1069 * - Positive value on success:
1070 * -The return value is the number of entries filled in the stats map.
1071 * -If xstats_map set to NULL then required capacity for xstats_map.
1072 * - Negative value on error:
1073 * -ENODEV for invalid *dev_id*
1074 * -ENOTSUP if the device doesn't support this function.
1078 rte_regexdev_xstats_names_get(uint8_t dev_id,
1079 struct rte_regexdev_xstats_map *xstats_map);
1083 * @b EXPERIMENTAL: this API may change without prior notice.
1085 * Retrieve extended statistics of an regex device.
1088 * The identifier of the device.
1090 * The id numbers of the stats to get. The ids can be got from the stat
1091 * position in the stat list from rte_regexdev_xstats_names_get(), or
1092 * by using rte_regexdev_xstats_by_name_get().
1094 * The values for each stats request by ID.
1096 * The number of stats requested.
1098 * - Positive value: number of stat entries filled into the values array
1099 * - Negative value on error:
1100 * -ENODEV for invalid *dev_id*
1101 * -ENOTSUP if the device doesn't support this function.
1105 rte_regexdev_xstats_get(uint8_t dev_id, const uint16_t *ids,
1106 uint64_t *values, uint16_t nb_values);
1110 * @b EXPERIMENTAL: this API may change without prior notice.
1112 * Retrieve the value of a single stat by requesting it by name.
1115 * The identifier of the device.
1117 * The stat name to retrieve.
1119 * If non-NULL, the numerical id of the stat will be returned, so that further
1120 * requests for the stat can be got using rte_regexdev_xstats_get, which will
1121 * be faster as it doesn't need to scan a list of names for the stat.
1123 * Must be non-NULL, retrieved xstat value will be stored in this address.
1126 * - 0: Successfully retrieved xstat value.
1127 * - -EINVAL: invalid parameters
1128 * - -ENOTSUP: if not supported.
1132 rte_regexdev_xstats_by_name_get(uint8_t dev_id, const char *name,
1133 uint16_t *id, uint64_t *value);
1137 * @b EXPERIMENTAL: this API may change without prior notice.
1139 * Reset the values of the xstats of the selected component in the device.
1142 * The identifier of the device.
1144 * Selects specific statistics to be reset. When NULL, all statistics will be
1145 * reset. If non-NULL, must point to array of at least *nb_ids* size.
1147 * The number of ids available from the *ids* array. Ignored when ids is NULL.
1150 * - 0: Successfully reset the statistics to zero.
1151 * - -EINVAL: invalid parameters.
1152 * - -ENOTSUP: if not supported.
1156 rte_regexdev_xstats_reset(uint8_t dev_id, const uint16_t *ids,
1161 * @b EXPERIMENTAL: this API may change without prior notice.
1163 * Trigger the RegEx device self test.
1166 * The identifier of the device.
1168 * - 0: Selftest successful.
1169 * - -ENOTSUP if the device doesn't support selftest.
1170 * - other values < 0 on failure.
1174 rte_regexdev_selftest(uint8_t dev_id);
1178 * @b EXPERIMENTAL: this API may change without prior notice.
1180 * Dump internal information about *dev_id* to the FILE* provided in *f*.
1183 * The identifier of the device.
1185 * A pointer to a file for output.
1188 * 0 on success, negative errno on failure.
1192 rte_regexdev_dump(uint8_t dev_id, FILE *f);
1194 /* Fast path APIs */
1197 * The generic *rte_regexdev_match* structure to hold the RegEx match
1199 * @see struct rte_regex_ops::matches
1201 struct rte_regexdev_match {
1206 uint32_t rule_id:20;
1207 /**< Rule identifier to which the pattern matched.
1208 * @see struct rte_regexdev_rule::rule_id
1210 uint32_t group_id:12;
1211 /**< Group identifier of the rule which the pattern
1212 * matched. @see struct rte_regexdev_rule::group_id
1214 uint16_t start_offset;
1215 /**< Starting Byte Position for matched rule. */
1219 /**< Length of match in bytes */
1220 uint16_t end_offset;
1221 /**< The end offset of the match. In case
1222 * MATCH_AS_END configuration is enabled.
1223 * @see RTE_REGEXDEV_CFG_MATCH_AS_END
1230 /* Enumerates RegEx request flags. */
1231 #define RTE_REGEX_OPS_REQ_GROUP_ID0_VALID_F (1 << 0)
1232 /**< Set when struct rte_regexdev_rule::group_id0 is valid. */
1234 #define RTE_REGEX_OPS_REQ_GROUP_ID1_VALID_F (1 << 1)
1235 /**< Set when struct rte_regexdev_rule::group_id1 is valid. */
1237 #define RTE_REGEX_OPS_REQ_GROUP_ID2_VALID_F (1 << 2)
1238 /**< Set when struct rte_regexdev_rule::group_id2 is valid. */
1240 #define RTE_REGEX_OPS_REQ_GROUP_ID3_VALID_F (1 << 3)
1241 /**< Set when struct rte_regexdev_rule::group_id3 is valid. */
1243 #define RTE_REGEX_OPS_REQ_STOP_ON_MATCH_F (1 << 4)
1244 /**< The RegEx engine will stop scanning and return the first match. */
1246 #define RTE_REGEX_OPS_REQ_MATCH_HIGH_PRIORITY_F (1 << 5)
1247 /**< In High Priority mode a maximum of one match will be returned per scan to
1248 * reduce the post-processing required by the application. The match with the
1249 * lowest Rule id, lowest start pointer and lowest match length will be
1252 * @see struct rte_regex_ops::nb_actual_matches
1253 * @see struct rte_regex_ops::nb_matches
1257 /* Enumerates RegEx response flags. */
1258 #define RTE_REGEX_OPS_RSP_PMI_SOJ_F (1 << 0)
1259 /**< Indicates that the RegEx device has encountered a partial match at the
1260 * start of scan in the given buffer.
1262 * @see RTE_REGEXDEV_CFG_CROSS_BUFFER_SCAN_F
1265 #define RTE_REGEX_OPS_RSP_PMI_EOJ_F (1 << 1)
1266 /**< Indicates that the RegEx device has encountered a partial match at the
1267 * end of scan in the given buffer.
1269 * @see RTE_REGEXDEV_CFG_CROSS_BUFFER_SCAN_F
1272 #define RTE_REGEX_OPS_RSP_MAX_SCAN_TIMEOUT_F (1 << 2)
1273 /**< Indicates that the RegEx device has exceeded the max timeout while
1274 * scanning the given buffer.
1276 * @see RTE_REGEXDEV_ATTR_MAX_SCAN_TIMEOUT
1279 #define RTE_REGEX_OPS_RSP_MAX_MATCH_F (1 << 3)
1280 /**< Indicates that the RegEx device has exceeded the max matches while
1281 * scanning the given buffer.
1283 * @see RTE_REGEXDEV_ATTR_MAX_MATCHES
1286 #define RTE_REGEX_OPS_RSP_MAX_PREFIX_F (1 << 4)
1287 /**< Indicates that the RegEx device has reached the max allowed prefix length
1288 * while scanning the given buffer.
1290 * @see RTE_REGEXDEV_ATTR_MAX_PREFIX
1294 * The generic *rte_regex_ops* structure to hold the RegEx attributes
1295 * for enqueue and dequeue operation.
1297 struct rte_regex_ops {
1300 /**< Request flags for the RegEx ops.
1301 * @see RTE_REGEX_OPS_REQ_*
1304 /**< Response flags for the RegEx ops.
1305 * @see RTE_REGEX_OPS_RSP_*
1307 uint16_t nb_actual_matches;
1308 /**< The total number of actual matches detected by the Regex device.*/
1309 uint16_t nb_matches;
1310 /**< The total number of matches returned by the RegEx device for this
1311 * scan. The size of *rte_regex_ops::matches* zero length array will be
1314 * @see struct rte_regex_ops::matches, struct rte_regexdev_match
1318 struct rte_mbuf *mbuf; /**< source mbuf, to search in. */
1322 /**< First group_id to match the rule against. At minimum one group
1323 * should be valid. Behaviour is undefined non of the groups are valid.
1325 * @see RTE_REGEX_OPS_REQ_GROUP_ID0_VALID_F
1328 /**< Second group_id to match the rule against.
1330 * @see RTE_REGEX_OPS_REQ_GROUP_ID1_VALID_F
1333 /**< Third group_id to match the rule against.
1335 * @see RTE_REGEX_OPS_REQ_GROUP_ID2_VALID_F
1338 /**< Forth group_id to match the rule against.
1340 * @see RTE_REGEX_OPS_REQ_GROUP_ID3_VALID_F
1347 /**< Application specific opaque value. An application may use
1348 * this field to hold application specific value to share
1349 * between dequeue and enqueue operation.
1350 * Implementation should not modify this field.
1353 /**< Pointer representation of *user_id* */
1359 uint64_t cross_buf_id;
1360 /**< ID used by the RegEx device in order to support cross
1362 * This ID is returned from the RegEx device on the dequeue
1363 * function. The application must send it back when calling
1364 * enqueue with the following packet.
1366 void *cross_buf_ptr;
1367 /**< Pointer representation of *corss_buf_id* */
1371 struct rte_regexdev_match matches[];
1372 /**< Zero length array to hold the match tuples.
1373 * The struct rte_regex_ops::nb_matches value holds the number of
1374 * elements in this array.
1376 * @see struct rte_regex_ops::nb_matches
1380 #include "rte_regexdev_core.h"
1384 * @b EXPERIMENTAL: this API may change without prior notice.
1386 * Enqueue a burst of scan request on a RegEx device.
1388 * The rte_regexdev_enqueue_burst() function is invoked to place
1389 * regex operations on the queue *qp_id* of the device designated by
1392 * The *nb_ops* parameter is the number of operations to process which are
1393 * supplied in the *ops* array of *rte_regexdev_op* structures.
1395 * The rte_regexdev_enqueue_burst() function returns the number of
1396 * operations it actually enqueued for processing. A return value equal to
1397 * *nb_ops* means that all packets have been enqueued.
1400 * The identifier of the device.
1402 * The index of the queue pair which packets are to be enqueued for
1403 * processing. The value must be in the range [0, nb_queue_pairs - 1]
1404 * previously supplied to rte_regexdev_configure().
1406 * The address of an array of *nb_ops* pointers to *rte_regexdev_op*
1407 * structures which contain the regex operations to be processed.
1409 * The number of operations to process.
1412 * The number of operations actually enqueued on the regex device. The return
1413 * value can be less than the value of the *nb_ops* parameter when the
1414 * regex devices queue is full or if invalid parameters are specified in
1415 * a *rte_regexdev_op*. If the return value is less than *nb_ops*, the
1416 * remaining ops at the end of *ops* are not consumed and the caller has
1417 * to take care of them.
1421 rte_regexdev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
1422 struct rte_regex_ops **ops, uint16_t nb_ops);
1426 * @b EXPERIMENTAL: this API may change without prior notice.
1428 * Dequeue a burst of scan response from a queue on the RegEx device.
1429 * The dequeued operation are stored in *rte_regexdev_op* structures
1430 * whose pointers are supplied in the *ops* array.
1432 * The rte_regexdev_dequeue_burst() function returns the number of ops
1433 * actually dequeued, which is the number of *rte_regexdev_op* data structures
1434 * effectively supplied into the *ops* array.
1436 * A return value equal to *nb_ops* indicates that the queue contained
1437 * at least *nb_ops* operations, and this is likely to signify that other
1438 * processed operations remain in the devices output queue. Applications
1439 * implementing a "retrieve as many processed operations as possible" policy
1440 * can check this specific case and keep invoking the
1441 * rte_regexdev_dequeue_burst() function until a value less than
1442 * *nb_ops* is returned.
1444 * The rte_regexdev_dequeue_burst() function does not provide any error
1445 * notification to avoid the corresponding overhead.
1448 * The RegEx device identifier
1450 * The index of the queue pair from which to retrieve processed packets.
1451 * The value must be in the range [0, nb_queue_pairs - 1] previously
1452 * supplied to rte_regexdev_configure().
1454 * The address of an array of pointers to *rte_regexdev_op* structures
1455 * that must be large enough to store *nb_ops* pointers in it.
1457 * The maximum number of operations to dequeue.
1460 * The number of operations actually dequeued, which is the number
1461 * of pointers to *rte_regexdev_op* structures effectively supplied to the
1462 * *ops* array. If the return value is less than *nb_ops*, the remaining
1463 * ops at the end of *ops* are not consumed and the caller has to take care
1468 rte_regexdev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
1469 struct rte_regex_ops **ops, uint16_t nb_ops);
1475 #endif /* _RTE_REGEXDEV_H_ */