Files
mercury/runtime/mercury_minimal_model.h
Zoltan Somogyi 9b2f51460b A bunch of improvements for minimal model tabling.
Estimated hours taken: 4
Branches: main

A bunch of improvements for minimal model tabling.

compiler/code_info.m:
	Improve the code we generate for model_non disjunctions with
	--no-allow-hijacks, which is implied by the usual (stack copy)
	version of minimal model tabling. When the top stack frame is the
	current procedure's ordinary frame, and its redoip is still do_fail,
	then use that redoip. Its use is not hijacking, because we are not
	hiding any choice from the code in runtime/mercury_minimal_model.c
	that looks for right branches in the SLD tree to prune; do_fail
	represents the ABSENCE of such a right branch.

compiler/table_gen.m:
	Instead of lying about the type of the one fixed argument of
	table_mm_answer_is_not_duplicate when hanging a foreign_proc that
	does several other things as well on that predicate, use a variant
	of that predicate with the right argument type specialized for this
	task.

library/table_builtin.m:
	Provide table_mm_answer_is_not_duplicate_shortcut.

library/table_builtin.m:
runtime/mercury_tabling.h:
	Make the implementation of table_mm_answer_is_not_duplicate be a
	foreign_proc, not hand-written code, for simpler maintenance.
	We gain no speedup from keeping it handwritten; the implementation
	isn't even used with --tabling-via-extra-args, which is now the
	default.

runtime/mercury_minimal_model.[ch]:
	Add some missing arguments on code inside a #ifdef, to make the code
	compile in dmm (debugging minimal model) grades.

runtime/mercury_tabling.[ch]:
	Fix the name of a C function in its definition, and delete Julien's
	attempt at a fix of its declaration.
2005-06-10 07:12:51 +00:00

276 lines
9.8 KiB
C

