/************************************************************************* * * * YAP Prolog %W% %G% * * * Yap Prolog was developed at NCCUP - Universidade do Porto * * * * Copyright L.Damas, V.S.Costa and Universidade do Porto 1985-1997 * * * ************************************************************************** * * * File: YAtom.h.m4 * * Last rev: 19/2/88 * * mods: * * comments: atom properties header file for YAP * * * *************************************************************************/ /* This code can only be defined *after* including Regs.h!!! */ #if USE_OFFSETS Constructor(Atom, Abs, AtomEntry *, p, Addr(p) - AtomBase) Destructor(Atom, Rep, AtomEntry *, a, AtomBase + Unsigned(a)) #else Constructor(Atom, Abs, AtomEntry *, p, p) Destructor(Atom, Rep, AtomEntry *, a, a) #endif #if USE_OFFSETS_IN_PROPS Constructor(Prop,Abs,PropEntry *,p,Addr(p)-AtomBase) Destructor(Prop,Rep,PropEntry *,p,AtomBase+Unsigned(p)) #else Constructor(Prop,Abs,PropEntry *,p,p) Destructor(Prop,Rep,PropEntry *,p,p) #endif #if USE_OFFSETS_IN_PROPS Destructor(Prop, RepFunctor, FunctorEntry *, p, AtomBase + Unsigned(p)) Constructor(Prop, AbsFunctor, FunctorEntry *, p, Addr(p)-AtomBase) #else Destructor(Prop, RepFunctor, FunctorEntry *, p, p) Constructor(Prop, AbsFunctor, FunctorEntry *, p, p) #endif Inline(ArityOfFunctor, Int, Functor, Fun, ((FunctorEntry *)Fun)->ArityOfFE) Inline(NameOfFunctor, Atom, Functor, Fun, ((FunctorEntry *)Fun)->NameOfFE) Inline(IsFunctorProperty, PropFlags, int, flags, (flags == FunctorProperty) ) /* summary of property codes used 00 00 predicate entry 80 00 db property bb 00 functor entry ff df sparse functor ff ex arithmetic property ff f7 array ff fa module property ff fb blackboard property ff fc value property ff ff op property */ /* Module property */ typedef struct { Prop NextOfPE; /* used to chain properties */ PropFlags KindOfPE; /* kind of property */ SMALLUNSGN IndexOfMod; /* indec in module table */ } ModEntry; #if USE_OFFSETS_IN_PROPS Destructor(Prop,RepMod,ModEntry *,p, AtomBase + Unsigned(p)) Constructor(Prop,AbsMod,ModEntry *,p,Addr(p)-AtomBase) #else Destructor(Prop,RepMod,ModEntry *,p,p) Constructor(Prop,AbsMod,ModEntry *,p,p) #endif #define ModProperty ((PropFlags)0xfffa) Inline(IsModProperty, PropFlags, int, flags, (flags == ModProperty)) /* operator property entry structure */ typedef struct { Prop NextOfPE; /* used to chain properties */ PropFlags KindOfPE; /* kind of property */ #if defined(YAPOR) || defined(THREADS) rwlock_t OpRWLock; /* a read-write lock to protect the entry */ #endif BITS16 Prefix, Infix, Posfix; /* precedences */ } OpEntry; #if USE_OFFSETS_IN_PROPS Destructor(Prop,RepOp,OpEntry *,p, AtomBase + Unsigned(p)) Constructor(Prop,AbsOp,OpEntry *,p,Addr(p)-AtomBase) #else Destructor(Prop,RepOp,OpEntry *,p,p) Constructor(Prop,AbsOp,OpEntry *,p,p) #endif #define OpProperty ((PropFlags)0xffff) Inline(IsOpProperty, PropFlags, int, flags, (flags == OpProperty) ) /* defines related to operator specifications */ #define MaskPrio 0x0fff #define DcrlpFlag 0x1000 #define DcrrpFlag 0x2000 typedef union arith_ret *eval_ret; /* expression property entry structure */ typedef struct { Prop NextOfPE; /* used to chain properties */ PropFlags KindOfPE; /* kind of property */ unsigned int ArityOfEE; BITS16 ENoOfEE; BITS16 FlagsOfEE; /* operations that implement the expression */ union { blob_type (*constant)(eval_ret); blob_type (*unary)(Term, eval_ret); blob_type (*binary)(Term, Term, eval_ret); } FOfEE; } ExpEntry; #if USE_OFFSETS_IN_PROPS Destructor(Prop,RepExp,ExpEntry *,p, AtomBase + Unsigned(p)) Constructor(Prop,AbsExp,ExpEntry *,p,Addr(p)-AtomBase) #else Destructor(Prop,RepExp,ExpEntry *,p,p) Constructor(Prop,AbsExp,ExpEntry *,p,p) #endif #define ExpProperty 0xffe0 /* only unary and binary expressions are acceptable */ Inline(IsExpProperty, PropFlags, int, flags, (flags == ExpProperty) ) /* value property entry structure */ typedef struct { Prop NextOfPE; /* used to chain properties */ PropFlags KindOfPE; /* kind of property */ #if defined(YAPOR) || defined(THREADS) rwlock_t VRWLock; /* a read-write lock to protect the entry */ #endif Term ValueOfVE; /* (atomic) value associated with the atom */ } ValEntry; #if USE_OFFSETS_IN_PROPS Destructor(Prop,RepVal,ValEntry *,p, AtomBase + Unsigned(p)) Constructor(Prop,AbsVal,ValEntry *,p,Addr(p)-AtomBase) #else Destructor(Prop,RepVal,ValEntry *,p,p) Constructor(Prop,AbsVal,ValEntry *,p,p) #endif #define ValProperty ((PropFlags)0xfffc) Inline(IsValProperty, PropFlags, int, flags, (flags == ValProperty) ) /* predicate property entry structure */ /* BasicPreds are things like var, nonvar, atom ...which are implemented through dedicated machine instructions. In this case the 8 lower bits of PredFlags are used to hold the machine instruction code for the pred. C_Preds are things write, read, ... implemented in C. In this case CodeOfPred holds the address of the correspondent C-function. */ typedef enum { CutTransparentPredFlag = 0x800000L, /* ! should ! across */ SourcePredFlag = 0x400000L, /* static predicate with source declaration */ MetaPredFlag = 0x200000L, /* predicate subject to a meta declaration */ SyncPredFlag = 0x100000L, /* has to synch before it can execute*/ UserCPredFlag = 0x080000L, /* CPred defined by the user */ MultiFileFlag = 0x040000L, /* is multi-file */ FastPredFlag = 0x020000L, /* is "compiled" */ TestPredFlag = 0x010000L, /* is a test (optim. comit) */ BasicPredFlag = 0x008000L, /* inline */ StandardPredFlag= 0x004000L, /* system predicate */ DynamicPredFlag= 0x002000L, /* dynamic predicate */ CPredFlag = 0x001000L, /* written in C */ SafePredFlag = 0x000800L, /* does not alter arguments */ CompiledPredFlag= 0x000400L, /* is static */ IndexedPredFlag= 0x000200L, /* has indexing code */ SpiedPredFlag = 0x000100L, /* is a spy point */ BinaryTestPredFlag=0x000080L, /* test predicate. */ #ifdef TABLING TabledPredFlag = 0x000040L, /* is tabled */ #endif /* TABLING */ #ifdef YAPOR SequentialPredFlag=0x000020L, /* may not create par. choice points!*/ #endif /* YAPOR */ ProfiledPredFlag = 0x000010L, /* pred is being profiled */ LogUpdatePredFlag= 0x000008L /* dynamic predicate with log. upd. sem.*/ } pred_flag; /* profile data */ typedef struct { #if defined(YAPOR) || defined(THREADS) lockvar lock; /* a simple lock to protect this entry */ #endif Int NOfEntries; /* nbr of times head unification succeeded*/ Int NOfHeadSuccesses; /* nbr of times head unification succeeded*/ Int NOfRetries; /* nbr of times a clause for the pred was retried */ } profile_data; typedef struct pred_entry { Prop NextOfPE; /* used to chain properties */ PropFlags KindOfPE; /* kind of property */ unsigned int ArityOfPE; /* arity of property */ CELL PredFlags; CODEADDR CodeOfPred; /* code address */ CODEADDR TrueCodeOfPred; /* if needing to spy or to lock */ Functor FunctorOfPred; /* functor for Predicate */ CODEADDR FirstClause, LastClause; Atom OwnerFile; /* File where the predicate was defined */ struct pred_entry *NextPredOfModule; /* next pred for same module */ #if defined(YAPOR) || defined(THREADS) rwlock_t PRWLock; /* a simple lock to protect this entry */ #endif #ifdef TABLING tab_ent_ptr TableOfPred; #endif /* TABLING */ SMALLUNSGN ModuleOfPred; /* module for this definition */ OPCODE OpcodeOfPred; /* undefcode, indexcode, spycode, .... */ profile_data StatisticsForPred; /* enable profiling for predicate */ SMALLUNSGN StateOfPred; /* actual state of predicate */ } PredEntry; #define PEProp ((PropFlags)(0x0000)) #if USE_OFFSETS_IN_PROPS Destructor(Prop,RepPred,PredEntry *,p, AtomBase + Unsigned(p)) Constructor(Prop,AbsPred,PredEntry *,p,Addr(p)-AtomBase) #else Destructor(Prop,RepPred,PredEntry *,p,p) Constructor(Prop,AbsPred,PredEntry *,p,p) #endif Inline(IsPredProperty, PropFlags, int, flags, (flags == PEProp) ) /********* maximum number of C-written predicates and cmp funcs ******************/ #define MAX_C_PREDS 360 #define MAX_CMP_FUNCS 20 typedef struct { PredEntry *p; CmpPredicate f; } cmp_entry; extern CPredicate c_predicates[MAX_C_PREDS]; extern cmp_entry cmp_funcs[MAX_CMP_FUNCS]; /* Flags for code or dbase entry */ /* There are several flags for code and data base entries */ typedef enum { GcFoundMask = 0x10000, /* informs this is a dynamic predicate */ DynamicMask = 0x8000, /* informs this is a dynamic predicate */ InUseMask = 0x4000, /* informs this block is being used */ ErasedMask = 0x2000, /* informs this block has been erased */ IndexMask = 0x1000, /* informs this is indexing code */ DBClMask = 0x0800, /* informs this is a data base structure */ LogUpdRuleMask= 0x0400, /* informs the code is for a log upd rule with env */ LogUpdMask = 0x0200, /* informs this is a logic update index. */ StaticMask = 0x0100, /* dealing with static predicates */ SpiedMask = 0x0080 /* this predicate is being spied */ /* other flags belong to DB */ } dbentry_flags; /* *********************** DBrefs **************************************/ #define KEEP_ENTRY_AGE 1 typedef struct DB_STRUCT { Functor id; /* allow pointers to this struct to id */ /* as dbref */ Term EntryTerm; /* cell bound to itself */ SMALLUNSGN Flags; /* Term Flags */ SMALLUNSGN NOfRefsTo; /* Number of references pointing here */ struct struct_dbentry *Parent; /* key of DBase reference */ CODEADDR Code; /* pointer to code if this is a clause */ struct DB_STRUCT **DBRefs; /* pointer to other references */ struct DB_STRUCT *Prev; /* Previous element in chain */ struct DB_STRUCT *Next; /* Next element in chain */ #if defined(YAPOR) || defined(THREADS) lockvar lock; /* a simple lock to protect this entry */ Int ref_count; /* how many branches are using this entry */ #endif #ifdef KEEP_ENTRY_AGE Int age; /* entry's age, negative if from recorda, positive if it was recordz */ #endif /* KEEP_ENTRY_AGE */ #ifdef COROUTINING CELL attachments; /* attached terms */ #endif CELL Mask; /* parts that should be cleared */ CELL Key; /* A mask that can be used to check before you unify */ CELL NOfCells; /* Size of Term */ CELL Entry; /* entry point */ Term Contents[MIN_ARRAY]; /* stored term */ } DBStruct; #define DBStructFlagsToDBStruct(X) ((DBRef)((X) - (CELL) &(((DBRef) NIL)->Flags))) #if defined(YAPOR) || defined(THREADS) #define INIT_DBREF_COUNT(X) (X)->ref_count = 0 #define INC_DBREF_COUNT(X) (X)->ref_count++ #define DEC_DBREF_COUNT(X) (X)->ref_count-- #define DBREF_IN_USE(X) ((X)->ref_count != 0) #else #define INIT_DBREF_COUNT(X) #define INC_DBREF_COUNT(X) #define DEC_DBREF_COUNT(X) #define DBREF_IN_USE(X) ((X)->Flags & InUseMask) #endif typedef DBStruct *DBRef; /* extern Functor FunctorDBRef; */ Inline(IsDBRefTerm, int, Term, t, IsApplTerm(t) && FunctorOfTerm(t) == FunctorDBRef) Inline(MkDBRefTerm, Term, DBRef, p, (AbsAppl(((CELL *)(p))))) Destructor(Term, DBRefOf, DBRef, t, ((DBRef)(RepAppl(t)))) Inline(IsRefTerm, int, Term, t, IsApplTerm(t) && FunctorOfTerm(t) == FunctorDBRef) Destructor(Term, RefOf, CODEADDR, t, DBRefOfTerm(t)) typedef struct struct_dbentry { Prop NextOfPE; /* used to chain properties */ PropFlags KindOfPE; /* kind of property */ unsigned int ArityOfDB; /* kind of property */ Functor FunctorOfDB; /* functor for this property */ #if defined(YAPOR) || defined(THREADS) rwlock_t DBRWLock; /* a simple lock to protect this entry */ #endif DBRef First; /* first DBase entry */ DBRef Last; /* last DBase entry */ SMALLUNSGN ModuleOfDB; /* module for this definition */ #ifdef KEEP_ENTRY_AGE Int age; /* age counter */ #else DBRef FirstNEr; /* first non-erased DBase entry */ #endif /* KEEP_ENTRY_AGE */ } DBEntry; typedef DBEntry *DBProp; #define DBProperty ((PropFlags)0x8000) typedef struct { Prop NextOfPE; /* used to chain properties */ PropFlags KindOfPE; /* kind of property */ unsigned int ArityOfDB; /* kind of property */ Functor FunctorOfDB; /* functor for this property */ #if defined(YAPOR) || defined(THREADS) rwlock_t DBRWLock; /* a simple lock to protect this entry */ #endif DBRef First; /* first DBase entry */ DBRef Last; /* last DBase entry */ SMALLUNSGN ModuleOfDB; /* module for this definition */ Int NOfEntries; /* age counter */ DBRef Index; /* age counter */ } LogUpdDBEntry; typedef LogUpdDBEntry *LogUpdDBProp; #define LogUpdDBBit 0x1 #define CodeDBBit 0x2 #define LogUpdDBProperty ((PropFlags)(0x8000|LogUpdDBBit)) #define CodeLogUpdDBProperty (DBProperty|LogUpdDBBit|CodeDBBit) #define CodeDBProperty (DBProperty|CodeDBBit) Inline(IsDBProperty, PropFlags, int, flags, ((flags & ~(LogUpdDBBit|CodeDBBit)) == DBProperty) ) #if USE_OFFSETS_IN_PROPS Destructor(Prop,RepDB,DBProp,p,AtomBase + Unsigned(p)) Constructor(Prop,AbsDB,DBProp,p,Addr(p)-AtomBase) #else Destructor(Prop,RepDB,DBProp,p,p) Constructor(Prop,AbsDB,DBProp,p,p) #endif /* These are the actual flags for DataBase terms */ typedef enum { DBAtomic = 0x1, DBVar = 0x2, DBNoVars = 0x4, DBComplex = 0x8, DBCode = 0x10, DBNoCode = 0x20, DBWithRefs = 0x40 } db_term_flags; #define MaxModules 255 typedef struct { Prop NextOfPE; /* used to chain properties */ PropFlags KindOfPE; /* kind of property */ Atom KeyOfBB; /* functor for this property */ DBRef Element; /* blackboard element */ #if defined(YAPOR) || defined(THREADS) rwlock_t BBRWLock; /* a read-write lock to protect the entry */ #endif SMALLUNSGN ModuleOfBB; /* module for this definition */ } BlackBoardEntry; typedef BlackBoardEntry *BBProp; #if USE_OFFSETS_IN_PROPS Destructor(Prop,RepBB,BlackBoardEntry *,p, AtomBase + Unsigned(p)) Constructor(Prop,AbsBB,BlackBoardEntry *,p,Addr(p)-AtomBase) #else Destructor(Prop,RepBB,BlackBoardEntry *,p,p) Constructor(Prop,AbsBB,BlackBoardEntry *,p,p) #endif #define BBProperty ((PropFlags)0xfffb) Inline(IsBBProperty, PropFlags, int, flags, (flags == BBProperty)) /* array property entry structure */ /* first case is for dynamic arrays */ typedef struct { Prop NextOfPE; /* used to chain properties */ PropFlags KindOfPE; /* kind of property */ Int ArrayEArity; /* Arity of Array (positive) */ #if defined(YAPOR) || defined(THREADS) rwlock_t ArRWLock; /* a read-write lock to protect the entry */ #endif Term ValueOfVE; /* Pointer to the actual array */ } ArrayEntry; /* second case is for static arrays */ /* first, the valid types */ typedef enum { array_of_ints, array_of_chars, array_of_uchars, array_of_doubles, array_of_ptrs, array_of_atoms, array_of_dbrefs, array_of_terms } static_array_types; typedef union { Int *ints; char *chars; unsigned char *uchars; Float *floats; AtomEntry **ptrs; Term *atoms; Term *dbrefs; DBRef *terms; } statarray_elements; /* next, the actual data structure */ typedef struct { Prop NextOfPE; /* used to chain properties */ PropFlags KindOfPE; /* kind of property */ Int ArrayEArity; /* Arity of Array (negative) */ #if defined(YAPOR) || defined(THREADS) rwlock_t ArRWLock; /* a read-write lock to protect the entry */ #endif static_array_types ArrayType; /* Type of Array Elements. */ statarray_elements ValueOfVE; /* Pointer to the Array itself */ } StaticArrayEntry; #if USE_OFFSETS_IN_PROPS Destructor(Prop,RepArray,ArrayEntry *,p, AtomBase + Unsigned(p)) Constructor(Prop,AbsArray,ArrayEntry *,p,Addr(p)-AtomBase) Destructor(Prop,RepStaticArray,StaticArrayEntry *,p, AtomBase + Unsigned(p)) Constructor(Prop,AbsStaticArray,StaticArrayEntry *,p,Addr(p)-AtomBase) #else Destructor(Prop,RepArray,ArrayEntry *,p,p) Constructor(Prop,AbsArray,ArrayEntry *,p,p) Destructor(Prop,RepStaticArray,StaticArrayEntry *,p,p) Constructor(Prop,AbsStaticArray,StaticArrayEntry *,p,p) #endif #define ArrayProperty ((PropFlags)0xfff7) Inline(ArrayIsDynamic, int, ArrayEntry *, are, ((are)->ArrayEArity > 0 )) Inline(IsArrayProperty, PropFlags, int, flags, (flags == ArrayProperty) ) /* Proto types */ /* cdmgr.c */ int STD_PROTO(RemoveIndexation,(PredEntry *)); /* dbase.c */ void STD_PROTO(ErDBE,(DBRef)); DBRef STD_PROTO(StoreTermInDB,(int,int)); Term STD_PROTO(FetchTermFromDB,(DBRef,int)); void STD_PROTO(ReleaseTermFromDB,(DBRef)); /* .c */ CODEADDR STD_PROTO(PredIsIndexable,(PredEntry *)); /* init.c */ Atom STD_PROTO(GetOp,(OpEntry *,int *,int)); /* vsc: redefined to GetAProp to avoid conflicts with Windows header files */ Prop STD_PROTO(GetAProp,(Atom,PropFlags)); Prop STD_PROTO(GetAPropHavingLock,(AtomEntry *,PropFlags)); EXTERN inline Prop PredPropByFunc(Functor f, SMALLUNSGN cur_mod) /* get predicate entry for ap/arity; create it if neccessary. */ { Prop p0; FunctorEntry *fe = (FunctorEntry *)f; WRITE_LOCK(fe->FRWLock); p0 = fe->PropsOfFE; while (p0) { PredEntry *p = RepPredProp(p0); if (/* p->KindOfPE != 0 || only props */ (p->ModuleOfPred == cur_mod || !(p->ModuleOfPred))) { WRITE_UNLOCK(f->FRWLock); return (p0); } p0 = p->NextOfPE; } return(NewPredPropByFunctor(fe,cur_mod)); } EXTERN inline Prop PredPropByAtom(Atom at, SMALLUNSGN cur_mod) /* get predicate entry for ap/arity; create it if neccessary. */ { Prop p0; AtomEntry *ae = RepAtom(at); WRITE_LOCK(ae->ARWLock); p0 = ae->PropsOfAE; while (p0) { PredEntry *pe = RepPredProp(p0); if ( pe->KindOfPE == PEProp && (pe->ModuleOfPred == cur_mod || !pe->ModuleOfPred)) { WRITE_UNLOCK(ae->ARWLock); return(p0); } p0 = pe->NextOfPE; } return(NewPredPropByAtom(ae,cur_mod)); } #if defined(YAPOR) || defined(THREADS) void STD_PROTO(ReleasePreAllocCodeSpace, (ADDR)); #else #define ReleasePreAllocCodeSpace(x) #endif