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         php_stream *s;
 106         zval *r = NULL;
 107         int fd = STDOUT_FILENO;
 108
 109         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "|r!", &r)) {
 110                 return;
 111         }
 112         if (r) {
 113                 php_stream_from_zval(s, r);
 114
 115                 if (SUCCESS != php_stream_cast(s, PHP_STREAM_AS_FD | PHP_STREAM_CAST_INTERNAL, (void **)&fd, 1)) {
 116                         RETURN_FALSE;
 117                 }
 118         }
 119         psi_context_dump(PSI_G(context), fd);
 120 }
 121
 122 ZEND_BEGIN_ARG_INFO_EX(ai_psi_validate, 0, 0, 1)
 123         ZEND_ARG_INFO(0, file)
 124 ZEND_END_ARG_INFO();
 125 static PHP_FUNCTION(psi_validate) {
 126         zend_string *file;
 127         struct psi_parser P;
 128         struct psi_data D = {0};
 129
 130         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "P", &file)) {
 131                 return;
 132         }
 133
 134         if (!psi_parser_init(&P, file->val, psi_error_wrapper, 0)) {
 135                 RETURN_FALSE;
 136         }
 137
 138         while (0 < psi_parser_scan(&P)) {
 139                 psi_parser_parse(&P, psi_token_alloc(&P));
 140                 if (P.num == PSI_T_EOF) {
 141                         break;
 142                 }
 143         }
 144         psi_parser_parse(&P, NULL);
 145
 146         psi_data_ctor(&D, P.error, P.flags);
 147         RETVAL_BOOL(psi_data_validate(&D, PSI_DATA(&P)) && !P.errors);
 148         psi_data_dtor(&D);
 149
 150         psi_parser_dtor(&P);
 151 }
 152
 153 static PHP_MINIT_FUNCTION(psi)
 154 {
 155         struct psi_context_ops *ops = NULL;
 156         zend_class_entry ce = {0};
 157         unsigned flags = 0;
 158
 159         if (psi_check_env("PSI_DEBUG")) {
 160                 flags |= PSI_DEBUG;
 161         }
 162         if (psi_check_env("PSI_SILENT")) {
 163                 flags |= PSI_SILENT;
 164         }
 165
 166         REGISTER_INI_ENTRIES();
 167
 168         INIT_NS_CLASS_ENTRY(ce, "psi", "object", NULL);
 169         psi_class_entry = zend_register_internal_class_ex(&ce, NULL);
 170         psi_class_entry->create_object = psi_object_init;
 171
 172         memcpy(&psi_object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
 173         psi_object_handlers.offset = XtOffsetOf(psi_object, std);
 174         psi_object_handlers.free_obj = psi_object_free;
 175         psi_object_handlers.clone_obj = NULL;
 176
 177 #ifdef HAVE_LIBJIT
 178         if (!strcasecmp(PSI_G(engine), "jit")) {
 179                 ops = psi_libjit_ops();
 180         } else
 181 #endif
 182 #ifdef HAVE_LIBFFI
 183                 ops = psi_libffi_ops();
 184 #endif
 185
 186         if (!ops) {
 187                 php_error(E_WARNING, "No PSI engine found");
 188                 return FAILURE;
 189         }
 190
 191         PSI_G(context) = psi_context_init(NULL, ops, psi_error_wrapper, flags);
 192         psi_context_build(PSI_G(context), PSI_G(directory));
 193
 194         if (psi_check_env("PSI_DUMP")) {
 195                 psi_context_dump(PSI_G(context), STDOUT_FILENO);
 196         }
 197
 198         return SUCCESS;
 199 }
 200
 201 static PHP_MSHUTDOWN_FUNCTION(psi)
 202 {
 203         psi_context_free(&PSI_G(context));
 204
 205         UNREGISTER_INI_ENTRIES();
 206
 207         return SUCCESS;
 208 }
 209
 210 #if defined(COMPILE_DL_PSI) && defined(ZTS)
 211 static PHP_RINIT_FUNCTION(psi)
 212 {
 213         ZEND_TSRMLS_CACHE_UPDATE();
 214         return SUCCESS;
 215 }
 216 #endif
 217
 218 static PHP_MINFO_FUNCTION(psi)
 219 {
 220         php_info_print_table_start();
 221         php_info_print_table_header(2, "PSI Support", "enabled");
 222         php_info_print_table_row(2, "Extension Version", PHP_PSI_VERSION);
 223         php_info_print_table_end();
 224         php_info_print_table_start();
 225         php_info_print_table_header(3, "Used Library", "Compiled", "Linked");
 226         php_info_print_table_row(3, "libffi",
 227 #ifndef PHP_PSI_LIBFFI_VERSION
 228 # define PHP_PSI_LIBFFI_VERSION "unknown"
 229 #endif
 230 #ifdef HAVE_LIBFFI
 231                         PHP_PSI_LIBFFI_VERSION, "unknown"
 232 #else
 233                         "disabled", "disabled"
 234 #endif
 235         );
 236         php_info_print_table_row(3, "libjit",
 237 #ifdef HAVE_LIBJIT
 238                         "unknown", "unknown"
 239 #else
 240                         "disabled", "disabled"
 241 #endif
 242         );
 243
 244         DISPLAY_INI_ENTRIES();
 245 }
 246
 247 static const zend_function_entry psi_functions[] = {
 248         PHP_FE(psi_dump, ai_psi_dump)
 249         PHP_FE(psi_validate, ai_psi_validate)
 250         PHP_FE_END
 251 };
 252
 253 zend_module_entry psi_module_entry = {
 254         STANDARD_MODULE_HEADER,
 255         "psi",
 256         psi_functions,
 257         PHP_MINIT(psi),
 258         PHP_MSHUTDOWN(psi),
 259 #if defined(COMPILE_DL_PSI) && defined(ZTS)
 260         PHP_RINIT(psi),         /* Replace with NULL if there's nothing to do at request start */
 261 #else
 262         NULL,
 263 #endif
 264         NULL,
 265         PHP_MINFO(psi),
 266         PHP_PSI_VERSION,
 267         STANDARD_MODULE_PROPERTIES
 268 };
 269
 270 #ifdef COMPILE_DL_PSI
 271 #ifdef ZTS
 272 ZEND_TSRMLS_CACHE_DEFINE();
 273 #endif
 274 ZEND_GET_MODULE(psi)
 275 #endif
 276
 277 /*
 278  * Local variables:
 279  * tab-width: 4
 280  * c-basic-offset: 4
 281  * End:
 282  * vim600: noet sw=4 ts=4 fdm=marker
 283  * vim<600: noet sw=4 ts=4
 284  */