// thread.cc - Define the components of a thread.
//
// ##Copyright##
// 
// Copyright 2000-2016 Peter Robinson  (pjr@itee.uq.edu.au)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.00 
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ##Copyright##
//
// $Id: thread.cc,v 1.12 2006/02/05 22:14:55 qp Exp $

#include <iostream>
#include <sstream>

#include "thread_qp.h"
#include "trace_qp.h"
#include "global.h"

void Thread::changeTimeslice(bool makeSet)
{
  if (makeSet)
    {
      	scheduler->Status().setEnableTimeslice();
	TInfo().setForbidThread(false);
    }
  else
    {
      scheduler->Status().resetEnableTimeslice();
      TInfo().setForbidThread(true);
    }
}

void
Thread::InitThread(void)
{
  programCounter = NULL;

  continuationInstr = NULL;
  currentEnvironment = envStack.getTop();
  currentEnvironment = envStack.push(currentEnvironment, continuationInstr, 0);

  currentChoicePoint = choiceStack.firstChoice();
  cutPoint = EMPTY_LOC;
  catchPoint = EMPTY_LOC;

  minCleanupCP = 0xFFFF;
  suspend_gc = false;
  metaCounter = 0;
  objectCounter = 0;
  ForeignFile = NULL;
  finter = NULL;
  error_value = EV_NO_ERROR;

  for (u_int i = 0; i < NUMBER_X_REGISTERS; i++) 
    {
      //X[i] = NULL;
     X[i] = AtomTable::nil;
    }
  EscapeInit();
}

//
// Save the X registers in SavedX
//
void    
Thread::SaveXRegisters(void)
{
  word32 i;
  for (i = 0; i < NUMBER_X_REGISTERS; i++)
    {
      SavedX[i] = X[i];
    }
}
//
// Restore the X registers in SavedX
//
void    
Thread::RestoreXRegisters(void)
{
  word32 i;
  for (i = 0; i < NUMBER_X_REGISTERS; i++)
    {
      X[i] = SavedX[i];
    }
}

Thread::Thread(Thread *pt,
	       const word32 ScratchpadSize,
	       const word32 HeapSize,
	       const word32 BindingTrailSize,
	       const word32 OtherTrailSize,
	       const word32 EnvSize,
	       const word32 ChoiceSize,
	       const word32 NameSize,
	       const word32 IPSize)
  : thread_info(pt),
    localAreas(true),
    quick_tidy_check(false),
    names(*(new NameTable(NameSize))),
    ipTable(*(new IPTable(IPSize))),
    buffers(*(new HeapBufferManager(20))),
    heap(*(new Heap("heap", HeapSize * K, true))),
    scratchpad(*(new Heap("scratchpad", ScratchpadSize * K))),
    gcstack(*(new ObjectsStack(HeapSize*K/2))),
    gcbits(*new GCBits(HeapSize*K)),
    bindingTrail(*(new BindingTrail(BindingTrailSize))),
    otherTrail(*(new OtherTrail(OtherTrailSize))),
    envStack(EnvSize),
    choiceStack(ChoiceSize)
#ifdef QP_DEBUG
    , trace(0)
#endif //QP_DEBUG
{
  InitThread();
};

Thread::Thread(Thread *pt,
	       ThreadOptions& thread_options)
  : thread_info(pt),
    localAreas(true),
    quick_tidy_check(false),
    names(*(new NameTable(thread_options.NameTableSize()))),
    ipTable(*(new IPTable(thread_options.IPTableSize()))),
    buffers(*(new HeapBufferManager(20))),
    heap(*(new Heap("heap", thread_options.HeapSize() * K, true))),
    scratchpad(*(new Heap("scratchpad", thread_options.ScratchpadSize() * K))),
    gcstack(*(new ObjectsStack(thread_options.HeapSize()*K/2))),
    gcbits(*new GCBits(thread_options.HeapSize()*K)),
    bindingTrail(*(new BindingTrail(thread_options.BindingTrailSize()))),
    otherTrail(*(new OtherTrail(thread_options.OtherTrailSize()))),
    envStack(thread_options.EnvironmentStackSize()),
    choiceStack(thread_options.ChoiceStackSize())
#ifdef QP_DEBUG
    , trace(0)
#endif // QP_DEBUG
{
  InitThread();
};


Thread::Thread(Thread *pt,
	       HeapBufferManager& SharedBuffers,
	       Heap& SharedScratchpad,
	       Heap& SharedHeap,
	       ObjectsStack& SharedGCstack,
	       GCBits& SharedGCBits,
	       NameTable& SharedNames,
	       IPTable& SharedIPTable,
	       BindingTrail& SharedBindingTrail,
	       OtherTrail& SharedOtherTrail,
	       const word32 EnvSize,
	       const word32 ChoiceSize)
  : thread_info(pt),
    localAreas(false),
    quick_tidy_check(false),
    names(SharedNames),
    ipTable(SharedIPTable),
    buffers(SharedBuffers),
    heap(SharedHeap),
    scratchpad(SharedScratchpad),
    gcstack(SharedGCstack),
    gcbits(SharedGCBits),
    bindingTrail(SharedBindingTrail),
    otherTrail(SharedOtherTrail),
    envStack(EnvSize),
    choiceStack(ChoiceSize)
#ifdef QP_DEBUG
    , trace(0)
#endif
{
  InitThread();
}


Thread::~Thread(void)
{
  if (finter != NULL) delete finter;

  if (localAreas)
    {
      delete &buffers;
      delete &scratchpad;
      delete &heap;
      delete &gcstack;
      delete &gcbits;
      delete &names;
      delete &ipTable;
      delete &bindingTrail;
      delete &otherTrail;
    }
}

ostream&
operator<<(ostream& ostrm, Thread& thread)
{
  ostrm << thread.getThreadCondition() << endl;

  return ostrm;
}

//
// Save the data area and the registers.
//
void
Thread::save(ostream&)
{
// TO DO: Thread::save()
}

//
// Load the data area and the registers.
//
word32
Thread::load(istream&, word32)
{
// TO DO: Thread::load()
  return 0;
}