git.m6w6.name Git - m6w6/ext-psi/blob - src/module.c

   1 /*******************************************************************************
   2  Copyright (c) 2016, Michael Wallner <mike@php.net>.
   3  All rights reserved.
   4
   5  Redistribution and use in source and binary forms, with or without
   6  modification, are permitted provided that the following conditions are met:
   7
   8      * Redistributions of source code must retain the above copyright notice,
   9        this list of conditions and the following disclaimer.
  10      * Redistributions in binary form must reproduce the above copyright
  11        notice, this list of conditions and the following disclaimer in the
  12        documentation and/or other materials provided with the distribution.
  13
  14  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  15  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
  18  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  20  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  21  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  22  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 *******************************************************************************/
  25
  26 #include "php_psi_stdinc.h"
  27
  28 #include "php.h"
  29 #include "php_ini.h"
  30 #include "ext/standard/info.h"
  31 #include "zend_constants.h"
  32 #include "zend_operators.h"
  33
  34 #include "php_psi.h"
  35 #include "token.h"
  36 #include "parser.h"
  37
  38 #if HAVE_LIBJIT
  39 # include "libjit.h"
  40 # ifndef HAVE_LIBFFI
  41 #  define PSI_ENGINE "jit"
  42 # endif
  43 #endif
  44 #if HAVE_LIBFFI
  45 # include "libffi.h"
  46 # define PSI_ENGINE "ffi"
  47 #endif
  48
  49 ZEND_DECLARE_MODULE_GLOBALS(psi);
  50
  51 PHP_INI_BEGIN()
  52         STD_PHP_INI_ENTRY("psi.engine", PSI_ENGINE, PHP_INI_SYSTEM, OnUpdateString, engine, zend_psi_globals, psi_globals)
  53         STD_PHP_INI_ENTRY("psi.directory", "psi.d", PHP_INI_SYSTEM, OnUpdateString, directory, zend_psi_globals, psi_globals)
  54 PHP_INI_END();
  55
  56 static zend_object_handlers psi_object_handlers;
  57 static zend_class_entry *psi_class_entry;
  58
  59 zend_class_entry *psi_object_get_class_entry()
  60 {
  61         return psi_class_entry;
  62 }
  63
  64 static void psi_object_free(zend_object *o)
  65 {
  66         psi_object *obj = PSI_OBJ(NULL, o);
  67
  68         if (obj->data) {
  69                 if (obj->dtor) {
  70                         obj->dtor(obj->data);
  71                 }
  72                 obj->data = NULL;
  73         }
  74         zend_object_std_dtor(o);
  75 }
  76
  77 zend_object *psi_object_init_ex(zend_class_entry *ce, void *data, void (*dtor)(void *))
  78 {
  79         psi_object *o;
  80
  81         if (!ce) {
  82                 ce = psi_class_entry;
  83         }
  84
  85         o = ecalloc(1, sizeof(*o) + zend_object_properties_size(ce));
  86
  87         o->data = data;
  88         o->dtor = dtor;
  89
  90         zend_object_std_init(&o->std, ce);
  91         object_properties_init(&o->std, ce);
  92         o->std.handlers = &psi_object_handlers;
  93         return &o->std;
  94 }
  95
  96 zend_object *psi_object_init(zend_class_entry *ce)
  97 {
  98         return psi_object_init_ex(ce, NULL, NULL);
  99 }
 100
 101 ZEND_BEGIN_ARG_INFO_EX(ai_psi_dump, 0, 0, 0)
 102         ZEND_ARG_INFO(0, stream)
 103 ZEND_END_ARG_INFO();
 104 static PHP_FUNCTION(psi_dump)
 105 {
 106         php_stream *s;
 107         zval *r = NULL;
 108         int fd = STDOUT_FILENO;
 109
 110         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "|r!", &r)) {
 111                 return;
 112         }
 113         if (r) {
 114                 php_stream_from_zval(s, r);
 115
 116                 if (SUCCESS != php_stream_cast(s, PHP_STREAM_AS_FD | PHP_STREAM_CAST_INTERNAL, (void **)&fd, 1)) {
 117                         RETURN_FALSE;
 118                 }
 119         }
 120         psi_context_dump(PSI_G(context), fd);
 121 }
 122
 123 ZEND_BEGIN_ARG_INFO_EX(ai_psi_validate, 0, 0, 1)
 124         ZEND_ARG_INFO(0, file)
 125         ZEND_ARG_INFO(0, flags)
 126 ZEND_END_ARG_INFO();
 127 static PHP_FUNCTION(psi_validate)
 128 {
 129         zend_string *file;
 130         struct psi_parser P;
 131         struct psi_data D = {0};
 132         zend_long flags = 0;
 133
 134         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "P|l", &file, &flags)) {
 135                 return;
 136         }
 137
 138         if (!psi_parser_init(&P, psi_error_wrapper, flags)) {
 139                 RETURN_FALSE;
 140         }
 141         if (!psi_parser_open_file(&P, file->val)) {
 142                 psi_parser_dtor(&P);
 143                 RETURN_FALSE;
 144         }
 145
 146         psi_parser_parse(&P);
 147         psi_data_ctor(&D, P.error, P.flags);
 148         RETVAL_BOOL(psi_data_validate(&D, PSI_DATA(&P)) && !P.errors);
 149         psi_data_dtor(&D);
 150
 151         psi_parser_dtor(&P);
 152 }
 153
 154 ZEND_BEGIN_ARG_INFO_EX(ai_psi_validate_string, 0, 0, 1)
 155         ZEND_ARG_INFO(0, string)
 156 ZEND_END_ARG_INFO();
 157 static PHP_FUNCTION(psi_validate_string)
 158 {
 159         zend_string *string;
 160         struct psi_parser P;
 161         struct psi_data D = {0};
 162         zend_long flags = 0;
 163
 164         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "S|l", &string, &flags)) {
 165                 return;
 166         }
 167
 168         if (!psi_parser_init(&P, psi_error_wrapper, flags)) {
 169                 RETURN_FALSE;
 170         }
 171         if (!psi_parser_open_string(&P, string->val, string->len)) {
 172                 psi_parser_dtor(&P);
 173                 RETURN_FALSE;
 174         }
 175
 176         psi_parser_parse(&P);
 177         psi_data_ctor(&D, P.error, P.flags);
 178         RETVAL_BOOL(psi_data_validate(&D, PSI_DATA(&P)) && !P.errors);
 179         psi_data_dtor(&D);
 180
 181         psi_parser_dtor(&P);
 182 }
 183
 184 static PHP_MINIT_FUNCTION(psi)
 185 {
 186         struct psi_context_ops *ops = NULL;
 187         zend_class_entry ce = {0};
 188         unsigned flags = 0;
 189
 190         REGISTER_INI_ENTRIES();
 191
 192         zend_register_long_constant(ZEND_STRL("PSI_DEBUG"), PSI_DEBUG, CONST_CS|CONST_PERSISTENT, module_number);
 193         zend_register_long_constant(ZEND_STRL("PSI_SILENT"), PSI_SILENT, CONST_CS|CONST_PERSISTENT, module_number);
 194
 195         INIT_NS_CLASS_ENTRY(ce, "psi", "object", NULL);
 196         psi_class_entry = zend_register_internal_class_ex(&ce, NULL);
 197         psi_class_entry->create_object = psi_object_init;
 198
 199         memcpy(&psi_object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
 200         psi_object_handlers.offset = XtOffsetOf(psi_object, std);
 201         psi_object_handlers.free_obj = psi_object_free;
 202         psi_object_handlers.clone_obj = NULL;
 203
 204 #ifdef HAVE_LIBJIT
 205         if (!strcasecmp(PSI_G(engine), "jit")) {
 206                 ops = psi_libjit_ops();
 207         } else
 208 #endif
 209 #ifdef HAVE_LIBFFI
 210                 ops = psi_libffi_ops();
 211 #endif
 212
 213         if (!ops) {
 214                 php_error(E_WARNING, "No PSI engine found");
 215                 return FAILURE;
 216         }
 217
 218         if (psi_check_env("PSI_DEBUG")) {
 219                 flags |= PSI_DEBUG;
 220         }
 221         if (psi_check_env("PSI_SILENT")) {
 222                 flags |= PSI_SILENT;
 223         }
 224
 225         PSI_G(context) = psi_context_init(NULL, ops, psi_error_wrapper, flags);
 226         psi_context_build(PSI_G(context), PSI_G(directory));
 227
 228         if (psi_check_env("PSI_DUMP")) {
 229                 psi_context_dump(PSI_G(context), STDOUT_FILENO);
 230         }
 231
 232         return SUCCESS;
 233 }
 234
 235 static PHP_MSHUTDOWN_FUNCTION(psi)
 236 {
 237         psi_context_free(&PSI_G(context));
 238
 239         UNREGISTER_INI_ENTRIES();
 240
 241         return SUCCESS;
 242 }
 243
 244 #if defined(COMPILE_DL_PSI) && defined(ZTS)
 245 static PHP_RINIT_FUNCTION(psi)
 246 {
 247         ZEND_TSRMLS_CACHE_UPDATE();
 248         return SUCCESS;
 249 }
 250 #endif
 251
 252 static PHP_MINFO_FUNCTION(psi)
 253 {
 254         php_info_print_table_start();
 255         php_info_print_table_header(2, "PSI Support", "enabled");
 256         php_info_print_table_row(2, "Extension Version", PHP_PSI_VERSION);
 257         php_info_print_table_end();
 258         php_info_print_table_start();
 259         php_info_print_table_header(3, "Used Library", "Compiled", "Linked");
 260         php_info_print_table_row(3, "libffi",
 261 #ifndef PHP_PSI_LIBFFI_VERSION
 262 # define PHP_PSI_LIBFFI_VERSION "unknown"
 263 #endif
 264 #ifdef HAVE_LIBFFI
 265                         PHP_PSI_LIBFFI_VERSION, "unknown"
 266 #else
 267                         "disabled", "disabled"
 268 #endif
 269         );
 270         php_info_print_table_row(3, "libjit",
 271 #ifdef HAVE_LIBJIT
 272                         "unknown", "unknown"
 273 #else
 274                         "disabled", "disabled"
 275 #endif
 276         );
 277
 278         DISPLAY_INI_ENTRIES();
 279 }
 280
 281 static const zend_function_entry psi_functions[] = {
 282         PHP_FE(psi_dump, ai_psi_dump)
 283         PHP_FE(psi_validate, ai_psi_validate)
 284         PHP_FE(psi_validate_string, ai_psi_validate_string)
 285         PHP_FE_END
 286 };
 287
 288 zend_module_entry psi_module_entry = {
 289         STANDARD_MODULE_HEADER,
 290         "psi",
 291         psi_functions,
 292         PHP_MINIT(psi),
 293         PHP_MSHUTDOWN(psi),
 294 #if defined(COMPILE_DL_PSI) && defined(ZTS)
 295         PHP_RINIT(psi),         /* Replace with NULL if there's nothing to do at request start */
 296 #else
 297         NULL,
 298 #endif
 299         NULL,
 300         PHP_MINFO(psi),
 301         PHP_PSI_VERSION,
 302         STANDARD_MODULE_PROPERTIES
 303 };
 304
 305 #ifdef COMPILE_DL_PSI
 306 #ifdef ZTS
 307 ZEND_TSRMLS_CACHE_DEFINE();
 308 #endif
 309 ZEND_GET_MODULE(psi)
 310 #endif
 311
 312 /*
 313  * Local variables:
 314  * tab-width: 4
 315  * c-basic-offset: 4
 316  * End:
 317  * vim600: noet sw=4 ts=4 fdm=marker
 318  * vim<600: noet sw=4 ts=4
 319  */