12 #include "php_scandir.h"
17 #define psi_predef_count(of) ((sizeof(psi_predef ##of## s)/sizeof(psi_predef ##of))-1)
18 typedef struct psi_predef_type
{
20 const char *type_name
;
23 static const psi_predef_type psi_predef_types
[] = {
26 #define psi_predef_type_count() psi_predef_count(_type)
28 typedef struct psi_predef_const
{
30 const char *type_name
;
35 static const psi_predef_const psi_predef_consts
[] = {
38 #define psi_predef_const_count() psi_predef_count(_const)
40 typedef struct psi_predef_struct_member
{
42 const char *type_name
;
48 } psi_predef_struct_member
;
49 #define PSI_PREDEF_STRUCT_MEMBERS 32
50 typedef struct psi_predef_struct
{
53 psi_predef_struct_member members
[PSI_PREDEF_STRUCT_MEMBERS
];
55 static const psi_predef_struct psi_predef_structs
[] = {
58 #define psi_predef_struct_count() psi_predef_count(_struct)
62 typedef struct psi_predef_func
{
66 static psi_predef_func psi_predef_funcs
[] = {
69 #define psi_predef_func_count() psi_predef_count(_func)
71 static int validate_lib(PSI_Data
*data
, void **dlopened
) {
73 const char *ptr
= data
->psi
.file
.ln
;
77 /* FIXME: assume stdlib */
79 } else if (!strchr(ptr
, '/')) {
80 len
= snprintf(lib
, MAXPATHLEN
, "lib%s.%s", ptr
, PHP_PSI_SHLIB_SUFFIX
);
81 if (MAXPATHLEN
== len
) {
82 data
->error(PSI_WARNING
, "Library name too long: '%s'", ptr
);
87 if (!(*dlopened
= dlopen(ptr
, RTLD_LAZY
|RTLD_LOCAL
))) {
88 data
->error(PSI_WARNING
, "Could not open library '%s': %s.",
89 data
->psi
.file
.ln
, dlerror());
95 static inline int locate_decl_type_alias(decl_typedefs
*defs
, decl_type
*type
) {
101 for (i
= 0; i
< defs
->count
; ++i
) {
102 if (!strcmp(defs
->list
[i
]->alias
, type
->name
)) {
103 type
->real
= defs
->list
[i
]->type
;
109 static inline int locate_decl_type_struct(decl_structs
*structs
, decl_type
*type
) {
115 for (i
= 0; i
< structs
->count
; ++i
) {
116 if (!strcmp(structs
->list
[i
]->name
, type
->name
)) {
117 type
->strct
= structs
->list
[i
];
124 static inline int validate_decl_type(PSI_Data
*data
, decl_type
*type
) {
125 switch (type
->type
) {
127 if (!data
->defs
|| !locate_decl_type_alias(data
->defs
, type
)) {
130 return validate_decl_type(data
, type
->real
);
132 if (!data
->structs
|| !locate_decl_type_struct(data
->structs
, type
)) {
139 static inline int validate_decl_typedef(PSI_Data
*data
, decl_typedef
*def
) {
140 if (!validate_decl_type(data
, def
->type
)) {
141 data
->error(PSI_WARNING
, "Type '%s' cannot be aliased to '%s'",
142 def
->type
->name
, def
->alias
);
145 /* FIXME: check def->alias */
149 static inline int validate_constant(PSI_Data
*data
, constant
*c
) {
154 static inline int validate_decl_arg(PSI_Data
*data
, decl_arg
*arg
) {
155 if (!validate_decl_type(data
, arg
->type
)) {
156 data
->error(PSI_WARNING
, "Cannot use '%s' as type for '%s'",
157 arg
->type
->name
, arg
->var
->name
);
163 static inline int validate_decl_struct(PSI_Data
*data
, decl_struct
*s
) {
166 for (i
= 0; i
< s
->args
->count
; ++i
) {
167 if (!validate_decl_arg(data
, s
->args
->args
[i
])) {
172 for (i
= 0; i
< s
->args
->count
; ++i
) {
173 decl_arg
*darg
= s
->args
->args
[i
];
175 if (!validate_decl_arg(data
, darg
)) {
179 ZEND_ASSERT(!darg
->var
->arg
|| darg
->var
->arg
== darg
);
180 darg
->var
->arg
= darg
;
185 if (darg
->var
->pointer_level
&& (!darg
->var
->array_size
|| darg
->var
->pointer_level
== 1)) {
188 t
= real_decl_type(darg
->type
)->type
;
192 decl_arg
*last
= s
->args
->args
[i
-1];
193 darg
->layout
= init_decl_struct_layout(
194 psi_t_align(t
, last
->layout
->pos
+ last
->layout
->len
),
195 psi_t_size(t
) * darg
->var
->array_size
);
197 darg
->layout
= init_decl_struct_layout(0, psi_t_size(t
));
200 if (s
->size
< darg
->layout
->pos
+ darg
->layout
->len
) {
201 s
->size
= darg
->layout
->pos
+ darg
->layout
->len
;
207 static const char * const abi_ccs
[] = {
209 "extern", /* > - all the same */
214 static inline int validate_decl_abi(PSI_Data
*data
, decl_abi
*abi
) {
217 for (i
= 0; i
< sizeof(abi_ccs
)/sizeof(char*); ++i
) {
218 if (strcasecmp(abi
->convention
, abi_ccs
[i
])) {
222 data
->error(PSI_WARNING
, "Invalid calling convention: '%s'", abi
->convention
);
225 static inline int validate_decl_func(PSI_Data
*data
, void *dl
, decl
*decl
, decl_arg
*func
)
227 if (!strcmp(func
->var
->name
, "dlsym")) {
228 data
->error(PSI_WARNING
, "Cannot dlsym dlsym (sic!)");
232 if (!validate_decl_arg(data
, func
)) {
236 # define RTLD_NEXT ((void *) -1l)
238 decl
->call
.sym
= dlsym(dl
?: RTLD_NEXT
, func
->var
->name
);
239 if (!decl
->call
.sym
) {
242 for (i
= 0; i
< psi_predef_func_count(); ++i
) {
243 psi_predef_func
*pre
= &psi_predef_funcs
[i
];
245 if (!strcmp(func
->var
->name
, pre
->name
)) {
246 decl
->call
.sym
= pre
->func
;
250 if (!decl
->call
.sym
) {
251 data
->error(PSI_WARNING
, "Failed to locate symbol '%s': %s",
252 func
->var
->name
, dlerror());
258 static inline int validate_decl(PSI_Data
*data
, void *dl
, decl
*decl
) {
259 if (!validate_decl_abi(data
, decl
->abi
)) {
262 if (!validate_decl_func(data
, dl
, decl
, decl
->func
)) {
268 for (i
= 0; i
< decl
->args
->count
; ++i
) {
269 if (!validate_decl_arg(data
, decl
->args
->args
[i
])) {
277 static inline decl_arg
*locate_struct_member(decl_struct
*s
, decl_var
*var
) {
281 for (i
= 0; i
< s
->args
->count
; ++i
) {
282 decl_arg
*darg
= s
->args
->args
[i
];
284 if (!strcmp(var
->name
, darg
->var
->name
)) {
285 return var
->arg
= darg
;
291 static inline int validate_set_value(PSI_Data
*data
, set_value
*set
, decl_arg
*ref
) {
293 decl_type
*ref_type
= real_decl_type(ref
->type
);
294 decl_var
*set_var
= set
->vars
->vars
[0];
296 switch (set
->func
->type
) {
298 set
->func
->handler
= psi_to_bool
;
301 set
->func
->handler
= psi_to_int
;
304 set
->func
->handler
= psi_to_double
;
306 case PSI_T_TO_STRING
:
307 set
->func
->handler
= psi_to_string
;
310 set
->func
->handler
= psi_to_array
;
312 EMPTY_SWITCH_DEFAULT_CASE();
315 if (strcmp(set_var
->name
, ref
->var
->name
)) {
319 if (set
->count
&& (set
->func
->type
!= PSI_T_TO_ARRAY
|| ref_type
->type
!= PSI_T_STRUCT
)) {
320 data
->error(E_WARNING
, "Inner `set` statement casts only work with to_array() casts on structs");
323 for (i
= 0; i
< set
->count
; ++i
) {
324 decl_var
*sub_var
= set
->inner
[i
]->vars
->vars
[0];
325 decl_arg
*sub_ref
= locate_struct_member(ref_type
->strct
, sub_var
);
328 if (!validate_set_value(data
, set
->inner
[i
], sub_ref
)) {
336 static inline decl
*locate_impl_decl(decls
*decls
, return_stmt
*ret
) {
339 for (i
= 0; i
< decls
->count
; ++i
) {
340 if (!strcmp(decls
->list
[i
]->func
->var
->name
, ret
->set
->vars
->vars
[0]->name
)) {
341 ret
->decl
= decls
->list
[i
]->func
;
342 return decls
->list
[i
];
347 static inline int validate_impl_ret_stmt(PSI_Data
*data
, impl
*impl
) {
350 /* we must have exactly one ret stmt delcaring the native func to call */
351 /* and which type cast to apply */
352 if (impl
->stmts
->ret
.count
!= 1) {
353 if (impl
->stmts
->ret
.count
> 1) {
354 data
->error(PSI_WARNING
, "Too many `return` statements for implmentation %s;"
355 " found %zu, exactly one is needed",
356 impl
->func
->name
, impl
->stmts
->ret
.count
);
358 data
->error(PSI_WARNING
, "Missing `return` statement for implementation %s",
364 ret
= impl
->stmts
->ret
.list
[0];
366 if (!(impl
->decl
= locate_impl_decl(data
->decls
, ret
))) {
367 data
->error(PSI_WARNING
, "Missing declaration for implementation %s",
372 if (!validate_set_value(data
, ret
->set
, ret
->decl
)) {
376 impl
->decl
->impl
= impl
;
380 static inline int validate_impl_let_stmts(PSI_Data
*data
, impl
*impl
) {
382 /* we can have multiple let stmts */
383 /* check that we have a let stmt for every decl arg */
384 if (impl
->decl
->args
) for (i
= 0; i
< impl
->decl
->args
->count
; ++i
) {
385 decl_arg
*darg
= impl
->decl
->args
->args
[i
];
388 for (j
= 0; j
< impl
->stmts
->let
.count
; ++j
) {
389 let_stmt
*let
= impl
->stmts
->let
.list
[j
];
391 if (!strcmp(let
->var
->name
, darg
->var
->name
)) {
398 data
->error(PSI_WARNING
, "Missing `let` statement for arg '%s %.*s%s'"
399 " of declaration '%s' for implementation '%s'",
400 darg
->type
->name
, (int) darg
->var
->pointer_level
, "*****",
401 darg
->var
->name
, impl
->decl
->func
->var
->name
, impl
->func
->name
);
405 /* check that the let_value references a known variable or NULL */
406 for (i
= 0; i
< impl
->stmts
->let
.count
; ++i
) {
407 let_stmt
*let
= impl
->stmts
->let
.list
[i
];
410 if (let
->val
&& let
->val
->func
&& let
->val
->func
->alloc
) {
411 if (!validate_decl_type(data
, let
->val
->func
->alloc
->type
)) {
412 data
->error(PSI_WARNING
, "Cannot use '%s' as type for calloc in `let` statement",
413 let
->val
->func
->alloc
->type
->name
);
417 if (let
->val
&& let
->val
->var
) {
418 if (impl
->func
->args
) for (j
= 0; j
< impl
->func
->args
->count
; ++j
) {
419 impl_arg
*iarg
= impl
->func
->args
->args
[j
];
421 if (!strcmp(let
->val
->var
->name
, iarg
->var
->name
)) {
428 data
->error(PSI_WARNING
, "Unknown value '$%s' of `let` statement"
429 " for variable '%s' of implementation '%s'",
430 let
->val
->var
->name
, let
->var
->name
, impl
->func
->name
);
437 static inline int validate_impl_set_stmts(PSI_Data
*data
, impl
*impl
) {
439 /* we can have any count of set stmts; processing out vars */
440 /* check that set stmts reference known variables */
441 for (i
= 0; i
< impl
->stmts
->set
.count
; ++i
) {
442 set_stmt
*set
= impl
->stmts
->set
.list
[i
];
445 if (impl
->func
->args
) for (j
= 0; j
< impl
->func
->args
->count
; ++j
) {
446 impl_arg
*iarg
= impl
->func
->args
->args
[j
];
448 if (!strcmp(set
->var
->name
, iarg
->var
->name
)) {
455 data
->error(PSI_WARNING
, "Unknown variable '$%s' of `set` statement"
456 " of implementation '%s'",
457 set
->var
->name
, impl
->func
->name
);
461 for (j
= 0; j
< set
->val
->vars
->count
; ++j
) {
462 decl_var
*set_var
= set
->val
->vars
->vars
[j
];
465 if (impl
->decl
->args
) for (k
= 0; k
< impl
->decl
->args
->count
; ++k
) {
466 decl_arg
*set_arg
= impl
->decl
->args
->args
[k
];
468 if (!strcmp(set_var
->name
, set_arg
->var
->name
)) {
470 if (!validate_set_value(data
, set
->val
, set_arg
)) {
473 set_var
->arg
= set_arg
;
479 data
->error(PSI_WARNING
, "Unknown value '%s' of `set` statement"
480 " for variable '$%s' of implementation '%s'",
481 set_var
->name
, set
->arg
->var
->name
, impl
->func
->name
);
488 static inline decl
*locate_free_decl(decls
*decls
, free_call
*f
) {
491 for (i
= 0; i
< decls
->count
; ++i
) {
492 if (!strcmp(decls
->list
[i
]->func
->var
->name
, f
->func
)) {
493 f
->decl
= decls
->list
[i
];
494 return decls
->list
[i
];
499 static inline int validate_impl_free_stmts(PSI_Data
*data
, impl
*impl
) {
501 /* we can have any count of free stmts; freeing any out vars */
502 for (i
= 0; i
< impl
->stmts
->fre
.count
; ++i
) {
503 free_stmt
*fre
= impl
->stmts
->fre
.list
[i
];
505 for (j
= 0; j
< fre
->calls
->count
; ++j
) {
506 free_call
*free_call
= fre
->calls
->list
[j
];
508 /* first find the decl of the free func */
509 if (!locate_free_decl(data
->decls
, free_call
)) {
510 data
->error(PSI_WARNING
, "Unknown function '%s' in `free` statement"
511 " of implementation '%s'", free_call
->func
, impl
->func
->name
);
514 if (!impl
->decl
->args
) {
515 data
->error(PSI_WARNING
, "Declaration '%s' of implementation '%s'"
516 " does not have any arguments to free",
517 impl
->decl
->func
->var
->name
, impl
->func
->name
);
520 /* now check for known vars */
521 for (l
= 0; l
< free_call
->vars
->count
; ++l
) {
523 decl_var
*free_var
= free_call
->vars
->vars
[l
];
525 for (k
= 0; k
< impl
->decl
->args
->count
; ++k
) {
526 decl_arg
*free_arg
= impl
->decl
->args
->args
[k
];
528 if (!strcmp(free_var
->name
, free_arg
->var
->name
)) {
530 free_var
->arg
= free_arg
;
536 data
->error(PSI_WARNING
, "Unknown variable '%s' of `free` statement"
537 " of implementation '%s'",
538 free_var
->name
, impl
->func
->name
);
546 static inline int validate_impl_stmts(PSI_Data
*data
, impl
*impl
) {
548 data
->error(PSI_WARNING
, "Missing body for implementation %s!",
553 if (!validate_impl_ret_stmt(data
, impl
)) {
557 if (!validate_impl_let_stmts(data
, impl
)) {
560 if (!validate_impl_set_stmts(data
, impl
)) {
563 if (!validate_impl_free_stmts(data
, impl
)) {
570 PSI_Context
*PSI_ContextInit(PSI_Context
*C
, PSI_ContextOps
*ops
, PSI_ContextErrorFunc error
)
576 C
= malloc(sizeof(*C
));
578 memset(C
, 0, sizeof(*C
));
587 ZEND_ASSERT(ops
->call
!= NULL
);
588 ZEND_ASSERT(ops
->compile
!= NULL
);
590 /* build up predefs in a temporary PSI_Data for validation */
591 memset(&T
, 0, sizeof(T
));
594 for (i
= 0; i
< psi_predef_type_count(); ++i
) {
595 const psi_predef_type
*pre
= &psi_predef_types
[i
];
596 decl_type
*type
= init_decl_type(pre
->type_tag
, pre
->type_name
);
597 decl_typedef
*def
= init_decl_typedef(pre
->alias
, type
);
599 T
.defs
= add_decl_typedef(T
.defs
, def
);
601 for (i
= 0; i
< psi_predef_const_count(); ++i
) {
602 const psi_predef_const
*pre
= &psi_predef_consts
[i
];
603 impl_def_val
*val
= init_impl_def_val(pre
->val_type_tag
, pre
->val_text
);
604 const_type
*type
= init_const_type(pre
->type_tag
, pre
->type_name
);
605 constant
*constant
= init_constant(type
, pre
->name
, val
);
607 T
.consts
= add_constant(T
.consts
, constant
);
609 for (i
= 0; i
< psi_predef_struct_count(); ++i
) {
610 const psi_predef_struct
*pre
= &psi_predef_structs
[i
];
611 decl_args
*dargs
= init_decl_args(NULL
);
612 decl_struct
*dstruct
;
614 for (j
= 0; j
< PSI_PREDEF_STRUCT_MEMBERS
; ++j
) {
615 const psi_predef_struct_member
*member
= &pre
->members
[j
];
624 type
= init_decl_type(member
->type_tag
, member
->type_name
);
625 dvar
= init_decl_var(member
->name
, member
->pointer_level
, member
->array_size
);
626 darg
= init_decl_arg(type
, dvar
);
627 darg
->layout
= init_decl_struct_layout(member
->off
, member
->len
);
628 dargs
= add_decl_arg(dargs
, darg
);
631 dstruct
= init_decl_struct(pre
->name
, dargs
);
632 dstruct
->size
= pre
->size
;
633 T
.structs
= add_decl_struct(T
.structs
, dstruct
);
636 for (i
= 0; i
< psi_predef_type_count(); ++i
) {
637 decl_typedef
*def
= T
.defs
->list
[i
];
639 if (validate_decl_typedef(&T
, def
)) {
640 C
->defs
= add_decl_typedef(C
->defs
, def
);
644 for (i
= 0; i
< psi_predef_const_count(); ++i
) {
645 constant
*constant
= T
.consts
->list
[i
];
647 if (validate_constant(&T
, constant
)) {
648 C
->consts
= add_constant(C
->consts
, constant
);
652 for (i
= 0; i
< psi_predef_struct_count(); ++i
) {
653 decl_struct
*dstruct
= T
.structs
->list
[i
];
655 if (validate_decl_struct(&T
, dstruct
)) {
656 C
->structs
= add_decl_struct(C
->structs
, dstruct
);
661 C
->data
= malloc(sizeof(*C
->data
));
662 PSI_DataExchange(C
->data
, &T
);
667 int PSI_ContextValidate(PSI_Context
*C
, PSI_Parser
*P
)
670 void *dlopened
= NULL
;
671 size_t count
= C
->count
++;
673 C
->data
= realloc(C
->data
, C
->count
* sizeof(*C
->data
));
674 D
= PSI_DataExchange(&C
->data
[count
], PSI_DATA(P
));
679 for (i
= 0; i
< D
->defs
->count
; ++i
) {
680 if (validate_decl_typedef(PSI_DATA(C
), D
->defs
->list
[i
])) {
681 C
->defs
= add_decl_typedef(C
->defs
, D
->defs
->list
[i
]);
688 for (i
= 0; i
< D
->structs
->count
; ++i
) {
689 if (validate_decl_struct(PSI_DATA(C
), D
->structs
->list
[i
])) {
690 C
->structs
= add_decl_struct(C
->structs
, D
->structs
->list
[i
]);
697 for (i
= 0; i
< D
->consts
->count
; ++i
) {
698 if (validate_constant(PSI_DATA(C
), D
->consts
->list
[i
])) {
699 C
->consts
= add_constant(C
->consts
, D
->consts
->list
[i
]);
704 if (!validate_lib(D
, &dlopened
)) {
708 add_decl_lib(&C
->psi
.libs
, dlopened
);
713 for (i
= 0; i
< D
->decls
->count
; ++i
) {
714 if (validate_decl(PSI_DATA(C
), dlopened
, D
->decls
->list
[i
])) {
715 C
->decls
= add_decl(C
->decls
, D
->decls
->list
[i
]);
722 for (i
= 0; i
< D
->impls
->count
; ++i
) {
723 if (validate_impl_stmts(PSI_DATA(C
), D
->impls
->list
[i
])) {
724 C
->impls
= add_impl(C
->impls
, D
->impls
->list
[i
]);
732 static int psi_select_dirent(const struct dirent
*entry
)
735 #define FNM_CASEFOLD 0
737 return 0 == fnmatch("*.psi", entry
->d_name
, FNM_CASEFOLD
);
740 void PSI_ContextBuild(PSI_Context
*C
, const char *paths
)
743 char *sep
= NULL
, *cpy
= strdup(paths
), *ptr
= cpy
;
744 struct dirent
**entries
= NULL
;
748 sep
= strchr(ptr
, ':');
754 n
= php_scandir(ptr
, &entries
, psi_select_dirent
, alphasort
);
757 for (i
= 0; i
< n
; ++i
) {
758 char psi
[MAXPATHLEN
];
761 if (MAXPATHLEN
<= slprintf(psi
, MAXPATHLEN
, "%s/%s", ptr
, entries
[i
]->d_name
)) {
762 C
->error(PSI_WARNING
, "Path to PSI file too long: %s/%s",
763 ptr
, entries
[i
]->d_name
);
765 if (!PSI_ParserInit(&P
, psi
, C
->error
, 0)) {
766 C
->error(PSI_WARNING
, "Failed to init PSI parser (%s): %s",
767 psi
, strerror(errno
));
771 while (-1 != PSI_ParserScan(&P
)) {
772 PSI_ParserParse(&P
, PSI_TokenAlloc(&P
));
774 PSI_ParserParse(&P
, NULL
);
775 PSI_ContextValidate(C
, &P
);
781 for (i
= 0; i
< n
; ++i
) {
791 if (PSI_ContextCompile(C
) && SUCCESS
!= zend_register_functions(NULL
, C
->closures
, NULL
, MODULE_PERSISTENT
)) {
792 C
->error(PSI_WARNING
, "Failed to register functions!");
799 zend_function_entry
*PSI_ContextCompile(PSI_Context
*C
)
806 zc
.flags
= CONST_PERSISTENT
|CONST_CS
;
807 zc
.module_number
= EG(current_module
)->module_number
;
809 for (i
= 0; i
< C
->consts
->count
; ++i
) {
810 constant
*c
= C
->consts
->list
[i
];
812 zc
.name
= zend_string_init(c
->name
+ (c
->name
[0] == '\\'), strlen(c
->name
) - (c
->name
[0] == '\\'), 1);
813 ZVAL_NEW_STR(&zc
.value
, zend_string_init(c
->val
->text
, strlen(c
->val
->text
), 1));
815 switch (c
->type
->type
) {
817 convert_to_boolean(&zc
.value
);
820 convert_to_long(&zc
.value
);
823 convert_to_double(&zc
.value
);
826 zend_register_constant(&zc
);
830 return C
->closures
= C
->ops
->compile(C
);
834 void PSI_ContextCall(PSI_Context
*C
, impl_val
*ret_val
, decl
*decl
)
836 C
->ops
->call(C
, ret_val
, decl
);
839 void PSI_ContextDtor(PSI_Context
*C
)
842 zend_function_entry
*zfe
;
848 free_decl_libs(&C
->psi
.libs
);
850 for (i
= 0; i
< C
->count
; ++i
) {
851 PSI_DataDtor(&C
->data
[i
]);
855 for (zfe
= C
->closures
; zfe
->fname
; ++zfe
) {
856 free((void *) zfe
->arg_info
);
861 if (C
->consts
->list
) {
862 free(C
->consts
->list
);
873 if (C
->structs
->list
) {
874 free(C
->structs
->list
);
879 if (C
->decls
->list
) {
880 free(C
->decls
->list
);
885 if (C
->impls
->list
) {
886 free(C
->impls
->list
);
891 memset(C
, 0, sizeof(*C
));
894 void PSI_ContextFree(PSI_Context
**C
)