/*
** Copyright (C) 2003-2005 The 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.
*/
/*
** mercury_minimal_model.h - definitions of some basic stuff used for the stack
** copy style of minimal model tabling. For tabling code, the Mercury compiler
** (compiler/table_gen.m) generates references to special procedures defined
** in library/table_builtin.m. The types and macros defined here are used
** by the procedures defined in library/table_builtin.m.
*/
#ifndef MERCURY_MINIMAL_MODEL_H
#define MERCURY_MINIMAL_MODEL_H
#include "mercury_imp.h"
#include "mercury_tabling.h"
#include "mercury_reg_workarounds.h"
#include "mercury_goto.h" /* for MR_declare_entry */
#include <stdio.h>
#ifdef MR_USE_MINIMAL_MODEL_STACK_COPY
/*
** The saved state of a generator or a consumer. While consumers get
** suspended while they are waiting for generators to produce more solutions,
** generators need their state saved when they restore the state of a consumer
** to consume a new solution.
**
** The saved state contains copies of
**
** - several virtual machine registers:
** MR_succip, MR_sp, MR_curfr and MR_maxfr
**
** - segments of the nondet and det stacks:
** the parts that cannot possibly change between the times of saving
** and restoring the saved state are not saved.
**
** The segments are described by three fields each. The *_real_start
** field gives the address of the first word in the real stack
** that is part of the saved segment, the *_block_size field
** gives the size of the saved segment in words, and the *_saved_block
** field points to the area of memory containing the saved segment.
**
** - the entire generator stack and the entire cut stack:
** they are usually so small, it is faster to save them all
** than to figure out which parts need saving.
**
** Each stack is described by its size in words and a pointer to
** an area of memory containing the entire saved stack.
*/
typedef struct {
MR_Code *MR_ss_succ_ip;
MR_Word *MR_ss_s_p;
MR_Word *MR_ss_cur_fr;
MR_Word *MR_ss_max_fr;
MR_Word *MR_ss_common_ancestor_fr;
MR_Integer MR_ss_gen_sp;
MR_Word *MR_ss_non_stack_real_start;
MR_Integer MR_ss_non_stack_block_size;
MR_Word *MR_ss_non_stack_saved_block;
MR_Word *MR_ss_det_stack_real_start;
MR_Integer MR_ss_det_stack_block_size;
MR_Word *MR_ss_det_stack_saved_block;
MR_Integer MR_ss_gen_stack_real_start;
MR_Integer MR_ss_gen_stack_block_size;
MR_GenStackFrame *MR_ss_gen_stack_saved_block;
MR_Integer MR_ss_cut_next;
MR_CutStackFrame *MR_ss_cut_stack_saved_block;
MR_Integer MR_ss_pneg_next;
MR_PNegStackFrame *MR_ss_pneg_stack_saved_block;
#ifdef MR_MINIMAL_MODEL_DEBUG
/* to make it possible to generate more detailed debugging output */
const MR_Label_Layout *MR_ss_top_layout;
#endif
} MR_SavedState;
/*
** The state of a consumer subgoal.
**
** The subgoal field points to the generator subgoal. If it is NULL, then the
** consumer has logically been deleted.
**
** The num_returned answers field gives the number of answers returned to this
** consumer so far.
**
** The answer list fields points into the answer list of the generator
** subgoal. The list of answers it points to expands transparently whenever
** the generator subgoal adds an answer to its answer list.
*/
struct MR_Consumer_Struct {
MR_SavedState MR_cns_saved_state;
MR_Subgoal *MR_cns_subgoal;
MR_Integer MR_cns_num_returned_answers;
MR_AnswerList *MR_cns_remaining_answer_list_ptr;
};
struct MR_ConsumerListNode_Struct {
MR_Consumer *MR_cl_item;
MR_ConsumerList MR_cl_next;
};
/*
** The following structure is used to hold the state and variables used in
** the table_mm_completion procedure.
*/
typedef struct {
MR_SavedState MR_ri_leader_state;
MR_SubgoalList MR_ri_subgoal_list;
MR_Subgoal *MR_ri_cur_subgoal;
MR_ConsumerList MR_ri_consumer_list; /* for the cur subgoal */
MR_Consumer *MR_ri_cur_consumer;
MR_Code *MR_ri_saved_succip;
} MR_CompletionInfo;
struct MR_SubgoalListNode_Struct {
MR_Subgoal *MR_sl_item;
MR_SubgoalList MR_sl_next;
};
/*
** The subgoal structure represents a subgoal, i.e. a call to a minimal model
** predicate with a given set of input arguments.
**
** The MR_sg_status obviously gives the current status of the subgoal.
**
** The MR_sg_leader field points to the leader of the clique of subgoals this
** subgoal is a member of, if the leader is not the subgoal itself. If the
** subgoal is the leader of its clique, then this field will be NULL.
**
** The MR_sg_followers field lists all the subgoals that follow this one.
** Each subgoal occurs in its own followers list.
**
** The MR_sg_followers_tail field points to the NULL pointer at the tail of
** the MR_sg_followers list, to allow us to add new elements at the tail in
** constant time.
**
** The MR_sg_completion_info field, when non-NULL, points to a data structure
** containing the local variables of the algorithm executed by the builtin
** predicate table_mm_completion. The execution of that algorithm invokes
** general Mercury code and moves stack segments around many times, which
** is why its local variables cannot be stored in a stack frame.
**
** The MR_sg_answer_table field points to the trie of answers returned for
** this subgoal so far (to enable efficient checks for duplicate answers).
**
** The MR_sg_answer_list field also contains the answers so far, in a list.
** The answers will be returned to consumers in the order given by this list.
** The MR_sg_answer_list_tail field points to the NULL pointer at the tail
** of this list, to allow us to add new elements to the list at the tail in
** constant time.
**
** The MR_sg_num_ans field gives the number of answers computed so far, i.e.
** the number of answers in MR_sg_answer_table and MR_sg_answer_list.
**
** The MR_sg_consumer_list gives the list of consumer goals, with the field
** MR_sg_consumer_list_tail allowing fast appending to the end.
**
** The MR_sg_generator_fr points to the generator's nondet stack frame.
**
** The MR_sg_deepest_nca_fr points to the deepest nondet stack frame that is
** a nearest common ancestor (nca) of the generator and one of its consumers.
*/
struct MR_Subgoal_Struct {
MR_TrieNode MR_sg_back_ptr;
MR_SubgoalStatus MR_sg_status;
MR_Subgoal *MR_sg_leader;
MR_SubgoalList MR_sg_followers;
MR_SubgoalList *MR_sg_followers_tail;
MR_CompletionInfo *MR_sg_completion_info;
MR_TableNode MR_sg_answer_table;
MR_Integer MR_sg_num_ans;
MR_AnswerList MR_sg_answer_list;
MR_AnswerList *MR_sg_answer_list_tail;
MR_ConsumerList MR_sg_consumer_list;
MR_ConsumerList *MR_sg_consumer_list_tail;
MR_Word *MR_sg_generator_fr;
MR_Word *MR_sg_deepest_nca_fr;
#ifdef MR_MINIMAL_MODEL_DEBUG
const MR_Proc_Layout *MR_sg_proc_layout;
#endif
};
/*---------------------------------------------------------------------------*/
extern const MR_Proc_Layout *MR_subgoal_debug_cur_proc;
extern void MR_enter_consumer_debug(MR_Consumer *consumer);
extern MR_ConsumerDebug *MR_lookup_consumer_debug_addr(MR_Consumer *consumer);
extern MR_ConsumerDebug *MR_lookup_consumer_debug_num(int consumer_index);
extern const char *MR_consumer_debug_name(MR_ConsumerDebug *consumer_dbg);
extern const char *MR_consumer_addr_name(MR_Consumer *consumer);
extern const char *MR_consumer_num_name(int consumer_index);
extern void MR_enter_subgoal_debug(MR_Subgoal *subgoal);
extern MR_SubgoalDebug *MR_lookup_subgoal_debug_addr(MR_Subgoal *subgoal);
extern MR_SubgoalDebug *MR_lookup_subgoal_debug_num(int subgoal_index);
extern const char *MR_subgoal_debug_name(MR_SubgoalDebug *subgoal_debug);
extern const char *MR_subgoal_addr_name(MR_Subgoal *subgoal);
extern const char *MR_subgoal_num_name(int subgoal_index);
extern const char *MR_subgoal_status(MR_SubgoalStatus status);
extern void MR_print_subgoal_debug(FILE *fp,
const MR_Proc_Layout *proc,
MR_SubgoalDebug *subgoal_debug);
extern void MR_print_subgoal(FILE *fp, const MR_Proc_Layout *proc,
MR_Subgoal *subgoal);
extern void MR_print_consumer_debug(FILE *fp,
const MR_Proc_Layout *proc,
MR_ConsumerDebug *consumer_debug);
extern void MR_print_consumer(FILE *fp, const MR_Proc_Layout *proc,
MR_Consumer *consumer);
extern MR_Subgoal *MR_setup_subgoal(MR_TrieNode);
#ifdef MR_TABLE_STATISTICS
extern void MR_minimal_model_report_stats(FILE *fp);
extern int MR_minmodel_stats_cnt_dupl_check;
extern int MR_minmodel_stats_cnt_dupl_check_not_dupl;
/* XXX */
#endif
#endif /* MR_USE_MINIMAL_MODEL_STACK_COPY */
#ifdef MR_HIGHLEVEL_CODE
extern void MR_CALL
mercury__table_builtin__table_mm_completion_1_p_0(
MR_C_Pointer subgoal_table_node, MR_C_Pointer *answer_block,
MR_Cont cont, void *cont_env_ptr);
extern void MR_CALL
mercury__table_builtin__table_mm_suspend_consumer_2_p_0(
MR_C_Pointer subgoal_table_node);
extern void MR_CALL
mercury__table_builtin__table_mm_return_all_nondet_2_p_0(
MR_C_Pointer answer_list, MR_C_Pointer answer_block);
extern void MR_CALL
mercury__table_builtin__table_mm_return_all_multi_2_p_0(
MR_C_Pointer answer_list, MR_C_Pointer answer_block);
#else /* ! MR_HIGHLEVEL_CODE */
#define MR_MMSC_SUSPEND_ENTRY \
MR_proc_entry_user_name(table_builtin, \
table_mm_suspend_consumer, 2, 0)
#define MR_MMSC_COMPLETION_ENTRY \
MR_proc_entry_user_name(table_builtin, \
table_mm_completion, 1, 0)
#define MR_MMSC_RET_ALL_NONDET_ENTRY \
MR_proc_entry_user_name(table_builtin, \
table_mm_return_all_nondet, 2, 0)
#define MR_MMSC_RET_ALL_MULTI_ENTRY \
MR_proc_entry_user_name(table_builtin, \
table_mm_return_all_multi, 2, 0)
MR_declare_entry(MR_MMSC_SUSPEND_ENTRY);
MR_declare_entry(MR_MMSC_COMPLETION_ENTRY);
MR_declare_entry(MR_MMSC_RET_ALL_NONDET_ENTRY);
MR_declare_entry(MR_MMSC_RET_ALL_MULTI_ENTRY);
#endif /* !MR_HIGHLEVEL_CODE */
#endif /* MERCURY_MINIMAL_MODEL_H */