pcre2_jit_stack_assign man page

Return to the PCRE2 index page.

This page is part of the PCRE2 HTML documentation. It was generated automatically from the original man page. If there is any nonsense in it, please consult the man page, in case the conversion went wrong.

SYNOPSIS

#include <pcre2.h>

void pcre2_jit_stack_assign(const pcre2_code *code, pcre2_jit_callback callback_function, void *callback_data);

This function provides control over the memory used as a stack at run-time by a call to pcre2_match() or pcre2_jit_match() with a pattern that has been successfully processed by the JIT compiler. The arguments are:

  code           the pointer returned by pcre2_compile()
  callback       a callback function
  callback_data  a JIT stack or a value to be passed to the callback

If callback is NULL and callback_data is NULL, an internal 32K block on the machine stack is used.

If callback is NULL and callback_data is not NULL, callback_data must be a valid JIT stack, the result of calling pcre2_jit_stack_alloc().

If callback not NULL, it is called with callback_data as an argument at the start of matching, in order to set up a JIT stack. If the result is NULL, the internal 32K stack is used; otherwise the return value must be a valid JIT stack, the result of calling pcre2_jit_stack_alloc().

You may safely assign the same JIT stack to multiple patterns, as long as they are all matched in the same thread. In a multithread application, each thread must use its own JIT stack. For more details, see the pcre2jit page.

There is a complete description of the PCRE2 native API in the pcre2api page and a description of the POSIX API in the pcre2posix page.

Return to the PCRE2 index page.