1 /*************************************************
2 * Perl-Compatible Regular Expressions *
3 *************************************************/
4
5 /* PCRE is a library of functions to support regular expressions whose syntax
6 and semantics are as close as possible to those of the Perl 5 language.
7
8 Written by Philip Hazel
9 Original API code Copyright (c) 1997-2012 University of Cambridge
10 New API code Copyright (c) 2016 University of Cambridge
11
12 -----------------------------------------------------------------------------
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15
16 * Redistributions of source code must retain the above copyright notice,
17 this list of conditions and the following disclaimer.
18
19 * Redistributions in binary form must reproduce the above copyright
20 notice, this list of conditions and the following disclaimer in the
21 documentation and/or other materials provided with the distribution.
22
23 * Neither the name of the University of Cambridge nor the names of its
24 contributors may be used to endorse or promote products derived from
25 this software without specific prior written permission.
26
27 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 POSSIBILITY OF SUCH DAMAGE.
38 -----------------------------------------------------------------------------
39 */
40
41 /* This module contains functions for serializing and deserializing
42 a sequence of compiled codes. */
43
44
45 #ifdef HAVE_CONFIG_H
46 #include "config.h"
47 #endif
48
49
50 #include "pcre2_internal.h"
51
52 /* Magic number to provide a small check against being handed junk. */
53
54 #define SERIALIZED_DATA_MAGIC 0x50523253u
55
56 /* Deserialization is limited to the current PCRE version and
57 character width. */
58
59 #define SERIALIZED_DATA_VERSION \
60 ((PCRE2_MAJOR) | ((PCRE2_MINOR) << 16))
61
62 #define SERIALIZED_DATA_CONFIG \
63 (sizeof(PCRE2_UCHAR) | ((sizeof(void*)) << 8) | ((sizeof(PCRE2_SIZE)) << 16))
64
65
66
67 /*************************************************
68 * Serialize compiled patterns *
69 *************************************************/
70
71 PCRE2_EXP_DEFN int32_t PCRE2_CALL_CONVENTION
pcre2_serialize_encode(const pcre2_code ** codes,int32_t number_of_codes,uint8_t ** serialized_bytes,PCRE2_SIZE * serialized_size,pcre2_general_context * gcontext)72 pcre2_serialize_encode(const pcre2_code **codes, int32_t number_of_codes,
73 uint8_t **serialized_bytes, PCRE2_SIZE *serialized_size,
74 pcre2_general_context *gcontext)
75 {
76 uint8_t *bytes;
77 uint8_t *dst_bytes;
78 int32_t i;
79 PCRE2_SIZE total_size;
80 const pcre2_real_code *re;
81 const uint8_t *tables;
82 pcre2_serialized_data *data;
83
84 const pcre2_memctl *memctl = (gcontext != NULL) ?
85 &gcontext->memctl : &PRIV(default_compile_context).memctl;
86
87 if (codes == NULL || serialized_bytes == NULL || serialized_size == NULL)
88 return PCRE2_ERROR_NULL;
89
90 if (number_of_codes <= 0) return PCRE2_ERROR_BADDATA;
91
92 /* Compute total size. */
93 total_size = sizeof(pcre2_serialized_data) + tables_length;
94 tables = NULL;
95
96 for (i = 0; i < number_of_codes; i++)
97 {
98 if (codes[i] == NULL) return PCRE2_ERROR_NULL;
99 re = (const pcre2_real_code *)(codes[i]);
100 if (re->magic_number != MAGIC_NUMBER) return PCRE2_ERROR_BADMAGIC;
101 if (tables == NULL)
102 tables = re->tables;
103 else if (tables != re->tables)
104 return PCRE2_ERROR_MIXEDTABLES;
105 total_size += re->blocksize;
106 }
107
108 /* Initialize the byte stream. */
109 bytes = memctl->malloc(total_size + sizeof(pcre2_memctl), memctl->memory_data);
110 if (bytes == NULL) return PCRE2_ERROR_NOMEMORY;
111
112 /* The controller is stored as a hidden parameter. */
113 memcpy(bytes, memctl, sizeof(pcre2_memctl));
114 bytes += sizeof(pcre2_memctl);
115
116 data = (pcre2_serialized_data *)bytes;
117 data->magic = SERIALIZED_DATA_MAGIC;
118 data->version = SERIALIZED_DATA_VERSION;
119 data->config = SERIALIZED_DATA_CONFIG;
120 data->number_of_codes = number_of_codes;
121
122 /* Copy all compiled code data. */
123 dst_bytes = bytes + sizeof(pcre2_serialized_data);
124 memcpy(dst_bytes, tables, tables_length);
125 dst_bytes += tables_length;
126
127 for (i = 0; i < number_of_codes; i++)
128 {
129 re = (const pcre2_real_code *)(codes[i]);
130 memcpy(dst_bytes, (char *)re, re->blocksize);
131 dst_bytes += re->blocksize;
132 }
133
134 *serialized_bytes = bytes;
135 *serialized_size = total_size;
136 return number_of_codes;
137 }
138
139
140 /*************************************************
141 * Deserialize compiled patterns *
142 *************************************************/
143
144 PCRE2_EXP_DEFN int32_t PCRE2_CALL_CONVENTION
pcre2_serialize_decode(pcre2_code ** codes,int32_t number_of_codes,const uint8_t * bytes,pcre2_general_context * gcontext)145 pcre2_serialize_decode(pcre2_code **codes, int32_t number_of_codes,
146 const uint8_t *bytes, pcre2_general_context *gcontext)
147 {
148 const pcre2_serialized_data *data = (const pcre2_serialized_data *)bytes;
149 const pcre2_memctl *memctl = (gcontext != NULL) ?
150 &gcontext->memctl : &PRIV(default_compile_context).memctl;
151
152 const uint8_t *src_bytes;
153 pcre2_real_code *dst_re;
154 uint8_t *tables;
155 int32_t i, j;
156
157 /* Sanity checks. */
158
159 if (data == NULL || codes == NULL) return PCRE2_ERROR_NULL;
160 if (number_of_codes <= 0) return PCRE2_ERROR_BADDATA;
161 if (data->number_of_codes <= 0) return PCRE2_ERROR_BADSERIALIZEDDATA;
162 if (data->magic != SERIALIZED_DATA_MAGIC) return PCRE2_ERROR_BADMAGIC;
163 if (data->version != SERIALIZED_DATA_VERSION) return PCRE2_ERROR_BADMODE;
164 if (data->config != SERIALIZED_DATA_CONFIG) return PCRE2_ERROR_BADMODE;
165
166 if (number_of_codes > data->number_of_codes)
167 number_of_codes = data->number_of_codes;
168
169 src_bytes = bytes + sizeof(pcre2_serialized_data);
170
171 /* Decode tables. The reference count for the tables is stored immediately
172 following them. */
173
174 tables = memctl->malloc(tables_length + sizeof(PCRE2_SIZE), memctl->memory_data);
175 if (tables == NULL) return PCRE2_ERROR_NOMEMORY;
176
177 memcpy(tables, src_bytes, tables_length);
178 *(PCRE2_SIZE *)(tables + tables_length) = number_of_codes;
179 src_bytes += tables_length;
180
181 /* Decode the byte stream. We must not try to read the size from the compiled
182 code block in the stream, because it might be unaligned, which causes errors on
183 hardware such as Sparc-64 that doesn't like unaligned memory accesses. The type
184 of the blocksize field is given its own name to ensure that it is the same here
185 as in the block. */
186
187 for (i = 0; i < number_of_codes; i++)
188 {
189 CODE_BLOCKSIZE_TYPE blocksize;
190 memcpy(&blocksize, src_bytes + offsetof(pcre2_real_code, blocksize),
191 sizeof(CODE_BLOCKSIZE_TYPE));
192 if (blocksize <= sizeof(pcre2_real_code))
193 return PCRE2_ERROR_BADSERIALIZEDDATA;
194
195 /* The allocator provided by gcontext replaces the original one. */
196
197 dst_re = (pcre2_real_code *)PRIV(memctl_malloc)(blocksize,
198 (pcre2_memctl *)gcontext);
199 if (dst_re == NULL)
200 {
201 memctl->free(tables, memctl->memory_data);
202 for (j = 0; j < i; j++)
203 {
204 memctl->free(codes[j], memctl->memory_data);
205 codes[j] = NULL;
206 }
207 return PCRE2_ERROR_NOMEMORY;
208 }
209
210 /* The new allocator must be preserved. */
211
212 memcpy(((uint8_t *)dst_re) + sizeof(pcre2_memctl),
213 src_bytes + sizeof(pcre2_memctl), blocksize - sizeof(pcre2_memctl));
214 if (dst_re->magic_number != MAGIC_NUMBER ||
215 dst_re->name_entry_size > MAX_NAME_SIZE + IMM2_SIZE + 1 ||
216 dst_re->name_count > MAX_NAME_COUNT)
217 return PCRE2_ERROR_BADSERIALIZEDDATA;
218
219 /* At the moment only one table is supported. */
220
221 dst_re->tables = tables;
222 dst_re->executable_jit = NULL;
223 dst_re->flags |= PCRE2_DEREF_TABLES;
224
225 codes[i] = dst_re;
226 src_bytes += blocksize;
227 }
228
229 return number_of_codes;
230 }
231
232
233 /*************************************************
234 * Get the number of serialized patterns *
235 *************************************************/
236
237 PCRE2_EXP_DEFN int32_t PCRE2_CALL_CONVENTION
pcre2_serialize_get_number_of_codes(const uint8_t * bytes)238 pcre2_serialize_get_number_of_codes(const uint8_t *bytes)
239 {
240 const pcre2_serialized_data *data = (const pcre2_serialized_data *)bytes;
241
242 if (data == NULL) return PCRE2_ERROR_NULL;
243 if (data->magic != SERIALIZED_DATA_MAGIC) return PCRE2_ERROR_BADMAGIC;
244 if (data->version != SERIALIZED_DATA_VERSION) return PCRE2_ERROR_BADMODE;
245 if (data->config != SERIALIZED_DATA_CONFIG) return PCRE2_ERROR_BADMODE;
246
247 return data->number_of_codes;
248 }
249
250
251 /*************************************************
252 * Free the allocated stream *
253 *************************************************/
254
255 PCRE2_EXP_DEFN void PCRE2_CALL_CONVENTION
pcre2_serialize_free(uint8_t * bytes)256 pcre2_serialize_free(uint8_t *bytes)
257 {
258 if (bytes != NULL)
259 {
260 pcre2_memctl *memctl = (pcre2_memctl *)(bytes - sizeof(pcre2_memctl));
261 memctl->free(memctl, memctl->memory_data);
262 }
263 }
264
265 /* End of pcre2_serialize.c */
266