/************************************************************************* * * * YAP Prolog * * * * Yap Prolog was developed at NCCUP - Universidade do Porto * * * * Copyright L.Damas, V.S.Costa and Universidade do Porto 1985-1997 * * * ************************************************************************** * * * File: save.c * * Last rev: * * mods: * * comments: saving and restoring a Prolog computation * * * *************************************************************************/ #ifdef SCCS static char SccsId[] = "@(#)save.c 1.3 3/15/90"; #endif #if _MSC_VER || defined(__MINGW32__) #include #endif #include "absmi.h" #include "alloc.h" #if USE_DL_MALLOC #include "dlmalloc.h" #endif #include "yapio.h" #include "sshift.h" #include "Foreign.h" #if HAVE_STRING_H #include #endif #if !HAVE_STRNCAT #define strncat(X,Y,Z) strcat(X,Y) #endif #if !HAVE_STRNCPY #define strncpy(X,Y,Z) strcpy(X,Y) #endif #if HAVE_FCNTL_H #include #endif #ifdef HAVE_UNISTD_H #include #endif #ifdef HAVE_SYS_TYPES_H #include #endif #ifdef HAVE_SYS_STAT_H #include #endif #include "iopreds.h" /********* hack for accesing several kinds of terms. Should be cleaned **/ static char StartUpFile[] = "startup"; static char end_msg[256] ="*** End of YAP saved state *****"; #ifdef DEBUG /* * #FOR DEBUGGING define DEBUG_RESTORE0 to check the file stuff, #define DEBUG_RESTORE1 to see if it is able to prepare the chain, #define DEBUG_RESTORE2 to see how things are going, #define DEBUG_RESTORE3 to check if the atom chain is still a working chain, * define DEBUG_RESTORE4 if you want to set the output for some * particular file, * define DEBUG_RESTORE5 if you want to see how the stacks are being * cleaned up, * define DEBUG_RESTORE6 if you want to follow the execution in * * Also a file is defined where you can write things, by default stderr * * Good Luck */ #endif STATIC_PROTO(int myread, (int, char *, Int)); STATIC_PROTO(void mywrite, (int, char *, Int)); STATIC_PROTO(int open_file, (char *, int)); STATIC_PROTO(void close_file, (void)); STATIC_PROTO(void putout, (CELL)); STATIC_PROTO(void putcellptr, (CELL *)); STATIC_PROTO(CELL get_cell, (void)); STATIC_PROTO(CELL *get_cellptr, ( /* CELL * */ void)); STATIC_PROTO(void put_info, (int, int)); STATIC_PROTO(void save_regs, (int)); STATIC_PROTO(void save_code_info, (void)); STATIC_PROTO(void save_heap, (void)); STATIC_PROTO(void save_stacks, (int)); STATIC_PROTO(void save_crc, (void)); STATIC_PROTO(Int do_save, (int)); STATIC_PROTO(Int p_save, (void)); STATIC_PROTO(Int p_save_program, (void)); STATIC_PROTO(int check_header, (CELL *, CELL *, CELL *, CELL *)); STATIC_PROTO(int get_heap_info, (void)); STATIC_PROTO(int get_regs, (int)); STATIC_PROTO(int get_insts, (OPCODE [])); STATIC_PROTO(int get_hash, (void)); STATIC_PROTO(int CopyCode, (void)); STATIC_PROTO(int CopyStacks, (void)); STATIC_PROTO(int get_coded, (int, OPCODE [])); STATIC_PROTO(void restore_codes, (void)); STATIC_PROTO(Term AdjustDBTerm, (Term, Term *)); STATIC_PROTO(void RestoreDB, (DBEntry *)); STATIC_PROTO(void CleanClauses, (yamop *, yamop *,PredEntry *)); STATIC_PROTO(void rehash, (CELL *, int, int)); STATIC_PROTO(void CleanCode, (PredEntry *)); STATIC_PROTO(void RestoreEntries, (PropEntry *)); STATIC_PROTO(void RestoreInvisibleAtoms, (void)); STATIC_PROTO(void RestoreFreeSpace, (void)); STATIC_PROTO(void restore_heap, (void)); #ifdef DEBUG_RESTORE3 STATIC_PROTO(void ShowAtoms, (void)); STATIC_PROTO(void ShowEntries, (PropEntry *)); #endif STATIC_PROTO(int OpenRestore, (char *, char *, CELL *, CELL *, CELL *, CELL *)); STATIC_PROTO(void CloseRestore, (void)); STATIC_PROTO(int check_opcodes, (OPCODE [])); STATIC_PROTO(void RestoreHeap, (OPCODE [])); STATIC_PROTO(Int p_restore, (void)); STATIC_PROTO(void restore_heap_regs, (void)); STATIC_PROTO(void restore_regs, (int)); #ifdef MACYAP STATIC_PROTO(void NewFileInfo, (long, long)); extern int DefVol; #endif #if HAVE_IO_H #include #endif #ifdef LIGHT #include #include void LightBug(char *); static void LightBug(s) char *s; { } #endif /* LIGHT */ static int do_system_error(yap_error_number etype, const char *msg) { #if HAVE_SNPRINTF #if HAVE_STRERROR snprintf(Yap_ErrorSay,MAX_ERROR_MSG_SIZE,"%s (%s when reading %s)", msg, strerror(errno), Yap_FileNameBuf); #else snprintf(Yap_ErrorSay,MAX_ERROR_MSG_SIZE,"%s, (system error %d when reading %s)",msg,errno,Yap_FileNameBuf); #endif #else #if HAVE_STRERROR sprintf(Yap_ErrorSay,"%s, (%s when reading %s)",msg,strerror(errno),Yap_FileNameBuf); #else sprintf(Yap_ErrorSay,"%s, (system error %d when reading %s)",msg,errno,Yap_FileNameBuf); #endif #endif Yap_ErrorMessage = Yap_ErrorSay; Yap_Error_TYPE = etype; return -1; } #if SHORT_INTS #ifdef M_WILLIAMS #include #endif static int myread(int fd, char *buff, Int len) { while (len > 0) { int nchars = read(fd, buff, len); if (nchars < 0) { return do_system_error(PERMISSION_ERROR_INPUT_PAST_END_OF_STREAM, "bad read on saved state"); } len -= nchars; buff += nchars; } return len; } static void mywrite(int fd, char *buff, Int len) { while (len > 16000) { write(fd, buff, 16000); len -= 16000; buff += 16000; } write(fd, buff, (unsigned) len); } #else /* SHORT_INTS */ inline static int myread(int fd, char *buffer, Int len) { int nread; while (len > 0) { nread = read(fd, buffer, (int)len); if (nread < 1) { return do_system_error(PERMISSION_ERROR_INPUT_PAST_END_OF_STREAM,"bad read on saved state"); } buffer += nread; len -= nread; } return len; } inline static void mywrite(int fd, char *buff, Int len) { Int nwritten; while (len > 0) { nwritten = (Int)write(fd, buff, (int)len); if (nwritten < 0) { Yap_ErrorMessage = "bad write on saved state"; Yap_Error(SYSTEM_ERROR,TermNil,Yap_ErrorMessage); } buff += nwritten; len -= nwritten; } } #endif /* SHORT_INTS */ #define FullSaved 1 /* Where the code was before */ typedef CELL *CELLPOINTER; static int splfild = 0; #ifdef DEBUG #ifdef DEBUG_RESTORE4 static FILE *errout; #else #define errout Yap_stderr #endif #endif /* DEBUG */ static Int OldHeapUsed; static CELL which_save; /* Open a file to read or to write */ static int open_file(char *my_file, int flag) { int splfild; #ifdef M_WILLIAMS if (flag & O_CREAT) splfild = creat(my_file, flag); else splfild = open(my_file, flag); if (splfild < 0) { #else #ifdef O_BINARY #if _MSC_VER if ((splfild = _open(my_file, flag | O_BINARY), _S_IREAD | _S_IWRITE) < 0) #else if ((splfild = open(my_file, flag | O_BINARY, 0775)) < 0) #endif #else /* O_BINARY */ if ((splfild = open(my_file, flag, 0755)) < 0) #endif /* O_BINARY */ #endif /* M_WILLIAMS */ { splfild = 0; /* We do not have an open file */ return -1; } #ifdef undf0 fprintf(errout, "Opened file %s\n", my_file); #endif return splfild; } static void close_file(void) { if (splfild == 0) return; close(splfild); splfild = 0; } /* stores a cell in a file */ static void putout(CELL l) { mywrite(splfild, (char *) &l, sizeof(CELL)); } /* stores a pointer to a cell in a file */ static void putcellptr(CELL *l) { mywrite(splfild, (char *) &l, sizeof(CELLPOINTER)); } /* gets a cell from a file */ static CELL get_cell(void) { CELL l; myread(splfild, (char *) &l, Unsigned(sizeof(CELL))); return (l); } /* gets a cell from a file */ static CELL get_header_cell(void) { CELL l; int count = 0, n; while (count < sizeof(CELL)) { if ((n = read(splfild, &l, sizeof(CELL)-count)) < 0) { do_system_error(PERMISSION_ERROR_INPUT_PAST_END_OF_STREAM,"failed to read saved state header"); return 0L; } count += n; } return l; } /* gets a pointer to cell from a file */ static CELL * get_cellptr(void) { CELL *l; myread(splfild, (char *) &l, Unsigned(sizeof(CELLPOINTER))); return (l); } /* * writes the header (at the moment YAPV*), info about what kind of saved * set, the work size, and the space ocuppied */ static void put_info(int info, int mode) { char msg[256]; sprintf(msg, "#!/bin/sh\nexec_dir=${YAPBINDIR:-%s}\nexec $exec_dir/yap $0 \"$@\"\n%cYAPV%s", BIN_DIR, 1, YAP_VERSION); mywrite(splfild, msg, strlen(msg) + 1); putout(Unsigned(info)); /* say whether we just saved the heap or everything */ putout(mode); /* current state of stacks, to be used by SavedInfo */ /* space available in heap area */ putout(Unsigned(Yap_GlobalBase)-Unsigned(Yap_HeapBase)); /* space available for stacks */ putout(Unsigned(Yap_LocalBase)-Unsigned(Yap_GlobalBase)); /* space available for trail */ putout(Unsigned(Yap_TrailTop)-Unsigned(Yap_TrailBase)); /* Space used in heap area */ putout(Unsigned(HeapTop)-Unsigned(Yap_HeapBase)); /* Space used for local stack */ putout(Unsigned(LCL0)-Unsigned(ASP)); /* Space used for global stack */ putout(Unsigned(H) - Unsigned(Yap_GlobalBase)); /* Space used for trail */ putout(Unsigned(TR) - Unsigned(Yap_TrailBase)); } static void save_regs(int mode) { /* save all registers */ putout((CELL)compile_arrays); if (mode == DO_EVERYTHING) { putcellptr((CELL *)CP); putcellptr(ENV); putcellptr(ASP); /* putout((CELL)N); */ putcellptr(H0); putcellptr(LCL0); putcellptr(H); putcellptr(HB); putcellptr((CELL *)B); putcellptr((CELL *)TR); putcellptr(YENV); putcellptr(S); putcellptr((CELL *)P); putout(CreepFlag); putout(EX); #ifdef COROUTINING putout(DelayedVars); #endif #if defined(SBA) || defined(TABLING) putcellptr(H_FZ); putcellptr((CELL *)B_FZ); putcellptr((CELL *)TR_FZ); #endif /* SBA || TABLING */ } putout(CurrentModule); if (mode == DO_EVERYTHING) { #ifdef COROUTINING putout(WokenGoals); #endif #ifdef DEPTH_LIMIT putout(DEPTH); #endif putout(GcGeneration); } /* The operand base */ putcellptr(CellPtr(XREGS)); putout(which_save); /* Now start by saving the code */ /* the heap boundaries */ putcellptr(CellPtr(Yap_HeapBase)); putcellptr(CellPtr(HeapTop)); /* and the space it ocuppies */ putout(Unsigned(HeapUsed)); /* Then the start of the free code */ putcellptr(CellPtr(FreeBlocks)); putcellptr(AuxSp); putcellptr(CellPtr(AuxTop)); if (mode == DO_EVERYTHING) { /* put the old trail base, just in case it moves again */ putout(ARG1); if (which_save == 2) { putout(ARG2); } putcellptr(CellPtr(Yap_TrailBase)); } } static void save_code_info(void) { /* First the instructions */ { op_numbers i; OPCODE my_ops[_std_top+1]; for (i = _Ystop; i <= _std_top; ++i) my_ops[i] = Yap_opcode(i); mywrite(splfild, (char *)my_ops, sizeof(OPCODE)*(_std_top+1)); } /* and the current character codes */ mywrite(splfild, Yap_chtype, NUMBER_OF_CHARS); } static void save_heap(void) { int j; /* Then save the whole heap */ #if defined(YAPOR) || defined(TABLING) && !defined(YAP_MEMORY_ALLOC_SCHEME) /* skip the local and global data structures */ j = Unsigned(&GLOBAL) - Unsigned(Yap_HeapBase); putout(j); mywrite(splfild, (char *) Yap_HeapBase, j); j = Unsigned(HeapTop) - Unsigned(&HashChain); putout(j); mywrite(splfild, (char *) &HashChain, j); #else j = Unsigned(HeapTop) - Unsigned(Yap_HeapBase); /* store 10 more cells because of the memory manager */ mywrite(splfild, (char *) Yap_HeapBase, j); #endif /* YAPOR || TABLING */ } static void save_stacks(int mode) { int j; switch (mode) { case DO_EVERYTHING: /* Now, go and save the state */ /* Save the local stack */ j = Unsigned(LCL0) - Unsigned(ASP); mywrite(splfild, (char *) ASP, j); /* Save the global stack */ j = Unsigned(H) - Unsigned(Yap_GlobalBase); mywrite(splfild, (char *) Yap_GlobalBase, j); /* Save the trail */ j = Unsigned(TR) - Unsigned(Yap_TrailBase); mywrite(splfild, (char *) Yap_TrailBase, j); break; case DO_ONLY_CODE: { tr_fr_ptr tr_ptr = TR; while (tr_ptr != (tr_fr_ptr)Yap_TrailBase) { CELL val = TrailTerm(tr_ptr-1); if (IsVarTerm(val)) { CELL *d1 = VarOfTerm(val); if (d1 < (CELL *)HeapTop) putout(val); } else if (IsPairTerm(val)) { CELL *d1 = RepPair(val); if (d1 < (CELL *)HeapTop) putout(val); } tr_ptr--; } } putcellptr(NULL); break; } } static void save_crc(void) { /* Save a CRC */ mywrite(splfild, end_msg, 256); #ifdef MACYAP NewFileInfo('TEXT', 'MYap'); if (DefVol) SetVol(0l, DefVol); DefVol = 0; #endif } static Int do_save(int mode) { #ifdef MACYAP NewFileInfo('YAPS', 'MYap'); #endif Term t1 = Deref(ARG1); if (!Yap_GetName(Yap_FileNameBuf, YAP_FILENAME_MAX, t1)) { Yap_Error(TYPE_ERROR_LIST,t1,"save/1"); return FALSE; } Yap_CloseStreams(TRUE); if ((splfild = open_file(Yap_FileNameBuf, O_WRONLY | O_CREAT)) < 0) { Yap_Error(SYSTEM_ERROR,MkAtomTerm(Yap_LookupAtom(Yap_FileNameBuf)), "restore/1, open(%s)", strerror(errno)); return(FALSE); } put_info(FullSaved, mode); save_regs(mode); save_code_info(); save_heap(); save_stacks(mode); save_crc(); close_file(); return (TRUE); } /* Saves a complete prolog environment */ static Int p_save(void) { #if defined(YAPOR) || defined(THREADS) if (NOfThreads != 1) { Yap_Error(SYSTEM_ERROR,TermNil,"cannot perform save: more than a worker/thread running"); return(FALSE); } #endif which_save = 1; return(do_save(DO_EVERYTHING)); } /* Saves a complete prolog environment */ static Int p_save2(void) { #if defined(YAPOR) || defined(THREADS) if (NOfThreads != 1) { Yap_Error(SYSTEM_ERROR,TermNil, "cannot perform save: more than a worker/thread running"); return(FALSE); } #endif which_save = 2; return(do_save(DO_EVERYTHING) && Yap_unify(ARG2,MkIntTerm(1))); } /* Just save the program, not the stacks */ static Int p_save_program(void) { which_save = 0; return do_save(DO_ONLY_CODE); } /* Now, to restore the saved code */ /* First check out if we are dealing with a valid file */ static int check_header(CELL *info, CELL *ATrail, CELL *AStack, CELL *AHeap) { char pp[80]; char msg[256]; CELL hp_size, gb_size, lc_size, tr_size, mode; /* make sure we always check if there are enough bytes */ /* skip the first line */ do { if (read(splfild, pp, 1) < 0) { do_system_error(PERMISSION_ERROR_INPUT_PAST_END_OF_STREAM,"failed to scan first line from saved state"); return FAIL_RESTORE; } } while (pp[0] != 1); /* now check the version */ sprintf(msg, "YAPV%s", YAP_VERSION); { int count = 0, n, to_read = Unsigned(strlen(msg) + 1); while (count < to_read) { if ((n = read(splfild, pp, to_read-count)) < 0) { do_system_error(PERMISSION_ERROR_INPUT_PAST_END_OF_STREAM,"failed to scan version info from saved state"); return FAIL_RESTORE; } count += n; } } if (pp[0] != 'Y' && pp[1] != 'A' && pp[0] != 'P') { Yap_ErrorMessage = Yap_ErrorSay; strncpy(Yap_ErrorMessage, "saved state ", MAX_ERROR_MSG_SIZE); strncat(Yap_ErrorMessage, Yap_FileNameBuf, MAX_ERROR_MSG_SIZE); strncat(Yap_ErrorMessage, " failed to match `YAP\'", MAX_ERROR_MSG_SIZE); Yap_Error_TYPE = CONSISTENCY_ERROR; return FAIL_RESTORE; } if (strcmp(pp, msg) != 0) { Yap_ErrorMessage = Yap_ErrorSay; strncpy(Yap_ErrorMessage, "saved state ", MAX_ERROR_MSG_SIZE); strncat(Yap_ErrorMessage, Yap_FileNameBuf, MAX_ERROR_MSG_SIZE); strncat(Yap_ErrorMessage, " failed to match version ID", MAX_ERROR_MSG_SIZE); Yap_Error_TYPE = CONSISTENCY_ERROR; return FAIL_RESTORE; } /* check info on header */ /* ignore info on saved state */ *info = get_header_cell(); if (Yap_ErrorMessage) return FAIL_RESTORE; /* check the restore mode */ mode = get_header_cell(); if (Yap_ErrorMessage) return FAIL_RESTORE; if (mode != DO_EVERYTHING && mode != DO_ONLY_CODE) { return FAIL_RESTORE; } /* ignore info on stacks size */ *AHeap = get_header_cell(); if (Yap_ErrorMessage) { return FAIL_RESTORE; } *AStack = get_header_cell(); if (Yap_ErrorMessage) { return FAIL_RESTORE; } *ATrail = get_header_cell(); if (Yap_ErrorMessage) { return FAIL_RESTORE; } /* now, check whether we got enough enough space to load the saved space */ hp_size = get_cell(); if (Yap_ErrorMessage) return FAIL_RESTORE; while (Yap_HeapBase != NULL && hp_size > Unsigned(HeapLim) - Unsigned(Yap_HeapBase)) { if(!Yap_growheap(FALSE, hp_size, NULL)) { return FAIL_RESTORE; } } if (mode == DO_EVERYTHING) { lc_size = get_cell(); if (Yap_ErrorMessage) return FAIL_RESTORE; gb_size=get_cell(); if (Yap_ErrorMessage) return FAIL_RESTORE; if (Yap_HeapBase != NULL && lc_size+gb_size > Unsigned(Yap_LocalBase) - Unsigned(Yap_GlobalBase)) { if (Yap_ErrorMessage != NULL) Yap_ErrorMessage = "could not allocate enough stack space"; return FAIL_RESTORE; } if (Yap_HeapBase != NULL && (tr_size = get_cell()) > Unsigned(Yap_TrailTop) - Unsigned(Yap_TrailBase)) { if (Yap_ErrorMessage != NULL) Yap_ErrorMessage = "could not allocate enough trail space"; return FAIL_RESTORE; } } else { /* skip cell size */ get_header_cell(); if (Yap_ErrorMessage) return FAIL_RESTORE; get_header_cell(); if (Yap_ErrorMessage) return FAIL_RESTORE; get_header_cell(); if (Yap_ErrorMessage) return FAIL_RESTORE; } return(mode); } /* Gets the state of the heap, and evaluates the related variables */ static int get_heap_info(void) { OldHeapBase = (ADDR) get_cellptr(); if (Yap_ErrorMessage) return -1; OldHeapTop = (ADDR) get_cellptr(); if (Yap_ErrorMessage) return -1; OldHeapUsed = (Int) get_cell(); if (Yap_ErrorMessage) return -1; FreeBlocks = (BlockHeader *) get_cellptr(); if (Yap_ErrorMessage) return -1; AuxSp = get_cellptr(); if (Yap_ErrorMessage) return -1; AuxTop = (ADDR)get_cellptr(); if (Yap_ErrorMessage) return -1; HDiff = Unsigned(Yap_HeapBase) - Unsigned(OldHeapBase); return 1; } /* Gets the register array */ /* Saves the old bases for the work areas */ /* and evaluates the difference from the old areas to the new ones */ static int get_regs(int flag) { CELL *NewGlobalBase = (CELL *)Yap_GlobalBase; CELL *NewLCL0 = LCL0; CELL *OldXREGS; /* Get regs */ compile_arrays = (int)get_cell(); if (Yap_ErrorMessage) return -1; if (flag == DO_EVERYTHING) { CP = (yamop *)get_cellptr(); if (Yap_ErrorMessage) return -1; ENV = get_cellptr(); if (Yap_ErrorMessage) return -1; ASP = get_cellptr(); if (Yap_ErrorMessage) return -1; /* N = get_cell(); */ H0 = get_cellptr(); if (Yap_ErrorMessage) return -1; LCL0 = get_cellptr(); if (Yap_ErrorMessage) return -1; H = get_cellptr(); if (Yap_ErrorMessage) return -1; HB = get_cellptr(); if (Yap_ErrorMessage) return -1; B = (choiceptr)get_cellptr(); if (Yap_ErrorMessage) return -1; TR = (tr_fr_ptr)get_cellptr(); if (Yap_ErrorMessage) return -1; YENV = get_cellptr(); if (Yap_ErrorMessage) return -1; S = get_cellptr(); if (Yap_ErrorMessage) return -1; P = (yamop *)get_cellptr(); if (Yap_ErrorMessage) return -1; CreepFlag = get_cell(); if (Yap_ErrorMessage) return -1; EX = get_cell(); if (Yap_ErrorMessage) return -1; #ifdef COROUTINING DelayedVars = get_cell(); if (Yap_ErrorMessage) return -1; #endif #if defined(SBA) || defined(TABLING) H_FZ = get_cellptr(); if (Yap_ErrorMessage) return -1; B_FZ = (choiceptr)get_cellptr(); if (Yap_ErrorMessage) return -1; TR_FZ = (tr_fr_ptr)get_cellptr(); if (Yap_ErrorMessage) return -1; #endif /* SBA || TABLING */ } CurrentModule = get_cell(); if (Yap_ErrorMessage) return -1; if (flag == DO_EVERYTHING) { #ifdef COROUTINING WokenGoals = get_cell(); if (Yap_ErrorMessage) return -1; #endif #ifdef DEPTH_LIMIT DEPTH = get_cell(); if (Yap_ErrorMessage) return -1; #endif GcGeneration = get_cell(); if (Yap_ErrorMessage) return -1; } /* Get the old bases */ OldXREGS = get_cellptr(); if (Yap_ErrorMessage) return -1; which_save = get_cell(); if (Yap_ErrorMessage) return -1; XDiff = (CELL)XREGS - (CELL)OldXREGS; if (Yap_ErrorMessage) return -1; if (get_heap_info() < 0) return -1; if (flag == DO_EVERYTHING) { ARG1 = get_cell(); if (Yap_ErrorMessage) return -1; if (which_save == 2) { ARG2 = get_cell(); if (Yap_ErrorMessage) return -1; } /* get old trail base */ OldTrailBase = (ADDR)get_cellptr(); if (Yap_ErrorMessage) return -1; /* Save the old register where we can easily access them */ OldASP = ASP; OldLCL0 = LCL0; OldGlobalBase = (CELL *)Yap_GlobalBase; OldH = H; OldTR = TR; GDiff = Unsigned(NewGlobalBase) - Unsigned(Yap_GlobalBase); LDiff = Unsigned(NewLCL0) - Unsigned(LCL0); TrDiff = LDiff; Yap_GlobalBase = (ADDR)NewGlobalBase; LCL0 = NewLCL0; } return 1; } /* Get the old opcodes and place them in a hash table */ static int get_insts(OPCODE old_ops[]) { return myread(splfild, (char *)old_ops, sizeof(OPCODE)*(_std_top+1)); } /* Get the old atoms hash table */ static int get_hash(void) { return myread(splfild, Yap_chtype , NUMBER_OF_CHARS); } /* Copy all of the old code to the new Heap */ static int CopyCode(void) { #if (defined(YAPOR) || defined(TABLING)) && !defined(YAP_MEMORY_ALLOC_SCHEME) /* skip the local and global data structures */ CELL j = get_cell(); if (Yap_ErrorMessage) return -1; if (j != Unsigned(&GLOBAL) - Unsigned(Yap_HeapBase)) { Yap_ErrorMessage = "code space size does not match saved state"; return -1; } if (myread(splfild, (char *) Yap_HeapBase, j) < 0) return -1; j = get_cell(); if (Yap_ErrorMessage) return -1; if (myread(splfild, (char *) &HashChain, j) < 0) return -1; #else if (myread(splfild, (char *) Yap_HeapBase, (Unsigned(OldHeapTop) - Unsigned(OldHeapBase))) < 0) return -1; #endif /* YAPOR || TABLING */ return 1; } /* Copy the local and global stack and also the trail to their new home */ /* In REGS we still have nonadjusted values !! */ static int CopyStacks(void) { Int j; char *NewASP; j = Unsigned(OldLCL0) - Unsigned(ASP); NewASP = (char *) (Unsigned(ASP) + (Unsigned(LCL0) - Unsigned(OldLCL0))); if (myread(splfild, (char *) NewASP, j) < 0) return -1; j = Unsigned(H) - Unsigned(OldGlobalBase); if (myread(splfild, (char *) Yap_GlobalBase, j) < 0) return -1; j = Unsigned(TR) - Unsigned(OldTrailBase); if (myread(splfild, Yap_TrailBase, j)) return -1; return 1; } /* Copy the local and global stack and also the trail to their new home */ /* In REGS we still have nonadjusted values !! */ static int CopyTrailEntries(void) { CELL entry, *Entries; Entries = (CELL *)Yap_TrailBase; do { *Entries++ = entry = get_cell(); if (Yap_ErrorMessage) return -1; } while ((CODEADDR)entry != NULL); return 1; } /* get things which are saved in the file */ static int get_coded(int flag, OPCODE old_ops[]) { char my_end_msg[256]; if (get_regs(flag) < 0) return -1; if (get_insts(old_ops) < 0) return -1; if (get_hash() < 0) return -1; if (CopyCode() < 0) return -1; switch (flag) { case DO_EVERYTHING: if (CopyStacks() < 0) return -1; break; case DO_ONLY_CODE: if (CopyTrailEntries() < 0) return -1; break; } /* Check CRC */ if (myread(splfild, my_end_msg, 256) < 0) return -1; if (strcmp(end_msg,my_end_msg) != 0) { Yap_ErrorMessage = "bad trailing CRC in saved state"; return -1; } return 1; } /* restore some heap registers */ static void restore_heap_regs(void) { HeapTop = AddrAdjust(HeapTop); *((YAP_SEG_SIZE *) HeapTop) = InUseFlag; HeapMax = HeapUsed = OldHeapUsed; restore_codes(); } /* adjust abstract machine registers */ static void restore_regs(int flag) { restore_heap_regs(); if (CurrentModule) { CurrentModule = AtomTermAdjust(CurrentModule);; } if (flag == DO_EVERYTHING) { CP = PtoOpAdjust(CP); ENV = PtoLocAdjust(ENV); ASP = PtoLocAdjust(ASP); H = PtoGloAdjust(H); B = (choiceptr)PtoLocAdjust(CellPtr(B)); TR = PtoTRAdjust(TR); P = PtoOpAdjust(P); HB = PtoLocAdjust(HB); YENV = PtoLocAdjust(YENV); S = PtoGloAdjust(S); if (EX) EX = AbsAppl(PtoGloAdjust(RepAppl(EX))); #ifdef COROUTINING DelayedVars = AbsAppl(PtoGloAdjust(RepAppl(DelayedVars))); #ifdef MULTI_ASSIGNMENT_VARIABLES WokenGoals = AbsAppl(PtoGloAdjust(RepAppl(WokenGoals))); #endif #endif } } static void recompute_mask(DBRef dbr) { if (dbr->Flags & DBNoVars) { dbr->Mask = Yap_EvalMasks((Term) dbr->DBT.Entry, &(dbr->Key)); } else if (dbr->Flags & DBComplex) { /* This is quite nasty, we want to recalculate the mask but we don't want to rebuild the whole term. We'll just build whatever we need to recompute the mask. */ CELL *x = (CELL *)HeapTop, *tp; unsigned int Arity, i; Term out; char *tbase = CharP(dbr->DBT.Contents-1); if (IsPairTerm(dbr->DBT.Entry)) { out = AbsPair(x); Arity = 2; tp = (CELL *)(tbase + (CELL) RepPair(dbr->DBT.Entry)); } else { Functor f; tp = (CELL *)(tbase + (CELL) RepAppl(dbr->DBT.Entry)); f = (Functor)(*tp++); out = AbsAppl(x); Arity = ArityOfFunctor(f); *x++ = (CELL)f; if (Arity > 3) Arity = 3; } for (i = 0; i < Arity; i++) { register Term tw = *tp++; if (IsVarTerm(tw)) { RESET_VARIABLE(x); } else if (IsApplTerm(tw)) { /* just fetch the functor from where it is in the data-base. This guarantees we have access to references and friends. */ CELL offset = (CELL)RepAppl(tw); if (offset > dbr->DBT.NOfCells*sizeof(CELL)) *x = tw; else *x = AbsAppl((CELL *)(tbase + offset)); } else if (IsAtomicTerm(tw)) { *x = tw; } else if (IsPairTerm(tw)) { *x = AbsPair(x); } x++; } dbr->Mask = Yap_EvalMasks(out, &(dbr->Key)); } } #define HASH_SHIFT 6 /* * This is used to make an hash table correct, after displacing its elements, * HCEnd should point to an area of free space, usually in the heap. The * routine is very dependent on the hash function used, and it destroys the * previous "hit" order */ static void rehash(CELL *oldcode, int NOfE, int KindOfEntries) { register CELL *savep, *basep; CELL *oldp = oldcode; int TableSize = NOfE - 1, NOfEntries; register int i; int hash; CELL WorkTerm, failplace = 0; CELL *Base = oldcode; if (HDiff == 0) return; basep = H; if (H + (NOfE*2) > ASP) { basep = (CELL *)TR; if (basep + (NOfE*2) > (CELL *)Yap_TrailTop) { if (!Yap_growtrail((ADDR)(basep + (NOfE*2))-Yap_TrailTop, TRUE)) { Yap_Error(OUT_OF_TRAIL_ERROR, TermNil, "not enough space to restore hash tables for indexing"); Yap_exit(1); } } } for (i = 0; i < NOfE; ++i) { if (*oldp == 0) { failplace = oldp[1]; break; } oldp += 2; } savep = basep; oldp = oldcode; for (i = 0; i < NOfE; ++i) { if (*oldp != 0) { savep[0] = oldp[0]; savep[1] = oldp[1]; oldp[0] = 0; oldp[1] = failplace; savep += 2; } oldp += 2; } NOfEntries = (savep - basep)/2; savep = basep; for (i = 0; i < NOfEntries; ++i) { register Int d; CELL *hentry; WorkTerm = savep[i*2]; hash = (Unsigned(WorkTerm) >> HASH_SHIFT) & TableSize; hentry = Base + hash * 2; d = TableSize & (Unsigned(WorkTerm) | 1); while (*hentry) { #ifdef DEBUG #ifdef CLASHES ++clashes; #endif /* CLASHES */ #endif /* DEBUG */ hash = (hash + d) & TableSize; hentry = Base + hash * 2; } hentry[0] = WorkTerm; hentry[1] = savep[i*2+1]; } } #include "rheap.h" /* restore the atom entries which are invisible for the user */ static void RestoreForeignCodeStructure(void) { ForeignObj *f_code; if (ForeignCodeLoaded != NULL) ForeignCodeLoaded = (void *)AddrAdjust((ADDR)ForeignCodeLoaded); f_code = ForeignCodeLoaded; while (f_code != NULL) { StringList objs, libs; if (f_code->objs != NULL) f_code->objs = (StringList)AddrAdjust((ADDR)f_code->objs); objs = f_code->objs; while (objs != NULL) { if (objs->next != NULL) objs->next = (StringList)AddrAdjust((ADDR)objs->next); if (objs->s != NULL) objs->s = (char *)AddrAdjust((ADDR)objs->s); objs = objs->next; } if (f_code->libs != NULL) f_code->libs = (StringList)AddrAdjust((ADDR)f_code->libs); libs = f_code->libs; while (libs != NULL) { if (libs->next != NULL) libs->next = (StringList)AddrAdjust((ADDR)libs->next); if (libs->s != NULL) libs->s = (char *)AddrAdjust((ADDR)libs->s); libs = libs->next; } if (f_code->f != NULL) f_code->f = (char *)AddrAdjust((ADDR)f_code->f); if (f_code->next != NULL) f_code->next = (ForeignObj *)AddrAdjust((ADDR)f_code->f); f_code = f_code->next; } } /* restore the atom entries which are invisible for the user */ static void RestoreIOStructures(void) { Yap_InitStdStreams(); } static void RestoreFreeSpace(void) { #if USE_DL_MALLOC Yap_av = (struct malloc_state *)AddrAdjust((ADDR)Yap_av); Yap_RestoreDLMalloc(); if (AuxSp != NULL) AuxSp = PtoHeapCellAdjust(AuxSp); if (AuxTop != NULL) AuxTop = AddrAdjust(AuxTop); #else /* restores the list of free space, with its curious structure */ BlockHeader *bpt, *bsz; if (FreeBlocks != NULL) FreeBlocks = BlockAdjust(FreeBlocks); bpt = FreeBlocks; if (AuxSp != NULL) AuxSp = CellPtoHeapAdjust(AuxSp); if (AuxTop != NULL) AuxTop = AddrAdjust(AuxTop); while (bpt != NULL) { if (bpt->b_next != NULL) { bsz = bpt->b_next = BlockAdjust(bpt->b_next); while (bsz != NULL) { if (bsz->b_next_size != NULL) bsz->b_next_size = BlockAdjust(bsz->b_next_size); if (bsz->b_next != NULL) bsz->b_next = BlockAdjust(bsz->b_next); bsz = bsz->b_next; } } if (bpt->b_next_size != NULL) bpt->b_next_size = BlockAdjust(bpt->b_next_size); bpt = bpt->b_next_size; } *((YAP_SEG_SIZE *) HeapTop) = InUseFlag; #endif } /* restore the atom entries which are invisible for the user */ static void RestoreInvisibleAtoms(void) { AtomEntry *at; Atom atm = INVISIBLECHAIN.Entry; INVISIBLECHAIN.Entry = atm = AtomAdjust(atm); at = RepAtom(atm); if (EndOfPAEntr(at)) return; do { #ifdef DEBUG_RESTORE2 /* useful during debug */ fprintf(errout, "Restoring %s\n", at->StrOfAE); #endif at->PropsOfAE = PropAdjust(at->PropsOfAE); RestoreEntries(RepProp(at->PropsOfAE)); atm = at->NextOfAE; at->NextOfAE = atm = AtomAdjust(atm); at = RepAtom(atm); } while (!EndOfPAEntr(at)); } /* * This is the really tough part, to restore the whole of the heap */ static void restore_heap(void) { AtomHashEntry *HashPtr = HashChain; register int i; for (i = 0; i < AtomHashTableSize; ++i) { Atom atm = HashPtr->Entry; if (atm) { AtomEntry *at; HashPtr->Entry = atm = AtomAdjust(atm); at = RepAtom(atm); do { #ifdef DEBUG_RESTORE2 /* useful during debug */ fprintf(errout, "Restoring %s\n", at->StrOfAE); #endif at->PropsOfAE = PropAdjust(at->PropsOfAE); RestoreEntries(RepProp(at->PropsOfAE)); atm = at->NextOfAE = AtomAdjust(at->NextOfAE); at = RepAtom(atm); } while (!EndOfPAEntr(at)); } HashPtr++; } RestoreInvisibleAtoms(); RestoreForeignCodeStructure(); RestoreIOStructures(); } #ifdef DEBUG_RESTORE3 static void ShowEntries(pp) PropEntry *pp; { while (!EndOfPAEntr(pp)) { fprintf(Yap_stderr,"Estou a ver a prop %x em %x\n", pp->KindOfPE, pp); pp = RepProp(pp->NextOfPE); } } static void ShowAtoms() { AtomHashEntry *HashPtr = HashChain; register int i; for (i = 0; i < AtomHashTableSize; ++i) { if (HashPtr->Entry != NIL) { AtomEntry *at; at = RepAtom(HashPtr->Entry); do { fprintf(Yap_stderr,"Passei ao %s em %x\n", at->StrOfAE, at); ShowEntries(RepProp(at->PropsOfAE)); } while (!EndOfPAEntr(at = RepAtom(at->NextOfAE))); } HashPtr++; } } #endif /* DEBUG_RESTORE3 */ #include static int commit_to_saved_state(char *s, CELL *Astate, CELL *ATrail, CELL *AStack, CELL *AHeap) { int mode; if ((mode = check_header(Astate,ATrail,AStack,AHeap)) == FAIL_RESTORE) return(FAIL_RESTORE); Yap_PrologMode = BootMode; if (Yap_HeapBase) { if (!yap_flags[HALT_AFTER_CONSULT_FLAG]) { Yap_TrueFileName(s,Yap_FileNameBuf2, YAP_FILENAME_MAX); fprintf(stderr, "%% Restoring file %s\n", Yap_FileNameBuf2); } Yap_CloseStreams(TRUE); } #ifdef DEBUG_RESTORE4 /* * This should be another file, like the log file */ errout = Yap_stderr; #endif return(mode); } static void cat_file_name(char *s, char *prefix, char *name, unsigned int max_length) { strncpy(s, prefix, max_length); #if _MSC_VER || defined(__MINGW32__) strncat(s,"\\", max_length); #else strncat(s,"/", max_length); #endif strncat(s, name, max_length); } static int OpenRestore(char *inpf, char *YapLibDir, CELL *Astate, CELL *ATrail, CELL *AStack, CELL *AHeap) { int mode = FAIL_RESTORE; Yap_ErrorMessage = NULL; if (inpf == NULL) inpf = StartUpFile; #if __simplescalar__ /* does not implement getcwd */ strncpy(Yap_FileNameBuf,yap_pwd,YAP_FILENAME_MAX); #elif HAVE_GETCWD if (getcwd (Yap_FileNameBuf, YAP_FILENAME_MAX) == NULL) Yap_FileNameBuf[0] = '\0'; #else if (getwd (Yap_FileNameBuf) == NULL) Yap_FileNameBuf[0] = '\0'; #endif strncat(Yap_FileNameBuf, "/", YAP_FILENAME_MAX); strncat(Yap_FileNameBuf, inpf, YAP_FILENAME_MAX); if (inpf != NULL && (splfild = open_file(inpf, O_RDONLY)) > 0) { if ((mode = commit_to_saved_state(inpf,Astate,ATrail,AStack,AHeap)) != FAIL_RESTORE) { Yap_ErrorMessage = NULL; return mode; } } if (!Yap_dir_separator(inpf[0]) && !Yap_volume_header(inpf)) { /* we have a relative path for the file, try to do somewhat better using YAPLIBDIR or friends. */ if (YapLibDir != NULL) { cat_file_name(Yap_FileNameBuf, Yap_LibDir, inpf, YAP_FILENAME_MAX); if ((splfild = open_file(Yap_FileNameBuf, O_RDONLY)) > 0) { if ((mode = commit_to_saved_state(Yap_FileNameBuf,Astate,ATrail,AStack,AHeap)) != FAIL_RESTORE) { Yap_ErrorMessage = NULL; return mode; } } } #if HAVE_GETENV { char *yap_env = getenv("YAPLIBDIR"); if (yap_env != NULL) { cat_file_name(Yap_FileNameBuf, yap_env, inpf, YAP_FILENAME_MAX); if ((splfild = open_file(Yap_FileNameBuf, O_RDONLY)) > 0) { if ((mode = commit_to_saved_state(Yap_FileNameBuf,Astate,ATrail,AStack,AHeap)) != FAIL_RESTORE) { Yap_ErrorMessage = NULL; return mode; } } } } #endif if (LIB_DIR != NULL) { cat_file_name(Yap_FileNameBuf, LIB_DIR, inpf, YAP_FILENAME_MAX); if ((splfild = open_file(Yap_FileNameBuf, O_RDONLY)) > 0) { if ((mode = commit_to_saved_state(Yap_FileNameBuf,Astate,ATrail,AStack,AHeap)) != FAIL_RESTORE) { Yap_ErrorMessage = NULL; return(mode); } } } } /* could not open file */ if (Yap_ErrorMessage == NULL) { #if __simplescalar__ /* does not implement getcwd */ strncpy(Yap_FileNameBuf,yap_pwd,YAP_FILENAME_MAX); #elif HAVE_GETCWD if (getcwd (Yap_FileNameBuf, YAP_FILENAME_MAX) == NULL) Yap_FileNameBuf[0] = '\0'; #else if (getwd (Yap_FileNameBuf) == NULL) Yap_FileNameBuf[0] = '\0'; #endif strncat(Yap_FileNameBuf, "/", YAP_FILENAME_MAX); strncat(Yap_FileNameBuf, inpf, YAP_FILENAME_MAX); do_system_error(PERMISSION_ERROR_OPEN_SOURCE_SINK,"could not open saved state"); } return FAIL_RESTORE; } static void CloseRestore(void) { #ifdef DEBUG_RESTORE3 ShowAtoms(); #endif close_file(); Yap_PrologMode = UserMode; } static int check_opcodes(OPCODE old_ops[]) { #if USE_THREADED_CODE int have_shifted = FALSE; op_numbers op = _Ystop; for (op = _Ystop; op < _std_top; op++) { if (Yap_opcode(op) != old_ops[op]) { have_shifted = TRUE; break; } } return(have_shifted); #else return(FALSE); #endif } static void RestoreHeap(OPCODE old_ops[]) { int heap_moved = (OldHeapBase != Yap_HeapBase), opcodes_moved; Term mod = CurrentModule; CurrentModule = PROLOG_MODULE; opcodes_moved = check_opcodes(old_ops); /* opcodes_moved has side-effects and should be tried first */ if (heap_moved) { RestoreFreeSpace(); } if (heap_moved || opcodes_moved) { restore_heap(); } /* This must be done after restore_heap */ Yap_InitAbsmi(); if (opcodes_moved) { Yap_InitCPreds(); Yap_InitBackCPreds(); } if (!(Yap_ReInitConstExps() && Yap_ReInitUnaryExps() && Yap_ReInitBinaryExps())) { Yap_Error(SYSTEM_ERROR, TermNil, "arithmetic operator not in saved state"); } #ifdef DEBUG_RESTORE1 fprintf(errout, "phase 1 done\n"); #endif CurrentModule = mod; } /* * This function is called to know about the parameters of the last saved * state */ int Yap_SavedInfo(char *FileName, char *YapLibDir, CELL *ATrail, CELL *AStack, CELL *AHeap) { CELL MyTrail, MyStack, MyHeap, MyState; int mode; mode = OpenRestore(FileName, YapLibDir, &MyState, &MyTrail, &MyStack, &MyHeap); if (mode == FAIL_RESTORE) { return -1; } close_file(); if (! *AHeap) *AHeap = MyHeap / 1024; if (mode != DO_ONLY_CODE && *AStack) *AStack = MyStack / 1024; if (mode != DO_ONLY_CODE && *ATrail) *ATrail = MyTrail / 1024; return (MyState); } static void UnmarkTrEntries(void) { CELL entry, *Entries; /* initialise a choice point */ B = (choiceptr)LCL0; B--; B->cp_ap = NOCODE; Entries = (CELL *)Yap_TrailBase; while ((entry = *Entries++) != (CELL)NULL) { if (IsVarTerm(entry)) { RESET_VARIABLE((CELL *)entry); } else if (IsPairTerm(entry)) { CELL *ent = CellPtoHeapAdjust(RepPair(entry)); register CELL flags; flags = *ent; ResetFlag(InUseMask, flags); *ent = flags; if (FlagOn(ErasedMask, flags)) { if (FlagOn(DBClMask, flags)) { Yap_ErDBE(DBStructFlagsToDBStruct(ent)); } else { if (flags & LogUpdMask) { if (flags & IndexMask) { Yap_ErLogUpdIndex(ClauseFlagsToLogUpdIndex(ent), NULL); } else { Yap_ErLogUpdCl(ClauseFlagsToLogUpdClause(ent)); } } else { Yap_ErCl(ClauseFlagsToDynamicClause(ent)); } } } #ifdef MULTI_ASSIGNMENT_VARIABLES } else /* if (IsApplTerm(d1)) */ { Entries += 2; #endif } } B = NULL; } int in_limbo = FALSE; /* * This function is called when wanting only to restore the heap and * associated registers */ static int Restore(char *s, char *lib_dir) { int restore_mode; OPCODE old_ops[_std_top+1]; CELL MyTrail, MyStack, MyHeap, MyState; if ((restore_mode = OpenRestore(s, lib_dir, &MyState, &MyTrail, &MyStack, &MyHeap)) == FAIL_RESTORE) return(FALSE); Yap_ShutdownLoadForeign(); in_limbo = TRUE; if (get_coded(restore_mode, old_ops) < 0) return FAIL_RESTORE; restore_regs(restore_mode); in_limbo = FALSE; /*#endif*/ RestoreHeap(old_ops); switch(restore_mode) { case DO_EVERYTHING: if (OldHeapBase != Yap_HeapBase || OldLCL0 != LCL0 || OldGlobalBase != (CELL *)Yap_GlobalBase || OldTrailBase != Yap_TrailBase) { Yap_AdjustStacksAndTrail(); if (which_save == 2) { Yap_AdjustRegs(2); } else { Yap_AdjustRegs(1); } break; #ifdef DEBUG_RESTORE2 fprintf(errout, "phase 2 done\n"); #endif } break; case DO_ONLY_CODE: UnmarkTrEntries(); Yap_InitYaamRegs(); break; } Yap_ReOpenLoadForeign(); Yap_InitPlIO(); /* reset time */ Yap_ReInitWallTime(); CloseRestore(); if (which_save == 2) { Yap_unify(ARG2, MkIntTerm(0)); } return restore_mode; } int Yap_Restore(char *s, char *lib_dir) { return Restore(s, lib_dir); } static Int p_restore(void) { int mode; Term t1 = Deref(ARG1); #if defined(YAPOR) || defined(THREADS) if (NOfThreads != 1) { Yap_Error(SYSTEM_ERROR,TermNil,"cannot perform save: more than a worker/thread running"); return(FALSE); } #endif if (!Yap_GetName(Yap_FileNameBuf, YAP_FILENAME_MAX, t1)) { Yap_Error(TYPE_ERROR_LIST,t1,"restore/1"); return(FALSE); } if ((mode = Restore(Yap_FileNameBuf, NULL)) == DO_ONLY_CODE) { #if PUSH_REGS restore_absmi_regs(&Yap_standard_regs); #endif /* back to the top level we go */ siglongjmp(Yap_RestartEnv,3); } return(mode != FAIL_RESTORE); } void Yap_InitSavePreds(void) { Yap_InitCPred("$save", 1, p_save, SafePredFlag|SyncPredFlag|HiddenPredFlag); Yap_InitCPred("$save", 2, p_save2, SafePredFlag|SyncPredFlag|HiddenPredFlag); Yap_InitCPred("$save_program", 1, p_save_program, SafePredFlag|SyncPredFlag|HiddenPredFlag); Yap_InitCPred("$restore", 1, p_restore, SyncPredFlag|HiddenPredFlag); }