ProgramPartitioner.hh

Go to the documentation of this file.

/*
    Copyright (c) 2012 Tampere University.

    This file is part of TTA-Based Codesign Environment (TCE).

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file ProgramPartitioner.hh
 *
 * Declaration of ProgramPartitioner class. A MachineFunctionPass that chooses
 * more restricted register classes for program's variables. The register classes
 * are chosen based on the connectivity and in the case of vector load sources
 * in a clustered regular machine, according to the vector lane index. In case
 * of clustered machines the chosen register classes map the register files in
 * each cluster node, therefore producing a node partitioning for the program.
 *
 * @author Pekka Jääskeläinen 2012
 */

#ifndef TCE_PROGRAM_PARTITIONER_HH
#define TCE_PROGRAM_PARTITIONER_HH

#include "CompilerWarnings.hh"

IGNORE_COMPILER_WARNING("-Wunused-parameter")

#include "llvm/CodeGen/Passes.h"
#include "tce_config.h"
#include "llvm/IR/Constant.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/Type.h"
#include "llvm/IR/Module.h"
#include "llvm/Pass.h"
#include "llvm/CodeGen/MachineFunctionPass.h"
#include "llvm/CodeGen/MachineRegisterInfo.h"
#include "llvm/Analysis/CFG.h"

#include "llvm/Support/Compiler.h"
#ifdef LLVM_OLDER_THAN_6_0
#include "llvm/Target/TargetInstrInfo.h"
#else
#include "llvm/CodeGen/TargetInstrInfo.h"
#endif
#include "llvm/ADT/DepthFirstIterator.h"

#include "llvm/Analysis/CallGraph.h"
#include "llvm/Analysis/AliasAnalysis.h"
#include "llvm/Analysis/Passes.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/raw_ostream.h"

#include "llvm/ADT/StringMap.h"

#include "hash_map.hh"

POP_COMPILER_DIAGS

struct ProgramPartitioner : public llvm::MachineFunctionPass {
    static char ID;
    ProgramPartitioner() : MachineFunctionPass(ID) {}

    virtual bool doInitialization(llvm::Module &M) override;
    virtual bool runOnMachineFunction(llvm::MachineFunction &MF) override;
    virtual bool doFinalization(llvm::Module &M) override;
    virtual bool findNodeIndex(
        const llvm::MachineInstr &I, 
        hash_map<const llvm::MachineInstr*, unsigned>& partitions,
        llvm::MachineFunction& MF,
        unsigned int& index);
#if LLVM_OLDER_THAN_4_0
    virtual const char *getPassName() const override {
#else
    virtual llvm::StringRef getPassName() const override {
#endif
        return "TCE: program variables to register file partitioner";
    }

public:
};

#endif