flush
[m6w6/ext-psi] / src / context.c
1 #include <sys/param.h>
2 #include <dlfcn.h>
3 #include <dirent.h>
4 #include <fnmatch.h>
5 #include <errno.h>
6
7 #ifdef HAVE_CONFIG_H
8 # include "config.h"
9 #endif
10
11 #include "php.h"
12 #include "php_scandir.h"
13 #include "php_psi.h"
14 #include "context.h"
15 #include "parser.h"
16
17 #define psi_predef_count(of) ((sizeof(psi_predef ##of## s)/sizeof(psi_predef ##of))-1)
18 typedef struct psi_predef_type {
19 token_t type_tag;
20 const char *type_name;
21 const char *alias;
22 } psi_predef_type;
23 static const psi_predef_type psi_predef_types[] = {
24 PHP_PSI_TYPES{0}
25 };
26 #define psi_predef_type_count() psi_predef_count(_type)
27
28 typedef struct psi_predef_const {
29 token_t type_tag;
30 const char *type_name;
31 const char *name;
32 const char *val_text;
33 token_t val_type_tag;
34 } psi_predef_const;
35 static const psi_predef_const psi_predef_consts[] = {
36 PHP_PSI_CONSTS{0}
37 };
38 #define psi_predef_const_count() psi_predef_count(_const)
39
40 typedef struct psi_predef_struct_member {
41 token_t type_tag;
42 const char *type_name;
43 const char *name;
44 size_t off;
45 size_t len;
46 size_t pointer_level;
47 size_t array_size;
48 } psi_predef_struct_member;
49 #define PSI_PREDEF_STRUCT_MEMBERS 32
50 typedef struct psi_predef_struct {
51 const char *name;
52 size_t size;
53 psi_predef_struct_member members[PSI_PREDEF_STRUCT_MEMBERS];
54 } psi_predef_struct;
55 static const psi_predef_struct psi_predef_structs[] = {
56 PHP_PSI_STRUCTS{0}
57 };
58 #define psi_predef_struct_count() psi_predef_count(_struct)
59
60 static int validate_lib(PSI_Data *data, void **dlopened) {
61 char lib[MAXPATHLEN];
62 const char *ptr = data->psi.file.ln;
63 size_t len;
64
65 if (!ptr) {
66 /* FIXME: assume stdlib */
67 return 1;
68 } else if (!strchr(ptr, '/')) {
69 #ifdef DARWIN
70 len = snprintf(lib, MAXPATHLEN, "lib%s.dylib", ptr);
71 #else
72 len = snprintf(lib, MAXPATHLEN, "lib%s.so", ptr);
73 #endif
74 if (MAXPATHLEN == len) {
75 data->error(PSI_WARNING, "Library name too long: '%s'", ptr);
76 }
77 lib[len] = 0;
78 ptr = lib;
79 }
80 if (!(*dlopened = dlopen(ptr, RTLD_LAZY|RTLD_LOCAL))) {
81 data->error(PSI_WARNING, "Could not open library '%s': %s.",
82 data->psi.file.ln, dlerror());
83 return 0;
84 }
85 return 1;
86 }
87
88 static inline int locate_decl_type_alias(decl_typedefs *defs, decl_type *type) {
89 size_t i;
90
91 if (type->real) {
92 return 1;
93 }
94 for (i = 0; i < defs->count; ++i) {
95 if (!strcmp(defs->list[i]->alias, type->name)) {
96 type->real = defs->list[i]->type;
97 return 1;
98 }
99 }
100 return 0;
101 }
102 static inline int locate_decl_type_struct(decl_structs *structs, decl_type *type) {
103 size_t i;
104
105 if (type->strct) {
106 return 1;
107 }
108 for (i = 0; i < structs->count; ++i) {
109 if (!strcmp(structs->list[i]->name, type->name)) {
110 type->strct = structs->list[i];
111 return 1;
112 }
113 }
114 return 0;
115 }
116
117 static inline int validate_decl_type(PSI_Data *data, decl_type *type) {
118 switch (type->type) {
119 case PSI_T_NAME:
120 if (!data->defs || !locate_decl_type_alias(data->defs, type)) {
121 return 0;
122 }
123 return validate_decl_type(data, type->real);
124 case PSI_T_STRUCT:
125 if (!data->structs || !locate_decl_type_struct(data->structs, type)) {
126 return 0;
127 }
128 break;
129 }
130 return 1;
131 }
132 static inline int validate_decl_typedef(PSI_Data *data, decl_typedef *def) {
133 if (!validate_decl_type(data, def->type)) {
134 data->error(PSI_WARNING, "Type '%s' cannot be aliased to '%s'",
135 def->type->name, def->alias);
136 return 0;
137 }
138 /* FIXME: check def->alias */
139 return 1;
140 }
141
142 static inline int validate_constant(PSI_Data *data, constant *c) {
143 /* FIXME */
144 return 1;
145 }
146
147 static inline int validate_decl_arg(PSI_Data *data, decl_arg *arg) {
148 if (!validate_decl_type(data, arg->type)) {
149 data->error(PSI_WARNING, "Cannot use '%s' as type for '%s'",
150 arg->type->name, arg->var->name);
151 return 0;
152 }
153 return 1;
154 }
155
156 static inline int validate_decl_struct(PSI_Data *data, decl_struct *s) {
157 size_t i;
158
159 for (i = 0; i < s->args->count; ++i) {
160 if (!validate_decl_arg(data, s->args->args[i])) {
161 return 0;
162 }
163 }
164
165 for (i = 0; i < s->args->count; ++i) {
166 decl_arg *darg = s->args->args[i];
167
168 if (!validate_decl_arg(data, darg)) {
169 return 0;
170 }
171
172 ZEND_ASSERT(!darg->var->arg);
173 darg->var->arg = darg;
174
175 if (!darg->layout) {
176 token_t t;
177
178 if (darg->var->pointer_level && (!darg->var->array_size || darg->var->pointer_level == 1)) {
179 t = PSI_T_POINTER;
180 } else {
181 t = real_decl_type(darg->type)->type;
182 }
183
184 if (i) {
185 decl_arg *last = s->args->args[i-1];
186 darg->layout = init_decl_struct_layout(
187 psi_t_align(t, last->layout->pos + last->layout->len),
188 psi_t_size(t) * darg->var->array_size);
189 } else {
190 darg->layout = init_decl_struct_layout(0, psi_t_size(t));
191 }
192 }
193 if (s->size < darg->layout->pos + darg->layout->len) {
194 s->size = darg->layout->pos + darg->layout->len;
195 }
196 }
197 return 1;
198 }
199
200 static const char * const abi_ccs[] = {
201 "default", /* \ */
202 "extern", /* > - all the same */
203 "cdecl", /* / */
204 "stdcall",
205 "fastcall",
206 };
207 static inline int validate_decl_abi(PSI_Data *data, decl_abi *abi) {
208 size_t i;
209
210 for (i = 0; i < sizeof(abi_ccs)/sizeof(char*); ++i) {
211 if (strcasecmp(abi->convention, abi_ccs[i])) {
212 return 1;
213 }
214 }
215 data->error(PSI_WARNING, "Invalid calling convention: '%s'", abi->convention);
216 return 0;
217 }
218 static inline int validate_decl_func(PSI_Data *data, void *dl, decl *decl, decl_arg *func)
219 {
220 if (!strcmp(func->var->name, "dlsym")) {
221 data->error(PSI_WARNING, "Cannot dlsym dlsym (sic!)");
222 return 0;
223 }
224
225 if (!validate_decl_arg(data, func)) {
226 return 0;
227 }
228 #ifndef RTLD_NEXT
229 # define RTLD_NEXT ((void *) -1l)
230 #endif
231 decl->dlptr = dlsym(dl ?: RTLD_NEXT, func->var->name);
232 if (!decl->dlptr) {
233 data->error(PSI_WARNING, "Failed to locate symbol '%s': %s",
234 func->var->name, dlerror());
235 }
236 return 1;
237 }
238
239 static inline int validate_decl(PSI_Data *data, void *dl, decl *decl) {
240 if (!validate_decl_abi(data, decl->abi)) {
241 return 0;
242 }
243 if (!validate_decl_func(data, dl, decl, decl->func)) {
244 return 0;
245 }
246 if (decl->args) {
247 size_t i;
248
249 for (i = 0; i < decl->args->count; ++i) {
250 if (!validate_decl_arg(data, decl->args->args[i])) {
251 return 0;
252 }
253 }
254 }
255 return 1;
256 }
257
258 static inline decl *locate_impl_decl(decls *decls, return_stmt *ret) {
259 size_t i;
260
261 for (i = 0; i < decls->count; ++i) {
262 if (!strcmp(decls->list[i]->func->var->name, ret->decl->name)) {
263 ret->decl->arg = decls->list[i]->func;
264 return decls->list[i];
265 }
266 }
267 return NULL;
268 }
269 static inline int validate_impl_ret_stmt(PSI_Data *data, impl *impl) {
270 /* we must have exactly one ret stmt delcaring the native func to call */
271 /* and which type cast to apply */
272 if (impl->stmts->ret.count != 1) {
273 if (impl->stmts->ret.count > 1) {
274 data->error(PSI_WARNING, "Too many `return` statements for implmentation %s;"
275 " found %zu, exactly one is needed",
276 impl->func->name, impl->stmts->ret.count);
277 } else {
278 data->error(PSI_WARNING, "Missing `return` statement for implementation %s",
279 impl->func->name);
280 }
281 return 0;
282 }
283 if (!(impl->decl = locate_impl_decl(data->decls, impl->stmts->ret.list[0]))) {
284 data->error(PSI_WARNING, "Missing declaration for implementation %s",
285 impl->func->name);
286 return 0;
287 }
288
289 return 1;
290 }
291 static inline int validate_impl_let_stmts(PSI_Data *data, impl *impl) {
292 size_t i, j;
293 /* we can have multiple let stmts */
294 /* check that we have a let stmt for every decl arg */
295 if (impl->decl->args) for (i = 0; i < impl->decl->args->count; ++i) {
296 decl_arg *darg = impl->decl->args->args[i];
297 int check = 0;
298
299 for (j = 0; j < impl->stmts->let.count; ++j) {
300 let_stmt *let = impl->stmts->let.list[j];
301
302 if (!strcmp(let->var->name, darg->var->name)) {
303 darg->let = let;
304 check = 1;
305 break;
306 }
307 }
308 if (!check) {
309 data->error(PSI_WARNING, "Missing `let` statement for arg '%s %.*s%s'"
310 " of declaration '%s' for implementation '%s'",
311 darg->type->name, (int) darg->var->pointer_level, "*****",
312 darg->var->name, impl->decl->func->var->name, impl->func->name);
313 return 0;
314 }
315 }
316 /* check that the let_value references a known variable or NULL */
317 for (i = 0; i < impl->stmts->let.count; ++i) {
318 let_stmt *let = impl->stmts->let.list[i];
319 int check = 0;
320
321 if (let->val && let->val->func && let->val->func->alloc) {
322 if (!validate_decl_type(data, let->val->func->alloc->type)) {
323 data->error(PSI_WARNING, "Cannot use '%s' as type for calloc in `let` statement",
324 let->val->func->alloc->type->name);
325 return 0;
326 }
327 }
328 if (let->val && let->val->var) {
329 if (impl->func->args) for (j = 0; j < impl->func->args->count; ++j) {
330 impl_arg *iarg = impl->func->args->args[j];
331
332 if (!strcmp(let->val->var->name, iarg->var->name)) {
333 let->arg = iarg;
334 check = 1;
335 break;
336 }
337 }
338 if (!check) {
339 data->error(PSI_WARNING, "Unknown value '$%s' of `let` statement"
340 " for variable '%s' of implementation '%s'",
341 let->val->var->name, let->var->name, impl->func->name);
342 return 0;
343 }
344 }
345 }
346 return 1;
347 }
348 static inline int validate_impl_set_stmts(PSI_Data *data, impl *impl) {
349 size_t i, j, k;
350 /* we can have any count of set stmts; processing out vars */
351 /* check that set stmts reference known variables */
352 for (i = 0; i < impl->stmts->set.count; ++i) {
353 set_stmt *set = impl->stmts->set.list[i];
354 int check = 0;
355
356 if (impl->func->args) for (j = 0; j < impl->func->args->count; ++j) {
357 impl_arg *iarg = impl->func->args->args[j];
358
359 if (!strcmp(set->var->name, iarg->var->name)) {
360 set->arg = iarg;
361 check = 1;
362 break;
363 }
364 }
365 if (!check) {
366 data->error(PSI_WARNING, "Unknown variable '$%s' of `set` statement"
367 " of implementation '%s'",
368 set->var->name, impl->func->name);
369 return 0;
370 }
371
372 for (j = 0; j < set->val->vars->count; ++j) {
373 decl_var *set_var = set->val->vars->vars[j];
374
375 check = 0;
376 if (impl->decl->args) for (k = 0; k < impl->decl->args->count; ++k) {
377 decl_arg *set_arg = impl->decl->args->args[k];
378
379 if (!strcmp(set_var->name, set_arg->var->name)) {
380 check = 1;
381 set_var->arg = set_arg;
382 break;
383 }
384 }
385
386 if (!check) {
387 data->error(PSI_WARNING, "Unknown value '%s' of `set` statement"
388 " for variable '$%s' of implementation '%s'",
389 set_var->name, set->arg->var->name, impl->func->name);
390 return 0;
391 }
392 }
393 }
394 return 1;
395 }
396 static inline int validate_impl_free_stmts(PSI_Data *data, impl *impl) {
397 size_t i, j, k;
398 /* we can have any count of free stmts; freeing any out vars */
399 for (i = 0; i < impl->stmts->fre.count; ++i) {
400 free_stmt *fre = impl->stmts->fre.list[i];
401
402 for (j = 0; j < fre->vars->count; ++j) {
403 decl_var *free_var = fre->vars->vars[j];
404 int check = 0;
405
406 if (!strcmp(free_var->name, impl->decl->func->var->name)) {
407 continue;
408 }
409 if (impl->decl->args) for (k = 0; k < impl->decl->args->count; ++k) {
410 decl_arg *free_arg = impl->decl->args->args[k];
411
412 if (!strcmp(free_var->name, free_arg->var->name)) {
413 check = 1;
414 free_var->arg = free_arg;
415 break;
416 }
417 }
418
419 if (!check) {
420 data->error(PSI_WARNING, "Unknown variable '%s' of `free` statement"
421 " of implementation '%s'",
422 free_var->name, impl->func->name);
423 return 0;
424 }
425 }
426 }
427 return 1;
428 }
429 static inline int validate_impl_stmts(PSI_Data *data, impl *impl) {
430 if (!impl->stmts) {
431 data->error(PSI_WARNING, "Missing body for implementation %s!",
432 impl->func->name);
433 return 0;
434 }
435
436 if (!validate_impl_ret_stmt(data, impl)) {
437 return 0;
438 }
439
440 if (!validate_impl_let_stmts(data, impl)) {
441 return 0;
442 }
443 if (!validate_impl_set_stmts(data, impl)) {
444 return 0;
445 }
446 if (!validate_impl_free_stmts(data, impl)) {
447 return 0;
448 }
449
450 return 1;
451 }
452
453 PSI_Context *PSI_ContextInit(PSI_Context *C, PSI_ContextOps *ops, PSI_ContextErrorFunc error)
454 {
455 size_t i, j;
456 PSI_Data T;
457
458 if (!C) {
459 C = malloc(sizeof(*C));
460 }
461 memset(C, 0, sizeof(*C));
462
463 C->error = error;
464 C->ops = ops;
465 ops->init(C);
466
467 /* build up predefs in a temporary PSI_Data for validation */
468 memset(&T, 0, sizeof(T));
469 T.error = error;
470
471 for (i = 0; i < psi_predef_type_count(); ++i) {
472 const psi_predef_type *pre = &psi_predef_types[i];
473 decl_type *type = init_decl_type(pre->type_tag, pre->type_name);
474 decl_typedef *def = init_decl_typedef(pre->alias, type);
475
476 T.defs = add_decl_typedef(T.defs, def);
477 }
478 for (i = 0; i < psi_predef_const_count(); ++i) {
479 const psi_predef_const *pre = &psi_predef_consts[i];
480 impl_def_val *val = init_impl_def_val(pre->val_type_tag, pre->val_text);
481 const_type *type = init_const_type(pre->type_tag, pre->type_name);
482 constant *constant = init_constant(type, pre->name, val);
483
484 T.consts = add_constant(T.consts, constant);
485 }
486 for (i = 0; i < psi_predef_struct_count(); ++i) {
487 const psi_predef_struct *pre = &psi_predef_structs[i];
488 decl_args *dargs = init_decl_args(NULL);
489 decl_struct *dstruct;
490
491 for (j = 0; j < PSI_PREDEF_STRUCT_MEMBERS; ++j) {
492 const psi_predef_struct_member *member = &pre->members[j];
493 decl_type *type;
494 decl_var *dvar;
495 decl_arg *darg;
496
497 if (!member->name) {
498 break;
499 }
500
501 type = init_decl_type(member->type_tag, member->type_name);
502 dvar = init_decl_var(member->name, member->pointer_level, member->array_size);
503 darg = init_decl_arg(type, dvar);
504 darg->layout = init_decl_struct_layout(member->off, member->len);
505 dargs = add_decl_arg(dargs, darg);
506 }
507
508 dstruct = init_decl_struct(pre->name, dargs);
509 dstruct->size = pre->size;
510 T.structs = add_decl_struct(T.structs, dstruct);
511 }
512
513 for (i = 0; i < psi_predef_type_count(); ++i) {
514 decl_typedef *def = T.defs->list[i];
515
516 if (validate_decl_typedef(&T, def)) {
517 C->defs = add_decl_typedef(C->defs, def);
518 }
519 }
520
521 for (i = 0; i < psi_predef_const_count(); ++i) {
522 constant *constant = T.consts->list[i];
523
524 if (validate_constant(&T, constant)) {
525 C->consts = add_constant(C->consts, constant);
526 }
527 }
528
529 for (i = 0; i < psi_predef_struct_count(); ++i) {
530 decl_struct *dstruct = T.structs->list[i];
531
532 if (validate_decl_struct(&T, dstruct)) {
533 C->structs = add_decl_struct(C->structs, dstruct);
534 }
535 }
536
537 C->count = 1;
538 C->data = malloc(sizeof(*C->data));
539 PSI_DataExchange(C->data, &T);
540
541 return C;
542 }
543
544 int PSI_ContextValidate(PSI_Context *C, PSI_Parser *P)
545 {
546 PSI_Data *D;
547 void *dlopened = NULL;
548 size_t count = C->count++;
549
550 C->data = realloc(C->data, C->count * sizeof(*C->data));
551 D = PSI_DataExchange(&C->data[count], PSI_DATA(P));
552
553 if (D->defs) {
554 size_t i;
555
556 for (i = 0; i < D->defs->count; ++i) {
557 if (validate_decl_typedef(PSI_DATA(C), D->defs->list[i])) {
558 C->defs = add_decl_typedef(C->defs, D->defs->list[i]);
559 }
560 }
561 }
562 if (D->structs) {
563 size_t i;
564
565 for (i = 0; i < D->structs->count; ++i) {
566 if (validate_decl_struct(PSI_DATA(C), D->structs->list[i])) {
567 C->structs = add_decl_struct(C->structs, D->structs->list[i]);
568 }
569 }
570 }
571 if (D->consts) {
572 size_t i;
573
574 for (i = 0; i < D->consts->count; ++i) {
575 if (validate_constant(PSI_DATA(C), D->consts->list[i])) {
576 C->consts = add_constant(C->consts, D->consts->list[i]);
577 }
578 }
579 }
580
581 if (!validate_lib(D, &dlopened)) {
582 return 0;
583 }
584
585 add_decl_lib(&C->psi.libs, dlopened);
586
587 if (D->decls) {
588 size_t i;
589
590 for (i = 0; i < D->decls->count; ++i) {
591 if (validate_decl(PSI_DATA(C), dlopened, D->decls->list[i])) {
592 C->decls = add_decl(C->decls, D->decls->list[i]);
593 }
594 }
595 }
596 if (D->impls) {
597 size_t i;
598
599 for (i = 0; i < D->impls->count; ++i) {
600 if (validate_impl_stmts(PSI_DATA(C), D->impls->list[i])) {
601 C->impls = add_impl(C->impls, D->impls->list[i]);
602 }
603 }
604 }
605
606 return 1;
607 }
608
609 static int psi_select_dirent(const struct dirent *entry)
610 {
611 #ifndef FNM_CASEFOLD
612 #define FNM_CASEFOLD 0
613 #endif
614 return 0 == fnmatch("*.psi", entry->d_name, FNM_CASEFOLD);
615 }
616
617 void PSI_ContextBuild(PSI_Context *C, const char *path)
618 {
619 int i, n;
620 struct dirent **entries = NULL;
621
622 n = php_scandir(path, &entries, psi_select_dirent, alphasort);
623
624 if (n < 0) {
625 return;
626 } else for (i = 0; i < n; ++i) {
627 char psi[MAXPATHLEN];
628 PSI_Parser P;
629
630 if (MAXPATHLEN <= slprintf(psi, MAXPATHLEN, "%s/%s", path, entries[i]->d_name)) {
631 C->error(PSI_WARNING, "Path to PSI file too long: %s/%s",
632 path, entries[i]->d_name);
633 }
634 if (!PSI_ParserInit(&P, psi, C->error, 0)) {
635 C->error(PSI_WARNING, "Failed to init PSI parser (%s): %s",
636 psi, strerror(errno));
637 continue;
638 }
639
640 while (-1 != PSI_ParserScan(&P)) {
641 PSI_ParserParse(&P, PSI_TokenAlloc(&P));
642 };
643 PSI_ParserParse(&P, NULL);
644 PSI_ContextValidate(C, &P);
645 PSI_ParserDtor(&P);
646 }
647
648 if (PSI_ContextCompile(C) && SUCCESS != zend_register_functions(NULL, C->closures, NULL, MODULE_PERSISTENT)) {
649 C->error(PSI_WARNING, "Failed to register functions!");
650 }
651
652 if (entries) {
653 for (i = 0; i < n; ++i) {
654 free(entries[i]);
655 }
656 free(entries);
657 }
658
659 }
660
661 zend_function_entry *PSI_ContextCompile(PSI_Context *C)
662 {
663 size_t i;
664
665 if (C->consts) {
666 zend_constant zc;
667
668 zc.flags = CONST_PERSISTENT|CONST_CS;
669 zc.module_number = EG(current_module)->module_number;
670
671 for (i = 0; i < C->consts->count; ++i) {
672 constant *c = C->consts->list[i];
673
674 zc.name = zend_string_init(c->name + (c->name[0] == '\\'), strlen(c->name) - (c->name[0] == '\\'), 1);
675 ZVAL_NEW_STR(&zc.value, zend_string_init(c->val->text, strlen(c->val->text), 1));
676
677 switch (c->type->type) {
678 case PSI_T_BOOL:
679 convert_to_boolean(&zc.value);
680 break;
681 case PSI_T_INT:
682 convert_to_long(&zc.value);
683 break;
684 case PSI_T_FLOAT:
685 convert_to_double(&zc.value);
686 break;
687 }
688 zend_register_constant(&zc);
689 }
690 }
691
692
693 return C->closures = C->ops->compile(C);
694 }
695
696 void PSI_ContextDtor(PSI_Context *C)
697 {
698 size_t i;
699
700 C->ops->dtor(C);
701
702 free_decl_libs(&C->psi.libs);
703
704 for (i = 0; i < C->count; ++i) {
705 PSI_DataDtor(&C->data[i]);
706 }
707
708 free(C->data);
709 free(C->closures);
710
711 if (C->consts) {
712 if (C->consts->list) {
713 free(C->consts->list);
714 }
715 free(C->consts);
716 }
717 if (C->defs) {
718 if (C->defs->list) {
719 free(C->defs->list);
720 }
721 free(C->defs);
722 }
723 if (C->structs) {
724 if (C->structs->list) {
725 free(C->structs->list);
726 }
727 free(C->structs);
728 }
729 if (C->decls) {
730 if (C->decls->list) {
731 free(C->decls->list);
732 }
733 free(C->decls);
734 }
735 if (C->impls) {
736 if (C->impls->list) {
737 free(C->impls->list);
738 }
739 free(C->impls);
740 }
741
742 memset(C, 0, sizeof(*C));
743 }
744
745 void PSI_ContextFree(PSI_Context **C)
746 {
747 if (*C) {
748 PSI_ContextDtor(*C);
749 free(*C);
750 *C = NULL;
751 }
752 }