mirror of
https://github.com/Mercury-Language/mercury.git
synced 2026-04-25 06:14:18 +00:00
8520a4c88c
Estimated hours taken: 6
A general cleanup of the code in the runtime directory, aimed at
formulating a more coherent header file inclusion policy. This change
fixes a couple of bugs that prevented the runtime from compiling in
certain configurations (e.g. on muse) due to missing #includes, and
also fixes a few minor unrelated things such as the use of `size_t'
instead of `unsigned'.
Our header file inclusion policy is that every header file should
#include any other header files needed by the declarations or by the
macros it defines. Cyclic interface dependencies, where two header
files each #include the other, must be avoided (by splitting up header
files into smaller indepdent units, if necessary).
At some stage in the future we should rename all the header files to
`mercury_*.h', to avoid any possible name clashes with system or user
header files.
runtime/Mmake:
Add a new target `check_headers' to check that each
header file is syntactically valid in isolation.
runtime/imp.h:
runtime/mercury_float.h:
runtime/mercury_string.h:
runtime/mercury_types.h:
runtime/calls.h:
Move the code in "imp.h" into new header files.
"imp.h" now contains nothing but #includes.
runtime/conf.h.in:
runtime/*.h:
runtime/{label,prof,prof_mem}.c:
runtime/*.mod:
Update the #includes to reflect the new header file structure.
Add some missing header guards. Add some comments.
Put the correct years in most of the copyright notices.
runtime/heap.h:
Fix a bug: add #include "context.h", needed for
min_heap_reclamation_point.
runtime/context.h:
Fix a bug: add #include "memory.h", needed for MemoryZone.
Move the general description comment to the top of the file.
Fix the indentation of some comments. Add a couple of new comments.
runtime/context.mod:
Delete a couple of unnecessary declarations.
runtime/wrapper.mod:
Change the type used for memory sizes from `unsigned' to `size_t'.
Change the `-p' (primary cache size) option so that it is always
a size in kilobytes, rather than being schitzophrenic about
whether it is bytes or kilobytes.
runtime/regorder_base.h:
Removed, since it not used (and constitutes a
double-maintenance problem).
68 lines
2.2 KiB
C
68 lines
2.2 KiB
C
/*
|
|
** Copyright (C) 1995-1997 University of Melbourne.
|
|
** This file may only be copied under the terms of the GNU Library General
|
|
** Public License - see the file COPYING.LIB in the Mercury distribution.
|
|
*/
|
|
|
|
/*
|
|
** init.h - this file defines stuff used by the automatically generated
|
|
** _init.c files.
|
|
*/
|
|
|
|
#ifndef INIT_H
|
|
#define INIT_H
|
|
|
|
#include "goto.h" /* for Declare_entry */
|
|
#include "mercury_types.h" /* for `Code *' */
|
|
|
|
/*
|
|
** mercury_main() is defined in the <module>_init.c file.
|
|
**
|
|
** The `argc' and `argv' parameters are as for main() in C.
|
|
** The `stack_bottom' parameter should be the address of a variable
|
|
** on the C stack. The conservative garbage collector treats that
|
|
** address as the start of the stack, so anything older than that
|
|
** address won't get scanned; don't store pointers to GC'ed memory
|
|
** in local variables that are older than that.
|
|
**
|
|
** mercury_main() just does some stuff to initialize the garbage
|
|
** collector, sets some global variables, and then calls
|
|
** mercury_runtime_main().
|
|
*/
|
|
extern int mercury_main(int argc, char **argv, char *stack_bottom);
|
|
|
|
/*
|
|
** mercury_runtime_main() is defined in wrapper.mod.
|
|
** It does some stuff to initialize the garbage collector
|
|
** and the Mercury engine's data areas, and then calls call_engine()
|
|
** to start execution in the library entry point. The library
|
|
** entry point initializes the io__state and then calls the program
|
|
** entry point.
|
|
*/
|
|
extern int mercury_runtime_main(int argc, char **argv);
|
|
|
|
/*
|
|
** mercury_main() takes the address of the following predicates/functions.
|
|
*/
|
|
Declare_entry(mercury__main_2_0);
|
|
Declare_entry(mercury__io__run_0_0);
|
|
extern void mercury_init_io(void);
|
|
|
|
/*
|
|
** The following global variables are defined in wrapper.mod,
|
|
** and set by mercury_main() on startup.
|
|
** The entry points are set based on the options to mkinit.c.
|
|
** The address_of_foo pointers are set to the address of
|
|
** the corresponding foo.
|
|
*/
|
|
extern Code * library_entry_point; /* normally mercury__io__run_0_0 */
|
|
extern Code * program_entry_point; /* normally mercury__main_2_0; */
|
|
|
|
extern void (*address_of_mercury_init_io)(void);
|
|
extern void (*address_of_init_modules)(void);
|
|
#ifdef CONSERVATIVE_GC
|
|
extern void (*address_of_init_gc)(void);
|
|
#endif
|
|
|
|
#endif /* INIT_H */
|