Instrumentation.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2013 Jonathan Anderson
 * All rights reserved.
 *
 * This software was developed by SRI International and the University of
 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
 * ("CTSRD"), as part of the DARPA CRASH research programme.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef TESLA_INSTRUMENTATION_H
#define TESLA_INSTRUMENTATION_H

#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/IRBuilder.h"

#include "Transition.h"

#include "tesla.pb.h"
#include <libtesla.h>

namespace llvm {
  class BasicBlock;
  class Constant;
  class Instruction;
  class LLVMContext;
  class Module;
  class Twine;
  class Type;
  class Value;
}

namespace tesla {

class Automaton;
class FieldAssignTransition;
class FnTransition;
class Transition;

class FnInstrumentation {
public:
  void AppendInstrumentation(const Automaton&, const FunctionEvent&,
                             TEquivalenceClass&);

protected:
  FnInstrumentation(llvm::Module& M, const llvm::Function *TargetFn,
                    llvm::Function *InstrFn, FunctionEvent::Direction Dir)
    : M(M), TargetFn(TargetFn), InstrFn(InstrFn), Dir(Dir)
  {
  }

  llvm::Module& M;                  
  const llvm::Function *TargetFn;   
  llvm::Function *InstrFn;          
  FunctionEvent::Direction Dir;     
};

class InstInstrumentation {
public:
   virtual bool Instrument(llvm::Instruction&) = 0;
};

typedef llvm::SmallVector<llvm::Value*,3> ArgVector;

typedef llvm::SmallVector<llvm::Type*,3> TypeVector;

llvm::Type* IntPtrType(llvm::Module&);

llvm::StructType* TransitionType(llvm::Module&);

llvm::StructType* TransitionSetType(llvm::Module&);

llvm::Constant* TeslaContext(AutomatonDescription::Context Context,
                             llvm::LLVMContext& Ctx);

llvm::BasicBlock* FindBlock(llvm::StringRef Name, llvm::Function&);

llvm::Function* FindStateUpdateFn(llvm::Module&,
                                  llvm::Type *IntType);

llvm::Value* Cast(llvm::Value *From, llvm::StringRef Name,
                  llvm::Type *NewType, llvm::IRBuilder<>&);

llvm::BasicBlock* CreateInstrPreamble(llvm::Module& Mod, llvm::Function *F,
                                      const llvm::Twine& Prefix,
                                      bool SuppressDebugInstrumentation);

llvm::Value* ConstructKey(llvm::IRBuilder<>&, llvm::Module&,
                          llvm::ArrayRef<llvm::Value*> Args);

llvm::Constant* ConstructTransition(llvm::IRBuilder<>&, llvm::Module&,
                                    const Transition&);

llvm::Constant* ConstructTransitions(llvm::IRBuilder<>&, llvm::Module&,
                                     const TEquivalenceClass&);

llvm::Function* FunctionInstrumentation(llvm::Module&, const llvm::Function&,
                                        FunctionEvent::Direction,
                                        FunctionEvent::CallContext,
                                        bool SuppressDebugInstr);

llvm::Function* StructInstrumentation(llvm::Module&, llvm::StructType*,
                                      llvm::StringRef FieldName, size_t Index,
                                      bool Store, bool SuppressDebugInstr);
}

#endif  /* !TESLA_INSTRUMENTATION_H */