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>
203 #include <rte_mbuf.h>
205 #define RTE_REGEXDEV_NAME_MAX_LEN RTE_DEV_NAME_MAX_LEN
207 extern int rte_regexdev_logtype;
209 #define RTE_REGEXDEV_LOG(level, ...) \
210 rte_log(RTE_LOG_ ## level, rte_regexdev_logtype, "" __VA_ARGS__)
212 /* Macros to check for valid port */
213 #define RTE_REGEXDEV_VALID_DEV_ID_OR_ERR_RET(dev_id, retval) do { \
214 if (!rte_regexdev_is_valid_dev(dev_id)) { \
215 RTE_REGEXDEV_LOG(ERR, "Invalid dev_id=%u\n", dev_id); \
220 #define RTE_REGEXDEV_VALID_DEV_ID_OR_RET(dev_id) do { \
221 if (!rte_regexdev_is_valid_dev(dev_id)) { \
222 RTE_REGEXDEV_LOG(ERR, "Invalid dev_id=%u\n", dev_id); \
229 * @b EXPERIMENTAL: this API may change without prior notice.
231 * Check if dev_id is ready.
234 * The dev identifier of the RegEx device.
237 * - 0 if device state is not in ready state.
238 * - 1 if device state is ready state.
241 int rte_regexdev_is_valid_dev(uint16_t dev_id);
245 * @b EXPERIMENTAL: this API may change without prior notice.
247 * Get the total number of RegEx devices that have been successfully
251 * The total number of usable RegEx devices.
255 rte_regexdev_count(void);
259 * @b EXPERIMENTAL: this API may change without prior notice.
261 * Get the device identifier for the named RegEx device.
264 * RegEx device name to select the RegEx device identifier.
267 * Returns RegEx device identifier on success.
268 * - <0: Failure to find named RegEx device.
272 rte_regexdev_get_dev_id(const char *name);
274 /* Enumerates RegEx device capabilities */
275 #define RTE_REGEXDEV_CAPA_RUNTIME_COMPILATION_F (1ULL << 0)
276 /**< RegEx device does support compiling the rules at runtime unlike
277 * loading only the pre-built rule database using
278 * struct rte_regexdev_config::rule_db in rte_regexdev_configure()
280 * @see struct rte_regexdev_config::rule_db, rte_regexdev_configure()
281 * @see struct rte_regexdev_info::regexdev_capa
284 #define RTE_REGEXDEV_CAPA_SUPP_PCRE_START_ANCHOR_F (1ULL << 1)
285 /**< RegEx device support PCRE Anchor to start of match flag.
286 * Example RegEx is `/\Gfoo\d/`. Here `\G` asserts position at the end of the
287 * previous match or the start of the string for the first match.
288 * This position will change each time the RegEx is applied to the subject
289 * string. If the RegEx is applied to `foo1foo2Zfoo3` the first two matches will
290 * be successful for `foo1foo2` and fail for `Zfoo3`.
292 * @see struct rte_regexdev_info::regexdev_capa
295 #define RTE_REGEXDEV_CAPA_SUPP_PCRE_ATOMIC_GROUPING_F (1ULL << 2)
296 /**< RegEx device support PCRE Atomic grouping.
297 * Atomic groups are represented by `(?>)`. An atomic group is a group that,
298 * when the RegEx engine exits from it, automatically throws away all
299 * backtracking positions remembered by any tokens inside the group.
300 * Example RegEx is `a(?>bc|b)c` if the given patterns are `abc` and `abcc` then
301 * `a(bc|b)c` matches both where as `a(?>bc|b)c` matches only abcc because
302 * atomic groups don't allow backtracking back to `b`.
304 * @see struct rte_regexdev_info::regexdev_capa
307 #define RTE_REGEXDEV_SUPP_PCRE_BACKTRACKING_CTRL_F (1ULL << 3)
308 /**< RegEx device support PCRE backtracking control verbs.
309 * Some examples of backtracking verbs are (*COMMIT), (*ACCEPT), (*FAIL),
312 * @see struct rte_regexdev_info::regexdev_capa
315 #define RTE_REGEXDEV_SUPP_PCRE_CALLOUTS_F (1ULL << 4)
316 /**< RegEx device support PCRE callouts.
317 * PCRE supports calling external function in between matches by using `(?C)`.
318 * Example RegEx `ABC(?C)D` if a given patter is `ABCD` then the RegEx engine
319 * will parse ABC perform a userdefined callout and return a successful match at
322 * @see struct rte_regexdev_info::regexdev_capa
325 #define RTE_REGEXDEV_SUPP_PCRE_BACKREFERENCE_F (1ULL << 5)
326 /**< RegEx device support PCRE backreference.
327 * Example RegEx is `(\2ABC|(GHI))+` `\2` matches the same text as most recently
328 * matched by the 2nd capturing group i.e. `GHI`.
330 * @see struct rte_regexdev_info::regexdev_capa
333 #define RTE_REGEXDEV_SUPP_PCRE_GREEDY_F (1ULL << 6)
334 /**< RegEx device support PCRE Greedy mode.
335 * For example if the RegEx is `AB\d*?` then `*?` represents zero or unlimited
336 * matches. In greedy mode the pattern `AB12345` will be matched completely
337 * where as the ungreedy mode `AB` will be returned as the match.
339 * @see struct rte_regexdev_info::regexdev_capa
342 #define RTE_REGEXDEV_SUPP_PCRE_MATCH_ALL_F (1ULL << 7)
343 /**< RegEx device support match all mode.
344 * For example if the RegEx is `AB\d*?` then `*?` represents zero or unlimited
345 * matches. In match all mode the pattern `AB12345` will return 6 matches.
346 * AB, AB1, AB12, AB123, AB1234, AB12345.
348 * @see struct rte_regexdev_info::regexdev_capa
351 #define RTE_REGEXDEV_SUPP_PCRE_LOOKAROUND_ASRT_F (1ULL << 8)
352 /**< RegEx device support PCRE Lookaround assertions
353 * (Zero-width assertions). Example RegEx is `[a-z]+\d+(?=!{3,})` if
354 * the given pattern is `dwad1234!` the RegEx engine doesn't report any matches
355 * because the assert `(?=!{3,})` fails. The pattern `dwad123!!!` would return a
358 * @see struct rte_regexdev_info::regexdev_capa
361 #define RTE_REGEXDEV_SUPP_PCRE_MATCH_POINT_RST_F (1ULL << 9)
362 /**< RegEx device doesn't support PCRE match point reset directive.
363 * Example RegEx is `[a-z]+\K\d+` if the pattern is `dwad123`
364 * then even though the entire pattern matches only `123`
365 * is reported as a match.
367 * @see struct rte_regexdev_info::regexdev_capa
370 #define RTE_REGEXDEV_SUPP_NEWLINE_CONVENTIONS_F (1ULL << 10)
371 /**< RegEx support PCRE newline convention.
372 * Newline conventions are represented as follows:
373 * (*CR) carriage return
375 * (*CRLF) carriage return, followed by linefeed
376 * (*ANYCRLF) any of the three above
377 * (*ANY) all Unicode newline sequences
379 * @see struct rte_regexdev_info::regexdev_capa
382 #define RTE_REGEXDEV_SUPP_PCRE_NEWLINE_SEQ_F (1ULL << 11)
383 /**< RegEx device support PCRE newline sequence.
384 * The escape sequence `\R` will match any newline sequence.
385 * It is equivalent to: `(?>\r\n|\n|\x0b|\f|\r|\x85)`.
387 * @see struct rte_regexdev_info::regexdev_capa
390 #define RTE_REGEXDEV_SUPP_PCRE_POSSESSIVE_QUALIFIERS_F (1ULL << 12)
391 /**< RegEx device support PCRE possessive qualifiers.
392 * Example RegEx possessive qualifiers `*+`, `++`, `?+`, `{m,n}+`.
393 * Possessive quantifier repeats the token as many times as possible and it does
394 * not give up matches as the engine backtracks. With a possessive quantifier,
395 * the deal is all or nothing.
397 * @see struct rte_regexdev_info::regexdev_capa
400 #define RTE_REGEXDEV_SUPP_PCRE_SUBROUTINE_REFERENCES_F (1ULL << 13)
401 /**< RegEx device support PCRE Subroutine references.
402 * PCRE Subroutine references allow for sub patterns to be assessed
403 * as part of the RegEx. Example RegEx is `(foo|fuzz)\g<1>+bar` matches the
404 * pattern `foofoofuzzfoofuzzbar`.
406 * @see struct rte_regexdev_info::regexdev_capa
409 #define RTE_REGEXDEV_SUPP_PCRE_UTF_8_F (1ULL << 14)
410 /**< RegEx device support UTF-8 character encoding.
412 * @see struct rte_regexdev_info::pcre_unsup_flags
415 #define RTE_REGEXDEV_SUPP_PCRE_UTF_16_F (1ULL << 15)
416 /**< RegEx device support UTF-16 character encoding.
418 * @see struct rte_regexdev_info::regexdev_capa
421 #define RTE_REGEXDEV_SUPP_PCRE_UTF_32_F (1ULL << 16)
422 /**< RegEx device support UTF-32 character encoding.
424 * @see struct rte_regexdev_info::regexdev_capa
427 #define RTE_REGEXDEV_SUPP_PCRE_WORD_BOUNDARY_F (1ULL << 17)
428 /**< RegEx device support word boundaries.
429 * The meta character `\b` represents word boundary anchor.
431 * @see struct rte_regexdev_info::regexdev_capa
434 #define RTE_REGEXDEV_SUPP_PCRE_FORWARD_REFERENCES_F (1ULL << 18)
435 /**< RegEx device support Forward references.
436 * Forward references allow you to use a back reference to a group that appears
437 * later in the RegEx. Example RegEx is `(\3ABC|(DEF|(GHI)))+` matches the
438 * following string `GHIGHIABCDEF`.
440 * @see struct rte_regexdev_info::regexdev_capa
443 #define RTE_REGEXDEV_SUPP_MATCH_AS_END_F (1ULL << 19)
444 /**< RegEx device support match as end.
445 * Match as end means that the match result holds the end offset of the
446 * detected match. No len value is set.
447 * If the device doesn't support this feature it means the match
448 * result holds the starting position of match and the length of the match.
450 * @see struct rte_regexdev_info::regexdev_capa
453 #define RTE_REGEXDEV_SUPP_CROSS_BUFFER_F (1ULL << 20)
454 /**< RegEx device support cross buffer match.
455 * Cross buffer matching means that the match can be detected even if the
456 * string was started in previous buffer.
457 * In case the device is configured as RTE_REGEXDEV_CFG_MATCH_AS_END
458 * the end offset will be relative for the first packet.
459 * For example RegEx is ABC the first buffer is xxxx second buffer yyyA and
460 * the last buffer BCzz.
461 * In case the match as end is configured the end offset will be 10.
463 * @see RTE_REGEXDEV_CFG_MATCH_AS_END_F
464 * @see RTE_REGEXDEV_CFG_CROSS_BUFFER_SCAN_F
465 * @see RTE_REGEX_OPS_RSP_PMI_SOJ_F
466 * @see RTE_REGEX_OPS_RSP_PMI_EOJ_F
469 #define RTE_REGEXDEV_SUPP_MATCH_ALL_F (1ULL << 21)
470 /**< RegEx device support match all.
471 * Match all means that the RegEx engine will return all possible matches.
472 * For example, assume the RegEx is `A+b`, given the input AAAb the
473 * returned matches will be: Ab, AAb and AAAb.
475 * @see RTE_REGEXDEV_CFG_MATCH_ALL_F
478 #define RTE_REGEXDEV_CAPA_QUEUE_PAIR_OOS_F (1ULL << 22)
479 /**< RegEx device supports out of order scan.
480 * Out of order scan means the response of a specific job can be returned as
481 * soon as it is ready even if previous jobs on the same queue didn't complete.
483 * @see RTE_REGEX_QUEUE_PAIR_CFG_OOS_F
484 * @see struct rte_regexdev_info::regexdev_capa
487 /* Enumerates PCRE rule flags */
488 #define RTE_REGEX_PCRE_RULE_ALLOW_EMPTY_F (1ULL << 0)
489 /**< When this flag is set, the pattern that can match against an empty string,
490 * such as `.*` are allowed.
492 * @see struct rte_regexdev_info::rule_flags
493 * @see struct rte_regexdev_rule::rule_flags
496 #define RTE_REGEX_PCRE_RULE_ANCHORED_F (1ULL << 1)
497 /**< When this flag is set, the pattern is forced to be "anchored", that is, it
498 * is constrained to match only at the first matching point in the string that
499 * is being searched. Similar to `^` and represented by `\A`.
501 * @see struct rte_regexdev_info::rule_flags
502 * @see struct rte_regexdev_rule::rule_flags
505 #define RTE_REGEX_PCRE_RULE_CASELESS_F (1ULL << 2)
506 /**< When this flag is set, letters in the pattern match both upper and lower
507 * case letters in the subject.
509 * @see struct rte_regexdev_info::rule_flags
510 * @see struct rte_regexdev_rule::rule_flags
513 #define RTE_REGEX_PCRE_RULE_DOTALL_F (1ULL << 3)
514 /**< When this flag is set, a dot metacharacter in the pattern matches any
515 * character, including one that indicates a newline.
517 * @see struct rte_regexdev_info::rule_flags
518 * @see struct rte_regexdev_rule::rule_flags
521 #define RTE_REGEX_PCRE_RULE_DUPNAMES_F (1ULL << 4)
522 /**< When this flag is set, names used to identify capture groups need not be
525 * @see struct rte_regexdev_info::rule_flags
526 * @see struct rte_regexdev_rule::rule_flags
529 #define RTE_REGEX_PCRE_RULE_EXTENDED_F (1ULL << 5)
530 /**< When this flag is set, most white space characters in the pattern are
531 * totally ignored except when escaped or inside a character class.
533 * @see struct rte_regexdev_info::rule_flags
534 * @see struct rte_regexdev_rule::rule_flags
537 #define RTE_REGEX_PCRE_RULE_MATCH_UNSET_BACKREF_F (1ULL << 6)
538 /**< When this flag is set, a backreference to an unset capture group matches an
541 * @see struct rte_regexdev_info::rule_flags
542 * @see struct rte_regexdev_rule::rule_flags
545 #define RTE_REGEX_PCRE_RULE_MULTILINE_F (1ULL << 7)
546 /**< When this flag is set, the `^` and `$` constructs match immediately
547 * following or immediately before internal newlines in the subject string,
548 * respectively, as well as at the very start and end.
550 * @see struct rte_regexdev_info::rule_flags
551 * @see struct rte_regexdev_rule::rule_flags
554 #define RTE_REGEX_PCRE_RULE_NO_AUTO_CAPTURE_F (1ULL << 8)
555 /**< When this Flag is set, it disables the use of numbered capturing
556 * parentheses in the pattern. References to capture groups (backreferences or
557 * recursion/subroutine calls) may only refer to named groups, though the
558 * reference can be by name or by number.
560 * @see struct rte_regexdev_info::rule_flags
561 * @see struct rte_regexdev_rule::rule_flags
564 #define RTE_REGEX_PCRE_RULE_UCP_F (1ULL << 9)
565 /**< By default, only ASCII characters are recognized, When this flag is set,
566 * Unicode properties are used instead to classify characters.
568 * @see struct rte_regexdev_info::rule_flags
569 * @see struct rte_regexdev_rule::rule_flags
572 #define RTE_REGEX_PCRE_RULE_UNGREEDY_F (1ULL << 10)
573 /**< When this flag is set, the "greediness" of the quantifiers is inverted
574 * so that they are not greedy by default, but become greedy if followed by
577 * @see struct rte_regexdev_info::rule_flags
578 * @see struct rte_regexdev_rule::rule_flags
581 #define RTE_REGEX_PCRE_RULE_UTF_F (1ULL << 11)
582 /**< When this flag is set, RegEx engine has to regard both the pattern and the
583 * subject strings that are subsequently processed as strings of UTF characters
584 * instead of single-code-unit strings.
586 * @see struct rte_regexdev_info::rule_flags
587 * @see struct rte_regexdev_rule::rule_flags
590 #define RTE_REGEX_PCRE_RULE_NEVER_BACKSLASH_C_F (1ULL << 12)
591 /**< This flag locks out the use of `\C` in the pattern that is being compiled.
592 * This escape matches one data unit, even in UTF mode which can cause
593 * unpredictable behavior in UTF-8 or UTF-16 modes, because it may leave the
594 * current matching point in the mi:set hlsearchddle of a multi-code-unit
597 * @see struct rte_regexdev_info::rule_flags
598 * @see struct rte_regexdev_rule::rule_flags
602 * RegEx device information
604 struct rte_regexdev_info {
605 const char *driver_name; /**< RegEx driver name. */
606 struct rte_device *dev; /**< Device information. */
607 uint16_t max_matches;
608 /**< Maximum matches per scan supported by this device. */
609 uint16_t max_queue_pairs;
610 /**< Maximum queue pairs supported by this device. */
611 uint16_t max_payload_size;
612 /**< Maximum payload size for a pattern match request or scan.
613 * @see RTE_REGEXDEV_CFG_CROSS_BUFFER_SCAN_F
615 uint32_t max_rules_per_group;
616 /**< Maximum rules supported per group by this device. */
618 /**< Maximum groups supported by this device. */
619 uint32_t regexdev_capa;
620 /**< RegEx device capabilities. @see RTE_REGEXDEV_CAPA_* */
622 /**< Supported compiler rule flags.
623 * @see RTE_REGEX_PCRE_RULE_*, struct rte_regexdev_rule::rule_flags
629 * @b EXPERIMENTAL: this API may change without prior notice.
631 * Retrieve the contextual information of a RegEx device.
634 * The identifier of the device.
636 * @param[out] dev_info
637 * A pointer to a structure of type *rte_regexdev_info* to be filled with the
638 * contextual information of the device.
641 * - 0: Success, driver updates the contextual information of the RegEx device
642 * - <0: Error code returned by the driver info get function.
646 rte_regexdev_info_get(uint8_t dev_id, struct rte_regexdev_info *dev_info);
648 /* Enumerates RegEx device configuration flags */
649 #define RTE_REGEXDEV_CFG_CROSS_BUFFER_SCAN_F (1ULL << 0)
650 /**< Cross buffer scan refers to the ability to be able to detect
651 * matches that occur across buffer boundaries, where the buffers are related
652 * to each other in some way. Enable this flag when to scan payload size
653 * greater than struct rte_regexdev_info::max_payload_size and/or
654 * matches can present across scan buffer boundaries.
656 * @see struct rte_regexdev_info::max_payload_size
657 * @see struct rte_regexdev_config::dev_cfg_flags, rte_regexdev_configure()
658 * @see RTE_REGEX_OPS_RSP_PMI_SOJ_F
659 * @see RTE_REGEX_OPS_RSP_PMI_EOJ_F
662 #define RTE_REGEXDEV_CFG_MATCH_AS_END_F (1ULL << 1)
663 /**< Match as end is the ability to return the result as ending offset.
664 * When this flag is set, the result for each match will hold the ending
665 * offset of the match in end_offset.
666 * If this flag is not set, then the match result will hold the starting offset
667 * in start_offset, and the length of the match in len.
669 * @see RTE_REGEXDEV_SUPP_MATCH_AS_END_F
672 #define RTE_REGEXDEV_CFG_MATCH_ALL_F (1ULL << 2)
673 /**< Match all is the ability to return all possible results.
675 * @see RTE_REGEXDEV_SUPP_MATCH_ALL_F
678 /** RegEx device configuration structure */
679 struct rte_regexdev_config {
680 uint16_t nb_max_matches;
681 /**< Maximum matches per scan configured on this device.
682 * This value cannot exceed the *max_matches*
683 * which previously provided in rte_regexdev_info_get().
684 * The value 0 is allowed, in which case, value 1 used.
685 * @see struct rte_regexdev_info::max_matches
687 uint16_t nb_queue_pairs;
688 /**< Number of RegEx queue pairs to configure on this device.
689 * This value cannot exceed the *max_queue_pairs* which previously
690 * provided in rte_regexdev_info_get().
691 * @see struct rte_regexdev_info::max_queue_pairs
693 uint32_t nb_rules_per_group;
694 /**< Number of rules per group to configure on this device.
695 * This value cannot exceed the *max_rules_per_group*
696 * which previously provided in rte_regexdev_info_get().
697 * The value 0 is allowed, in which case,
698 * struct rte_regexdev_info::max_rules_per_group used.
699 * @see struct rte_regexdev_info::max_rules_per_group
702 /**< Number of groups to configure on this device.
703 * This value cannot exceed the *max_groups*
704 * which previously provided in rte_regexdev_info_get().
705 * @see struct rte_regexdev_info::max_groups
708 /**< Import initial set of prebuilt rule database on this device.
709 * The value NULL is allowed, in which case, the device will not
710 * be configured prebuilt rule database. Application may use
711 * rte_regexdev_rule_db_update() or rte_regexdev_rule_db_import() API
712 * to update or import rule database after the
713 * rte_regexdev_configure().
714 * @see rte_regexdev_rule_db_update(), rte_regexdev_rule_db_import()
716 uint32_t rule_db_len;
717 /**< Length of *rule_db* buffer. */
718 uint32_t dev_cfg_flags;
719 /**< RegEx device configuration flags, See RTE_REGEXDEV_CFG_* */
724 * @b EXPERIMENTAL: this API may change without prior notice.
726 * Configure a RegEx device.
728 * This function must be invoked first before any other function in the
729 * API. This function can also be re-invoked when a device is in the
732 * The caller may use rte_regexdev_info_get() to get the capability of each
733 * resources available for this regex device.
736 * The identifier of the device to configure.
738 * The RegEx device configuration structure.
741 * - 0: Success, device configured. Otherwise negative errno is returned.
745 rte_regexdev_configure(uint8_t dev_id, const struct rte_regexdev_config *cfg);
747 /* Enumerates RegEx queue pair configuration flags */
748 #define RTE_REGEX_QUEUE_PAIR_CFG_OOS_F (1ULL << 0)
749 /**< Out of order scan, If not set, a scan must retire after previously issued
750 * in-order scans to this queue pair. If set, this scan can be retired as soon
751 * as device returns completion. Application should not set out of order scan
752 * flag if it needs to maintain the ingress order of scan request.
754 * @see struct rte_regexdev_qp_conf::qp_conf_flags
755 * @see rte_regexdev_queue_pair_setup()
758 struct rte_regex_ops;
759 typedef void (*regexdev_stop_flush_t)(uint8_t dev_id, uint16_t qp_id,
760 struct rte_regex_ops *op);
761 /**< Callback function called during rte_regexdev_stop(), invoked once per
765 /** RegEx queue pair configuration structure */
766 struct rte_regexdev_qp_conf {
767 uint32_t qp_conf_flags;
768 /**< Queue pair config flags, See RTE_REGEX_QUEUE_PAIR_CFG_* */
770 /**< The number of descriptors to allocate for this queue pair. */
771 regexdev_stop_flush_t cb;
772 /**< Callback function called during rte_regexdev_stop(), invoked
773 * once per flushed regex op. Value NULL is allowed, in which case
774 * callback will not be invoked. This function can be used to properly
775 * dispose of outstanding regex ops from response queue,
776 * for example ops containing memory pointers.
777 * @see rte_regexdev_stop()
783 * @b EXPERIMENTAL: this API may change without prior notice.
785 * Allocate and set up a RegEx queue pair for a RegEx device.
788 * The identifier of the device.
789 * @param queue_pair_id
790 * The index of the RegEx queue pair to setup. The value must be in the range
791 * [0, nb_queue_pairs - 1] previously supplied to rte_regexdev_configure().
793 * The pointer to the configuration data to be used for the RegEx queue pair.
794 * NULL value is allowed, in which case default configuration used.
797 * 0 on success. Otherwise negative errno is returned.
801 rte_regexdev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
802 const struct rte_regexdev_qp_conf *qp_conf);
806 * @b EXPERIMENTAL: this API may change without prior notice.
808 * Start a RegEx device.
810 * The device start step is the last one and consists of setting the RegEx
811 * queues to start accepting the pattern matching scan requests.
813 * On success, all basic functions exported by the API (RegEx enqueue,
814 * RegEx dequeue and so on) can be invoked.
817 * RegEx device identifier.
820 * 0 on success. Otherwise negative errno is returned.
824 rte_regexdev_start(uint8_t dev_id);
828 * @b EXPERIMENTAL: this API may change without prior notice.
830 * Stop a RegEx device.
832 * Stop a RegEx device. The device can be restarted with a call to
833 * rte_regexdev_start().
835 * This function causes all queued response regex ops to be drained in the
836 * response queue. While draining ops out of the device,
837 * struct rte_regexdev_qp_conf::cb will be invoked for each ops.
840 * RegEx device identifier.
843 * 0 on success. Otherwise negative errno is returned.
847 rte_regexdev_stop(uint8_t dev_id);
851 * @b EXPERIMENTAL: this API may change without prior notice.
853 * Close a RegEx device. The device cannot be restarted!
856 * RegEx device identifier
859 * 0 on success. Otherwise negative errno is returned.
863 rte_regexdev_close(uint8_t dev_id);
865 /* Device get/set attributes */
867 /** Enumerates RegEx device attribute identifier */
868 enum rte_regexdev_attr_id {
869 RTE_REGEXDEV_ATTR_SOCKET_ID,
870 /**< The NUMA socket id to which the device is connected or
871 * a default of zero if the socket could not be determined.
875 RTE_REGEXDEV_ATTR_MAX_MATCHES,
876 /**< Maximum number of matches per scan.
877 * datatype: *uint8_t*
878 * operation: *get* and *set*
879 * @see RTE_REGEX_OPS_RSP_MAX_MATCH_F
881 RTE_REGEXDEV_ATTR_MAX_SCAN_TIMEOUT,
882 /**< Upper bound scan time in ns.
883 * datatype: *uint16_t*
884 * operation: *get* and *set*
885 * @see RTE_REGEX_OPS_RSP_MAX_SCAN_TIMEOUT_F
887 RTE_REGEXDEV_ATTR_MAX_PREFIX,
888 /**< Maximum number of prefix detected per scan.
889 * This would be useful for denial of service detection.
890 * datatype: *uint16_t*
891 * operation: *get* and *set*
892 * @see RTE_REGEX_OPS_RSP_MAX_PREFIX_F
898 * @b EXPERIMENTAL: this API may change without prior notice.
900 * Get an attribute from a RegEx device.
903 * RegEx device identifier.
905 * The attribute ID to retrieve.
907 * A pointer that will be filled in with the attribute
908 * value if successful.
911 * - 0: Successfully retrieved attribute value.
912 * - -EINVAL: Invalid device or *attr_id* provided, or *attr_value* is NULL.
913 * - -ENOTSUP: if the device doesn't support specific *attr_id*.
917 rte_regexdev_attr_get(uint8_t dev_id, enum rte_regexdev_attr_id attr_id,
922 * @b EXPERIMENTAL: this API may change without prior notice.
924 * Set an attribute to a RegEx device.
927 * RegEx device identifier.
929 * The attribute ID to retrieve.
931 * Pointer that will be filled in with the attribute value
932 * by the application.
935 * - 0: Successfully applied the attribute value.
936 * - -EINVAL: Invalid device or *attr_id* provided, or *attr_value* is NULL.
937 * - -ENOTSUP: if the device doesn't support specific *attr_id*.
941 rte_regexdev_attr_set(uint8_t dev_id, enum rte_regexdev_attr_id attr_id,
942 const void *attr_value);
944 /* Rule related APIs */
945 /** Enumerates RegEx rule operation. */
946 enum rte_regexdev_rule_op {
947 RTE_REGEX_RULE_OP_ADD,
948 /**< Add RegEx rule to rule database. */
949 RTE_REGEX_RULE_OP_REMOVE
950 /**< Remove RegEx rule from rule database. */
953 /** Structure to hold a RegEx rule attributes. */
954 struct rte_regexdev_rule {
955 enum rte_regexdev_rule_op op;
956 /**< OP type of the rule either a OP_ADD or OP_DELETE. */
958 /**< Group identifier to which the rule belongs to. */
960 /**< Rule identifier which is returned on successful match. */
961 const char *pcre_rule;
962 /**< Buffer to hold the PCRE rule. */
963 uint16_t pcre_rule_len;
964 /**< Length of the PCRE rule. */
966 /* PCRE rule flags. Supported device specific PCRE rules enumerated
967 * in struct rte_regexdev_info::rule_flags. For successful rule
968 * database update, application needs to provide only supported
970 * @See RTE_REGEX_PCRE_RULE_*, struct rte_regexdev_info::rule_flags
976 * @b EXPERIMENTAL: this API may change without prior notice.
978 * Update the local rule set.
979 * This functions only modify the rule set in memory.
980 * In order for the changes to take effect, the function
981 * rte_regexdev_rule_db_compile_active must be called.
984 * RegEx device identifier.
986 * Points to an array of *nb_rules* objects of type *rte_regexdev_rule*
987 * structure which contain the regex rules attributes to be updated
990 * The number of PCRE rules to update the rule database.
993 * The number of regex rules actually updated on the regex device's rule
994 * database. The return value can be less than the value of the *nb_rules*
995 * parameter when the regex devices fails to update the rule database or
996 * if invalid parameters are specified in a *rte_regexdev_rule*.
997 * If the return value is less than *nb_rules*, the remaining PCRE rules
998 * at the end of *rules* are not consumed and the caller has to take
999 * care of them and rte_errno is set accordingly.
1000 * Possible errno values include:
1001 * - -EINVAL: Invalid device ID or rules is NULL
1002 * - -ENOTSUP: The last processed rule is not supported on this device.
1003 * - -ENOSPC: No space available in rule database.
1005 * @see rte_regexdev_rule_db_import(), rte_regexdev_rule_db_export(),
1006 * rte_regexdev_rule_db_compile_activate()
1010 rte_regexdev_rule_db_update(uint8_t dev_id,
1011 const struct rte_regexdev_rule *rules,
1016 * @b EXPERIMENTAL: this API may change without prior notice.
1018 * Compile local rule set and burn the complied result to the
1022 * RegEx device identifier.
1025 * 0 on success, otherwise negative errno.
1027 * @see rte_regexdev_rule_db_import(), rte_regexdev_rule_db_export(),
1028 * rte_regexdev_rule_db_update()
1032 rte_regexdev_rule_db_compile_activate(uint8_t dev_id);
1036 * @b EXPERIMENTAL: this API may change without prior notice.
1038 * Import a prebuilt rule database from a buffer to a RegEx device.
1041 * RegEx device identifier.
1043 * Points to prebuilt rule database.
1044 * @param rule_db_len
1045 * Length of the rule database.
1048 * - 0: Successfully updated the prebuilt rule database.
1049 * - -EINVAL: Invalid device ID or rule_db is NULL
1050 * - -ENOTSUP: Rule database import is not supported on this device.
1051 * - -ENOSPC: No space available in rule database.
1053 * @see rte_regexdev_rule_db_update(), rte_regexdev_rule_db_export()
1057 rte_regexdev_rule_db_import(uint8_t dev_id, const char *rule_db,
1058 uint32_t rule_db_len);
1062 * @b EXPERIMENTAL: this API may change without prior notice.
1064 * Export the prebuilt rule database from a RegEx device to the buffer.
1067 * RegEx device identifier.
1068 * @param[out] rule_db
1069 * Block of memory to insert the rule database. Must be at least size in
1070 * capacity. If set to NULL, function returns required capacity.
1073 * - 0: Successfully exported the prebuilt rule database.
1074 * - size: If rule_db set to NULL then required capacity for *rule_db*
1075 * - -EINVAL: Invalid device ID
1076 * - -ENOTSUP: Rule database export is not supported on this device.
1078 * @see rte_regexdev_rule_db_update(), rte_regexdev_rule_db_import()
1082 rte_regexdev_rule_db_export(uint8_t dev_id, char *rule_db);
1084 /* Extended statistics */
1085 /** Maximum name length for extended statistics counters */
1086 #define RTE_REGEXDEV_XSTATS_NAME_SIZE 64
1089 * A name-key lookup element for extended statistics.
1091 * This structure is used to map between names and ID numbers
1092 * for extended RegEx device statistics.
1094 struct rte_regexdev_xstats_map {
1096 /**< xstat identifier */
1097 char name[RTE_REGEXDEV_XSTATS_NAME_SIZE];
1103 * @b EXPERIMENTAL: this API may change without prior notice.
1105 * Retrieve names of extended statistics of a regex device.
1108 * The identifier of the regex device.
1109 * @param[out] xstats_map
1110 * Block of memory to insert id and names into. Must be at least size in
1111 * capacity. If set to NULL, function returns required capacity.
1113 * - Positive value on success:
1114 * -The return value is the number of entries filled in the stats map.
1115 * -If xstats_map set to NULL then required capacity for xstats_map.
1116 * - Negative value on error:
1117 * -ENODEV for invalid *dev_id*
1118 * -ENOTSUP if the device doesn't support this function.
1122 rte_regexdev_xstats_names_get(uint8_t dev_id,
1123 struct rte_regexdev_xstats_map *xstats_map);
1127 * @b EXPERIMENTAL: this API may change without prior notice.
1129 * Retrieve extended statistics of an regex device.
1132 * The identifier of the device.
1134 * The id numbers of the stats to get. The ids can be got from the stat
1135 * position in the stat list from rte_regexdev_xstats_names_get(), or
1136 * by using rte_regexdev_xstats_by_name_get().
1138 * The values for each stats request by ID.
1140 * The number of stats requested.
1142 * - Positive value: number of stat entries filled into the values array
1143 * - Negative value on error:
1144 * -ENODEV for invalid *dev_id*
1145 * -ENOTSUP if the device doesn't support this function.
1149 rte_regexdev_xstats_get(uint8_t dev_id, const uint16_t *ids,
1150 uint64_t *values, uint16_t nb_values);
1154 * @b EXPERIMENTAL: this API may change without prior notice.
1156 * Retrieve the value of a single stat by requesting it by name.
1159 * The identifier of the device.
1161 * The stat name to retrieve.
1163 * If non-NULL, the numerical id of the stat will be returned, so that further
1164 * requests for the stat can be got using rte_regexdev_xstats_get, which will
1165 * be faster as it doesn't need to scan a list of names for the stat.
1167 * Must be non-NULL, retrieved xstat value will be stored in this address.
1170 * - 0: Successfully retrieved xstat value.
1171 * - -EINVAL: invalid parameters
1172 * - -ENOTSUP: if not supported.
1176 rte_regexdev_xstats_by_name_get(uint8_t dev_id, const char *name,
1177 uint16_t *id, uint64_t *value);
1181 * @b EXPERIMENTAL: this API may change without prior notice.
1183 * Reset the values of the xstats of the selected component in the device.
1186 * The identifier of the device.
1188 * Selects specific statistics to be reset. When NULL, all statistics will be
1189 * reset. If non-NULL, must point to array of at least *nb_ids* size.
1191 * The number of ids available from the *ids* array. Ignored when ids is NULL.
1194 * - 0: Successfully reset the statistics to zero.
1195 * - -EINVAL: invalid parameters.
1196 * - -ENOTSUP: if not supported.
1200 rte_regexdev_xstats_reset(uint8_t dev_id, const uint16_t *ids,
1205 * @b EXPERIMENTAL: this API may change without prior notice.
1207 * Trigger the RegEx device self test.
1210 * The identifier of the device.
1212 * - 0: Selftest successful.
1213 * - -ENOTSUP if the device doesn't support selftest.
1214 * - other values < 0 on failure.
1218 rte_regexdev_selftest(uint8_t dev_id);
1222 * @b EXPERIMENTAL: this API may change without prior notice.
1224 * Dump internal information about *dev_id* to the FILE* provided in *f*.
1227 * The identifier of the device.
1229 * A pointer to a file for output.
1232 * 0 on success, negative errno on failure.
1236 rte_regexdev_dump(uint8_t dev_id, FILE *f);
1238 /* Fast path APIs */
1241 * The generic *rte_regexdev_match* structure to hold the RegEx match
1243 * @see struct rte_regex_ops::matches
1245 struct rte_regexdev_match {
1250 uint32_t rule_id:20;
1251 /**< Rule identifier to which the pattern matched.
1252 * @see struct rte_regexdev_rule::rule_id
1254 uint32_t group_id:12;
1255 /**< Group identifier of the rule which the pattern
1256 * matched. @see struct rte_regexdev_rule::group_id
1258 uint16_t start_offset;
1259 /**< Starting Byte Position for matched rule. */
1263 /**< Length of match in bytes */
1264 uint16_t end_offset;
1265 /**< The end offset of the match. In case
1266 * MATCH_AS_END configuration is enabled.
1267 * @see RTE_REGEXDEV_CFG_MATCH_AS_END
1274 /* Enumerates RegEx request flags. */
1275 #define RTE_REGEX_OPS_REQ_GROUP_ID0_VALID_F (1 << 0)
1276 /**< Set when struct rte_regexdev_rule::group_id0 is valid. */
1278 #define RTE_REGEX_OPS_REQ_GROUP_ID1_VALID_F (1 << 1)
1279 /**< Set when struct rte_regexdev_rule::group_id1 is valid. */
1281 #define RTE_REGEX_OPS_REQ_GROUP_ID2_VALID_F (1 << 2)
1282 /**< Set when struct rte_regexdev_rule::group_id2 is valid. */
1284 #define RTE_REGEX_OPS_REQ_GROUP_ID3_VALID_F (1 << 3)
1285 /**< Set when struct rte_regexdev_rule::group_id3 is valid. */
1287 #define RTE_REGEX_OPS_REQ_STOP_ON_MATCH_F (1 << 4)
1288 /**< The RegEx engine will stop scanning and return the first match. */
1290 #define RTE_REGEX_OPS_REQ_MATCH_HIGH_PRIORITY_F (1 << 5)
1291 /**< In High Priority mode a maximum of one match will be returned per scan to
1292 * reduce the post-processing required by the application. The match with the
1293 * lowest Rule id, lowest start pointer and lowest match length will be
1296 * @see struct rte_regex_ops::nb_actual_matches
1297 * @see struct rte_regex_ops::nb_matches
1301 /* Enumerates RegEx response flags. */
1302 #define RTE_REGEX_OPS_RSP_PMI_SOJ_F (1 << 0)
1303 /**< Indicates that the RegEx device has encountered a partial match at the
1304 * start of scan in the given buffer.
1306 * @see RTE_REGEXDEV_CFG_CROSS_BUFFER_SCAN_F
1309 #define RTE_REGEX_OPS_RSP_PMI_EOJ_F (1 << 1)
1310 /**< Indicates that the RegEx device has encountered a partial match at the
1311 * end of scan in the given buffer.
1313 * @see RTE_REGEXDEV_CFG_CROSS_BUFFER_SCAN_F
1316 #define RTE_REGEX_OPS_RSP_MAX_SCAN_TIMEOUT_F (1 << 2)
1317 /**< Indicates that the RegEx device has exceeded the max timeout while
1318 * scanning the given buffer.
1320 * @see RTE_REGEXDEV_ATTR_MAX_SCAN_TIMEOUT
1323 #define RTE_REGEX_OPS_RSP_MAX_MATCH_F (1 << 3)
1324 /**< Indicates that the RegEx device has exceeded the max matches while
1325 * scanning the given buffer.
1327 * @see RTE_REGEXDEV_ATTR_MAX_MATCHES
1330 #define RTE_REGEX_OPS_RSP_MAX_PREFIX_F (1 << 4)
1331 /**< Indicates that the RegEx device has reached the max allowed prefix length
1332 * while scanning the given buffer.
1334 * @see RTE_REGEXDEV_ATTR_MAX_PREFIX
1337 #define RTE_REGEX_OPS_RSP_RESOURCE_LIMIT_REACHED_F (1 << 4)
1338 /**< Indicates that the RegEx device has reached the max allowed resource
1339 * allowed while scanning the given buffer.
1343 * The generic *rte_regex_ops* structure to hold the RegEx attributes
1344 * for enqueue and dequeue operation.
1346 struct rte_regex_ops {
1349 /**< Request flags for the RegEx ops.
1350 * @see RTE_REGEX_OPS_REQ_*
1353 /**< Response flags for the RegEx ops.
1354 * @see RTE_REGEX_OPS_RSP_*
1356 uint16_t nb_actual_matches;
1357 /**< The total number of actual matches detected by the Regex device.*/
1358 uint16_t nb_matches;
1359 /**< The total number of matches returned by the RegEx device for this
1360 * scan. The size of *rte_regex_ops::matches* zero length array will be
1363 * @see struct rte_regex_ops::matches, struct rte_regexdev_match
1367 struct rte_mbuf *mbuf; /**< source mbuf, to search in. */
1371 /**< First group_id to match the rule against. At minimum one group
1372 * should be valid. Behaviour is undefined non of the groups are valid.
1374 * @see RTE_REGEX_OPS_REQ_GROUP_ID0_VALID_F
1377 /**< Second group_id to match the rule against.
1379 * @see RTE_REGEX_OPS_REQ_GROUP_ID1_VALID_F
1382 /**< Third group_id to match the rule against.
1384 * @see RTE_REGEX_OPS_REQ_GROUP_ID2_VALID_F
1387 /**< Forth group_id to match the rule against.
1389 * @see RTE_REGEX_OPS_REQ_GROUP_ID3_VALID_F
1396 /**< Application specific opaque value. An application may use
1397 * this field to hold application specific value to share
1398 * between dequeue and enqueue operation.
1399 * Implementation should not modify this field.
1402 /**< Pointer representation of *user_id* */
1408 uint64_t cross_buf_id;
1409 /**< ID used by the RegEx device in order to support cross
1411 * This ID is returned from the RegEx device on the dequeue
1412 * function. The application must send it back when calling
1413 * enqueue with the following packet.
1415 void *cross_buf_ptr;
1416 /**< Pointer representation of *corss_buf_id* */
1420 struct rte_regexdev_match matches[];
1421 /**< Zero length array to hold the match tuples.
1422 * The struct rte_regex_ops::nb_matches value holds the number of
1423 * elements in this array.
1425 * @see struct rte_regex_ops::nb_matches
1429 #include "rte_regexdev_core.h"
1433 * @b EXPERIMENTAL: this API may change without prior notice.
1435 * Enqueue a burst of scan request on a RegEx device.
1437 * The rte_regexdev_enqueue_burst() function is invoked to place
1438 * regex operations on the queue *qp_id* of the device designated by
1441 * The *nb_ops* parameter is the number of operations to process which are
1442 * supplied in the *ops* array of *rte_regexdev_op* structures.
1444 * The rte_regexdev_enqueue_burst() function returns the number of
1445 * operations it actually enqueued for processing. A return value equal to
1446 * *nb_ops* means that all packets have been enqueued.
1449 * The identifier of the device.
1451 * The index of the queue pair which packets are to be enqueued for
1452 * processing. The value must be in the range [0, nb_queue_pairs - 1]
1453 * previously supplied to rte_regexdev_configure().
1455 * The address of an array of *nb_ops* pointers to *rte_regexdev_op*
1456 * structures which contain the regex operations to be processed.
1458 * The number of operations to process.
1461 * The number of operations actually enqueued on the regex device. The return
1462 * value can be less than the value of the *nb_ops* parameter when the
1463 * regex devices queue is full or if invalid parameters are specified in
1464 * a *rte_regexdev_op*. If the return value is less than *nb_ops*, the
1465 * remaining ops at the end of *ops* are not consumed and the caller has
1466 * to take care of them.
1469 static inline uint16_t
1470 rte_regexdev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
1471 struct rte_regex_ops **ops, uint16_t nb_ops)
1473 struct rte_regexdev *dev = &rte_regex_devices[dev_id];
1474 #ifdef RTE_LIBRTE_REGEXDEV_DEBUG
1475 RTE_REGEXDEV_VALID_DEV_ID_OR_ERR_RET(dev_id, -EINVAL);
1476 RTE_FUNC_PTR_OR_ERR_RET(*dev->enqueue, -ENOTSUP);
1477 if (qp_id >= dev->data->dev_conf.nb_queue_pairs) {
1478 RTE_REGEXDEV_LOG(ERR, "Invalid queue %d\n", qp_id);
1482 return (*dev->enqueue)(dev, qp_id, ops, nb_ops);
1487 * @b EXPERIMENTAL: this API may change without prior notice.
1489 * Dequeue a burst of scan response from a queue on the RegEx device.
1490 * The dequeued operation are stored in *rte_regexdev_op* structures
1491 * whose pointers are supplied in the *ops* array.
1493 * The rte_regexdev_dequeue_burst() function returns the number of ops
1494 * actually dequeued, which is the number of *rte_regexdev_op* data structures
1495 * effectively supplied into the *ops* array.
1497 * A return value equal to *nb_ops* indicates that the queue contained
1498 * at least *nb_ops* operations, and this is likely to signify that other
1499 * processed operations remain in the devices output queue. Applications
1500 * implementing a "retrieve as many processed operations as possible" policy
1501 * can check this specific case and keep invoking the
1502 * rte_regexdev_dequeue_burst() function until a value less than
1503 * *nb_ops* is returned.
1505 * The rte_regexdev_dequeue_burst() function does not provide any error
1506 * notification to avoid the corresponding overhead.
1509 * The RegEx device identifier
1511 * The index of the queue pair from which to retrieve processed packets.
1512 * The value must be in the range [0, nb_queue_pairs - 1] previously
1513 * supplied to rte_regexdev_configure().
1515 * The address of an array of pointers to *rte_regexdev_op* structures
1516 * that must be large enough to store *nb_ops* pointers in it.
1518 * The maximum number of operations to dequeue.
1521 * The number of operations actually dequeued, which is the number
1522 * of pointers to *rte_regexdev_op* structures effectively supplied to the
1523 * *ops* array. If the return value is less than *nb_ops*, the remaining
1524 * ops at the end of *ops* are not consumed and the caller has to take care
1528 static inline uint16_t
1529 rte_regexdev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
1530 struct rte_regex_ops **ops, uint16_t nb_ops)
1532 struct rte_regexdev *dev = &rte_regex_devices[dev_id];
1533 #ifdef RTE_LIBRTE_REGEXDEV_DEBUG
1534 RTE_REGEXDEV_VALID_DEV_ID_OR_ERR_RET(dev_id, -EINVAL);
1535 RTE_FUNC_PTR_OR_ERR_RET(*dev->dequeue, -ENOTSUP);
1536 if (qp_id >= dev->data->dev_conf.nb_queue_pairs) {
1537 RTE_REGEXDEV_LOG(ERR, "Invalid queue %d\n", qp_id);
1541 return (*dev->dequeue)(dev, qp_id, ops, nb_ops);
1548 #endif /* _RTE_REGEXDEV_H_ */