/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You 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.0
 *
 *  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.
 */

/**
 * @author Intel, George A. Timoshenko
 *
 */

#ifndef _TRANSLATOR_INTFC_H_
#define _TRANSLATOR_INTFC_H_

#include "PMFAction.h"

#include "open/types.h"
#include <string.h>
#include <assert.h>

namespace Jitrino {

class MethodDesc;
class IRBuilder;
class InstFactory;
class CompilationInterface;
class ControlFlowGraph;
class Opnd;
class Inst;
class Node;
class ExceptionInfo;
class IRManager;
class MemoryManager;
class Method_Table;
class CompilationContext;
class SessionAction;

    // to select which byte code translator optimizations are done
struct TranslatorFlags {
    bool propValues         : 1;    // do value propagation
    bool onlyBalancedSync   : 1;    // treat all method synchronization as balanced
    bool ignoreSync         : 1;    // do not generate monitor enter/exit instructions
    bool syncAsEnterFence   : 1;    // implement monitor enter as enter fence and
    bool genMinMaxAbs       : 1;    // gen min/max/abs opcodes instead of using select
    bool genFMinMaxAbs      : 1;    // gen min/max/abs opcodes for floats
    bool optArrayInit       : 1;    // skip array initializers from optimizations
    bool lazyResolution     : 1;    //do not ask VM to resolve any classes during a compilation
    bool assertOnRecursion  : 1;    //assert of translator work in recursove compilation. Used to check lazy resolution mode.
};

class IRBuilderAction;
class TranslatorAction: public Action {
public:
    void init();
    const TranslatorFlags& getFlags() const {return flags;}
    IRBuilderAction* getIRBuilderAction() const {return irbAction;}
protected:
    void readFlags();
    TranslatorFlags flags;
    IRBuilderAction* irbAction;
};

class TranslatorSession: public SessionAction {
public:
    virtual void run ();
private:
    void translate();
    void postTranslatorCleanup();

    TranslatorFlags flags;
};


class OpndStack {
public:
    OpndStack(MemoryManager& memManager,U_32 slots);
    bool isEmpty() {
        return tos == 0;
    }
    bool isFull() {
        return tos == maxSlots;
    }
    U_32 getNumElems() {
        return tos;
    }
    Opnd* top() {
        if (isEmpty()) {
            assert(0);
            return NULL;
        }
        return opnds[tos-1];
    }
    Opnd* pop() {
        if (isEmpty()) {
            assert(0);
            return NULL;
        }
        return opnds[--tos];
    }
    bool push(Opnd* opnd) {
        if (isFull()) {
            assert(0);
            return false;
        }
        opnds[tos++] = opnd;
        return true;
    }
    Opnd* getElem(U_32 i) {
        if (i >= tos) {
            assert(0);
            return NULL;
        }
        return opnds[i];
    }
    void makeEmpty() {
        tos=0;
    }
private:
    //
    // private fields
    //
    const U_32 maxSlots;
    U_32 tos;
    Opnd**    opnds;
};


//
// utility methods added to allow refactoring of Opnd.h
//
extern bool 
isNonNullOpnd(Opnd* opnd);

extern bool 
isExactTypeOpnd(Opnd* opnd);

extern bool
isStackOpndAliveOpnd(Opnd* opnd);

extern bool
isStackOpndSavedOpnd(Opnd* opnd);

extern void
setNonNullOpnd(Opnd* opnd,bool val);

extern void
setExactTypeOpnd(Opnd* opnd,bool val);

extern void
setStackOpndAliveOpnd(Opnd* opnd,bool val);

extern void
setStackOpndSavedOpnd(Opnd* opnd,bool val);

} //namespace Jitrino 

#endif // _TRANSLATOR_INTFC_H_