3 EFI_REGULAR_EXPRESSION_PROTOCOL Implementation
5 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
11 #include "RegularExpressionDxe.h"
14 EFI_REGEX_SYNTAX_TYPE
* CONST mSupportedSyntaxes
[] = {
15 &gEfiRegexSyntaxTypePosixExtendedGuid
,
16 &gEfiRegexSyntaxTypePerlGuid
20 EFI_REGULAR_EXPRESSION_PROTOCOL mProtocolInstance
= {
21 RegularExpressionMatch
,
22 RegularExpressionGetInfo
27 #define CHAR16_ENCODING ONIG_ENCODING_UTF16_LE
30 Call the Oniguruma regex match API.
32 Same parameters as RegularExpressionMatch, except SyntaxType is required.
34 @param String A pointer to a NULL terminated string to match against the
35 regular expression string specified by Pattern.
37 @param Pattern A pointer to a NULL terminated string that represents the
39 @param SyntaxType A pointer to the EFI_REGEX_SYNTAX_TYPE that identifies the
40 regular expression syntax type to use. May be NULL in which
41 case the function will use its default regular expression
44 @param Result On return, points to TRUE if String fully matches against
45 the regular expression Pattern using the regular expression
46 SyntaxType. Otherwise, points to FALSE.
48 @param Captures A Pointer to an array of EFI_REGEX_CAPTURE objects to receive
49 the captured groups in the event of a match. The full
50 sub-string match is put in Captures[0], and the results of N
51 capturing groups are put in Captures[1:N]. If Captures is
52 NULL, then this function doesn't allocate the memory for the
53 array and does not build up the elements. It only returns the
54 number of matching patterns in CapturesCount. If Captures is
55 not NULL, this function returns a pointer to an array and
56 builds up the elements in the array. CapturesCount is also
57 updated to the number of matching patterns found. It is the
58 caller's responsibility to free the memory pool in Captures
59 and in each CapturePtr in the array elements.
61 @param CapturesCount On output, CapturesCount is the number of matching patterns
62 found in String. Zero means no matching patterns were found
65 @retval EFI_SUCCESS Regex compilation and match completed successfully.
66 @retval EFI_DEVICE_ERROR Regex compilation failed.
74 IN EFI_REGEX_SYNTAX_TYPE
*SyntaxType
,
76 OUT EFI_REGEX_CAPTURE
**Captures
, OPTIONAL
77 OUT UINTN
*CapturesCount
81 OnigSyntaxType
*OnigSyntax
;
84 OnigErrorInfo ErrorInfo
;
85 OnigUChar ErrorMessage
[ONIG_MAX_ERROR_MESSAGE_LEN
];
94 // Detemine the internal syntax type
96 OnigSyntax
= ONIG_SYNTAX_DEFAULT
;
97 if (CompareGuid (SyntaxType
, &gEfiRegexSyntaxTypePosixExtendedGuid
)) {
98 OnigSyntax
= ONIG_SYNTAX_POSIX_EXTENDED
;
99 } else if (CompareGuid (SyntaxType
, &gEfiRegexSyntaxTypePerlGuid
)) {
100 OnigSyntax
= ONIG_SYNTAX_PERL
;
102 DEBUG ((DEBUG_ERROR
, "Unsupported regex syntax - using default\n"));
103 return EFI_UNSUPPORTED
;
109 Start
= (OnigUChar
*)Pattern
;
110 OnigResult
= onig_new (
113 Start
+ onigenc_str_bytelen_null (CHAR16_ENCODING
, Start
),
120 if (OnigResult
!= ONIG_NORMAL
) {
121 onig_error_code_to_str (ErrorMessage
, OnigResult
, &ErrorInfo
);
122 DEBUG ((DEBUG_ERROR
, "Regex compilation failed: %a\n", ErrorMessage
));
123 return EFI_DEVICE_ERROR
;
129 Start
= (OnigUChar
*)String
;
130 Region
= onig_region_new ();
131 if (Region
== NULL
) {
132 onig_free (OnigRegex
);
133 return EFI_OUT_OF_RESOURCES
;
135 OnigResult
= onig_search (
138 Start
+ onigenc_str_bytelen_null (CHAR16_ENCODING
, Start
),
140 Start
+ onigenc_str_bytelen_null (CHAR16_ENCODING
, Start
),
145 if (OnigResult
>= 0) {
149 if (OnigResult
!= ONIG_MISMATCH
) {
150 onig_error_code_to_str (ErrorMessage
, OnigResult
);
151 DEBUG ((DEBUG_ERROR
, "Regex match failed: %a\n", ErrorMessage
));
152 onig_region_free (Region
, 1);
153 onig_free (OnigRegex
);
154 return EFI_DEVICE_ERROR
;
159 // If successful, copy out the region (capture) information
161 if (*Result
&& Captures
!= NULL
) {
162 *CapturesCount
= Region
->num_regs
;
163 *Captures
= AllocateZeroPool (*CapturesCount
* sizeof(**Captures
));
164 if (*Captures
!= NULL
) {
165 for (Index
= 0; Index
< *CapturesCount
; ++Index
) {
167 // Region beg/end values represent bytes, not characters
169 (*Captures
)[Index
].Length
= (Region
->end
[Index
] - Region
->beg
[Index
]) / sizeof(CHAR16
);
170 (*Captures
)[Index
].CapturePtr
= AllocateCopyPool (
171 ((*Captures
)[Index
].Length
) * sizeof (CHAR16
),
172 (CHAR16
*)((UINTN
)String
+ Region
->beg
[Index
])
174 if ((*Captures
)[Index
].CapturePtr
== NULL
) {
175 Status
= EFI_OUT_OF_RESOURCES
;
180 if (EFI_ERROR (Status
)) {
181 for (Index
= 0; Index
< *CapturesCount
; ++Index
) {
182 if ((*Captures
)[Index
].CapturePtr
!= NULL
) {
183 FreePool ((CHAR16
*)(*Captures
)[Index
].CapturePtr
);
186 FreePool (*Captures
);
191 onig_region_free (Region
, 1);
192 onig_free (OnigRegex
);
198 Returns information about the regular expression syntax types supported
199 by the implementation.
201 @param This A pointer to the EFI_REGULAR_EXPRESSION_PROTOCOL
204 @param RegExSyntaxTypeListSize On input, the size in bytes of RegExSyntaxTypeList.
205 On output with a return code of EFI_SUCCESS, the
206 size in bytes of the data returned in
207 RegExSyntaxTypeList. On output with a return code
208 of EFI_BUFFER_TOO_SMALL, the size of
209 RegExSyntaxTypeList required to obtain the list.
211 @param RegExSyntaxTypeList A caller-allocated memory buffer filled by the
212 driver with one EFI_REGEX_SYNTAX_TYPE element
213 for each supported Regular expression syntax
214 type. The list must not change across multiple
215 calls to the same driver. The first syntax
216 type in the list is the default type for the
219 @retval EFI_SUCCESS The regular expression syntax types list
220 was returned successfully.
221 @retval EFI_UNSUPPORTED The service is not supported by this driver.
222 @retval EFI_DEVICE_ERROR The list of syntax types could not be
223 retrieved due to a hardware or firmware error.
224 @retval EFI_BUFFER_TOO_SMALL The buffer RegExSyntaxTypeList is too small
226 @retval EFI_INVALID_PARAMETER RegExSyntaxTypeListSize is NULL
231 RegularExpressionGetInfo (
232 IN EFI_REGULAR_EXPRESSION_PROTOCOL
*This
,
233 IN OUT UINTN
*RegExSyntaxTypeListSize
,
234 OUT EFI_REGEX_SYNTAX_TYPE
*RegExSyntaxTypeList
240 if (This
== NULL
|| RegExSyntaxTypeListSize
== NULL
) {
241 return EFI_INVALID_PARAMETER
;
244 if (*RegExSyntaxTypeListSize
!= 0 && RegExSyntaxTypeList
== NULL
) {
245 return EFI_INVALID_PARAMETER
;
248 SyntaxSize
= ARRAY_SIZE (mSupportedSyntaxes
) * sizeof(**mSupportedSyntaxes
);
250 if (*RegExSyntaxTypeListSize
< SyntaxSize
) {
251 *RegExSyntaxTypeListSize
= SyntaxSize
;
252 return EFI_BUFFER_TOO_SMALL
;
255 for (Index
= 0; Index
< ARRAY_SIZE (mSupportedSyntaxes
); ++Index
) {
256 CopyMem (&RegExSyntaxTypeList
[Index
], mSupportedSyntaxes
[Index
], sizeof(**mSupportedSyntaxes
));
258 *RegExSyntaxTypeListSize
= SyntaxSize
;
264 Checks if the input string matches to the regular expression pattern.
266 @param This A pointer to the EFI_REGULAR_EXPRESSION_PROTOCOL instance.
267 Type EFI_REGULAR_EXPRESSION_PROTOCOL is defined in Section
270 @param String A pointer to a NULL terminated string to match against the
271 regular expression string specified by Pattern.
273 @param Pattern A pointer to a NULL terminated string that represents the
276 @param SyntaxType A pointer to the EFI_REGEX_SYNTAX_TYPE that identifies the
277 regular expression syntax type to use. May be NULL in which
278 case the function will use its default regular expression
281 @param Result On return, points to TRUE if String fully matches against
282 the regular expression Pattern using the regular expression
283 SyntaxType. Otherwise, points to FALSE.
285 @param Captures A Pointer to an array of EFI_REGEX_CAPTURE objects to receive
286 the captured groups in the event of a match. The full
287 sub-string match is put in Captures[0], and the results of N
288 capturing groups are put in Captures[1:N]. If Captures is
289 NULL, then this function doesn't allocate the memory for the
290 array and does not build up the elements. It only returns the
291 number of matching patterns in CapturesCount. If Captures is
292 not NULL, this function returns a pointer to an array and
293 builds up the elements in the array. CapturesCount is also
294 updated to the number of matching patterns found. It is the
295 caller's responsibility to free the memory pool in Captures
296 and in each CapturePtr in the array elements.
298 @param CapturesCount On output, CapturesCount is the number of matching patterns
299 found in String. Zero means no matching patterns were found
302 @retval EFI_SUCCESS The regular expression string matching
303 completed successfully.
304 @retval EFI_UNSUPPORTED The regular expression syntax specified by
305 SyntaxType is not supported by this driver.
306 @retval EFI_DEVICE_ERROR The regular expression string matching
307 failed due to a hardware or firmware error.
308 @retval EFI_INVALID_PARAMETER String, Pattern, Result, or CapturesCountis
314 RegularExpressionMatch (
315 IN EFI_REGULAR_EXPRESSION_PROTOCOL
*This
,
318 IN EFI_REGEX_SYNTAX_TYPE
*SyntaxType
, OPTIONAL
320 OUT EFI_REGEX_CAPTURE
**Captures
, OPTIONAL
321 OUT UINTN
*CapturesCount
328 if (This
== NULL
|| String
== NULL
|| Pattern
== NULL
|| Result
== NULL
|| CapturesCount
== NULL
) {
329 return EFI_INVALID_PARAMETER
;
333 // Figure out which syntax to use
335 if (SyntaxType
== NULL
) {
336 SyntaxType
= mSupportedSyntaxes
[0];
339 for (Index
= 0; Index
< ARRAY_SIZE (mSupportedSyntaxes
); ++Index
) {
340 if (CompareGuid (SyntaxType
, mSupportedSyntaxes
[Index
])) {
346 return EFI_UNSUPPORTED
;
350 Status
= OnigurumaMatch (String
, Pattern
, SyntaxType
, Result
, Captures
, CapturesCount
);
356 Entry point for RegularExpressionDxe.
358 @param ImageHandle Image handle this driver.
359 @param SystemTable Pointer to SystemTable.
361 @retval Status Whether this function complete successfully.
366 RegularExpressionDxeEntry (
367 IN EFI_HANDLE ImageHandle
,
368 IN EFI_SYSTEM_TABLE
*SystemTable
373 Status
= gBS
->InstallMultipleProtocolInterfaces (
375 &gEfiRegularExpressionProtocolGuid
,