[PATCH] Use Boyer-Moore-Horspool for simple LIKE contains patterns

Started by Atsushi Ogawa11 days ago3 messageshackers
Jump to latest
#1Atsushi Ogawa
atsushi.ogawa001@gmail.com

Hi,

This patch adds a Boyer-Moore-Horspool (BMH) fast path for simple LIKE
'%literal%' contains-search patterns.

Motivation
col LIKE '%literal%' is a common query shape. The existing matcher scans
the input one position at a time, which is O(text * pattern) in the worst
case. For medium-to-long search literals, a Boyer-Moore-Horspool search
skips ahead using a 256-entry bad-character table and is substantially
faster in practice, while staying simple and allocation-light.

What the patch does
The dispatch happens at execution time, inside the existing textlike and
namelike entry points. On the first call for a given FmgrInfo, the code
inspects the (escape-normalized) pattern; if it is eligible it builds and
caches a small BMH search state in FmgrInfo.fn_extra and uses it for every
subsequent row. If the pattern is not eligible, it caches a "generic"
marker so that later rows go straight to the existing matcher with no
re-analysis. Scalar-array operator calls (LIKE ANY / LIKE ALL) also stay on
the generic path because the pattern can change between array elements
under one FmgrInfo.

Because dispatch stays inside the existing textlike and namelike functions,
planner behavior and index-path selection, including pg_trgm, are unchanged.

The BMH path is used only when:

the pattern is stable for the current execution (constant, or a
query-stable parameter as reported by get_fn_expr_arg_stable())
the pattern starts and ends with %
the middle part contains no unescaped % or _
the unescaped literal is at least four bytes
the database encoding is single-byte or UTF-8
the collation is deterministic
Correctness and eligibility
Because BMH is a byte-oriented search, it is restricted to single-byte and
UTF-8 encodings, where a byte match cannot land in the middle of a
character. Other multibyte encodings stay on the existing generic matcher;
for those the code records the "generic" marker before doing any pattern
analysis, so the existing matcher implementation itself is unchanged.

Nondeterministic collations also stay on the existing path, since equality
there is not a byte comparison (canonical equivalence, expansions such as
ß/ss, etc.).

The four-byte minimum is a conservative, measurement-derived choice. A
prototype that enabled BMH for three-byte literals was roughly 7.7% slower
than the generic matcher in that case.

Testing
Regression tests cover eligible and fallback patterns, escaped wildcards,
varying patterns, scalar-array operations, NULLs, name, prepared
statements, and deterministic and nondeterministic ICU collations.

Tested against PostgreSQL HEAD 5594f20 Simplify truncate_query_log()
callers. The patch passes the core regression tests, contrib/pg_trgm, and
the full Meson test suite. A differential test covering 84 patterns, 10,000
input strings, and both text and name produced identical results before and
after the patch.

Benchmarks
Environment: Oracle Linux 8 (Linux 5.4 aarch64, Neoverse-N1),
GCC 8.5.0, built with CFLAGS="-O2 -g" --without-readline --without-zlib.

All tables report averages over seven runs. Both execution orders were
measured: normal means baseline then patched, and swapped means patched then
baseline.

1M-row synthetic contains search, 50 loops per run:

literal order baseline ms patched ms change
------- ------ ----------- ---------- ------
4 normal 13040.802 10517.101 -19.4%
4 swapped 12996.720 10541.411 -18.9%
8 normal 12574.798 6801.678 -45.9%
8 swapped 12586.869 6787.560 -46.1%
12 normal 12627.778 5787.701 -54.2%
12 swapped 12549.117 5749.858 -54.2%
16 normal 12684.681 5425.017 -57.2%
16 swapped 12615.273 5414.224 -57.1%

pg_attribute.attname contains search, 50,000 loops per run:

pattern order path baseline ms patched ms change
-------- ------- ---------------- ----------- ---------- ------
%class% normal BMH 17098.160 13102.455 -23.4%
%class% swapped BMH 17146.756 13157.733 -23.3%
%cla_s% normal generic fallback 17218.321 17419.863 +1.17%
%cla_s% swapped generic fallback 17137.538 17317.907 +1.05%

Non-UTF-8 multibyte fallback (EUC), 1M rows, 20 loops per run,
inner-wildcard miss:

