LibCallSemantics.h

//===- LibCallSemantics.h - Describe library semantics --------------------===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file defines interfaces that can be used to describe language specific
// runtime library interfaces (e.g. libc, libm, etc) to LLVM optimizers.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_ANALYSIS_LIBCALLSEMANTICS_H
#define LLVM_ANALYSIS_LIBCALLSEMANTICS_H

#include "llvm/Analysis/AliasAnalysis.h"

namespace llvm {

  struct LibCallLocationInfo {
    // TODO: Flags: isContextSensitive etc.
    
    enum LocResult {
      Yes, No, Unknown
    };
    LocResult (*isLocation)(CallSite CS, const Value *Ptr, unsigned Size);
  };
  
  struct LibCallFunctionInfo {
    const char *Name;
    
    
    AliasAnalysis::ModRefResult UniversalBehavior;
    
    struct LocationMRInfo {
      unsigned LocationID;
      AliasAnalysis::ModRefResult MRInfo;
    };
    
    enum {
      DoesOnly,
      
      DoesNot
    } DetailsType;
    
    const LocationMRInfo *LocationDetails;
  };
  
  
  class LibCallInfo {
    // Implementation details of this object, private.
    mutable void *Impl;
    mutable const LibCallLocationInfo *Locations;
    mutable unsigned NumLocations;
  public:
    LibCallInfo() : Impl(0), Locations(0), NumLocations(0) {}
    virtual ~LibCallInfo();
    
    //===------------------------------------------------------------------===//
    //  Accessor Methods: Efficient access to contained data.
    //===------------------------------------------------------------------===//
    
    const LibCallLocationInfo &getLocationInfo(unsigned LocID) const;
    
    
    const LibCallFunctionInfo *getFunctionInfo(Function *F) const;
    
    
    //===------------------------------------------------------------------===//
    //  Implementation Methods: Subclasses should implement these.
    //===------------------------------------------------------------------===//
    
    virtual unsigned getLocationInfo(const LibCallLocationInfo *&Array) const {
      return 0;
    }
    
    virtual const LibCallFunctionInfo *getFunctionInfoArray() const = 0;
  };

} // end namespace llvm

#endif

---