xref: /aosp_15_r20/external/pcre/doc/html/pcre2_jit_stack_create.html (revision 22dc650d8ae982c6770746019a6f94af92b0f024)
1<html>
2<head>
3<title>pcre2_jit_stack_create specification</title>
4</head>
5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6<h1>pcre2_jit_stack_create man page</h1>
7<p>
8Return to the <a href="index.html">PCRE2 index page</a>.
9</p>
10<p>
11This page is part of the PCRE2 HTML documentation. It was generated
12automatically from the original man page. If there is any nonsense in it,
13please consult the man page, in case the conversion went wrong.
14<br>
15<br><b>
16SYNOPSIS
17</b><br>
18<P>
19<b>#include &#60;pcre2.h&#62;</b>
20</P>
21<P>
22<b>pcre2_jit_stack *pcre2_jit_stack_create(size_t <i>startsize</i>,</b>
23<b>  size_t <i>maxsize</i>, pcre2_general_context *<i>gcontext</i>);</b>
24</P>
25<br><b>
26DESCRIPTION
27</b><br>
28<P>
29This function is used to create a stack for use by the code compiled by the JIT
30compiler. The first two arguments are a starting size for the stack, and a
31maximum size to which it is allowed to grow. The final argument is a general
32context, for memory allocation functions, or NULL for standard memory
33allocation. The result can be passed to the JIT run-time code by calling
34<b>pcre2_jit_stack_assign()</b> to associate the stack with a compiled pattern,
35which can then be processed by <b>pcre2_match()</b> or <b>pcre2_jit_match()</b>.
36A maximum stack size of 512KiB to 1MiB should be more than enough for any
37pattern. If the stack couldn't be allocated or the values passed were not
38reasonable, NULL will be returned. For more details, see the
39<a href="pcre2jit.html"><b>pcre2jit</b></a>
40page.
41</P>
42<P>
43There is a complete description of the PCRE2 native API in the
44<a href="pcre2api.html"><b>pcre2api</b></a>
45page and a description of the POSIX API in the
46<a href="pcre2posix.html"><b>pcre2posix</b></a>
47page.
48<p>
49Return to the <a href="index.html">PCRE2 index page</a>.
50</p>
51