Hyperscan 5.4 Developer’s Reference Guide

Feb 22, 2023

• Copyright
• Preface
  • Overview
  • Audience
  • Conventions
• Introduction
  • Compilation
  • Scanning
  • Tools
  • Example Code
• Getting Started
  • Very Quick Start
  • Requirements
• Compiling Patterns
  • Building a Database
  • Pattern Support
  • Semantics
  • Instruction Set Specialization
  • Approximate matching
  • Logical Combinations
• Scanning for Patterns
  • Handling Matches
  • Streaming Mode
  • Block Mode
  • Vectored Mode
  • Scratch Space
  • Custom Allocators
• Serialization
  • The Runtime Library
• Performance Considerations
  • Regular expression constructs
  • Library usage
  • Block-based matching
  • Unnecessary databases
  • Allocate scratch ahead of time
  • Allocate one scratch space per scanning context
  • Anchored patterns
  • Matching everywhere
  • Bounded repeats in streaming mode
  • Prefer literals
  • “Dot all” mode
  • Single-match flag
  • Start of Match flag
  • Approximate matching
• Tools
  • Quick Check: hscheck
  • Benchmarker: hsbench
  • Correctness Testing: hscollider
  • Debugging: hsdump
  • Pattern Format
• API Reference: Constants
  • Error Codes
  • hs_expr_ext flags
  • Pattern flags
  • CPU feature support flags
  • CPU tuning flags
  • Compile mode flags
• API Reference: Files
  • File: hs.h
  • File: hs_common.h
  • File: hs_compile.h
  • File: hs_runtime.h
• Chimera
  • Introduction
  • Requirements
  • Compiling Patterns
  • Scanning for Patterns
  • API Reference: Constants
  • API Reference: Files