type encoding order baseline ms patched ms change
---- -------- ------- ----------- ---------- ------
text EUC_JP normal 12061.780 12111.844 +0.42%
text EUC_JP swapped 12053.521 12071.416 +0.15%
text EUC_KR normal 12508.889 12652.742 +1.15%
text EUC_KR swapped 12481.675 12610.906 +1.04%
name EUC_JP normal 5631.629 5693.626 +1.10%
name EUC_JP swapped 5586.379 5634.642 +0.86%
name EUC_KR normal 5811.589 5851.628 +0.69%
name EUC_KR swapped 5806.066 5836.244 +0.52%
Callgrind measured a small fallback cost: executed instructions increased
by 0.184% on aarch64 and 0.248% on x86-64. The wall-clock benchmarks above
showed fallback differences of at most 1.17%.

To keep the initial patch focused, it handles ordinary LIKE only; ILIKE and
NOT LIKE are unchanged.

Regards,
Atsushi Ogawa

Attachments:

Use-Boyer-Moore-Horspool-for-simple-LIKE-patterns.patchapplication/octet-stream; name=Use-Boyer-Moore-Horspool-for-simple-LIKE-patterns.patchDownload+643-2
#2Greg Sabino Mullane
greg@turnstep.com
In reply to: Atsushi Ogawa (#1)
Re: [PATCH] Use Boyer-Moore-Horspool for simple LIKE contains patterns

Great idea, love seeing the speedups! Also appreciate the background,
detailed explanation, and benchmarks. Quick code review:

git grep shows we already use BMH in src/backend/utils/adt/varlena.c
Worth acknowledging that in a code comment somewhere? I didn't see any
obvious advantage to refactoring things out at quick glance, but a mention
might be nice.

+ * by '%' wildcards. Remove backslash escapes while building the search

state.

Slightly off comment. This is for like_bmh_pattern_is_eligible - we are not
removing here, just skipping things when we count.

if (i + 1 >= plen - 1)

Worth a comment to explain that we are catching the '%foo\%' case here.

pattern_stable = get_fn_expr_arg_stable(flinfo, 1);

/*
* ScalarArrayOpExpr invokes the operator once per array element. The
* array expression can be stable while the pattern passed to this function
* changes between calls, so it must not use a cached search state.
*/
if (flinfo->fn_expr != NULL && IsA(flinfo->fn_expr, ScalarArrayOpExpr))
pattern_stable = false;

My first thought was to make this an if/else so we don't reclobber, but
seeing how later on we check collation every time, I'm wondering if we
shouldn't just check the pattern as well every time via a memcmp like
regexp.c does in RE_compile_and_cache (and remove that block above). So we
store it verbatim in the like_bmh_init() function with memcpy, then make
the check inside like_bmh_match() that looks like this:

unlikely(collation has changed)

into:

unlikely(
collation has changed
OR pattern length has changed
OR pattern itself has changed (e.g. memcmp true)
)

Also means you could then roll get_fn_expr_arg_stable into that big old ||
grouping, and remove pattern_stable entirely.

Hm...that collation test and message is already caught and done by
GenericMatchText, so you could throw !OidIsValid(collation) into that ||
group as well, and remove the ereport section entirely. It then falls
through later to GenericMatchText, which complains about the collation
there.

Anyway, the patch compiled cleanly against d15a6bc2 (Tue Jul 14 10:28:04
2026 +0200)

It did have one test failure:

@@ -151,8 +151,8 @@
p | matched
--------+---------
%abcd% | t
- %b%e% | f
%b_d% | t
+ %b%e% | f
%wxyz% | f
(4 rows)

I think it's from the "Row-varying patterns must use the generic matcher."
test.

Cheers,
Greg

#3Atsushi Ogawa
atsushi.ogawa001@gmail.com
In reply to: Greg Sabino Mullane (#2)
Re: [PATCH] Use Boyer-Moore-Horspool for simple LIKE contains patterns

Hi Greg,

Thanks for the careful review. I have attached a v2 patch.

git grep shows we already use BMH in src/backend/utils/adt/varlena.c
Worth acknowledging that in a code comment somewhere? I didn't see any
obvious advantage to refactoring things out at quick glance, but a mention
might be nice.

Agreed. I added a comment at the top of like_bmh.c that cross-references
the
existing Boyer-Moore-Horspool implementation in varlena.c and explains why I
kept the implementations separate. The varlena.c code searches one
(haystack, needle) pair with an adaptively sized skip table, whereas the
LIKE
path interprets its internal backslash escapes while extracting the literal
and caches the prepared search state in FmgrInfo for use across rows. I did
not find a clean way to share that machinery without introducing more
coupling
than seemed useful.

+ * by '%' wildcards.  Remove backslash escapes while building the search
+ * state.

Slightly off comment. This is for like_bmh_pattern_is_eligible - we are

not

removing here, just skipping things when we count.

Right. I reworded the comment to say that the eligibility check skips
backslash escapes while counting the literal length. The escapes are
removed
later, when the search state is built.

if (i + 1 >= plen - 1)

Worth a comment to explain that we are catching the '%foo\%' case here.

Added. The new comment explains that this rejects patterns such as
'%foo\%', where the backslash escapes the closing '%' rather than a literal
byte.

pattern_stable = get_fn_expr_arg_stable(flinfo, 1);

/*
* ScalarArrayOpExpr invokes the operator once per array element. The
* array expression can be stable while the pattern passed to this

function

* changes between calls, so it must not use a cached search state.
*/
if (flinfo->fn_expr != NULL && IsA(flinfo->fn_expr, ScalarArrayOpExpr))
pattern_stable = false;

My first thought was to make this an if/else so we don't reclobber, but
seeing how later on we check collation every time, I'm wondering if we
shouldn't just check the pattern as well every time via a memcmp like
regexp.c does in RE_compile_and_cache (and remove that block above).
So we store it verbatim in the like_bmh_init() function with memcpy, then
make the check inside like_bmh_match() that looks like this:

unlikely(collation has changed)

into:

unlikely(
collation has changed
OR pattern length has changed
OR pattern itself has changed (e.g. memcmp true)
)

Also means you could then roll get_fn_expr_arg_stable into that big old ||
grouping, and remove pattern_stable entirely.

I implemented the suggested verbatim-pattern cache and benchmarked it
directly
against the initial patch's structural-stability design. The test scanned
two
million rows per transaction, with a warmup followed by the median of seven
pgbench runs of 40 transactions each. The benchmark used an AMD EPYC 7763
host with 8 vCPUs, GCC 11.4.0, and an -O2 -g build, using a UTF-8 database
with C locale. The results below are median latency per scan:

case initial patch memcmp vs. initial
------------------------------------ ------------- -------- -----------
constant, 4-byte literal 63.7 ms 65.1 ms +2.3%
constant, 32-byte literal 48.8 ms 48.4 ms -0.8%
constant, 4-byte literal, 8-byte input 43.2 ms 44.0 ms +1.8%
non-constant, fixed value at runtime 92.9 ms 57.0 ms -38.6%
non-constant, changes on every row 91.6 ms 172.4 ms +88.2%

The per-row length check and memcmp were therefore not particularly
expensive
for stable constant patterns. The more important tradeoff involved
non-constant patterns. When the value remained fixed at runtime, the
verbatim
cache was faster because it could use BMH. When the pattern changed on
every
row, however, it was substantially slower than the initial patch, which
sends
that case to the existing generic matcher. The verbatim variant had to
repeat
the eligibility check and rebuild the 256-entry skip table for every row.

I then tested a hybrid of the two approaches. Patterns that
get_fn_expr_arg_stable() identifies as a Const or external Param keep the
existing comparison-free search state. An eligible non-stable pattern
stores
its verbatim bytes and is revalidated with a length check and memcmp. On
the
first mismatch, the state is changed permanently to the generic marker. The
mismatching row and all later rows use the existing matcher; the eligibility
check and skip-table build are never repeated.

ScalarArrayOpExpr still has to be classified as non-stable, since its array
expression can be a Const while the operator receives a different element on
each call. It now uses the same revalidation path and falls back
permanently
if the elements differ.

I reran the comparison on aarch64 using two clean build trees based on the
same source revision and configured with the same options. Both servers
used
the same data directory. The table contained two million 32-byte strings, a
fixed pattern column, and an alternating pattern column. Parallel query was
disabled, each server was warmed before measurement, and the server order
was
alternated in ABBA order. The figures below are medians of 16 EXPLAIN
(ANALYZE, TIMING OFF) runs:

case initial patch hybrid vs. initial
-------------------------------- ------------- -------- -----------
constant pattern 194.1 ms 185.6 ms -4.4%
non-constant, fixed at runtime 299.8 ms 199.9 ms -33.3%
non-constant, changes every row 303.4 ms 304.9 ms +0.5%
generic fallback control 288.5 ms 289.5 ms +0.3%

The constant-pattern difference appears to be a compiler-dependent
code-layout
effect rather than a benefit of the hybrid design, so I do not interpret it
as
a general speedup. More importantly, the runtime-fixed case captures the
benefit of the verbatim cache, while the row-varying case tracks the generic
fallback control instead of rebuilding the 256-entry skip table for every
row.

The attached v2 patch uses this hybrid design. Thus the common stable path
does not pay a memcmp, runtime-fixed non-constant values can use BMH, and a
pattern that is observed to vary falls back without any rebuild penalty.

Hm...that collation test and message is already caught and done by
GenericMatchText, so you could throw !OidIsValid(collation) into that ||
group as well, and remove the ereport section entirely. It then falls
through later to GenericMatchText, which complains about the collation
there.

Done. The invalid-collation case is now included in the rejection group and
falls through to GenericMatchText. I removed the duplicate ereport block
from
like_bmh.c.

It did have one test failure:

@@ -151,8 +151,8 @@
p | matched
--------+---------
%abcd% | t
- %b%e% | f
%b_d% | t
+ %b%e% | f
%wxyz% | f
(4 rows)

I think it's from the "Row-varying patterns must use the generic matcher."
test.

Thanks for catching this. This was a locale-dependent sort-order issue in
the
test, not a matcher failure. The query now uses ORDER BY p COLLATE "C".

I retested the revised patch against PostgreSQL HEAD 0348090: all 246 core
regression tests passed, including like_bmh, and all four contrib/pg_trgm
tests passed.

Thanks,
Atsushi Ogawa

2026年7月15日(水) 3:29 Greg Sabino Mullane <htamfids@gmail.com>:

Show quoted text

Great idea, love seeing the speedups! Also appreciate the background,
detailed explanation, and benchmarks. Quick code review:

git grep shows we already use BMH in src/backend/utils/adt/varlena.c
Worth acknowledging that in a code comment somewhere? I didn't see any
obvious advantage to refactoring things out at quick glance, but a mention
might be nice.

+ * by '%' wildcards. Remove backslash escapes while building the

search state.

Slightly off comment. This is for like_bmh_pattern_is_eligible - we are
not removing here, just skipping things when we count.

if (i + 1 >= plen - 1)

Worth a comment to explain that we are catching the '%foo\%' case here.

pattern_stable = get_fn_expr_arg_stable(flinfo, 1);

/*
* ScalarArrayOpExpr invokes the operator once per array element. The
* array expression can be stable while the pattern passed to this

function

* changes between calls, so it must not use a cached search state.
*/
if (flinfo->fn_expr != NULL && IsA(flinfo->fn_expr, ScalarArrayOpExpr))
pattern_stable = false;

My first thought was to make this an if/else so we don't reclobber, but
seeing how later on we check collation every time, I'm wondering if we
shouldn't just check the pattern as well every time via a memcmp like
regexp.c does in RE_compile_and_cache (and remove that block above). So we
store it verbatim in the like_bmh_init() function with memcpy, then make
the check inside like_bmh_match() that looks like this:

unlikely(collation has changed)

into:

unlikely(
collation has changed
OR pattern length has changed
OR pattern itself has changed (e.g. memcmp true)
)

Also means you could then roll get_fn_expr_arg_stable into that big old ||
grouping, and remove pattern_stable entirely.

Hm...that collation test and message is already caught and done by
GenericMatchText, so you could throw !OidIsValid(collation) into that ||
group as well, and remove the ereport section entirely. It then falls
through later to GenericMatchText, which complains about the collation
there.

Anyway, the patch compiled cleanly against d15a6bc2 (Tue Jul 14 10:28:04
2026 +0200)

It did have one test failure:

@@ -151,8 +151,8 @@
p | matched
--------+---------
%abcd% | t
- %b%e% | f
%b_d% | t
+ %b%e% | f
%wxyz% | f
(4 rows)

I think it's from the "Row-varying patterns must use the generic matcher."
test.

Cheers,
Greg

Attachments:

v2-0001-Use-Boyer-Moore-Horspool-for-simple-LIKE-patterns.patchapplication/octet-stream; name=v2-0001-Use-Boyer-Moore-Horspool-for-simple-LIKE-patterns.patchDownload+721-2