mirror of
https://github.com/Mercury-Language/mercury.git
synced 2026-04-29 16:24:43 +00:00
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).
74 lines
2.0 KiB
C
74 lines
2.0 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.
|
|
*/
|
|
|
|
/* misc.h - debugging messages, fatal_error(), and checked_malloc() */
|
|
|
|
#ifndef MISC_H
|
|
#define MISC_H
|
|
|
|
#include "mercury_types.h" /* for `Code *' */
|
|
|
|
#ifndef SPEED
|
|
|
|
extern void mkframe_msg(void);
|
|
extern void modframe_msg(void);
|
|
extern void succeed_msg(void);
|
|
extern void succeeddiscard_msg(void);
|
|
extern void fail_msg(void);
|
|
extern void redo_msg(void);
|
|
extern void call_msg(/* const */ Code *proc, /* const */ Code *succcont);
|
|
extern void tailcall_msg(/* const */ Code *proc);
|
|
extern void proceed_msg(void);
|
|
extern void cr1_msg(Word val0, const Word *addr);
|
|
extern void cr2_msg(Word val0, Word val1, const Word *addr);
|
|
extern void incr_hp_msg(Word val, const Word *addr);
|
|
extern void incr_sp_msg(Word val, const Word *addr);
|
|
extern void decr_sp_msg(Word val, const Word *addr);
|
|
extern void push_msg(Word val, const Word *addr);
|
|
extern void pop_msg(Word val, const Word *addr);
|
|
#endif
|
|
|
|
#if !defined(SPEED) || defined(DEBUG_GOTOS)
|
|
|
|
extern void goto_msg(/* const */ Code *addr);
|
|
extern void reg_msg(void);
|
|
|
|
#endif
|
|
|
|
#ifndef SPEED
|
|
|
|
extern void printint(Word n);
|
|
extern void printstring(const char *s);
|
|
extern void printheap(const Word *h);
|
|
extern void printdetstack(const Word *s);
|
|
extern void printnondstack(const Word *s);
|
|
extern void dumpframe(/* const */ Word *);
|
|
extern void dumpnondstack(void);
|
|
extern void printlist(Word p);
|
|
extern void printframe(const char *);
|
|
extern void printregs(const char *msg);
|
|
|
|
#endif
|
|
|
|
extern void printlabel(/* const */ Code *w);
|
|
|
|
#if 0 /* this used to be used for some hand-coded examples */
|
|
extern Word do_mklist(int start, int len);
|
|
#endif
|
|
|
|
#if __GNUC__
|
|
#define NO_RETURN __attribute__((noreturn))
|
|
#else
|
|
#define NO_RETURN
|
|
#endif
|
|
extern void fatal_error(const char *msg) NO_RETURN;
|
|
|
|
/* XXX checked_malloc() should be moved to memory.h or heap.h */
|
|
#include <stddef.h> /* for size_t */
|
|
void *checked_malloc(size_t n);
|
|
|
|
#endif /* MISC_H */
|