1 /* Copyright (C) 2001, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
25 #include "instructions.h"
28 #include "procprop.h" /* scm_sym_name */
29 #include "srcprop.h" /* scm_sym_filename */
33 static SCM write_program
= SCM_BOOL_F
;
35 SCM_DEFINE (scm_make_program
, "make-program", 1, 2, 0,
36 (SCM objcode
, SCM objtable
, SCM free_variables
),
38 #define FUNC_NAME s_scm_make_program
40 SCM_VALIDATE_OBJCODE (1, objcode
);
41 if (SCM_UNLIKELY (SCM_UNBNDP (objtable
)))
42 objtable
= SCM_BOOL_F
;
43 else if (scm_is_true (objtable
))
44 SCM_VALIDATE_VECTOR (2, objtable
);
46 if (SCM_UNBNDP (free_variables
) || scm_is_false (free_variables
))
48 SCM ret
= scm_words (scm_tc7_program
, 3);
49 SCM_SET_CELL_OBJECT_1 (ret
, objcode
);
50 SCM_SET_CELL_OBJECT_2 (ret
, objtable
);
57 SCM_VALIDATE_VECTOR (3, free_variables
);
58 len
= scm_c_vector_length (free_variables
);
59 if (SCM_UNLIKELY (len
>> 16))
60 SCM_OUT_OF_RANGE (3, free_variables
);
61 ret
= scm_words (scm_tc7_program
| (len
<<16), 3 + len
);
62 SCM_SET_CELL_OBJECT_1 (ret
, objcode
);
63 SCM_SET_CELL_OBJECT_2 (ret
, objtable
);
64 for (i
= 0; i
< len
; i
++)
65 SCM_SET_CELL_OBJECT (ret
, 3+i
,
66 SCM_SIMPLE_VECTOR_REF (free_variables
, i
));
72 SCM_DEFINE (scm_make_rtl_program
, "make-rtl-program", 1, 2, 0,
73 (SCM bytevector
, SCM byte_offset
, SCM free_variables
),
75 #define FUNC_NAME s_scm_make_rtl_program
80 if (!scm_is_bytevector (bytevector
))
81 scm_wrong_type_arg (FUNC_NAME
, 1, bytevector
);
82 if (SCM_UNBNDP (byte_offset
))
86 offset
= scm_to_uint32 (byte_offset
);
87 if (offset
> SCM_BYTEVECTOR_LENGTH (bytevector
))
88 SCM_OUT_OF_RANGE (2, byte_offset
);
91 code
= (scm_t_uint8
*) SCM_BYTEVECTOR_CONTENTS (bytevector
) + offset
;
92 if (((scm_t_uintptr
) code
) % 4)
93 SCM_OUT_OF_RANGE (2, byte_offset
);
95 if (SCM_UNBNDP (free_variables
) || scm_is_false (free_variables
))
96 return scm_cell (scm_tc7_rtl_program
, (scm_t_bits
) code
);
102 SCM_DEFINE (scm_rtl_program_code
, "rtl-program-code", 1, 0, 0,
105 #define FUNC_NAME s_scm_rtl_program_code
107 SCM_VALIDATE_RTL_PROGRAM (1, program
);
109 /* FIXME: we need scm_from_uintptr (). */
110 return scm_from_size_t ((size_t) SCM_RTL_PROGRAM_CODE (program
));
115 scm_i_rtl_program_name (SCM program
)
117 static SCM rtl_program_name
= SCM_BOOL_F
;
119 if (SCM_PRIMITIVE_P (program
))
120 return SCM_SUBR_NAME (program
);
122 if (scm_is_false (rtl_program_name
) && scm_module_system_booted_p
)
124 scm_c_private_variable ("system vm program", "rtl-program-name");
126 return scm_call_1 (scm_variable_ref (rtl_program_name
), program
);
130 scm_i_rtl_program_documentation (SCM program
)
132 static SCM rtl_program_documentation
= SCM_BOOL_F
;
134 if (SCM_PRIMITIVE_P (program
))
137 if (scm_is_false (rtl_program_documentation
) && scm_module_system_booted_p
)
138 rtl_program_documentation
=
139 scm_c_private_variable ("system vm program",
140 "rtl-program-documentation");
142 return scm_call_1 (scm_variable_ref (rtl_program_documentation
), program
);
146 scm_i_rtl_program_properties (SCM program
)
148 static SCM rtl_program_properties
= SCM_BOOL_F
;
150 if (SCM_PRIMITIVE_P (program
))
152 SCM name
= scm_i_rtl_program_name (program
);
153 if (scm_is_false (name
))
155 return scm_acons (scm_sym_name
, name
, SCM_EOL
);
158 if (scm_is_false (rtl_program_properties
) && scm_module_system_booted_p
)
159 rtl_program_properties
=
160 scm_c_private_variable ("system vm program", "rtl-program-properties");
162 return scm_call_1 (scm_variable_ref (rtl_program_properties
), program
);
166 scm_i_program_print (SCM program
, SCM port
, scm_print_state
*pstate
)
168 static int print_error
= 0;
170 if (scm_is_false (write_program
) && scm_module_system_booted_p
)
171 write_program
= scm_c_private_variable ("system vm program",
174 if (SCM_PROGRAM_IS_CONTINUATION (program
))
177 scm_puts_unlocked ("#<continuation ", port
);
178 scm_uintprint (SCM_UNPACK (program
), 16, port
);
179 scm_putc_unlocked ('>', port
);
181 else if (SCM_PROGRAM_IS_PARTIAL_CONTINUATION (program
))
184 scm_puts_unlocked ("#<partial-continuation ", port
);
185 scm_uintprint (SCM_UNPACK (program
), 16, port
);
186 scm_putc_unlocked ('>', port
);
188 else if (scm_is_false (write_program
) || print_error
)
190 if (SCM_RTL_PROGRAM_P (program
))
192 scm_puts_unlocked ("#<rtl-program ", port
);
193 scm_uintprint (SCM_UNPACK (program
), 16, port
);
194 scm_putc_unlocked (' ', port
);
195 scm_uintprint ((scm_t_uintptr
) SCM_RTL_PROGRAM_CODE (program
), 16, port
);
196 scm_putc_unlocked ('>', port
);
200 scm_puts_unlocked ("#<program ", port
);
201 scm_uintprint (SCM_UNPACK (program
), 16, port
);
202 scm_putc_unlocked ('>', port
);
208 scm_call_2 (SCM_VARIABLE_REF (write_program
), program
, port
);
218 SCM_DEFINE (scm_program_p
, "program?", 1, 0, 0,
221 #define FUNC_NAME s_scm_program_p
223 return scm_from_bool (SCM_PROGRAM_P (obj
));
227 SCM_DEFINE (scm_rtl_program_p
, "rtl-program?", 1, 0, 0,
230 #define FUNC_NAME s_scm_rtl_program_p
232 return scm_from_bool (SCM_RTL_PROGRAM_P (obj
));
236 SCM_DEFINE (scm_primitive_p
, "primitive?", 1, 0, 0,
239 #define FUNC_NAME s_scm_primitive_p
241 return scm_from_bool (SCM_PRIMITIVE_P (obj
));
245 SCM_DEFINE (scm_primitive_call_ip
, "primitive-call-ip", 1, 0, 0,
248 #define FUNC_NAME s_scm_primitive_p
250 SCM_MAKE_VALIDATE (1, prim
, PRIMITIVE_P
);
252 return scm_from_int (scm_i_primitive_call_ip (prim
));
256 SCM_DEFINE (scm_program_base
, "program-base", 1, 0, 0,
259 #define FUNC_NAME s_scm_program_base
261 const struct scm_objcode
*c_objcode
;
263 SCM_VALIDATE_PROGRAM (1, program
);
265 c_objcode
= SCM_PROGRAM_DATA (program
);
266 return scm_from_unsigned_integer ((scm_t_bits
) SCM_C_OBJCODE_BASE (c_objcode
));
270 SCM_DEFINE (scm_program_objects
, "program-objects", 1, 0, 0,
273 #define FUNC_NAME s_scm_program_objects
275 SCM_VALIDATE_PROGRAM (1, program
);
276 return SCM_PROGRAM_OBJTABLE (program
);
280 SCM_DEFINE (scm_program_module
, "program-module", 1, 0, 0,
283 #define FUNC_NAME s_scm_program_module
286 SCM_VALIDATE_PROGRAM (1, program
);
287 objs
= SCM_PROGRAM_OBJTABLE (program
);
288 /* If a program is the result of compiling GLIL to assembly, then if
289 it has an objtable, the first entry will be a module. But some
290 programs are hand-coded trampolines, like boot programs and
291 primitives and the like. So if a program happens to have a
292 non-module in the first slot of the objtable, assume that it is
293 such a trampoline, and just return #f for the module. */
294 mod
= scm_is_true (objs
) ? scm_c_vector_ref (objs
, 0) : SCM_BOOL_F
;
295 return SCM_MODULEP (mod
) ? mod
: SCM_BOOL_F
;
299 SCM_DEFINE (scm_program_meta
, "program-meta", 1, 0, 0,
302 #define FUNC_NAME s_scm_program_meta
306 SCM_VALIDATE_PROGRAM (1, program
);
308 metaobj
= scm_objcode_meta (SCM_PROGRAM_OBJCODE (program
));
309 if (scm_is_true (metaobj
))
310 return scm_make_program (metaobj
, SCM_PROGRAM_OBJTABLE (program
),
317 SCM_DEFINE (scm_program_bindings
, "program-bindings", 1, 0, 0,
320 #define FUNC_NAME s_scm_program_bindings
324 SCM_VALIDATE_PROGRAM (1, program
);
326 meta
= scm_program_meta (program
);
327 if (scm_is_false (meta
))
330 return scm_car (scm_call_0 (meta
));
334 SCM_DEFINE (scm_program_sources
, "%program-sources", 1, 0, 0,
337 #define FUNC_NAME s_scm_program_sources
339 SCM meta
, sources
, ret
, filename
;
341 SCM_VALIDATE_PROGRAM (1, program
);
343 meta
= scm_program_meta (program
);
344 if (scm_is_false (meta
))
347 filename
= SCM_BOOL_F
;
349 for (sources
= scm_cadr (scm_call_0 (meta
)); !scm_is_null (sources
);
350 sources
= scm_cdr (sources
))
352 SCM x
= scm_car (sources
);
355 if (scm_is_number (scm_car (x
)))
357 SCM addr
= scm_car (x
);
358 ret
= scm_acons (addr
, scm_cons (filename
, scm_cdr (x
)),
361 else if (scm_is_eq (scm_car (x
), scm_sym_filename
))
362 filename
= scm_cdr (x
);
365 return scm_reverse_x (ret
, SCM_UNDEFINED
);
369 SCM_DEFINE (scm_program_arities
, "program-arities", 1, 0, 0,
372 #define FUNC_NAME s_scm_program_arities
376 SCM_VALIDATE_PROGRAM (1, program
);
378 meta
= scm_program_meta (program
);
379 if (scm_is_false (meta
))
382 return scm_caddr (scm_call_0 (meta
));
387 scm_i_program_properties (SCM program
)
388 #define FUNC_NAME "%program-properties"
392 SCM_VALIDATE_PROGRAM (1, program
);
394 meta
= scm_program_meta (program
);
395 if (scm_is_false (meta
))
398 return scm_cdddr (scm_call_0 (meta
));
403 scm_program_source (SCM program
, SCM ip
, SCM sources
)
405 static SCM program_source
= SCM_BOOL_F
;
407 if (scm_is_false (program_source
)) {
408 if (!scm_module_system_booted_p
)
412 scm_c_private_variable ("system vm program", "program-source");
415 if (SCM_UNBNDP (sources
))
416 return scm_call_2 (scm_variable_ref (program_source
), program
, ip
);
418 return scm_call_3 (scm_variable_ref (program_source
), program
, ip
, sources
);
421 SCM_DEFINE (scm_program_num_free_variables
, "program-num-free-variables", 1, 0, 0,
424 #define FUNC_NAME s_scm_program_num_free_variables
426 if (SCM_RTL_PROGRAM_P (program
)) {
427 return scm_from_ulong (SCM_RTL_PROGRAM_NUM_FREE_VARIABLES (program
));
430 SCM_VALIDATE_PROGRAM (1, program
);
431 return scm_from_ulong (SCM_PROGRAM_NUM_FREE_VARIABLES (program
));
435 SCM_DEFINE (scm_program_free_variable_ref
, "program-free-variable-ref", 2, 0, 0,
436 (SCM program
, SCM i
),
438 #define FUNC_NAME s_scm_program_free_variable_ref
442 if (SCM_RTL_PROGRAM_P (program
)) {
443 SCM_VALIDATE_ULONG_COPY (2, i
, idx
);
444 if (idx
>= SCM_RTL_PROGRAM_NUM_FREE_VARIABLES (program
))
445 SCM_OUT_OF_RANGE (2, i
);
446 return SCM_RTL_PROGRAM_FREE_VARIABLE_REF (program
, idx
);
449 SCM_VALIDATE_PROGRAM (1, program
);
450 SCM_VALIDATE_ULONG_COPY (2, i
, idx
);
451 if (idx
>= SCM_PROGRAM_NUM_FREE_VARIABLES (program
))
452 SCM_OUT_OF_RANGE (2, i
);
453 return SCM_PROGRAM_FREE_VARIABLE_REF (program
, idx
);
457 SCM_DEFINE (scm_program_free_variable_set_x
, "program-free-variable-set!", 3, 0, 0,
458 (SCM program
, SCM i
, SCM x
),
460 #define FUNC_NAME s_scm_program_free_variable_set_x
464 if (SCM_RTL_PROGRAM_P (program
)) {
465 SCM_VALIDATE_ULONG_COPY (2, i
, idx
);
466 if (idx
>= SCM_RTL_PROGRAM_NUM_FREE_VARIABLES (program
))
467 SCM_OUT_OF_RANGE (2, i
);
468 SCM_RTL_PROGRAM_FREE_VARIABLE_SET (program
, idx
, x
);
469 return SCM_UNSPECIFIED
;
472 SCM_VALIDATE_PROGRAM (1, program
);
473 SCM_VALIDATE_ULONG_COPY (2, i
, idx
);
474 if (idx
>= SCM_PROGRAM_NUM_FREE_VARIABLES (program
))
475 SCM_OUT_OF_RANGE (2, i
);
476 SCM_PROGRAM_FREE_VARIABLE_SET (program
, idx
, x
);
477 return SCM_UNSPECIFIED
;
481 SCM_DEFINE (scm_program_objcode
, "program-objcode", 1, 0, 0,
483 "Return a @var{program}'s object code.")
484 #define FUNC_NAME s_scm_program_objcode
486 SCM_VALIDATE_PROGRAM (1, program
);
488 return SCM_PROGRAM_OBJCODE (program
);
492 /* procedure-minimum-arity support. */
494 parse_arity (SCM arity
, int *req
, int *opt
, int *rest
)
496 SCM x
= scm_cddr (arity
);
500 *req
= scm_to_int (scm_car (x
));
504 *opt
= scm_to_int (scm_car (x
));
507 *rest
= scm_is_true (scm_car (x
));
515 *req
= *opt
= *rest
= 0;
519 scm_i_rtl_program_minimum_arity (SCM program
, int *req
, int *opt
, int *rest
)
521 static SCM rtl_program_minimum_arity
= SCM_BOOL_F
;
524 if (SCM_PRIMITIVE_P (program
))
525 return scm_i_primitive_arity (program
, req
, opt
, rest
);
527 if (SCM_PROGRAM_IS_FOREIGN (program
))
528 return scm_i_foreign_arity (program
, req
, opt
, rest
);
530 if (SCM_PROGRAM_IS_CONTINUATION (program
))
537 if (scm_is_false (rtl_program_minimum_arity
) && scm_module_system_booted_p
)
538 rtl_program_minimum_arity
=
539 scm_c_private_variable ("system vm program",
540 "rtl-program-minimum-arity");
542 l
= scm_call_1 (scm_variable_ref (rtl_program_minimum_arity
), program
);
543 if (scm_is_false (l
))
546 *req
= scm_to_int (scm_car (l
));
547 *opt
= scm_to_int (scm_cadr (l
));
548 *rest
= scm_is_true (scm_caddr (l
));
554 scm_i_program_arity (SCM program
, int *req
, int *opt
, int *rest
)
558 if (SCM_RTL_PROGRAM_P (program
))
559 return scm_i_rtl_program_minimum_arity (program
, req
, opt
, rest
);
561 arities
= scm_program_arities (program
);
562 if (!scm_is_pair (arities
))
565 parse_arity (scm_car (arities
), req
, opt
, rest
);
566 arities
= scm_cdr (arities
);
568 for (; scm_is_pair (arities
); arities
= scm_cdr (arities
))
570 int thisreq
, thisopt
, thisrest
;
572 parse_arity (scm_car (arities
), &thisreq
, &thisopt
, &thisrest
);
576 && ((thisrest
&& (!*rest
|| thisopt
> *opt
))
577 || (!thisrest
&& !*rest
&& thisopt
> *opt
))))
591 scm_bootstrap_programs (void)
593 scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION
,
595 (scm_t_extension_init_func
)scm_init_programs
, NULL
);
599 scm_init_programs (void)
601 #ifndef SCM_MAGIC_SNARFER
602 #include "libguile/programs.x"