1/*
2 * Copyright (c) 2015-2016, Intel Corporation
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * * Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Intel Corporation nor the names of its contributors
13 * may be used to endorse or promote products derived from this software
14 * without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef MCCLELLAN_H
30#define MCCLELLAN_H
31
32#include "callback.h"
33#include "ue2common.h"
34
35struct mq;
36struct NFA;
37
38// 8-bit McClellan
39
40char nfaExecMcClellan8_testEOD(const struct NFA *nfa, const char *state,
41 const char *streamState, u64a offset,
42 NfaCallback callback, void *context);
43char nfaExecMcClellan8_Q(const struct NFA *n, struct mq *q, s64a end);
44char nfaExecMcClellan8_Q2(const struct NFA *n, struct mq *q, s64a end);
45char nfaExecMcClellan8_QR(const struct NFA *n, struct mq *q, ReportID report);
46char nfaExecMcClellan8_reportCurrent(const struct NFA *n, struct mq *q);
47char nfaExecMcClellan8_inAccept(const struct NFA *n, ReportID report,
48 struct mq *q);
49char nfaExecMcClellan8_inAnyAccept(const struct NFA *n, struct mq *q);
50char nfaExecMcClellan8_queueInitState(const struct NFA *n, struct mq *q);
51char nfaExecMcClellan8_initCompressedState(const struct NFA *n, u64a offset,
52 void *state, u8 key);
53char nfaExecMcClellan8_queueCompressState(const struct NFA *nfa,
54 const struct mq *q, s64a loc);
55char nfaExecMcClellan8_expandState(const struct NFA *nfa, void *dest,
56 const void *src, u64a offset, u8 key);
57
58#define nfaExecMcClellan8_B_Reverse NFA_API_NO_IMPL
59#define nfaExecMcClellan8_zombie_status NFA_API_ZOMBIE_NO_IMPL
60
61// 16-bit McClellan
62
63char nfaExecMcClellan16_testEOD(const struct NFA *nfa, const char *state,
64 const char *streamState, u64a offset,
65 NfaCallback callback, void *context);
66char nfaExecMcClellan16_Q(const struct NFA *n, struct mq *q, s64a end);
67char nfaExecMcClellan16_Q2(const struct NFA *n, struct mq *q, s64a end);
68char nfaExecMcClellan16_QR(const struct NFA *n, struct mq *q, ReportID report);
69char nfaExecMcClellan16_reportCurrent(const struct NFA *n, struct mq *q);
70char nfaExecMcClellan16_inAccept(const struct NFA *n, ReportID report,
71 struct mq *q);
72char nfaExecMcClellan16_inAnyAccept(const struct NFA *n, struct mq *q);
73char nfaExecMcClellan16_queueInitState(const struct NFA *n, struct mq *q);
74char nfaExecMcClellan16_initCompressedState(const struct NFA *n, u64a offset,
75 void *state, u8 key);
76char nfaExecMcClellan16_queueCompressState(const struct NFA *nfa,
77 const struct mq *q, s64a loc);
78char nfaExecMcClellan16_expandState(const struct NFA *nfa, void *dest,
79 const void *src, u64a offset, u8 key);
80
81#define nfaExecMcClellan16_B_Reverse NFA_API_NO_IMPL
82#define nfaExecMcClellan16_zombie_status NFA_API_ZOMBIE_NO_IMPL
83
84/**
85 * Simple streaming mode calls:
86 * - always uses the anchored start state regardless if top is set regardless of
87 * start_off
88 * - never checks eod
89 */
90void nfaExecMcClellan8_SimpStream(const struct NFA *nfa, char *state,
91 const u8 *buf, char top, size_t start_off,
92 size_t len, NfaCallback cb, void *ctxt);
93
94void nfaExecMcClellan16_SimpStream(const struct NFA *nfa, char *state,
95 const u8 *buf, char top, size_t start_off,
96 size_t len, NfaCallback cb, void *ctxt);
97
98/**
99 * Simple block mode calls:
100 * - always uses the anchored start state regardless of initial start
101 */
102
103char nfaExecMcClellan8_B(const struct NFA *n, u64a offset, const u8 *buffer,
104 size_t length, NfaCallback cb, void *context);
105
106char nfaExecMcClellan16_B(const struct NFA *n, u64a offset, const u8 *buffer,
107 size_t length, NfaCallback cb, void *context);
108
109#endif
110