release/src/router/pcre/doc/pcre_jit_stack_alloc.3

   1 .TH PCRE_JIT_STACK_ALLOC 3 "24 June 2012" "PCRE 8.30"
   2 .SH NAME
   3 PCRE - Perl-compatible regular expressions
   4 .SH SYNOPSIS
   5 .rs
   6 .sp
   7 .B #include <pcre.h>
   8 .PP
   9 .SM
  10 .B pcre_jit_stack *pcre_jit_stack_alloc(int \fIstartsize\fP,
  11 .ti +5n
  12 .B int \fImaxsize\fP);
  13 .PP
  14 .B pcre16_jit_stack *pcre16_jit_stack_alloc(int \fIstartsize\fP,
  15 .ti +5n
  16 .B int \fImaxsize\fP);
  17 .PP
  18 .B pcre32_jit_stack *pcre32_jit_stack_alloc(int \fIstartsize\fP,
  19 .ti +5n
  20 .B int \fImaxsize\fP);
  21 .
  22 .SH DESCRIPTION
  23 .rs
  24 .sp
  25 This function is used to create a stack for use by the code compiled by the JIT
  26 optimization of \fBpcre[16|32]_study()\fP. The arguments are a starting size for
  27 the stack, and a maximum size to which it is allowed to grow. The result can be
  28 passed to the JIT run-time code by \fBpcre[16|32]_assign_jit_stack()\fP, or that
  29 function can set up a callback for obtaining a stack. A maximum stack size of
  30 512K to 1M should be more than enough for any pattern. For more details, see
  31 the
  32 .\" HREF
  33 \fBpcrejit\fP
  34 .\"
  35 page.
  36 .P
  37 There is a complete description of the PCRE native API in the
  38 .\" HREF
  39 \fBpcreapi\fP
  40 .\"
  41 page and a description of the POSIX API in the
  42 .\" HREF
  43 \fBpcreposix\fP
  44 .\"
  45 page.