forked from crazyxman/simdjson_php
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathphp_simdjson.h
235 lines (209 loc) · 9.86 KB
/
php_simdjson.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
/*
+----------------------------------------------------------------------+
| simdjson_php |
+----------------------------------------------------------------------+
| This source file is subject to version 2.0 of the Apache license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| http://www.apache.org/licenses/LICENSE-2.0.html |
+----------------------------------------------------------------------+
| Author: Jinxi Wang <[email protected]> |
+----------------------------------------------------------------------+
*/
#ifndef PHP_SIMDJSON_H
#define PHP_SIMDJSON_H
/*
* Error constant implementation notes:
*
* - 0 always means success, and non-0 is a failure condition.
* - Prefix these with SIMDJSON_PHP_ERR_ to distinguish them from other values.
* - The error codes (value or labels) belonging to the C simdjson project may change in the future.
*
* Maybe these should be exposed as extern const once there's a project that needs the other values.
* For now, they're also exposed as `REGISTER_LONG_CONSTANT("SIMDJSON_ERR_" #errcode, (val), CONST_PERSISTENT)`
*/
#define SIMDJSON_PHP_ERR_SUCCESS 0
#define SIMDJSON_PHP_ERR_INVALID_PHP_PROPERTY 255
#define SIMDJSON_PHP_ERR_KEY_COUNT_NOT_COUNTABLE 254
/*
* Put all of the publicly visible functionality and macros into the same header file
* (On windows, the include paths used by the c compiler may be different)
*/
#include "Zend/zend.h"
#include "Zend/zend_portability.h"
/*
* All code in this header file should be changed to go within BEGIN_EXTERN_C/END_EXTERN_C macros
* (both header definitions, and C++ declarations, including function implementations),
* so that pecls written in C can use this functionality without separate C++ files to load bindings.h.
*
* This header file deliberately does not depend on other header files in this project,
* to make including this header file easier for other PECLs (avoid include path issues)
*
* BEGIN_EXTERN_C is needed for symbols to be mangled using C rules instead of C++ rules in all includers.
* (This macro can be used from both C and C++ source files)
*/
BEGIN_EXTERN_C()
extern zend_module_entry simdjson_module_entry;
#define phpext_simdjson_ptr &simdjson_module_entry
#define PHP_SIMDJSON_VERSION "5.0.0dev"
/**
* PHP_SIMDJSON_VERSION_ID has the same format as PHP_VERSION_ID: Major version * 10000 + Minor version * 100 + Patch version.
* This is meant for use by PECL extensions that depend on simdjson.
* (e.g. 4.5.6dev and 4.5.6 would be 40506)
*/
#define PHP_SIMDJSON_VERSION_ID 50000
#define SIMDJSON_SUPPORT_URL "https://github.com/JakubOnderka/simdjson_php"
#define SIMDJSON_PARSE_DEFAULT_DEPTH 512
/**
* Number of strings in array of array or object keys that will be deduplicated
*/
#define SIMDJSON_DEDUP_STRING_COUNT 256
/**
* Maximum length of strings to be considered for deduplication.
* Longer strings are less likely to be duplicated and the memory overhead
* of storing them in the hash table might exceed the benefits.
*/
#define SIMDJSON_MAX_DEDUP_LENGTH 64
/**
* Configure simdjson library
*/
#define SIMDJSON_EXCEPTIONS 0
#ifdef ZEND_DEBUG
#define SIMDJSON_DEVELOPMENT_CHECKS 1 // enable development checks when using PHP debug build
#else
#define SIMDJSON_DEVELOPMENT_CHECKS 0
#endif
/*
* NOTE: Namespaces and references(&) are C++ only functionality.
* To expose this functionality to other C PECLs,
* switch to a forward struct declaration of a struct that only wraps simdjson::dom::parser
*/
struct simdjson_php_parser;
ZEND_BEGIN_MODULE_GLOBALS(simdjson)
/*
* php::simdjson::parser pointer, constructed on first use with request-scope lifetime.
* Note that in ZTS builds, the thread for each request will deliberately have different instances for each concurrently running request.
* (The simdjson library is not thread safe)
*
* This is similar to php-src's ext/session session data storage.
*/
struct simdjson_php_parser *parser;
ZEND_END_MODULE_GLOBALS(simdjson)
PHP_MINIT_FUNCTION(simdjson);
PHP_MSHUTDOWN_FUNCTION(simdjson);
PHP_RINIT_FUNCTION(simdjson);
PHP_RSHUTDOWN_FUNCTION(simdjson);
PHP_MINFO_FUNCTION(simdjson);
#ifdef ZTS
#ifdef COMPILE_DL_SIMDJSON
ZEND_TSRMLS_CACHE_EXTERN()
#endif
#endif
/* Only the functions and variables defined with PHP_SIMDJSON_API can be loaded by other PECLs */
#ifdef PHP_WIN32
# define PHP_SIMDJSON_API __declspec(dllexport)
#elif defined(__GNUC__) && __GNUC__ >= 4
# define PHP_SIMDJSON_API __attribute__ ((visibility("default")))
#else
# define PHP_SIMDJSON_API /* nothing special */
#endif
/** Defines 'class SimdJsonException' and 'class SimdJsonBase64Encode' */
extern PHP_SIMDJSON_API zend_class_entry *simdjson_decoder_exception_ce;
extern PHP_SIMDJSON_API zend_class_entry *simdjson_encoder_exception_ce;
extern PHP_SIMDJSON_API zend_class_entry *simdjson_base64_encode_ce;
extern zend_string *simdjson_json_serialize;
/**
* NOTE: Namespaces and references(&) and classes (instead of structs) are C++ only functionality.
*
* To expose this functionality to other C PECLs,
* switch to a forward class declaration of a class that only wraps simdjson::dom::parser
*/
typedef uint8_t simdjson_php_error_code;
/* NOTE: Callers should check if len is greater than 4GB - simdjson will always return a non zero error code for those */
/**
* Returns or creates the singleton parser used internally by simdjson (e.g. for the `php_simdjson_*_default()` methods).
* (Thread-local in ZTS builds of PHP)
*
* Callers must NOT free this.
*/
PHP_SIMDJSON_API struct simdjson_php_parser *php_simdjson_get_default_singleton_parser(void);
/* FIXME add php_simdjson_get_default_singleton_parser api */
/* FIXME add php_simdjson_decode_with_default_singleton_parser(return_value, json, len, bool associative) */
/**
* Returns the error message corresponding to a given error code returned by a call to simdjson_php.
*/
PHP_SIMDJSON_API const char* php_simdjson_error_msg(simdjson_php_error_code code);
/**
* Throw a SimdJsonException with the provided error code and the corresponding error message.
*/
PHP_SIMDJSON_API void php_simdjson_throw_jsonexception(simdjson_php_error_code code);
/**
* Create a brand new parser instance.
*
* The caller must free it with php_simdjson_free_parser once it is no longer used.
*
* Callers may use this instead of the shared singleton parser when memory usage is a concern
* (e.g. the PECLs are likely to be used load a string that's megabytes long in a long-lived php process)
*
* Callers should free this parser before or during the request shutdown phase.
*/
PHP_SIMDJSON_API struct simdjson_php_parser* php_simdjson_create_parser(void);
/**
* Release a parser **constructed by php_simdjson_create_parser** and all associated buffers.
*/
PHP_SIMDJSON_API void php_simdjson_free_parser(struct simdjson_php_parser* parser);
/**
* Returns 0 if the given json string is valid
*/
PHP_SIMDJSON_API simdjson_php_error_code php_simdjson_validate(struct simdjson_php_parser* parser, const zend_string *json, size_t depth);
/**
* Parses the given string into a return code.
*
* If the returned error code is 0, then return_value contains the parsed value.
* If the returned error code is non-0, then return_value will not be initialized.
*/
PHP_SIMDJSON_API simdjson_php_error_code php_simdjson_parse(struct simdjson_php_parser* parser, const zend_string *json, zval *return_value, bool associative, size_t depth);
/**
* Parses the given string into a return code. You have to be sure that the provided JSON contains simdjson::SIMDJSON_PADDING
*
* If the returned error code is 0, then return_value contains the parsed value.
* If the returned error code is non-0, then return_value will not be initialized.
*/
PHP_SIMDJSON_API simdjson_php_error_code php_simdjson_parse_buffer(simdjson_php_parser* parser, const char *json, size_t len, zval *return_value, bool associative, size_t depth);
/**
* Parses the part of the given string at the json pointer 'key' into a PHP value at return_value
*
* If the returned error code is 0, then return_value contains the parsed value (or null).
* If the returned error code is non-0, then return_value will not be initialized.
*
* - SIMDJSON_ERR_NO_SUCH_FIELD is returned if the json pointer 'key' is not found
* - Other errors are returned for invalid json, etc.
*
* @see https://www.rfc-editor.org/rfc/rfc6901.html
*/
PHP_SIMDJSON_API simdjson_php_error_code php_simdjson_key_value(struct simdjson_php_parser* parser, const zend_string *json, const char *key, zval *return_value, bool associative, size_t depth);
/**
* Checks if the json pointer 'key' exists in the given json string.
*
* - 0 if the key exists
* - NO_SUCH_FIELD if a field does not exist in an object
* - INDEX_OUT_OF_BOUNDS if an array index is larger than an array length
* - INCORRECT_TYPE if a non-integer is used to access an array
* - INVALID_JSON_POINTER if the JSON pointer is invalid and cannot be parsed
*
* @see https://www.rfc-editor.org/rfc/rfc6901.html
*/
PHP_SIMDJSON_API uint8_t php_simdjson_key_exists(struct simdjson_php_parser* parser, const zend_string *json, const char *key);
/**
* Count the keys of the given array/object at json pointer 'key' exists in the given json string.
*
* If the returned error code is 0, then the zval in return_value is overwritten with the key count using ZVAL_LONG.
* - For arrays, this is the array size
* - For objects, this is the object size
* - For other values, this is 0 (when fail_if_uncountable is false)
*
* @see https://www.rfc-editor.org/rfc/rfc6901.html
*/
PHP_SIMDJSON_API simdjson_php_error_code php_simdjson_key_count(struct simdjson_php_parser* parser, const zend_string *json, const char *key, zval *return_value);
END_EXTERN_C()
#endif