/usr/src/gnu/usr.bin/clang/libclangCodeGen/../../../llvm/clang/lib/CodeGen/CGObjCGNU.cpp

Bug Summary

File:	src/gnu/usr.bin/clang/libclangCodeGen/../../../llvm/clang/lib/CodeGen/CGObjCGNU.cpp
Warning:	line 2394, column 36 Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -cc1 -triple amd64-unknown-openbsd7.0 -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name CGObjCGNU.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model static -mframe-pointer=all -relaxed-aliasing -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -fcoverage-compilation-dir=/usr/src/gnu/usr.bin/clang/libclangCodeGen/obj -resource-dir /usr/local/lib/clang/13.0.0 -I /usr/src/gnu/usr.bin/clang/libclangCodeGen/../../../llvm/clang/include -I /usr/src/gnu/usr.bin/clang/libclangCodeGen/../../../llvm/llvm/include -I /usr/src/gnu/usr.bin/clang/libclangCodeGen/../include -I /usr/src/gnu/usr.bin/clang/libclangCodeGen/obj -I /usr/src/gnu/usr.bin/clang/libclangCodeGen/obj/../include -D NDEBUG -D __STDC_LIMIT_MACROS -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D LLVM_PREFIX="/usr" -internal-isystem /usr/include/c++/v1 -internal-isystem /usr/local/lib/clang/13.0.0/include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/usr/src/gnu/usr.bin/clang/libclangCodeGen/obj -ferror-limit 19 -fvisibility-inlines-hidden -fwrapv -stack-protector 2 -fno-rtti -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -fno-builtin-malloc -fno-builtin-calloc -fno-builtin-realloc -fno-builtin-valloc -fno-builtin-free -fno-builtin-strdup -fno-builtin-strndup -analyzer-output=html -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /home/ben/Projects/vmm/scan-build/2022-01-12-194120-40624-1 -x c++ /usr/src/gnu/usr.bin/clang/libclangCodeGen/../../../llvm/clang/lib/CodeGen/CGObjCGNU.cpp

/usr/src/gnu/usr.bin/clang/libclangCodeGen/../../../llvm/clang/lib/CodeGen/CGObjCGNU.cpp

→

1//===------- CGObjCGNU.cpp - Emit LLVM Code from ASTs for a Module --------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This provides Objective-C code generation targeting the GNU runtime.  The
10// class in this file generates structures used by the GNU Objective-C runtime
11// library.  These structures are defined in objc/objc.h and objc/objc-api.h in
12// the GNU runtime distribution.
13//
14//===----------------------------------------------------------------------===//

16#include "CGCXXABI.h"
17#include "CGCleanup.h"
18#include "CGObjCRuntime.h"
19#include "CodeGenFunction.h"
20#include "CodeGenModule.h"
21#include "clang/AST/ASTContext.h"
22#include "clang/AST/Attr.h"
23#include "clang/AST/Decl.h"
24#include "clang/AST/DeclObjC.h"
25#include "clang/AST/RecordLayout.h"
26#include "clang/AST/StmtObjC.h"
27#include "clang/Basic/FileManager.h"
28#include "clang/Basic/SourceManager.h"
29#include "clang/CodeGen/ConstantInitBuilder.h"
30#include "llvm/ADT/SmallVector.h"
31#include "llvm/ADT/StringMap.h"
32#include "llvm/IR/DataLayout.h"
33#include "llvm/IR/Intrinsics.h"
34#include "llvm/IR/LLVMContext.h"
35#include "llvm/IR/Module.h"
36#include "llvm/Support/Compiler.h"
37#include "llvm/Support/ConvertUTF.h"
38#include <cctype>

40using namespace clang;
41using namespace CodeGen;

43namespace {

45/// Class that lazily initialises the runtime function.  Avoids inserting the
46/// types and the function declaration into a module if they're not used, and
47/// avoids constructing the type more than once if it's used more than once.
48class LazyRuntimeFunction {
CodeGenModule *CGM;
llvm::FunctionType *FTy;
const char *FunctionName;
llvm::FunctionCallee Function;

54public:
/// Constructor leaves this class uninitialized, because it is intended to
/// be used as a field in another class and not all of the types that are
/// used as arguments will necessarily be available at construction time.
LazyRuntimeFunction()
    : CGM(nullptr), FunctionName(nullptr), Function(nullptr) {}

/// Initialises the lazy function with the name, return type, and the types
/// of the arguments.
template <typename... Tys>
void init(CodeGenModule *Mod, const char *name, llvm::Type *RetTy,
          Tys *... Types) {
  CGM = Mod;
  FunctionName = name;
  Function = nullptr;
  if(sizeof...(Tys)) {
    SmallVector<llvm::Type *, 8> ArgTys({Types...});
    FTy = llvm::FunctionType::get(RetTy, ArgTys, false);
  }
  else {
    FTy = llvm::FunctionType::get(RetTy, None, false);
  }
}

llvm::FunctionType *getType() { return FTy; }

/// Overloaded cast operator, allows the class to be implicitly cast to an
/// LLVM constant.
operator llvm::FunctionCallee() {
  if (!Function) {
    if (!FunctionName)
      return nullptr;
    Function = CGM->CreateRuntimeFunction(FTy, FunctionName);
  }
  return Function;
}
90};


93/// GNU Objective-C runtime code generation.  This class implements the parts of
94/// Objective-C support that are specific to the GNU family of runtimes (GCC,
95/// GNUstep and ObjFW).
96class CGObjCGNU : public CGObjCRuntime {
97protected:
/// The LLVM module into which output is inserted
llvm::Module &TheModule;
/// strut objc_super.  Used for sending messages to super.  This structure
/// contains the receiver (object) and the expected class.
llvm::StructType *ObjCSuperTy;
/// struct objc_super*.  The type of the argument to the superclass message
/// lookup functions.
llvm::PointerType *PtrToObjCSuperTy;
/// LLVM type for selectors.  Opaque pointer (i8*) unless a header declaring
/// SEL is included in a header somewhere, in which case it will be whatever
/// type is declared in that header, most likely {i8*, i8*}.
llvm::PointerType *SelectorTy;
/// LLVM i8 type.  Cached here to avoid repeatedly getting it in all of the
/// places where it's used
llvm::IntegerType *Int8Ty;
/// Pointer to i8 - LLVM type of char*, for all of the places where the
/// runtime needs to deal with C strings.
llvm::PointerType *PtrToInt8Ty;
/// struct objc_protocol type
llvm::StructType *ProtocolTy;
/// Protocol * type.
llvm::PointerType *ProtocolPtrTy;
/// Instance Method Pointer type.  This is a pointer to a function that takes,
/// at a minimum, an object and a selector, and is the generic type for
/// Objective-C methods.  Due to differences between variadic / non-variadic
/// calling conventions, it must always be cast to the correct type before
/// actually being used.
llvm::PointerType *IMPTy;
/// Type of an untyped Objective-C object.  Clang treats id as a built-in type
/// when compiling Objective-C code, so this may be an opaque pointer (i8*),
/// but if the runtime header declaring it is included then it may be a
/// pointer to a structure.
llvm::PointerType *IdTy;
/// Pointer to a pointer to an Objective-C object.  Used in the new ABI
/// message lookup function and some GC-related functions.
llvm::PointerType *PtrToIdTy;
/// The clang type of id.  Used when using the clang CGCall infrastructure to
/// call Objective-C methods.
CanQualType ASTIdTy;
/// LLVM type for C int type.
llvm::IntegerType *IntTy;
/// LLVM type for an opaque pointer.  This is identical to PtrToInt8Ty, but is
/// used in the code to document the difference between i8* meaning a pointer
/// to a C string and i8* meaning a pointer to some opaque type.
llvm::PointerType *PtrTy;
/// LLVM type for C long type.  The runtime uses this in a lot of places where
/// it should be using intptr_t, but we can't fix this without breaking
/// compatibility with GCC...
llvm::IntegerType *LongTy;
/// LLVM type for C size_t.  Used in various runtime data structures.
llvm::IntegerType *SizeTy;
/// LLVM type for C intptr_t.
llvm::IntegerType *IntPtrTy;
/// LLVM type for C ptrdiff_t.  Mainly used in property accessor functions.
llvm::IntegerType *PtrDiffTy;
/// LLVM type for C int*.  Used for GCC-ABI-compatible non-fragile instance
/// variables.
llvm::PointerType *PtrToIntTy;
/// LLVM type for Objective-C BOOL type.
llvm::Type *BoolTy;
/// 32-bit integer type, to save us needing to look it up every time it's used.
llvm::IntegerType *Int32Ty;
/// 64-bit integer type, to save us needing to look it up every time it's used.
llvm::IntegerType *Int64Ty;
/// The type of struct objc_property.
llvm::StructType *PropertyMetadataTy;
/// Metadata kind used to tie method lookups to message sends.  The GNUstep
/// runtime provides some LLVM passes that can use this to do things like
/// automatic IMP caching and speculative inlining.
unsigned msgSendMDKind;
/// Does the current target use SEH-based exceptions? False implies
/// Itanium-style DWARF unwinding.
bool usesSEHExceptions;

/// Helper to check if we are targeting a specific runtime version or later.
bool isRuntime(ObjCRuntime::Kind kind, unsigned major, unsigned minor=0) {
  const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;
  return (R.getKind() == kind) &&
    (R.getVersion() >= VersionTuple(major, minor));
}

std::string ManglePublicSymbol(StringRef Name) {
  return (StringRef(CGM.getTriple().isOSBinFormatCOFF() ? "$_" : "._") + Name).str();
}

std::string SymbolForProtocol(Twine Name) {
  return (ManglePublicSymbol("OBJC_PROTOCOL_") + Name).str();
}

std::string SymbolForProtocolRef(StringRef Name) {
  return (ManglePublicSymbol("OBJC_REF_PROTOCOL_") + Name).str();
}


/// Helper function that generates a constant string and returns a pointer to
/// the start of the string.  The result of this function can be used anywhere
/// where the C code specifies const char*.
llvm::Constant *MakeConstantString(StringRef Str, const char *Name = "") {
  ConstantAddress Array =
      CGM.GetAddrOfConstantCString(std::string(Str), Name);
  return llvm::ConstantExpr::getGetElementPtr(Array.getElementType(),
                                              Array.getPointer(), Zeros);
}

/// Emits a linkonce_odr string, whose name is the prefix followed by the
/// string value.  This allows the linker to combine the strings between
/// different modules.  Used for EH typeinfo names, selector strings, and a
/// few other things.
llvm::Constant *ExportUniqueString(const std::string &Str,
                                   const std::string &prefix,
                                   bool Private=false) {
  std::string name = prefix + Str;
  auto *ConstStr = TheModule.getGlobalVariable(name);
  if (!ConstStr) {
    llvm::Constant *value = llvm::ConstantDataArray::getString(VMContext,Str);
    auto *GV = new llvm::GlobalVariable(TheModule, value->getType(), true,
            llvm::GlobalValue::LinkOnceODRLinkage, value, name);
    GV->setComdat(TheModule.getOrInsertComdat(name));
    if (Private)
      GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
    ConstStr = GV;
  }
  return llvm::ConstantExpr::getGetElementPtr(ConstStr->getValueType(),
                                              ConstStr, Zeros);
}

/// Returns a property name and encoding string.
llvm::Constant *MakePropertyEncodingString(const ObjCPropertyDecl *PD,
                                           const Decl *Container) {
  assert(!isRuntime(ObjCRuntime::GNUstep, 2))((void)0);
  if (isRuntime(ObjCRuntime::GNUstep, 1, 6)) {
    std::string NameAndAttributes;
    std::string TypeStr =
      CGM.getContext().getObjCEncodingForPropertyDecl(PD, Container);
    NameAndAttributes += '\0';
    NameAndAttributes += TypeStr.length() + 3;
    NameAndAttributes += TypeStr;
    NameAndAttributes += '\0';
    NameAndAttributes += PD->getNameAsString();
    return MakeConstantString(NameAndAttributes);
  }
  return MakeConstantString(PD->getNameAsString());
}

/// Push the property attributes into two structure fields.
void PushPropertyAttributes(ConstantStructBuilder &Fields,
    const ObjCPropertyDecl *property, bool isSynthesized=true, bool
    isDynamic=true) {
  int attrs = property->getPropertyAttributes();
  // For read-only properties, clear the copy and retain flags
  if (attrs & ObjCPropertyAttribute::kind_readonly) {
    attrs &= ~ObjCPropertyAttribute::kind_copy;
    attrs &= ~ObjCPropertyAttribute::kind_retain;
    attrs &= ~ObjCPropertyAttribute::kind_weak;
    attrs &= ~ObjCPropertyAttribute::kind_strong;
  }
  // The first flags field has the same attribute values as clang uses internally
  Fields.addInt(Int8Ty, attrs & 0xff);
  attrs >>= 8;
  attrs <<= 2;
  // For protocol properties, synthesized and dynamic have no meaning, so we
  // reuse these flags to indicate that this is a protocol property (both set
  // has no meaning, as a property can't be both synthesized and dynamic)
  attrs |= isSynthesized ? (1<<0) : 0;
  attrs |= isDynamic ? (1<<1) : 0;
  // The second field is the next four fields left shifted by two, with the
  // low bit set to indicate whether the field is synthesized or dynamic.
  Fields.addInt(Int8Ty, attrs & 0xff);
  // Two padding fields
  Fields.addInt(Int8Ty, 0);
  Fields.addInt(Int8Ty, 0);
}

virtual llvm::Constant *GenerateCategoryProtocolList(const
    ObjCCategoryDecl *OCD);
virtual ConstantArrayBuilder PushPropertyListHeader(ConstantStructBuilder &Fields,
    int count) {
    // int count;
    Fields.addInt(IntTy, count);
    // int size; (only in GNUstep v2 ABI.
    if (isRuntime(ObjCRuntime::GNUstep, 2)) {
      llvm::DataLayout td(&TheModule);
      Fields.addInt(IntTy, td.getTypeSizeInBits(PropertyMetadataTy) /
          CGM.getContext().getCharWidth());
    }
    // struct objc_property_list *next;
    Fields.add(NULLPtr);
    // struct objc_property properties[]
    return Fields.beginArray(PropertyMetadataTy);
}
virtual void PushProperty(ConstantArrayBuilder &PropertiesArray,
          const ObjCPropertyDecl *property,
          const Decl *OCD,
          bool isSynthesized=true, bool
          isDynamic=true) {
  auto Fields = PropertiesArray.beginStruct(PropertyMetadataTy);
  ASTContext &Context = CGM.getContext();
  Fields.add(MakePropertyEncodingString(property, OCD));
  PushPropertyAttributes(Fields, property, isSynthesized, isDynamic);
  auto addPropertyMethod = [&](const ObjCMethodDecl *accessor) {
    if (accessor) {
      std::string TypeStr = Context.getObjCEncodingForMethodDecl(accessor);
      llvm::Constant *TypeEncoding = MakeConstantString(TypeStr);
      Fields.add(MakeConstantString(accessor->getSelector().getAsString()));
      Fields.add(TypeEncoding);
    } else {
      Fields.add(NULLPtr);
      Fields.add(NULLPtr);
    }
  };
  addPropertyMethod(property->getGetterMethodDecl());
  addPropertyMethod(property->getSetterMethodDecl());
  Fields.finishAndAddTo(PropertiesArray);
}

/// Ensures that the value has the required type, by inserting a bitcast if
/// required.  This function lets us avoid inserting bitcasts that are
/// redundant.
llvm::Value* EnforceType(CGBuilderTy &B, llvm::Value *V, llvm::Type *Ty) {
  if (V->getType() == Ty) return V;
  return B.CreateBitCast(V, Ty);
}
Address EnforceType(CGBuilderTy &B, Address V, llvm::Type *Ty) {
  if (V.getType() == Ty) return V;
  return B.CreateBitCast(V, Ty);
}

// Some zeros used for GEPs in lots of places.
llvm::Constant *Zeros[2];
/// Null pointer value.  Mainly used as a terminator in various arrays.
llvm::Constant *NULLPtr;
/// LLVM context.
llvm::LLVMContext &VMContext;

332protected:

/// Placeholder for the class.  Lots of things refer to the class before we've
/// actually emitted it.  We use this alias as a placeholder, and then replace
/// it with a pointer to the class structure before finally emitting the
/// module.
llvm::GlobalAlias *ClassPtrAlias;
/// Placeholder for the metaclass.  Lots of things refer to the class before
/// we've / actually emitted it.  We use this alias as a placeholder, and then
/// replace / it with a pointer to the metaclass structure before finally
/// emitting the / module.
llvm::GlobalAlias *MetaClassPtrAlias;
/// All of the classes that have been generated for this compilation units.
std::vector<llvm::Constant*> Classes;
/// All of the categories that have been generated for this compilation units.
std::vector<llvm::Constant*> Categories;
/// All of the Objective-C constant strings that have been generated for this
/// compilation units.
std::vector<llvm::Constant*> ConstantStrings;
/// Map from string values to Objective-C constant strings in the output.
/// Used to prevent emitting Objective-C strings more than once.  This should
/// not be required at all - CodeGenModule should manage this list.
llvm::StringMap<llvm::Constant*> ObjCStrings;
/// All of the protocols that have been declared.
llvm::StringMap<llvm::Constant*> ExistingProtocols;
/// For each variant of a selector, we store the type encoding and a
/// placeholder value.  For an untyped selector, the type will be the empty
/// string.  Selector references are all done via the module's selector table,
/// so we create an alias as a placeholder and then replace it with the real
/// value later.
typedef std::pair<std::string, llvm::GlobalAlias*> TypedSelector;
/// Type of the selector map.  This is roughly equivalent to the structure
/// used in the GNUstep runtime, which maintains a list of all of the valid
/// types for a selector in a table.
typedef llvm::DenseMap<Selector, SmallVector<TypedSelector, 2> >
  SelectorMap;
/// A map from selectors to selector types.  This allows us to emit all
/// selectors of the same name and type together.
SelectorMap SelectorTable;

/// Selectors related to memory management.  When compiling in GC mode, we
/// omit these.
Selector RetainSel, ReleaseSel, AutoreleaseSel;
/// Runtime functions used for memory management in GC mode.  Note that clang
/// supports code generation for calling these functions, but neither GNU
/// runtime actually supports this API properly yet.
LazyRuntimeFunction IvarAssignFn, StrongCastAssignFn, MemMoveFn, WeakReadFn,
  WeakAssignFn, GlobalAssignFn;

typedef std::pair<std::string, std::string> ClassAliasPair;
/// All classes that have aliases set for them.
std::vector<ClassAliasPair> ClassAliases;

385protected:
/// Function used for throwing Objective-C exceptions.
LazyRuntimeFunction ExceptionThrowFn;
/// Function used for rethrowing exceptions, used at the end of \@finally or
/// \@synchronize blocks.
LazyRuntimeFunction ExceptionReThrowFn;
/// Function called when entering a catch function.  This is required for
/// differentiating Objective-C exceptions and foreign exceptions.
LazyRuntimeFunction EnterCatchFn;
/// Function called when exiting from a catch block.  Used to do exception
/// cleanup.
LazyRuntimeFunction ExitCatchFn;
/// Function called when entering an \@synchronize block.  Acquires the lock.
LazyRuntimeFunction SyncEnterFn;
/// Function called when exiting an \@synchronize block.  Releases the lock.
LazyRuntimeFunction SyncExitFn;

402private:
/// Function called if fast enumeration detects that the collection is
/// modified during the update.
LazyRuntimeFunction EnumerationMutationFn;
/// Function for implementing synthesized property getters that return an
/// object.
LazyRuntimeFunction GetPropertyFn;
/// Function for implementing synthesized property setters that return an
/// object.
LazyRuntimeFunction SetPropertyFn;
/// Function used for non-object declared property getters.
LazyRuntimeFunction GetStructPropertyFn;
/// Function used for non-object declared property setters.
LazyRuntimeFunction SetStructPropertyFn;

417protected:
/// The version of the runtime that this class targets.  Must match the
/// version in the runtime.
int RuntimeVersion;
/// The version of the protocol class.  Used to differentiate between ObjC1
/// and ObjC2 protocols.  Objective-C 1 protocols can not contain optional
/// components and can not contain declared properties.  We always emit
/// Objective-C 2 property structures, but we have to pretend that they're
/// Objective-C 1 property structures when targeting the GCC runtime or it
/// will abort.
const int ProtocolVersion;
/// The version of the class ABI.  This value is used in the class structure
/// and indicates how various fields should be interpreted.
const int ClassABIVersion;
/// Generates an instance variable list structure.  This is a structure
/// containing a size and an array of structures containing instance variable
/// metadata.  This is used purely for introspection in the fragile ABI.  In
/// the non-fragile ABI, it's used for instance variable fixup.
virtual llvm::Constant *GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
                           ArrayRef<llvm::Constant *> IvarTypes,
                           ArrayRef<llvm::Constant *> IvarOffsets,
                           ArrayRef<llvm::Constant *> IvarAlign,
                           ArrayRef<Qualifiers::ObjCLifetime> IvarOwnership);

/// Generates a method list structure.  This is a structure containing a size
/// and an array of structures containing method metadata.
///
/// This structure is used by both classes and categories, and contains a next
/// pointer allowing them to be chained together in a linked list.
llvm::Constant *GenerateMethodList(StringRef ClassName,
    StringRef CategoryName,
    ArrayRef<const ObjCMethodDecl*> Methods,
    bool isClassMethodList);

/// Emits an empty protocol.  This is used for \@protocol() where no protocol
/// is found.  The runtime will (hopefully) fix up the pointer to refer to the
/// real protocol.
virtual llvm::Constant *GenerateEmptyProtocol(StringRef ProtocolName);

/// Generates a list of property metadata structures.  This follows the same
/// pattern as method and instance variable metadata lists.
llvm::Constant *GeneratePropertyList(const Decl *Container,
    const ObjCContainerDecl *OCD,
    bool isClassProperty=false,
    bool protocolOptionalProperties=false);

/// Generates a list of referenced protocols.  Classes, categories, and
/// protocols all use this structure.
llvm::Constant *GenerateProtocolList(ArrayRef<std::string> Protocols);

/// To ensure that all protocols are seen by the runtime, we add a category on
/// a class defined in the runtime, declaring no methods, but adopting the
/// protocols.  This is a horribly ugly hack, but it allows us to collect all
/// of the protocols without changing the ABI.
void GenerateProtocolHolderCategory();

/// Generates a class structure.
llvm::Constant *GenerateClassStructure(
    llvm::Constant *MetaClass,
    llvm::Constant *SuperClass,
    unsigned info,
    const char *Name,
    llvm::Constant *Version,
    llvm::Constant *InstanceSize,
    llvm::Constant *IVars,
    llvm::Constant *Methods,
    llvm::Constant *Protocols,
    llvm::Constant *IvarOffsets,
    llvm::Constant *Properties,
    llvm::Constant *StrongIvarBitmap,
    llvm::Constant *WeakIvarBitmap,
    bool isMeta=false);

/// Generates a method list.  This is used by protocols to define the required
/// and optional methods.
virtual llvm::Constant *GenerateProtocolMethodList(
    ArrayRef<const ObjCMethodDecl*> Methods);
/// Emits optional and required method lists.
template<class T>
void EmitProtocolMethodList(T &&Methods, llvm::Constant *&Required,
    llvm::Constant *&Optional) {
  SmallVector<const ObjCMethodDecl*, 16> RequiredMethods;
  SmallVector<const ObjCMethodDecl*, 16> OptionalMethods;
  for (const auto *I : Methods)
    if (I->isOptional())
      OptionalMethods.push_back(I);
    else
      RequiredMethods.push_back(I);
  Required = GenerateProtocolMethodList(RequiredMethods);
  Optional = GenerateProtocolMethodList(OptionalMethods);
}

/// Returns a selector with the specified type encoding.  An empty string is
/// used to return an untyped selector (with the types field set to NULL).
virtual llvm::Value *GetTypedSelector(CodeGenFunction &CGF, Selector Sel,
                                      const std::string &TypeEncoding);

/// Returns the name of ivar offset variables.  In the GNUstep v1 ABI, this
/// contains the class and ivar names, in the v2 ABI this contains the type
/// encoding as well.
virtual std::string GetIVarOffsetVariableName(const ObjCInterfaceDecl *ID,
                                              const ObjCIvarDecl *Ivar) {
  const std::string Name = "__objc_ivar_offset_" + ID->getNameAsString()
    + '.' + Ivar->getNameAsString();
  return Name;
}
/// Returns the variable used to store the offset of an instance variable.
llvm::GlobalVariable *ObjCIvarOffsetVariable(const ObjCInterfaceDecl *ID,
    const ObjCIvarDecl *Ivar);
/// Emits a reference to a class.  This allows the linker to object if there
/// is no class of the matching name.
void EmitClassRef(const std::string &className);

/// Emits a pointer to the named class
virtual llvm::Value *GetClassNamed(CodeGenFunction &CGF,
                                   const std::string &Name, bool isWeak);

/// Looks up the method for sending a message to the specified object.  This
/// mechanism differs between the GCC and GNU runtimes, so this method must be
/// overridden in subclasses.
virtual llvm::Value *LookupIMP(CodeGenFunction &CGF,
                               llvm::Value *&Receiver,
                               llvm::Value *cmd,
                               llvm::MDNode *node,
                               MessageSendInfo &MSI) = 0;

/// Looks up the method for sending a message to a superclass.  This
/// mechanism differs between the GCC and GNU runtimes, so this method must
/// be overridden in subclasses.
virtual llvm::Value *LookupIMPSuper(CodeGenFunction &CGF,
                                    Address ObjCSuper,
                                    llvm::Value *cmd,
                                    MessageSendInfo &MSI) = 0;

/// Libobjc2 uses a bitfield representation where small(ish) bitfields are
/// stored in a 64-bit value with the low bit set to 1 and the remaining 63
/// bits set to their values, LSB first, while larger ones are stored in a
/// structure of this / form:
///
/// struct { int32_t length; int32_t values[length]; };
///
/// The values in the array are stored in host-endian format, with the least
/// significant bit being assumed to come first in the bitfield.  Therefore,
/// a bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] },
/// while a bitfield / with the 63rd bit set will be 1<<64.
llvm::Constant *MakeBitField(ArrayRef<bool> bits);

564public:
CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
    unsigned protocolClassVersion, unsigned classABI=1);

ConstantAddress GenerateConstantString(const StringLiteral *) override;

RValue
GenerateMessageSend(CodeGenFunction &CGF, ReturnValueSlot Return,
                    QualType ResultType, Selector Sel,
                    llvm::Value *Receiver, const CallArgList &CallArgs,
                    const ObjCInterfaceDecl *Class,
                    const ObjCMethodDecl *Method) override;
RValue
GenerateMessageSendSuper(CodeGenFunction &CGF, ReturnValueSlot Return,
                         QualType ResultType, Selector Sel,
                         const ObjCInterfaceDecl *Class,
                         bool isCategoryImpl, llvm::Value *Receiver,
                         bool IsClassMessage, const CallArgList &CallArgs,
                         const ObjCMethodDecl *Method) override;
llvm::Value *GetClass(CodeGenFunction &CGF,
                      const ObjCInterfaceDecl *OID) override;
llvm::Value *GetSelector(CodeGenFunction &CGF, Selector Sel) override;
Address GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) override;
llvm::Value *GetSelector(CodeGenFunction &CGF,
                         const ObjCMethodDecl *Method) override;
virtual llvm::Constant *GetConstantSelector(Selector Sel,
                                            const std::string &TypeEncoding) {
  llvm_unreachable("Runtime unable to generate constant selector")__builtin_unreachable();
}
llvm::Constant *GetConstantSelector(const ObjCMethodDecl *M) {
  return GetConstantSelector(M->getSelector(),
      CGM.getContext().getObjCEncodingForMethodDecl(M));
}
llvm::Constant *GetEHType(QualType T) override;

llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
                               const ObjCContainerDecl *CD) override;
void GenerateDirectMethodPrologue(CodeGenFunction &CGF, llvm::Function *Fn,
                                  const ObjCMethodDecl *OMD,
                                  const ObjCContainerDecl *CD) override;
void GenerateCategory(const ObjCCategoryImplDecl *CMD) override;
void GenerateClass(const ObjCImplementationDecl *ClassDecl) override;
void RegisterAlias(const ObjCCompatibleAliasDecl *OAD) override;
llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
                                 const ObjCProtocolDecl *PD) override;
void GenerateProtocol(const ObjCProtocolDecl *PD) override;

virtual llvm::Constant *GenerateProtocolRef(const ObjCProtocolDecl *PD);

llvm::Constant *GetOrEmitProtocol(const ObjCProtocolDecl *PD) override {
  return GenerateProtocolRef(PD);
}

llvm::Function *ModuleInitFunction() override;
llvm::FunctionCallee GetPropertyGetFunction() override;
llvm::FunctionCallee GetPropertySetFunction() override;
llvm::FunctionCallee GetOptimizedPropertySetFunction(bool atomic,
                                                     bool copy) override;
llvm::FunctionCallee GetSetStructFunction() override;
llvm::FunctionCallee GetGetStructFunction() override;
llvm::FunctionCallee GetCppAtomicObjectGetFunction() override;
llvm::FunctionCallee GetCppAtomicObjectSetFunction() override;
llvm::FunctionCallee EnumerationMutationFunction() override;

void EmitTryStmt(CodeGenFunction &CGF,
                 const ObjCAtTryStmt &S) override;
void EmitSynchronizedStmt(CodeGenFunction &CGF,
                          const ObjCAtSynchronizedStmt &S) override;
void EmitThrowStmt(CodeGenFunction &CGF,
                   const ObjCAtThrowStmt &S,
                   bool ClearInsertionPoint=true) override;
llvm::Value * EmitObjCWeakRead(CodeGenFunction &CGF,
                               Address AddrWeakObj) override;
void EmitObjCWeakAssign(CodeGenFunction &CGF,
                        llvm::Value *src, Address dst) override;
void EmitObjCGlobalAssign(CodeGenFunction &CGF,
                          llvm::Value *src, Address dest,
                          bool threadlocal=false) override;
void EmitObjCIvarAssign(CodeGenFunction &CGF, llvm::Value *src,
                        Address dest, llvm::Value *ivarOffset) override;
void EmitObjCStrongCastAssign(CodeGenFunction &CGF,
                              llvm::Value *src, Address dest) override;
void EmitGCMemmoveCollectable(CodeGenFunction &CGF, Address DestPtr,
                              Address SrcPtr,
                              llvm::Value *Size) override;
LValue EmitObjCValueForIvar(CodeGenFunction &CGF, QualType ObjectTy,
                            llvm::Value *BaseValue, const ObjCIvarDecl *Ivar,
                            unsigned CVRQualifiers) override;
llvm::Value *EmitIvarOffset(CodeGenFunction &CGF,
                            const ObjCInterfaceDecl *Interface,
                            const ObjCIvarDecl *Ivar) override;
llvm::Value *EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) override;
llvm::Constant *BuildGCBlockLayout(CodeGenModule &CGM,
                                   const CGBlockInfo &blockInfo) override {
  return NULLPtr;
}
llvm::Constant *BuildRCBlockLayout(CodeGenModule &CGM,
                                   const CGBlockInfo &blockInfo) override {
  return NULLPtr;
}

llvm::Constant *BuildByrefLayout(CodeGenModule &CGM, QualType T) override {
  return NULLPtr;
}
668};

670/// Class representing the legacy GCC Objective-C ABI.  This is the default when
671/// -fobjc-nonfragile-abi is not specified.
672///
673/// The GCC ABI target actually generates code that is approximately compatible
674/// with the new GNUstep runtime ABI, but refrains from using any features that
675/// would not work with the GCC runtime.  For example, clang always generates
676/// the extended form of the class structure, and the extra fields are simply
677/// ignored by GCC libobjc.
678class CGObjCGCC : public CGObjCGNU {
/// The GCC ABI message lookup function.  Returns an IMP pointing to the
/// method implementation for this message.
LazyRuntimeFunction MsgLookupFn;
/// The GCC ABI superclass message lookup function.  Takes a pointer to a
/// structure describing the receiver and the class, and a selector as
/// arguments.  Returns the IMP for the corresponding method.
LazyRuntimeFunction MsgLookupSuperFn;

687protected:
llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
                       llvm::Value *cmd, llvm::MDNode *node,
                       MessageSendInfo &MSI) override {
  CGBuilderTy &Builder = CGF.Builder;
  llvm::Value *args[] = {
          EnforceType(Builder, Receiver, IdTy),
          EnforceType(Builder, cmd, SelectorTy) };
  llvm::CallBase *imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);
  imp->setMetadata(msgSendMDKind, node);
  return imp;
}

llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
                            llvm::Value *cmd, MessageSendInfo &MSI) override {
  CGBuilderTy &Builder = CGF.Builder;
  llvm::Value *lookupArgs[] = {EnforceType(Builder, ObjCSuper,
      PtrToObjCSuperTy).getPointer(), cmd};
  return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
}

708public:
CGObjCGCC(CodeGenModule &Mod) : CGObjCGNU(Mod, 8, 2) {
  // IMP objc_msg_lookup(id, SEL);
  MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy);
  // IMP objc_msg_lookup_super(struct objc_super*, SEL);
  MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
                        PtrToObjCSuperTy, SelectorTy);
}
716};

718/// Class used when targeting the new GNUstep runtime ABI.
719class CGObjCGNUstep : public CGObjCGNU {
  /// The slot lookup function.  Returns a pointer to a cacheable structure
  /// that contains (among other things) the IMP.
  LazyRuntimeFunction SlotLookupFn;
  /// The GNUstep ABI superclass message lookup function.  Takes a pointer to
  /// a structure describing the receiver and the class, and a selector as
  /// arguments.  Returns the slot for the corresponding method.  Superclass
  /// message lookup rarely changes, so this is a good caching opportunity.
  LazyRuntimeFunction SlotLookupSuperFn;
  /// Specialised function for setting atomic retain properties
  LazyRuntimeFunction SetPropertyAtomic;
  /// Specialised function for setting atomic copy properties
  LazyRuntimeFunction SetPropertyAtomicCopy;
  /// Specialised function for setting nonatomic retain properties
  LazyRuntimeFunction SetPropertyNonAtomic;
  /// Specialised function for setting nonatomic copy properties
  LazyRuntimeFunction SetPropertyNonAtomicCopy;
  /// Function to perform atomic copies of C++ objects with nontrivial copy
  /// constructors from Objective-C ivars.
  LazyRuntimeFunction CxxAtomicObjectGetFn;
  /// Function to perform atomic copies of C++ objects with nontrivial copy
  /// constructors to Objective-C ivars.
  LazyRuntimeFunction CxxAtomicObjectSetFn;
  /// Type of a slot structure pointer.  This is returned by the various
  /// lookup functions.
  llvm::Type *SlotTy;
  /// Type of a slot structure.
  llvm::Type *SlotStructTy;

public:
  llvm::Constant *GetEHType(QualType T) override;

protected:
  llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
                         llvm::Value *cmd, llvm::MDNode *node,
                         MessageSendInfo &MSI) override {
    CGBuilderTy &Builder = CGF.Builder;
    llvm::FunctionCallee LookupFn = SlotLookupFn;

    // Store the receiver on the stack so that we can reload it later
    Address ReceiverPtr =
      CGF.CreateTempAlloca(Receiver->getType(), CGF.getPointerAlign());
    Builder.CreateStore(Receiver, ReceiverPtr);

    llvm::Value *self;

    if (isa<ObjCMethodDecl>(CGF.CurCodeDecl)) {
      self = CGF.LoadObjCSelf();
    } else {
      self = llvm::ConstantPointerNull::get(IdTy);
    }

    // The lookup function is guaranteed not to capture the receiver pointer.
    if (auto *LookupFn2 = dyn_cast<llvm::Function>(LookupFn.getCallee()))
      LookupFn2->addParamAttr(0, llvm::Attribute::NoCapture);

    llvm::Value *args[] = {
            EnforceType(Builder, ReceiverPtr.getPointer(), PtrToIdTy),
            EnforceType(Builder, cmd, SelectorTy),
            EnforceType(Builder, self, IdTy) };
    llvm::CallBase *slot = CGF.EmitRuntimeCallOrInvoke(LookupFn, args);
    slot->setOnlyReadsMemory();
    slot->setMetadata(msgSendMDKind, node);

    // Load the imp from the slot
    llvm::Value *imp = Builder.CreateAlignedLoad(
        IMPTy, Builder.CreateStructGEP(SlotStructTy, slot, 4),
        CGF.getPointerAlign());

    // The lookup function may have changed the receiver, so make sure we use
    // the new one.
    Receiver = Builder.CreateLoad(ReceiverPtr, true);
    return imp;
  }

  llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
                              llvm::Value *cmd,
                              MessageSendInfo &MSI) override {
    CGBuilderTy &Builder = CGF.Builder;
    llvm::Value *lookupArgs[] = {ObjCSuper.getPointer(), cmd};

    llvm::CallInst *slot =
      CGF.EmitNounwindRuntimeCall(SlotLookupSuperFn, lookupArgs);
    slot->setOnlyReadsMemory();

    return Builder.CreateAlignedLoad(
        IMPTy, Builder.CreateStructGEP(SlotStructTy, slot, 4),
        CGF.getPointerAlign());
  }

public:
  CGObjCGNUstep(CodeGenModule &Mod) : CGObjCGNUstep(Mod, 9, 3, 1) {}
  CGObjCGNUstep(CodeGenModule &Mod, unsigned ABI, unsigned ProtocolABI,
      unsigned ClassABI) :
    CGObjCGNU(Mod, ABI, ProtocolABI, ClassABI) {
    const ObjCRuntime &R = CGM.getLangOpts().ObjCRuntime;

    SlotStructTy = llvm::StructType::get(PtrTy, PtrTy, PtrTy, IntTy, IMPTy);
    SlotTy = llvm::PointerType::getUnqual(SlotStructTy);
    // Slot_t objc_msg_lookup_sender(id *receiver, SEL selector, id sender);
    SlotLookupFn.init(&CGM, "objc_msg_lookup_sender", SlotTy, PtrToIdTy,
                      SelectorTy, IdTy);
    // Slot_t objc_slot_lookup_super(struct objc_super*, SEL);
    SlotLookupSuperFn.init(&CGM, "objc_slot_lookup_super", SlotTy,
                           PtrToObjCSuperTy, SelectorTy);
    // If we're in ObjC++ mode, then we want to make
    if (usesSEHExceptions) {
        llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
        // void objc_exception_rethrow(void)
        ExceptionReThrowFn.init(&CGM, "objc_exception_rethrow", VoidTy);
    } else if (CGM.getLangOpts().CPlusPlus) {
      llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
      // void *__cxa_begin_catch(void *e)
      EnterCatchFn.init(&CGM, "__cxa_begin_catch", PtrTy, PtrTy);
      // void __cxa_end_catch(void)
      ExitCatchFn.init(&CGM, "__cxa_end_catch", VoidTy);
      // void _Unwind_Resume_or_Rethrow(void*)
      ExceptionReThrowFn.init(&CGM, "_Unwind_Resume_or_Rethrow", VoidTy,
                              PtrTy);
    } else if (R.getVersion() >= VersionTuple(1, 7)) {
      llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
      // id objc_begin_catch(void *e)
      EnterCatchFn.init(&CGM, "objc_begin_catch", IdTy, PtrTy);
      // void objc_end_catch(void)
      ExitCatchFn.init(&CGM, "objc_end_catch", VoidTy);
      // void _Unwind_Resume_or_Rethrow(void*)
      ExceptionReThrowFn.init(&CGM, "objc_exception_rethrow", VoidTy, PtrTy);
    }
    llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);
    SetPropertyAtomic.init(&CGM, "objc_setProperty_atomic", VoidTy, IdTy,
                           SelectorTy, IdTy, PtrDiffTy);
    SetPropertyAtomicCopy.init(&CGM, "objc_setProperty_atomic_copy", VoidTy,
                               IdTy, SelectorTy, IdTy, PtrDiffTy);
    SetPropertyNonAtomic.init(&CGM, "objc_setProperty_nonatomic", VoidTy,
                              IdTy, SelectorTy, IdTy, PtrDiffTy);
    SetPropertyNonAtomicCopy.init(&CGM, "objc_setProperty_nonatomic_copy",
                                  VoidTy, IdTy, SelectorTy, IdTy, PtrDiffTy);
    // void objc_setCppObjectAtomic(void *dest, const void *src, void
    // *helper);
    CxxAtomicObjectSetFn.init(&CGM, "objc_setCppObjectAtomic", VoidTy, PtrTy,
                              PtrTy, PtrTy);
    // void objc_getCppObjectAtomic(void *dest, const void *src, void
    // *helper);
    CxxAtomicObjectGetFn.init(&CGM, "objc_getCppObjectAtomic", VoidTy, PtrTy,
                              PtrTy, PtrTy);
  }

  llvm::FunctionCallee GetCppAtomicObjectGetFunction() override {
    // The optimised functions were added in version 1.7 of the GNUstep
    // runtime.
    assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=((void)0)
        VersionTuple(1, 7))((void)0);
    return CxxAtomicObjectGetFn;
  }

  llvm::FunctionCallee GetCppAtomicObjectSetFunction() override {
    // The optimised functions were added in version 1.7 of the GNUstep
    // runtime.
    assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=((void)0)
        VersionTuple(1, 7))((void)0);
    return CxxAtomicObjectSetFn;
  }

  llvm::FunctionCallee GetOptimizedPropertySetFunction(bool atomic,
                                                       bool copy) override {
    // The optimised property functions omit the GC check, and so are not
    // safe to use in GC mode.  The standard functions are fast in GC mode,
    // so there is less advantage in using them.
    assert ((CGM.getLangOpts().getGC() == LangOptions::NonGC))((void)0);
    // The optimised functions were added in version 1.7 of the GNUstep
    // runtime.
    assert (CGM.getLangOpts().ObjCRuntime.getVersion() >=((void)0)
        VersionTuple(1, 7))((void)0);

    if (atomic) {
      if (copy) return SetPropertyAtomicCopy;
      return SetPropertyAtomic;
    }

    return copy ? SetPropertyNonAtomicCopy : SetPropertyNonAtomic;
  }
900};

902/// GNUstep Objective-C ABI version 2 implementation.
903/// This is the ABI that provides a clean break with the legacy GCC ABI and
904/// cleans up a number of things that were added to work around 1980s linkers.
905class CGObjCGNUstep2 : public CGObjCGNUstep {
enum SectionKind
{
  SelectorSection = 0,
  ClassSection,
  ClassReferenceSection,
  CategorySection,
  ProtocolSection,
  ProtocolReferenceSection,
  ClassAliasSection,
  ConstantStringSection
};
static const char *const SectionsBaseNames[8];
static const char *const PECOFFSectionsBaseNames[8];
template<SectionKind K>
std::string sectionName() {
  if (CGM.getTriple().isOSBinFormatCOFF()) {
    std::string name(PECOFFSectionsBaseNames[K]);
    name += "$m";
    return name;
  }
  return SectionsBaseNames[K];
}
/// The GCC ABI superclass message lookup function.  Takes a pointer to a
/// structure describing the receiver and the class, and a selector as
/// arguments.  Returns the IMP for the corresponding method.
LazyRuntimeFunction MsgLookupSuperFn;
/// A flag indicating if we've emitted at least one protocol.
/// If we haven't, then we need to emit an empty protocol, to ensure that the
/// __start__objc_protocols and __stop__objc_protocols sections exist.
bool EmittedProtocol = false;
/// A flag indicating if we've emitted at least one protocol reference.
/// If we haven't, then we need to emit an empty protocol, to ensure that the
/// __start__objc_protocol_refs and __stop__objc_protocol_refs sections
/// exist.
bool EmittedProtocolRef = false;
/// A flag indicating if we've emitted at least one class.
/// If we haven't, then we need to emit an empty protocol, to ensure that the
/// __start__objc_classes and __stop__objc_classes sections / exist.
bool EmittedClass = false;
/// Generate the name of a symbol for a reference to a class.  Accesses to
/// classes should be indirected via this.

typedef std::pair<std::string, std::pair<llvm::GlobalVariable*, int>>
    EarlyInitPair;
std::vector<EarlyInitPair> EarlyInitList;

std::string SymbolForClassRef(StringRef Name, bool isWeak) {
  if (isWeak)
    return (ManglePublicSymbol("OBJC_WEAK_REF_CLASS_") + Name).str();
  else
    return (ManglePublicSymbol("OBJC_REF_CLASS_") + Name).str();
}
/// Generate the name of a class symbol.
std::string SymbolForClass(StringRef Name) {
  return (ManglePublicSymbol("OBJC_CLASS_") + Name).str();
}
void CallRuntimeFunction(CGBuilderTy &B, StringRef FunctionName,
    ArrayRef<llvm::Value*> Args) {
  SmallVector<llvm::Type *,8> Types;
  for (auto *Arg : Args)
    Types.push_back(Arg->getType());
  llvm::FunctionType *FT = llvm::FunctionType::get(B.getVoidTy(), Types,
      false);
  llvm::FunctionCallee Fn = CGM.CreateRuntimeFunction(FT, FunctionName);
  B.CreateCall(Fn, Args);
}

ConstantAddress GenerateConstantString(const StringLiteral *SL) override {

  auto Str = SL->getString();
  CharUnits Align = CGM.getPointerAlign();

  // Look for an existing one
  llvm::StringMap<llvm::Constant*>::iterator old = ObjCStrings.find(Str);
  if (old != ObjCStrings.end())
    return ConstantAddress(old->getValue(), Align);

  bool isNonASCII = SL->containsNonAscii();

  auto LiteralLength = SL->getLength();

  if ((CGM.getTarget().getPointerWidth(0) == 64) &&
      (LiteralLength < 9) && !isNonASCII) {
    // Tiny strings are only used on 64-bit platforms.  They store 8 7-bit
    // ASCII characters in the high 56 bits, followed by a 4-bit length and a
    // 3-bit tag (which is always 4).
    uint64_t str = 0;
    // Fill in the characters
    for (unsigned i=0 ; i<LiteralLength ; i++)
      str |= ((uint64_t)SL->getCodeUnit(i)) << ((64 - 4 - 3) - (i*7));
    // Fill in the length
    str |= LiteralLength << 3;
    // Set the tag
    str |= 4;
    auto *ObjCStr = llvm::ConstantExpr::getIntToPtr(
        llvm::ConstantInt::get(Int64Ty, str), IdTy);
    ObjCStrings[Str] = ObjCStr;
    return ConstantAddress(ObjCStr, Align);
  }

  StringRef StringClass = CGM.getLangOpts().ObjCConstantStringClass;

  if (StringClass.empty()) StringClass = "NSConstantString";

  std::string Sym = SymbolForClass(StringClass);

  llvm::Constant *isa = TheModule.getNamedGlobal(Sym);

  if (!isa) {
    isa = new llvm::GlobalVariable(TheModule, IdTy, /* isConstant */false,
            llvm::GlobalValue::ExternalLinkage, nullptr, Sym);
    if (CGM.getTriple().isOSBinFormatCOFF()) {
      cast<llvm::GlobalValue>(isa)->setDLLStorageClass(llvm::GlobalValue::DLLImportStorageClass);
    }
  } else if (isa->getType() != PtrToIdTy)
    isa = llvm::ConstantExpr::getBitCast(isa, PtrToIdTy);

  //  struct
  //  {
  //    Class isa;
  //    uint32_t flags;
  //    uint32_t length; // Number of codepoints
  //    uint32_t size; // Number of bytes
  //    uint32_t hash;
  //    const char *data;
  //  };

  ConstantInitBuilder Builder(CGM);
  auto Fields = Builder.beginStruct();
  if (!CGM.getTriple().isOSBinFormatCOFF()) {
    Fields.add(isa);
  } else {
    Fields.addNullPointer(PtrTy);
  }
  // For now, all non-ASCII strings are represented as UTF-16.  As such, the
  // number of bytes is simply double the number of UTF-16 codepoints.  In
  // ASCII strings, the number of bytes is equal to the number of non-ASCII
  // codepoints.
  if (isNonASCII) {
    unsigned NumU8CodeUnits = Str.size();
    // A UTF-16 representation of a unicode string contains at most the same
    // number of code units as a UTF-8 representation.  Allocate that much
    // space, plus one for the final null character.
    SmallVector<llvm::UTF16, 128> ToBuf(NumU8CodeUnits + 1);
    const llvm::UTF8 *FromPtr = (const llvm::UTF8 *)Str.data();
    llvm::UTF16 *ToPtr = &ToBuf[0];
    (void)llvm::ConvertUTF8toUTF16(&FromPtr, FromPtr + NumU8CodeUnits,
        &ToPtr, ToPtr + NumU8CodeUnits, llvm::strictConversion);
    uint32_t StringLength = ToPtr - &ToBuf[0];
    // Add null terminator
    *ToPtr = 0;
    // Flags: 2 indicates UTF-16 encoding
    Fields.addInt(Int32Ty, 2);
    // Number of UTF-16 codepoints
    Fields.addInt(Int32Ty, StringLength);
    // Number of bytes
    Fields.addInt(Int32Ty, StringLength * 2);
    // Hash.  Not currently initialised by the compiler.
    Fields.addInt(Int32Ty, 0);
    // pointer to the data string.
    auto Arr = llvm::makeArrayRef(&ToBuf[0], ToPtr+1);
    auto *C = llvm::ConstantDataArray::get(VMContext, Arr);
    auto *Buffer = new llvm::GlobalVariable(TheModule, C->getType(),
        /*isConstant=*/true, llvm::GlobalValue::PrivateLinkage, C, ".str");
    Buffer->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
    Fields.add(Buffer);
  } else {
    // Flags: 0 indicates ASCII encoding
    Fields.addInt(Int32Ty, 0);
    // Number of UTF-16 codepoints, each ASCII byte is a UTF-16 codepoint
    Fields.addInt(Int32Ty, Str.size());
    // Number of bytes
    Fields.addInt(Int32Ty, Str.size());
    // Hash.  Not currently initialised by the compiler.
    Fields.addInt(Int32Ty, 0);
    // Data pointer
    Fields.add(MakeConstantString(Str));
  }
  std::string StringName;
  bool isNamed = !isNonASCII;
  if (isNamed) {
    StringName = ".objc_str_";
    for (int i=0,e=Str.size() ; i<e ; ++i) {
      unsigned char c = Str[i];
      if (isalnum(c))
        StringName += c;
      else if (c == ' ')
        StringName += '_';
      else {
        isNamed = false;
        break;
      }
    }
  }
  llvm::GlobalVariable *ObjCStrGV =
    Fields.finishAndCreateGlobal(
        isNamed ? StringRef(StringName) : ".objc_string",
        Align, false, isNamed ? llvm::GlobalValue::LinkOnceODRLinkage
                              : llvm::GlobalValue::PrivateLinkage);
  ObjCStrGV->setSection(sectionName<ConstantStringSection>());
  if (isNamed) {
    ObjCStrGV->setComdat(TheModule.getOrInsertComdat(StringName));
    ObjCStrGV->setVisibility(llvm::GlobalValue::HiddenVisibility);
  }
  if (CGM.getTriple().isOSBinFormatCOFF()) {
    std::pair<llvm::GlobalVariable*, int> v{ObjCStrGV, 0};
    EarlyInitList.emplace_back(Sym, v);
  }
  llvm::Constant *ObjCStr = llvm::ConstantExpr::getBitCast(ObjCStrGV, IdTy);
  ObjCStrings[Str] = ObjCStr;
  ConstantStrings.push_back(ObjCStr);
  return ConstantAddress(ObjCStr, Align);
}

void PushProperty(ConstantArrayBuilder &PropertiesArray,
          const ObjCPropertyDecl *property,
          const Decl *OCD,
          bool isSynthesized=true, bool
          isDynamic=true) override {
  // struct objc_property
  // {
  //   const char *name;
  //   const char *attributes;
  //   const char *type;
  //   SEL getter;
  //   SEL setter;
  // };
  auto Fields = PropertiesArray.beginStruct(PropertyMetadataTy);
  ASTContext &Context = CGM.getContext();
  Fields.add(MakeConstantString(property->getNameAsString()));
  std::string TypeStr =
    CGM.getContext().getObjCEncodingForPropertyDecl(property, OCD);
  Fields.add(MakeConstantString(TypeStr));
  std::string typeStr;
  Context.getObjCEncodingForType(property->getType(), typeStr);
  Fields.add(MakeConstantString(typeStr));
  auto addPropertyMethod = [&](const ObjCMethodDecl *accessor) {
    if (accessor) {
      std::string TypeStr = Context.getObjCEncodingForMethodDecl(accessor);
      Fields.add(GetConstantSelector(accessor->getSelector(), TypeStr));
    } else {
      Fields.add(NULLPtr);
    }
  };
  addPropertyMethod(property->getGetterMethodDecl());
  addPropertyMethod(property->getSetterMethodDecl());
  Fields.finishAndAddTo(PropertiesArray);
}

llvm::Constant *
GenerateProtocolMethodList(ArrayRef<const ObjCMethodDecl*> Methods) override {
  // struct objc_protocol_method_description
  // {
  //   SEL selector;
  //   const char *types;
  // };
  llvm::StructType *ObjCMethodDescTy =
    llvm::StructType::get(CGM.getLLVMContext(),
        { PtrToInt8Ty, PtrToInt8Ty });
  ASTContext &Context = CGM.getContext();
  ConstantInitBuilder Builder(CGM);
  // struct objc_protocol_method_description_list
  // {
  //   int count;
  //   int size;
  //   struct objc_protocol_method_description methods[];
  // };
  auto MethodList = Builder.beginStruct();
  // int count;
  MethodList.addInt(IntTy, Methods.size());
  // int size; // sizeof(struct objc_method_description)
  llvm::DataLayout td(&TheModule);
  MethodList.addInt(IntTy, td.getTypeSizeInBits(ObjCMethodDescTy) /
      CGM.getContext().getCharWidth());
  // struct objc_method_description[]
  auto MethodArray = MethodList.beginArray(ObjCMethodDescTy);
  for (auto *M : Methods) {
    auto Method = MethodArray.beginStruct(ObjCMethodDescTy);
    Method.add(CGObjCGNU::GetConstantSelector(M));
    Method.add(GetTypeString(Context.getObjCEncodingForMethodDecl(M, true)));
    Method.finishAndAddTo(MethodArray);
  }
  MethodArray.finishAndAddTo(MethodList);
  return MethodList.finishAndCreateGlobal(".objc_protocol_method_list",
                                          CGM.getPointerAlign());
}
llvm::Constant *GenerateCategoryProtocolList(const ObjCCategoryDecl *OCD)
  override {
  const auto &ReferencedProtocols = OCD->getReferencedProtocols();
  auto RuntimeProtocols = GetRuntimeProtocolList(ReferencedProtocols.begin(),
                                                 ReferencedProtocols.end());
  SmallVector<llvm::Constant *, 16> Protocols;
  for (const auto *PI : RuntimeProtocols)
    Protocols.push_back(
        llvm::ConstantExpr::getBitCast(GenerateProtocolRef(PI),
          ProtocolPtrTy));
  return GenerateProtocolList(Protocols);
}

llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
                            llvm::Value *cmd, MessageSendInfo &MSI) override {
  // Don't access the slot unless we're trying to cache the result.
  CGBuilderTy &Builder = CGF.Builder;
  llvm::Value *lookupArgs[] = {CGObjCGNU::EnforceType(Builder, ObjCSuper,
      PtrToObjCSuperTy).getPointer(), cmd};
  return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
}

llvm::GlobalVariable *GetClassVar(StringRef Name, bool isWeak=false) {
  std::string SymbolName = SymbolForClassRef(Name, isWeak);
  auto *ClassSymbol = TheModule.getNamedGlobal(SymbolName);
  if (ClassSymbol)
    return ClassSymbol;
  ClassSymbol = new llvm::GlobalVariable(TheModule,
      IdTy, false, llvm::GlobalValue::ExternalLinkage,
      nullptr, SymbolName);
  // If this is a weak symbol, then we are creating a valid definition for
  // the symbol, pointing to a weak definition of the real class pointer.  If
  // this is not a weak reference, then we are expecting another compilation
  // unit to provide the real indirection symbol.
  if (isWeak)
    ClassSymbol->setInitializer(new llvm::GlobalVariable(TheModule,
        Int8Ty, false, llvm::GlobalValue::ExternalWeakLinkage,
        nullptr, SymbolForClass(Name)));
  else {
    if (CGM.getTriple().isOSBinFormatCOFF()) {
      IdentifierInfo &II = CGM.getContext().Idents.get(Name);
      TranslationUnitDecl *TUDecl = CGM.getContext().getTranslationUnitDecl();
      DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);

      const ObjCInterfaceDecl *OID = nullptr;
      for (const auto *Result : DC->lookup(&II))
        if ((OID = dyn_cast<ObjCInterfaceDecl>(Result)))
          break;

      // The first Interface we find may be a @class,
      // which should only be treated as the source of
      // truth in the absence of a true declaration.
      assert(OID && "Failed to find ObjCInterfaceDecl")((void)0);
      const ObjCInterfaceDecl *OIDDef = OID->getDefinition();
      if (OIDDef != nullptr)
        OID = OIDDef;

      auto Storage = llvm::GlobalValue::DefaultStorageClass;
      if (OID->hasAttr<DLLImportAttr>())
        Storage = llvm::GlobalValue::DLLImportStorageClass;
      else if (OID->hasAttr<DLLExportAttr>())
        Storage = llvm::GlobalValue::DLLExportStorageClass;

      cast<llvm::GlobalValue>(ClassSymbol)->setDLLStorageClass(Storage);
    }
  }
  assert(ClassSymbol->getName() == SymbolName)((void)0);
  return ClassSymbol;
}
llvm::Value *GetClassNamed(CodeGenFunction &CGF,
                           const std::string &Name,
                           bool isWeak) override {
  return CGF.Builder.CreateLoad(Address(GetClassVar(Name, isWeak),
        CGM.getPointerAlign()));
}
int32_t FlagsForOwnership(Qualifiers::ObjCLifetime Ownership) {
  // typedef enum {
  //   ownership_invalid = 0,
  //   ownership_strong  = 1,
  //   ownership_weak    = 2,
  //   ownership_unsafe  = 3
  // } ivar_ownership;
  int Flag;
  switch (Ownership) {
    case Qualifiers::OCL_Strong:
        Flag = 1;
        break;
    case Qualifiers::OCL_Weak:
        Flag = 2;
        break;
    case Qualifiers::OCL_ExplicitNone:
        Flag = 3;
        break;
    case Qualifiers::OCL_None:
    case Qualifiers::OCL_Autoreleasing:
      assert(Ownership != Qualifiers::OCL_Autoreleasing)((void)0);
      Flag = 0;
  }
  return Flag;
}
llvm::Constant *GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
                 ArrayRef<llvm::Constant *> IvarTypes,
                 ArrayRef<llvm::Constant *> IvarOffsets,
                 ArrayRef<llvm::Constant *> IvarAlign,
                 ArrayRef<Qualifiers::ObjCLifetime> IvarOwnership) override {
  llvm_unreachable("Method should not be called!")__builtin_unreachable();
}

llvm::Constant *GenerateEmptyProtocol(StringRef ProtocolName) override {
  std::string Name = SymbolForProtocol(ProtocolName);
  auto *GV = TheModule.getGlobalVariable(Name);
  if (!GV) {
    // Emit a placeholder symbol.
    GV = new llvm::GlobalVariable(TheModule, ProtocolTy, false,
        llvm::GlobalValue::ExternalLinkage, nullptr, Name);
    GV->setAlignment(CGM.getPointerAlign().getAsAlign());
  }
  return llvm::ConstantExpr::getBitCast(GV, ProtocolPtrTy);
}

/// Existing protocol references.
llvm::StringMap<llvm::Constant*> ExistingProtocolRefs;

llvm::Value *GenerateProtocolRef(CodeGenFunction &CGF,
                                 const ObjCProtocolDecl *PD) override {
  auto Name = PD->getNameAsString();
  auto *&Ref = ExistingProtocolRefs[Name];
  if (!Ref) {
    auto *&Protocol = ExistingProtocols[Name];
    if (!Protocol)
      Protocol = GenerateProtocolRef(PD);
    std::string RefName = SymbolForProtocolRef(Name);
    assert(!TheModule.getGlobalVariable(RefName))((void)0);
    // Emit a reference symbol.
    auto GV = new llvm::GlobalVariable(TheModule, ProtocolPtrTy,
        false, llvm::GlobalValue::LinkOnceODRLinkage,
        llvm::ConstantExpr::getBitCast(Protocol, ProtocolPtrTy), RefName);
    GV->setComdat(TheModule.getOrInsertComdat(RefName));
    GV->setSection(sectionName<ProtocolReferenceSection>());
    GV->setAlignment(CGM.getPointerAlign().getAsAlign());
    Ref = GV;
  }
  EmittedProtocolRef = true;
  return CGF.Builder.CreateAlignedLoad(ProtocolPtrTy, Ref,
                                       CGM.getPointerAlign());
}

llvm::Constant *GenerateProtocolList(ArrayRef<llvm::Constant*> Protocols) {
  llvm::ArrayType *ProtocolArrayTy = llvm::ArrayType::get(ProtocolPtrTy,
      Protocols.size());
  llvm::Constant * ProtocolArray = llvm::ConstantArray::get(ProtocolArrayTy,
      Protocols);
  ConstantInitBuilder builder(CGM);
  auto ProtocolBuilder = builder.beginStruct();
  ProtocolBuilder.addNullPointer(PtrTy);
  ProtocolBuilder.addInt(SizeTy, Protocols.size());
  ProtocolBuilder.add(ProtocolArray);
  return ProtocolBuilder.finishAndCreateGlobal(".objc_protocol_list",
      CGM.getPointerAlign(), false, llvm::GlobalValue::InternalLinkage);
}

void GenerateProtocol(const ObjCProtocolDecl *PD) override {
  // Do nothing - we only emit referenced protocols.
}
llvm::Constant *GenerateProtocolRef(const ObjCProtocolDecl *PD) override {
  std::string ProtocolName = PD->getNameAsString();
  auto *&Protocol = ExistingProtocols[ProtocolName];
  if (Protocol)
    return Protocol;

  EmittedProtocol = true;

  auto SymName = SymbolForProtocol(ProtocolName);
  auto *OldGV = TheModule.getGlobalVariable(SymName);

  // Use the protocol definition, if there is one.
  if (const ObjCProtocolDecl *Def = PD->getDefinition())
    PD = Def;
  else {
    // If there is no definition, then create an external linkage symbol and
    // hope that someone else fills it in for us (and fail to link if they
    // don't).
    assert(!OldGV)((void)0);
    Protocol = new llvm::GlobalVariable(TheModule, ProtocolTy,
      /*isConstant*/false,
      llvm::GlobalValue::ExternalLinkage, nullptr, SymName);
    return Protocol;
  }

  SmallVector<llvm::Constant*, 16> Protocols;
  auto RuntimeProtocols =
      GetRuntimeProtocolList(PD->protocol_begin(), PD->protocol_end());
  for (const auto *PI : RuntimeProtocols)
    Protocols.push_back(
        llvm::ConstantExpr::getBitCast(GenerateProtocolRef(PI),
          ProtocolPtrTy));
  llvm::Constant *ProtocolList = GenerateProtocolList(Protocols);

  // Collect information about methods
  llvm::Constant *InstanceMethodList, *OptionalInstanceMethodList;
  llvm::Constant *ClassMethodList, *OptionalClassMethodList;
  EmitProtocolMethodList(PD->instance_methods(), InstanceMethodList,
      OptionalInstanceMethodList);
  EmitProtocolMethodList(PD->class_methods(), ClassMethodList,
      OptionalClassMethodList);

  // The isa pointer must be set to a magic number so the runtime knows it's
  // the correct layout.
  ConstantInitBuilder builder(CGM);
  auto ProtocolBuilder = builder.beginStruct();
  ProtocolBuilder.add(llvm::ConstantExpr::getIntToPtr(
        llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
  ProtocolBuilder.add(MakeConstantString(ProtocolName));
  ProtocolBuilder.add(ProtocolList);
  ProtocolBuilder.add(InstanceMethodList);
  ProtocolBuilder.add(ClassMethodList);
  ProtocolBuilder.add(OptionalInstanceMethodList);
  ProtocolBuilder.add(OptionalClassMethodList);
  // Required instance properties
  ProtocolBuilder.add(GeneratePropertyList(nullptr, PD, false, false));
  // Optional instance properties
  ProtocolBuilder.add(GeneratePropertyList(nullptr, PD, false, true));
  // Required class properties
  ProtocolBuilder.add(GeneratePropertyList(nullptr, PD, true, false));
  // Optional class properties
  ProtocolBuilder.add(GeneratePropertyList(nullptr, PD, true, true));

  auto *GV = ProtocolBuilder.finishAndCreateGlobal(SymName,
      CGM.getPointerAlign(), false, llvm::GlobalValue::ExternalLinkage);
  GV->setSection(sectionName<ProtocolSection>());
  GV->setComdat(TheModule.getOrInsertComdat(SymName));
  if (OldGV) {
    OldGV->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(GV,
          OldGV->getType()));
    OldGV->removeFromParent();
    GV->setName(SymName);
  }
  Protocol = GV;
  return GV;
}
llvm::Constant *EnforceType(llvm::Constant *Val, llvm::Type *Ty) {
  if (Val->getType() == Ty)
    return Val;
  return llvm::ConstantExpr::getBitCast(Val, Ty);
}
llvm::Value *GetTypedSelector(CodeGenFunction &CGF, Selector Sel,
                              const std::string &TypeEncoding) override {
  return GetConstantSelector(Sel, TypeEncoding);
}
llvm::Constant  *GetTypeString(llvm::StringRef TypeEncoding) {
  if (TypeEncoding.empty())
    return NULLPtr;
  std::string MangledTypes = std::string(TypeEncoding);
  std::replace(MangledTypes.begin(), MangledTypes.end(),
    '@', '\1');
  std::string TypesVarName = ".objc_sel_types_" + MangledTypes;
  auto *TypesGlobal = TheModule.getGlobalVariable(TypesVarName);
  if (!TypesGlobal) {
    llvm::Constant *Init = llvm::ConstantDataArray::getString(VMContext,
        TypeEncoding);
    auto *GV = new llvm::GlobalVariable(TheModule, Init->getType(),
        true, llvm::GlobalValue::LinkOnceODRLinkage, Init, TypesVarName);
    GV->setComdat(TheModule.getOrInsertComdat(TypesVarName));
    GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
    TypesGlobal = GV;
  }
  return llvm::ConstantExpr::getGetElementPtr(TypesGlobal->getValueType(),
      TypesGlobal, Zeros);
}
llvm::Constant *GetConstantSelector(Selector Sel,
                                    const std::string &TypeEncoding) override {
  // @ is used as a special character in symbol names (used for symbol
  // versioning), so mangle the name to not include it.  Replace it with a
  // character that is not a valid type encoding character (and, being
  // non-printable, never will be!)
  std::string MangledTypes = TypeEncoding;
  std::replace(MangledTypes.begin(), MangledTypes.end(),
    '@', '\1');
  auto SelVarName = (StringRef(".objc_selector_") + Sel.getAsString() + "_" +
    MangledTypes).str();
  if (auto *GV = TheModule.getNamedGlobal(SelVarName))
    return EnforceType(GV, SelectorTy);
  ConstantInitBuilder builder(CGM);
  auto SelBuilder = builder.beginStruct();
  SelBuilder.add(ExportUniqueString(Sel.getAsString(), ".objc_sel_name_",
        true));
  SelBuilder.add(GetTypeString(TypeEncoding));
  auto *GV = SelBuilder.finishAndCreateGlobal(SelVarName,
      CGM.getPointerAlign(), false, llvm::GlobalValue::LinkOnceODRLinkage);
  GV->setComdat(TheModule.getOrInsertComdat(SelVarName));
  GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
  GV->setSection(sectionName<SelectorSection>());
  auto *SelVal = EnforceType(GV, SelectorTy);
  return SelVal;
}
llvm::StructType *emptyStruct = nullptr;

/// Return pointers to the start and end of a section.  On ELF platforms, we
/// use the __start_ and __stop_ symbols that GNU-compatible linkers will set
/// to the start and end of section names, as long as those section names are
/// valid identifiers and the symbols are referenced but not defined.  On
/// Windows, we use the fact that MSVC-compatible linkers will lexically sort
/// by subsections and place everything that we want to reference in a middle
/// subsection and then insert zero-sized symbols in subsections a and z.
std::pair<llvm::Constant*,llvm::Constant*>
GetSectionBounds(StringRef Section) {
  if (CGM.getTriple().isOSBinFormatCOFF()) {
    if (emptyStruct == nullptr) {
      emptyStruct = llvm::StructType::create(VMContext, ".objc_section_sentinel");
      emptyStruct->setBody({}, /*isPacked*/true);
    }
    auto ZeroInit = llvm::Constant::getNullValue(emptyStruct);
    auto Sym = [&](StringRef Prefix, StringRef SecSuffix) {
      auto *Sym = new llvm::GlobalVariable(TheModule, emptyStruct,
          /*isConstant*/false,
          llvm::GlobalValue::LinkOnceODRLinkage, ZeroInit, Prefix +
          Section);
      Sym->setVisibility(llvm::GlobalValue::HiddenVisibility);
      Sym->setSection((Section + SecSuffix).str());
      Sym->setComdat(TheModule.getOrInsertComdat((Prefix +
          Section).str()));
      Sym->setAlignment(CGM.getPointerAlign().getAsAlign());
      return Sym;
    };
    return { Sym("__start_", "$a"), Sym("__stop", "$z") };
  }
  auto *Start = new llvm::GlobalVariable(TheModule, PtrTy,
      /*isConstant*/false,
      llvm::GlobalValue::ExternalLinkage, nullptr, StringRef("__start_") +
      Section);
  Start->setVisibility(llvm::GlobalValue::HiddenVisibility);
  auto *Stop = new llvm::GlobalVariable(TheModule, PtrTy,
      /*isConstant*/false,
      llvm::GlobalValue::ExternalLinkage, nullptr, StringRef("__stop_") +
      Section);
  Stop->setVisibility(llvm::GlobalValue::HiddenVisibility);
  return { Start, Stop };
}
CatchTypeInfo getCatchAllTypeInfo() override {
  return CGM.getCXXABI().getCatchAllTypeInfo();
}
llvm::Function *ModuleInitFunction() override {
  llvm::Function *LoadFunction = llvm::Function::Create(
    llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext), false),
    llvm::GlobalValue::LinkOnceODRLinkage, ".objcv2_load_function",
    &TheModule);
  LoadFunction->setVisibility(llvm::GlobalValue::HiddenVisibility);
  LoadFunction->setComdat(TheModule.getOrInsertComdat(".objcv2_load_function"));

  llvm::BasicBlock *EntryBB =
      llvm::BasicBlock::Create(VMContext, "entry", LoadFunction);
  CGBuilderTy B(CGM, VMContext);
  B.SetInsertPoint(EntryBB);
  ConstantInitBuilder builder(CGM);
  auto InitStructBuilder = builder.beginStruct();
  InitStructBuilder.addInt(Int64Ty, 0);
  auto &sectionVec = CGM.getTriple().isOSBinFormatCOFF() ? PECOFFSectionsBaseNames : SectionsBaseNames;
  for (auto *s : sectionVec) {
    auto bounds = GetSectionBounds(s);
    InitStructBuilder.add(bounds.first);
    InitStructBuilder.add(bounds.second);
  }
  auto *InitStruct = InitStructBuilder.finishAndCreateGlobal(".objc_init",
      CGM.getPointerAlign(), false, llvm::GlobalValue::LinkOnceODRLinkage);
  InitStruct->setVisibility(llvm::GlobalValue::HiddenVisibility);
  InitStruct->setComdat(TheModule.getOrInsertComdat(".objc_init"));

  CallRuntimeFunction(B, "__objc_load", {InitStruct});;
  B.CreateRetVoid();
  // Make sure that the optimisers don't delete this function.
  CGM.addCompilerUsedGlobal(LoadFunction);
  // FIXME: Currently ELF only!
  // We have to do this by hand, rather than with @llvm.ctors, so that the
  // linker can remove the duplicate invocations.
  auto *InitVar = new llvm::GlobalVariable(TheModule, LoadFunction->getType(),
      /*isConstant*/false, llvm::GlobalValue::LinkOnceAnyLinkage,
      LoadFunction, ".objc_ctor");
  // Check that this hasn't been renamed.  This shouldn't happen, because
  // this function should be called precisely once.
  assert(InitVar->getName() == ".objc_ctor")((void)0);
  // In Windows, initialisers are sorted by the suffix.  XCL is for library
  // initialisers, which run before user initialisers.  We are running
  // Objective-C loads at the end of library load.  This means +load methods
  // will run before any other static constructors, but that static
  // constructors can see a fully initialised Objective-C state.
  if (CGM.getTriple().isOSBinFormatCOFF())
      InitVar->setSection(".CRT$XCLz");
  else
  {
    if (CGM.getCodeGenOpts().UseInitArray)
      InitVar->setSection(".init_array");
    else
      InitVar->setSection(".ctors");
  }
  InitVar->setVisibility(llvm::GlobalValue::HiddenVisibility);
  InitVar->setComdat(TheModule.getOrInsertComdat(".objc_ctor"));
  CGM.addUsedGlobal(InitVar);
  for (auto *C : Categories) {
    auto *Cat = cast<llvm::GlobalVariable>(C->stripPointerCasts());
    Cat->setSection(sectionName<CategorySection>());
    CGM.addUsedGlobal(Cat);
  }
  auto createNullGlobal = [&](StringRef Name, ArrayRef<llvm::Constant*> Init,
      StringRef Section) {
    auto nullBuilder = builder.beginStruct();
    for (auto *F : Init)
      nullBuilder.add(F);
    auto GV = nullBuilder.finishAndCreateGlobal(Name, CGM.getPointerAlign(),
        false, llvm::GlobalValue::LinkOnceODRLinkage);
    GV->setSection(Section);
    GV->setComdat(TheModule.getOrInsertComdat(Name));
    GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
    CGM.addUsedGlobal(GV);
    return GV;
  };
  for (auto clsAlias : ClassAliases)
    createNullGlobal(std::string(".objc_class_alias") +
        clsAlias.second, { MakeConstantString(clsAlias.second),
        GetClassVar(clsAlias.first) }, sectionName<ClassAliasSection>());
  // On ELF platforms, add a null value for each special section so that we
  // can always guarantee that the _start and _stop symbols will exist and be
  // meaningful.  This is not required on COFF platforms, where our start and
  // stop symbols will create the section.
  if (!CGM.getTriple().isOSBinFormatCOFF()) {
    createNullGlobal(".objc_null_selector", {NULLPtr, NULLPtr},
        sectionName<SelectorSection>());
    if (Categories.empty())
      createNullGlobal(".objc_null_category", {NULLPtr, NULLPtr,
                    NULLPtr, NULLPtr, NULLPtr, NULLPtr, NULLPtr},
          sectionName<CategorySection>());
    if (!EmittedClass) {
      createNullGlobal(".objc_null_cls_init_ref", NULLPtr,
          sectionName<ClassSection>());
      createNullGlobal(".objc_null_class_ref", { NULLPtr, NULLPtr },
          sectionName<ClassReferenceSection>());
    }
    if (!EmittedProtocol)
      createNullGlobal(".objc_null_protocol", {NULLPtr, NULLPtr, NULLPtr,
          NULLPtr, NULLPtr, NULLPtr, NULLPtr, NULLPtr, NULLPtr, NULLPtr,
          NULLPtr}, sectionName<ProtocolSection>());
    if (!EmittedProtocolRef)
      createNullGlobal(".objc_null_protocol_ref", {NULLPtr},
          sectionName<ProtocolReferenceSection>());
    if (ClassAliases.empty())
      createNullGlobal(".objc_null_class_alias", { NULLPtr, NULLPtr },
          sectionName<ClassAliasSection>());
    if (ConstantStrings.empty()) {
      auto i32Zero = llvm::ConstantInt::get(Int32Ty, 0);
      createNullGlobal(".objc_null_constant_string", { NULLPtr, i32Zero,
          i32Zero, i32Zero, i32Zero, NULLPtr },
          sectionName<ConstantStringSection>());
    }
  }
  ConstantStrings.clear();
  Categories.clear();
  Classes.clear();

  if (EarlyInitList.size() > 0) {
    auto *Init = llvm::Function::Create(llvm::FunctionType::get(CGM.VoidTy,
          {}), llvm::GlobalValue::InternalLinkage, ".objc_early_init",
        &CGM.getModule());
    llvm::IRBuilder<> b(llvm::BasicBlock::Create(CGM.getLLVMContext(), "entry",
          Init));
    for (const auto &lateInit : EarlyInitList) {
      auto *global = TheModule.getGlobalVariable(lateInit.first);
      if (global) {
        llvm::GlobalVariable *GV = lateInit.second.first;
        b.CreateAlignedStore(
            global,
            b.CreateStructGEP(GV->getValueType(), GV, lateInit.second.second),
            CGM.getPointerAlign().getAsAlign());
      }
    }
    b.CreateRetVoid();
    // We can't use the normal LLVM global initialisation array, because we
    // need to specify that this runs early in library initialisation.
    auto *InitVar = new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
        /*isConstant*/true, llvm::GlobalValue::InternalLinkage,
        Init, ".objc_early_init_ptr");
    InitVar->setSection(".CRT$XCLb");
    CGM.addUsedGlobal(InitVar);
  }
  return nullptr;
}
/// In the v2 ABI, ivar offset variables use the type encoding in their name
/// to trigger linker failures if the types don't match.
std::string GetIVarOffsetVariableName(const ObjCInterfaceDecl *ID,
                                      const ObjCIvarDecl *Ivar) override {
  std::string TypeEncoding;
  CGM.getContext().getObjCEncodingForType(Ivar->getType(), TypeEncoding);
  // Prevent the @ from being interpreted as a symbol version.
  std::replace(TypeEncoding.begin(), TypeEncoding.end(),
    '@', '\1');
  const std::string Name = "__objc_ivar_offset_" + ID->getNameAsString()
    + '.' + Ivar->getNameAsString() + '.' + TypeEncoding;
  return Name;
}
llvm::Value *EmitIvarOffset(CodeGenFunction &CGF,
                            const ObjCInterfaceDecl *Interface,
                            const ObjCIvarDecl *Ivar) override {
  const std::string Name = GetIVarOffsetVariableName(Ivar->getContainingInterface(), Ivar);
  llvm::GlobalVariable *IvarOffsetPointer = TheModule.getNamedGlobal(Name);
  if (!IvarOffsetPointer)
    IvarOffsetPointer = new llvm::GlobalVariable(TheModule, IntTy, false,
            llvm::GlobalValue::ExternalLinkage, nullptr, Name);
  CharUnits Align = CGM.getIntAlign();
  llvm::Value *Offset =
      CGF.Builder.CreateAlignedLoad(IntTy, IvarOffsetPointer, Align);
  if (Offset->getType() != PtrDiffTy)
    Offset = CGF.Builder.CreateZExtOrBitCast(Offset, PtrDiffTy);
  return Offset;
}
void GenerateClass(const ObjCImplementationDecl *OID) override {
  ASTContext &Context = CGM.getContext();
  bool IsCOFF = CGM.getTriple().isOSBinFormatCOFF();

  // Get the class name
  ObjCInterfaceDecl *classDecl =
      const_cast<ObjCInterfaceDecl *>(OID->getClassInterface());
  std::string className = classDecl->getNameAsString();
  auto *classNameConstant = MakeConstantString(className);

  ConstantInitBuilder builder(CGM);
  auto metaclassFields = builder.beginStruct();
  // struct objc_class *isa;
  metaclassFields.addNullPointer(PtrTy);
  // struct objc_class *super_class;
  metaclassFields.addNullPointer(PtrTy);
  // const char *name;
  metaclassFields.add(classNameConstant);
  // long version;
  metaclassFields.addInt(LongTy, 0);
  // unsigned long info;
  // objc_class_flag_meta
  metaclassFields.addInt(LongTy, 1);
  // long instance_size;
  // Setting this to zero is consistent with the older ABI, but it might be
  // more sensible to set this to sizeof(struct objc_class)
  metaclassFields.addInt(LongTy, 0);
  // struct objc_ivar_list *ivars;
  metaclassFields.addNullPointer(PtrTy);
  // struct objc_method_list *methods
  // FIXME: Almost identical code is copied and pasted below for the
  // class, but refactoring it cleanly requires C++14 generic lambdas.
  if (OID->classmeth_begin() == OID->classmeth_end())
    metaclassFields.addNullPointer(PtrTy);
  else {
    SmallVector<ObjCMethodDecl*, 16> ClassMethods;
    ClassMethods.insert(ClassMethods.begin(), OID->classmeth_begin(),
        OID->classmeth_end());
    metaclassFields.addBitCast(
            GenerateMethodList(className, "", ClassMethods, true),
            PtrTy);
  }
  // void *dtable;
  metaclassFields.addNullPointer(PtrTy);
  // IMP cxx_construct;
  metaclassFields.addNullPointer(PtrTy);
  // IMP cxx_destruct;
  metaclassFields.addNullPointer(PtrTy);
  // struct objc_class *subclass_list
  metaclassFields.addNullPointer(PtrTy);
  // struct objc_class *sibling_class
  metaclassFields.addNullPointer(PtrTy);
  // struct objc_protocol_list *protocols;
  metaclassFields.addNullPointer(PtrTy);
  // struct reference_list *extra_data;
  metaclassFields.addNullPointer(PtrTy);
  // long abi_version;
  metaclassFields.addInt(LongTy, 0);
  // struct objc_property_list *properties
  metaclassFields.add(GeneratePropertyList(OID, classDecl, /*isClassProperty*/true));

  auto *metaclass = metaclassFields.finishAndCreateGlobal(
      ManglePublicSymbol("OBJC_METACLASS_") + className,
      CGM.getPointerAlign());

  auto classFields = builder.beginStruct();
  // struct objc_class *isa;
  classFields.add(metaclass);
  // struct objc_class *super_class;
  // Get the superclass name.
  const ObjCInterfaceDecl * SuperClassDecl =
    OID->getClassInterface()->getSuperClass();
  llvm::Constant *SuperClass = nullptr;
  if (SuperClassDecl) {
    auto SuperClassName = SymbolForClass(SuperClassDecl->getNameAsString());
    SuperClass = TheModule.getNamedGlobal(SuperClassName);
    if (!SuperClass)
    {
      SuperClass = new llvm::GlobalVariable(TheModule, PtrTy, false,
          llvm::GlobalValue::ExternalLinkage, nullptr, SuperClassName);
      if (IsCOFF) {
        auto Storage = llvm::GlobalValue::DefaultStorageClass;
        if (SuperClassDecl->hasAttr<DLLImportAttr>())
          Storage = llvm::GlobalValue::DLLImportStorageClass;
        else if (SuperClassDecl->hasAttr<DLLExportAttr>())
          Storage = llvm::GlobalValue::DLLExportStorageClass;

        cast<llvm::GlobalValue>(SuperClass)->setDLLStorageClass(Storage);
      }
    }
    if (!IsCOFF)
      classFields.add(llvm::ConstantExpr::getBitCast(SuperClass, PtrTy));
    else
      classFields.addNullPointer(PtrTy);
  } else
    classFields.addNullPointer(PtrTy);
  // const char *name;
  classFields.add(classNameConstant);
  // long version;
  classFields.addInt(LongTy, 0);
  // unsigned long info;
  // !objc_class_flag_meta
  classFields.addInt(LongTy, 0);
  // long instance_size;
  int superInstanceSize = !SuperClassDecl ? 0 :
    Context.getASTObjCInterfaceLayout(SuperClassDecl).getSize().getQuantity();
  // Instance size is negative for classes that have not yet had their ivar
  // layout calculated.
  classFields.addInt(LongTy,
    0 - (Context.getASTObjCImplementationLayout(OID).getSize().getQuantity() -
    superInstanceSize));

  if (classDecl->all_declared_ivar_begin() == nullptr)
    classFields.addNullPointer(PtrTy);
  else {
    int ivar_count = 0;
    for (const ObjCIvarDecl *IVD = classDecl->all_declared_ivar_begin(); IVD;
         IVD = IVD->getNextIvar()) ivar_count++;
    llvm::DataLayout td(&TheModule);
    // struct objc_ivar_list *ivars;
    ConstantInitBuilder b(CGM);
    auto ivarListBuilder = b.beginStruct();
    // int count;
    ivarListBuilder.addInt(IntTy, ivar_count);
    // size_t size;
    llvm::StructType *ObjCIvarTy = llvm::StructType::get(
      PtrToInt8Ty,
      PtrToInt8Ty,
      PtrToInt8Ty,
      Int32Ty,
      Int32Ty);
    ivarListBuilder.addInt(SizeTy, td.getTypeSizeInBits(ObjCIvarTy) /
        CGM.getContext().getCharWidth());
    // struct objc_ivar ivars[]
    auto ivarArrayBuilder = ivarListBuilder.beginArray();
    for (const ObjCIvarDecl *IVD = classDecl->all_declared_ivar_begin(); IVD;
         IVD = IVD->getNextIvar()) {
      auto ivarTy = IVD->getType();
      auto ivarBuilder = ivarArrayBuilder.beginStruct();
      // const char *name;
      ivarBuilder.add(MakeConstantString(IVD->getNameAsString()));
      // const char *type;
      std::string TypeStr;
      //Context.getObjCEncodingForType(ivarTy, TypeStr, IVD, true);
      Context.getObjCEncodingForMethodParameter(Decl::OBJC_TQ_None, ivarTy, TypeStr, true);
      ivarBuilder.add(MakeConstantString(TypeStr));
      // int *offset;
      uint64_t BaseOffset = ComputeIvarBaseOffset(CGM, OID, IVD);
      uint64_t Offset = BaseOffset - superInstanceSize;
      llvm::Constant *OffsetValue = llvm::ConstantInt::get(IntTy, Offset);
      std::string OffsetName = GetIVarOffsetVariableName(classDecl, IVD);
      llvm::GlobalVariable *OffsetVar = TheModule.getGlobalVariable(OffsetName);
      if (OffsetVar)
        OffsetVar->setInitializer(OffsetValue);
      else
        OffsetVar = new llvm::GlobalVariable(TheModule, IntTy,
          false, llvm::GlobalValue::ExternalLinkage,
          OffsetValue, OffsetName);
      auto ivarVisibility =
          (IVD->getAccessControl() == ObjCIvarDecl::Private ||
           IVD->getAccessControl() == ObjCIvarDecl::Package ||
           classDecl->getVisibility() == HiddenVisibility) ?
                  llvm::GlobalValue::HiddenVisibility :
                  llvm::GlobalValue::DefaultVisibility;
      OffsetVar->setVisibility(ivarVisibility);
      ivarBuilder.add(OffsetVar);
      // Ivar size
      ivarBuilder.addInt(Int32Ty,
          CGM.getContext().getTypeSizeInChars(ivarTy).getQuantity());
      // Alignment will be stored as a base-2 log of the alignment.
      unsigned align =
          llvm::Log2_32(Context.getTypeAlignInChars(ivarTy).getQuantity());
      // Objects that require more than 2^64-byte alignment should be impossible!
      assert(align < 64)((void)0);
      // uint32_t flags;
      // Bits 0-1 are ownership.
      // Bit 2 indicates an extended type encoding
      // Bits 3-8 contain log2(aligment)
      ivarBuilder.addInt(Int32Ty,
          (align << 3) | (1<<2) |
          FlagsForOwnership(ivarTy.getQualifiers().getObjCLifetime()));
      ivarBuilder.finishAndAddTo(ivarArrayBuilder);
    }
    ivarArrayBuilder.finishAndAddTo(ivarListBuilder);
    auto ivarList = ivarListBuilder.finishAndCreateGlobal(".objc_ivar_list",
        CGM.getPointerAlign(), /*constant*/ false,
        llvm::GlobalValue::PrivateLinkage);
    classFields.add(ivarList);
  }
  // struct objc_method_list *methods
  SmallVector<const ObjCMethodDecl*, 16> InstanceMethods;
  InstanceMethods.insert(InstanceMethods.begin(), OID->instmeth_begin(),
      OID->instmeth_end());
  for (auto *propImpl : OID->property_impls())
    if (propImpl->getPropertyImplementation() ==
        ObjCPropertyImplDecl::Synthesize) {
      auto addIfExists = [&](const ObjCMethodDecl *OMD) {
        if (OMD && OMD->hasBody())
          InstanceMethods.push_back(OMD);
      };
      addIfExists(propImpl->getGetterMethodDecl());
      addIfExists(propImpl->getSetterMethodDecl());
    }

  if (InstanceMethods.size() == 0)
    classFields.addNullPointer(PtrTy);
  else
    classFields.addBitCast(
            GenerateMethodList(className, "", InstanceMethods, false),
            PtrTy);
  // void *dtable;
  classFields.addNullPointer(PtrTy);
  // IMP cxx_construct;
  classFields.addNullPointer(PtrTy);
  // IMP cxx_destruct;
  classFields.addNullPointer(PtrTy);
  // struct objc_class *subclass_list
  classFields.addNullPointer(PtrTy);
  // struct objc_class *sibling_class
  classFields.addNullPointer(PtrTy);
  // struct objc_protocol_list *protocols;
  auto RuntimeProtocols = GetRuntimeProtocolList(classDecl->protocol_begin(),
                                                 classDecl->protocol_end());
  SmallVector<llvm::Constant *, 16> Protocols;
  for (const auto *I : RuntimeProtocols)
    Protocols.push_back(
        llvm::ConstantExpr::getBitCast(GenerateProtocolRef(I),
          ProtocolPtrTy));
  if (Protocols.empty())
    classFields.addNullPointer(PtrTy);
  else
    classFields.add(GenerateProtocolList(Protocols));
  // struct reference_list *extra_data;
  classFields.addNullPointer(PtrTy);
  // long abi_version;
  classFields.addInt(LongTy, 0);
  // struct objc_property_list *properties
  classFields.add(GeneratePropertyList(OID, classDecl));

  llvm::GlobalVariable *classStruct =
    classFields.finishAndCreateGlobal(SymbolForClass(className),
      CGM.getPointerAlign(), false, llvm::GlobalValue::ExternalLinkage);

  auto *classRefSymbol = GetClassVar(className);
  classRefSymbol->setSection(sectionName<ClassReferenceSection>());
  classRefSymbol->setInitializer(llvm::ConstantExpr::getBitCast(classStruct, IdTy));

  if (IsCOFF) {
    // we can't import a class struct.
    if (OID->getClassInterface()->hasAttr<DLLExportAttr>()) {
      classStruct->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
      cast<llvm::GlobalValue>(classRefSymbol)->setDLLStorageClass(llvm::GlobalValue::DLLExportStorageClass);
    }

    if (SuperClass) {
      std::pair<llvm::GlobalVariable*, int> v{classStruct, 1};
      EarlyInitList.emplace_back(std::string(SuperClass->getName()),
                                 std::move(v));
    }

  }


  // Resolve the class aliases, if they exist.
  // FIXME: Class pointer aliases shouldn't exist!
  if (ClassPtrAlias) {
    ClassPtrAlias->replaceAllUsesWith(
        llvm::ConstantExpr::getBitCast(classStruct, IdTy));
    ClassPtrAlias->eraseFromParent();
    ClassPtrAlias = nullptr;
  }
  if (auto Placeholder =
      TheModule.getNamedGlobal(SymbolForClass(className)))
    if (Placeholder != classStruct) {
      Placeholder->replaceAllUsesWith(
          llvm::ConstantExpr::getBitCast(classStruct, Placeholder->getType()));
      Placeholder->eraseFromParent();
      classStruct->setName(SymbolForClass(className));
    }
  if (MetaClassPtrAlias) {
    MetaClassPtrAlias->replaceAllUsesWith(
        llvm::ConstantExpr::getBitCast(metaclass, IdTy));
    MetaClassPtrAlias->eraseFromParent();
    MetaClassPtrAlias = nullptr;
  }
  assert(classStruct->getName() == SymbolForClass(className))((void)0);

  auto classInitRef = new llvm::GlobalVariable(TheModule,
      classStruct->getType(), false, llvm::GlobalValue::ExternalLinkage,
      classStruct, ManglePublicSymbol("OBJC_INIT_CLASS_") + className);
  classInitRef->setSection(sectionName<ClassSection>());
  CGM.addUsedGlobal(classInitRef);

  EmittedClass = true;
}
public:
  CGObjCGNUstep2(CodeGenModule &Mod) : CGObjCGNUstep(Mod, 10, 4, 2) {
    MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
                          PtrToObjCSuperTy, SelectorTy);
    // struct objc_property
    // {
    //   const char *name;
    //   const char *attributes;
    //   const char *type;
    //   SEL getter;
    //   SEL setter;
    // }
    PropertyMetadataTy =
      llvm::StructType::get(CGM.getLLVMContext(),
          { PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty, PtrToInt8Ty });
  }

2016};

2018const char *const CGObjCGNUstep2::SectionsBaseNames[8] =
2019{
2020"__objc_selectors",
2021"__objc_classes",
2022"__objc_class_refs",
2023"__objc_cats",
2024"__objc_protocols",
2025"__objc_protocol_refs",
2026"__objc_class_aliases",
2027"__objc_constant_string"
2028};

2030const char *const CGObjCGNUstep2::PECOFFSectionsBaseNames[8] =
2031{
2032".objcrt$SEL",
2033".objcrt$CLS",
2034".objcrt$CLR",
2035".objcrt$CAT",
2036".objcrt$PCL",
2037".objcrt$PCR",
2038".objcrt$CAL",
2039".objcrt$STR"
2040};

2042/// Support for the ObjFW runtime.
2043class CGObjCObjFW: public CGObjCGNU {
2044protected:
/// The GCC ABI message lookup function.  Returns an IMP pointing to the
/// method implementation for this message.
LazyRuntimeFunction MsgLookupFn;
/// stret lookup function.  While this does not seem to make sense at the
/// first look, this is required to call the correct forwarding function.
LazyRuntimeFunction MsgLookupFnSRet;
/// The GCC ABI superclass message lookup function.  Takes a pointer to a
/// structure describing the receiver and the class, and a selector as
/// arguments.  Returns the IMP for the corresponding method.
LazyRuntimeFunction MsgLookupSuperFn, MsgLookupSuperFnSRet;

llvm::Value *LookupIMP(CodeGenFunction &CGF, llvm::Value *&Receiver,
                       llvm::Value *cmd, llvm::MDNode *node,
                       MessageSendInfo &MSI) override {
  CGBuilderTy &Builder = CGF.Builder;
  llvm::Value *args[] = {
          EnforceType(Builder, Receiver, IdTy),
          EnforceType(Builder, cmd, SelectorTy) };

  llvm::CallBase *imp;
  if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
    imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFnSRet, args);
  else
    imp = CGF.EmitRuntimeCallOrInvoke(MsgLookupFn, args);

  imp->setMetadata(msgSendMDKind, node);
  return imp;
}

llvm::Value *LookupIMPSuper(CodeGenFunction &CGF, Address ObjCSuper,
                            llvm::Value *cmd, MessageSendInfo &MSI) override {
  CGBuilderTy &Builder = CGF.Builder;
  llvm::Value *lookupArgs[] = {
      EnforceType(Builder, ObjCSuper.getPointer(), PtrToObjCSuperTy), cmd,
  };

  if (CGM.ReturnTypeUsesSRet(MSI.CallInfo))
    return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFnSRet, lookupArgs);
  else
    return CGF.EmitNounwindRuntimeCall(MsgLookupSuperFn, lookupArgs);
}

llvm::Value *GetClassNamed(CodeGenFunction &CGF, const std::string &Name,
                           bool isWeak) override {
  if (isWeak)
    return CGObjCGNU::GetClassNamed(CGF, Name, isWeak);

  EmitClassRef(Name);
  std::string SymbolName = "_OBJC_CLASS_" + Name;
  llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(SymbolName);
  if (!ClassSymbol)
    ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
                                           llvm::GlobalValue::ExternalLinkage,
                                           nullptr, SymbolName);
  return ClassSymbol;
}

2102public:
CGObjCObjFW(CodeGenModule &Mod): CGObjCGNU(Mod, 9, 3) {
  // IMP objc_msg_lookup(id, SEL);
  MsgLookupFn.init(&CGM, "objc_msg_lookup", IMPTy, IdTy, SelectorTy);
  MsgLookupFnSRet.init(&CGM, "objc_msg_lookup_stret", IMPTy, IdTy,
                       SelectorTy);
  // IMP objc_msg_lookup_super(struct objc_super*, SEL);
  MsgLookupSuperFn.init(&CGM, "objc_msg_lookup_super", IMPTy,
                        PtrToObjCSuperTy, SelectorTy);
  MsgLookupSuperFnSRet.init(&CGM, "objc_msg_lookup_super_stret", IMPTy,
                            PtrToObjCSuperTy, SelectorTy);
}
2114};
2115} // end anonymous namespace

2117/// Emits a reference to a dummy variable which is emitted with each class.
2118/// This ensures that a linker error will be generated when trying to link
2119/// together modules where a referenced class is not defined.
2120void CGObjCGNU::EmitClassRef(const std::string &className) {
std::string symbolRef = "__objc_class_ref_" + className;
// Don't emit two copies of the same symbol
if (TheModule.getGlobalVariable(symbolRef))
  return;
std::string symbolName = "__objc_class_name_" + className;
llvm::GlobalVariable *ClassSymbol = TheModule.getGlobalVariable(symbolName);
if (!ClassSymbol) {
  ClassSymbol = new llvm::GlobalVariable(TheModule, LongTy, false,
                                         llvm::GlobalValue::ExternalLinkage,
                                         nullptr, symbolName);
}
new llvm::GlobalVariable(TheModule, ClassSymbol->getType(), true,
  llvm::GlobalValue::WeakAnyLinkage, ClassSymbol, symbolRef);
2134}

2136CGObjCGNU::CGObjCGNU(CodeGenModule &cgm, unsigned runtimeABIVersion,
                   unsigned protocolClassVersion, unsigned classABI)
: CGObjCRuntime(cgm), TheModule(CGM.getModule()),
  VMContext(cgm.getLLVMContext()), ClassPtrAlias(nullptr),
  MetaClassPtrAlias(nullptr), RuntimeVersion(runtimeABIVersion),
  ProtocolVersion(protocolClassVersion), ClassABIVersion(classABI) {

msgSendMDKind = VMContext.getMDKindID("GNUObjCMessageSend");
usesSEHExceptions =
    cgm.getContext().getTargetInfo().getTriple().isWindowsMSVCEnvironment();

CodeGenTypes &Types = CGM.getTypes();
IntTy = cast<llvm::IntegerType>(
    Types.ConvertType(CGM.getContext().IntTy));
LongTy = cast<llvm::IntegerType>(
    Types.ConvertType(CGM.getContext().LongTy));
SizeTy = cast<llvm::IntegerType>(
    Types.ConvertType(CGM.getContext().getSizeType()));
PtrDiffTy = cast<llvm::IntegerType>(
    Types.ConvertType(CGM.getContext().getPointerDiffType()));
BoolTy = CGM.getTypes().ConvertType(CGM.getContext().BoolTy);

Int8Ty = llvm::Type::getInt8Ty(VMContext);
// C string type.  Used in lots of places.
PtrToInt8Ty = llvm::PointerType::getUnqual(Int8Ty);
ProtocolPtrTy = llvm::PointerType::getUnqual(
    Types.ConvertType(CGM.getContext().getObjCProtoType()));

Zeros[0] = llvm::ConstantInt::get(LongTy, 0);
Zeros[1] = Zeros[0];
NULLPtr = llvm::ConstantPointerNull::get(PtrToInt8Ty);
// Get the selector Type.
QualType selTy = CGM.getContext().getObjCSelType();
if (QualType() == selTy) {
  SelectorTy = PtrToInt8Ty;
} else {
  SelectorTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(selTy));
}

PtrToIntTy = llvm::PointerType::getUnqual(IntTy);
PtrTy = PtrToInt8Ty;

Int32Ty = llvm::Type::getInt32Ty(VMContext);
Int64Ty = llvm::Type::getInt64Ty(VMContext);

IntPtrTy =
    CGM.getDataLayout().getPointerSizeInBits() == 32 ? Int32Ty : Int64Ty;

// Object type
QualType UnqualIdTy = CGM.getContext().getObjCIdType();
ASTIdTy = CanQualType();
if (UnqualIdTy != QualType()) {
  ASTIdTy = CGM.getContext().getCanonicalType(UnqualIdTy);
  IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
} else {
  IdTy = PtrToInt8Ty;
}
PtrToIdTy = llvm::PointerType::getUnqual(IdTy);
ProtocolTy = llvm::StructType::get(IdTy,
    PtrToInt8Ty, // name
    PtrToInt8Ty, // protocols
    PtrToInt8Ty, // instance methods
    PtrToInt8Ty, // class methods
    PtrToInt8Ty, // optional instance methods
    PtrToInt8Ty, // optional class methods
    PtrToInt8Ty, // properties
    PtrToInt8Ty);// optional properties

// struct objc_property_gsv1
// {
//   const char *name;
//   char attributes;
//   char attributes2;
//   char unused1;
//   char unused2;
//   const char *getter_name;
//   const char *getter_types;
//   const char *setter_name;
//   const char *setter_types;
// }
PropertyMetadataTy = llvm::StructType::get(CGM.getLLVMContext(), {
    PtrToInt8Ty, Int8Ty, Int8Ty, Int8Ty, Int8Ty, PtrToInt8Ty, PtrToInt8Ty,
    PtrToInt8Ty, PtrToInt8Ty });

ObjCSuperTy = llvm::StructType::get(IdTy, IdTy);
PtrToObjCSuperTy = llvm::PointerType::getUnqual(ObjCSuperTy);

llvm::Type *VoidTy = llvm::Type::getVoidTy(VMContext);

// void objc_exception_throw(id);
ExceptionThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy);
ExceptionReThrowFn.init(&CGM, "objc_exception_throw", VoidTy, IdTy);
// int objc_sync_enter(id);
SyncEnterFn.init(&CGM, "objc_sync_enter", IntTy, IdTy);
// int objc_sync_exit(id);
SyncExitFn.init(&CGM, "objc_sync_exit", IntTy, IdTy);

// void objc_enumerationMutation (id)
EnumerationMutationFn.init(&CGM, "objc_enumerationMutation", VoidTy, IdTy);

// id objc_getProperty(id, SEL, ptrdiff_t, BOOL)
GetPropertyFn.init(&CGM, "objc_getProperty", IdTy, IdTy, SelectorTy,
                   PtrDiffTy, BoolTy);
// void objc_setProperty(id, SEL, ptrdiff_t, id, BOOL, BOOL)
SetPropertyFn.init(&CGM, "objc_setProperty", VoidTy, IdTy, SelectorTy,
                   PtrDiffTy, IdTy, BoolTy, BoolTy);
// void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
GetStructPropertyFn.init(&CGM, "objc_getPropertyStruct", VoidTy, PtrTy, PtrTy,
                         PtrDiffTy, BoolTy, BoolTy);
// void objc_setPropertyStruct(void*, void*, ptrdiff_t, BOOL, BOOL)
SetStructPropertyFn.init(&CGM, "objc_setPropertyStruct", VoidTy, PtrTy, PtrTy,
                         PtrDiffTy, BoolTy, BoolTy);

// IMP type
llvm::Type *IMPArgs[] = { IdTy, SelectorTy };
IMPTy = llvm::PointerType::getUnqual(llvm::FunctionType::get(IdTy, IMPArgs,
            true));

const LangOptions &Opts = CGM.getLangOpts();
if ((Opts.getGC() != LangOptions::NonGC) || Opts.ObjCAutoRefCount)
  RuntimeVersion = 10;

// Don't bother initialising the GC stuff unless we're compiling in GC mode
if (Opts.getGC() != LangOptions::NonGC) {
  // This is a bit of an hack.  We should sort this out by having a proper
  // CGObjCGNUstep subclass for GC, but we may want to really support the old
  // ABI and GC added in ObjectiveC2.framework, so we fudge it a bit for now
  // Get selectors needed in GC mode
  RetainSel = GetNullarySelector("retain", CGM.getContext());
  ReleaseSel = GetNullarySelector("release", CGM.getContext());
  AutoreleaseSel = GetNullarySelector("autorelease", CGM.getContext());

  // Get functions needed in GC mode

  // id objc_assign_ivar(id, id, ptrdiff_t);
  IvarAssignFn.init(&CGM, "objc_assign_ivar", IdTy, IdTy, IdTy, PtrDiffTy);
  // id objc_assign_strongCast (id, id*)
  StrongCastAssignFn.init(&CGM, "objc_assign_strongCast", IdTy, IdTy,
                          PtrToIdTy);
  // id objc_assign_global(id, id*);
  GlobalAssignFn.init(&CGM, "objc_assign_global", IdTy, IdTy, PtrToIdTy);
  // id objc_assign_weak(id, id*);
  WeakAssignFn.init(&CGM, "objc_assign_weak", IdTy, IdTy, PtrToIdTy);
  // id objc_read_weak(id*);
  WeakReadFn.init(&CGM, "objc_read_weak", IdTy, PtrToIdTy);
  // void *objc_memmove_collectable(void*, void *, size_t);
  MemMoveFn.init(&CGM, "objc_memmove_collectable", PtrTy, PtrTy, PtrTy,
                 SizeTy);
}
2285}

2287llvm::Value *CGObjCGNU::GetClassNamed(CodeGenFunction &CGF,
                                    const std::string &Name, bool isWeak) {
llvm::Constant *ClassName = MakeConstantString(Name);
// With the incompatible ABI, this will need to be replaced with a direct
// reference to the class symbol.  For the compatible nonfragile ABI we are
// still performing this lookup at run time but emitting the symbol for the
// class externally so that we can make the switch later.
//
// Libobjc2 contains an LLVM pass that replaces calls to objc_lookup_class
// with memoized versions or with static references if it's safe to do so.
if (!isWeak)
  EmitClassRef(Name);

llvm::FunctionCallee ClassLookupFn = CGM.CreateRuntimeFunction(
    llvm::FunctionType::get(IdTy, PtrToInt8Ty, true), "objc_lookup_class");
return CGF.EmitNounwindRuntimeCall(ClassLookupFn, ClassName);
2303}

2305// This has to perform the lookup every time, since posing and related
2306// techniques can modify the name -> class mapping.
2307llvm::Value *CGObjCGNU::GetClass(CodeGenFunction &CGF,
                               const ObjCInterfaceDecl *OID) {
auto *Value =
    GetClassNamed(CGF, OID->getNameAsString(), OID->isWeakImported());
if (auto *ClassSymbol = dyn_cast<llvm::GlobalVariable>(Value))
  CGM.setGVProperties(ClassSymbol, OID);
return Value;
2314}

2316llvm::Value *CGObjCGNU::EmitNSAutoreleasePoolClassRef(CodeGenFunction &CGF) {
auto *Value  = GetClassNamed(CGF, "NSAutoreleasePool", false);
if (CGM.getTriple().isOSBinFormatCOFF()) {
  if (auto *ClassSymbol = dyn_cast<llvm::GlobalVariable>(Value)) {
    IdentifierInfo &II = CGF.CGM.getContext().Idents.get("NSAutoreleasePool");
    TranslationUnitDecl *TUDecl = CGM.getContext().getTranslationUnitDecl();
    DeclContext *DC = TranslationUnitDecl::castToDeclContext(TUDecl);

    const VarDecl *VD = nullptr;
    for (const auto *Result : DC->lookup(&II))
      if ((VD = dyn_cast<VarDecl>(Result)))
        break;

    CGM.setGVProperties(ClassSymbol, VD);
  }
}
return Value;
2333}

2335llvm::Value *CGObjCGNU::GetTypedSelector(CodeGenFunction &CGF, Selector Sel,
                                       const std::string &TypeEncoding) {
SmallVectorImpl<TypedSelector> &Types = SelectorTable[Sel];
llvm::GlobalAlias *SelValue = nullptr;

for (SmallVectorImpl<TypedSelector>::iterator i = Types.begin(),
    e = Types.end() ; i!=e ; i++) {
  if (i->first == TypeEncoding) {
    SelValue = i->second;
    break;
  }
}
if (!SelValue) {
  SelValue = llvm::GlobalAlias::create(
      SelectorTy->getElementType(), 0, llvm::GlobalValue::PrivateLinkage,
      ".objc_selector_" + Sel.getAsString(), &TheModule);
  Types.emplace_back(TypeEncoding, SelValue);
}

return SelValue;
2355}

2357Address CGObjCGNU::GetAddrOfSelector(CodeGenFunction &CGF, Selector Sel) {
llvm::Value *SelValue = GetSelector(CGF, Sel);

// Store it to a temporary.  Does this satisfy the semantics of
// GetAddrOfSelector?  Hopefully.
Address tmp = CGF.CreateTempAlloca(SelValue->getType(),
                                   CGF.getPointerAlign());
CGF.Builder.CreateStore(SelValue, tmp);
return tmp;
2366}

2368llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF, Selector Sel) {
return GetTypedSelector(CGF, Sel, std::string());
2370}

2372llvm::Value *CGObjCGNU::GetSelector(CodeGenFunction &CGF,
                                  const ObjCMethodDecl *Method) {
std::string SelTypes = CGM.getContext().getObjCEncodingForMethodDecl(Method);
return GetTypedSelector(CGF, Method->getSelector(), SelTypes);
2376}

2378llvm::Constant *CGObjCGNU::GetEHType(QualType T) {
if (T->isObjCIdType() || T->isObjCQualifiedIdType()) {
6
←
Calling 'Type::isObjCIdType'→
10
←
Returning from 'Type::isObjCIdType'→
11
←
Calling 'Type::isObjCQualifiedIdType'→
15
←
Returning from 'Type::isObjCQualifiedIdType'→
16
←
Taking false branch→
  // With the old ABI, there was only one kind of catchall, which broke
  // foreign exceptions.  With the new ABI, we use __objc_id_typeinfo as
  // a pointer indicating object catchalls, and NULL to indicate real
  // catchalls
  if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
    return MakeConstantString("@id");
  } else {
    return nullptr;
  }
}

// All other types should be Objective-C interface pointer types.
const ObjCObjectPointerType *OPT = T->getAs<ObjCObjectPointerType>();
17
←
Assuming the object is not a 'ObjCObjectPointerType'→
18
←
'OPT' initialized to a null pointer value→
assert(OPT && "Invalid @catch type.")((void)0);
const ObjCInterfaceDecl *IDecl = OPT->getObjectType()->getInterface();
19
←
Called C++ object pointer is null
assert(IDecl && "Invalid @catch type.")((void)0);
return MakeConstantString(IDecl->getIdentifier()->getName());
2397}

2399llvm::Constant *CGObjCGNUstep::GetEHType(QualType T) {
if (usesSEHExceptions)
1
Assuming field 'usesSEHExceptions' is false→
2
←
Taking false branch→
  return CGM.getCXXABI().getAddrOfRTTIDescriptor(T);

if (!CGM.getLangOpts().CPlusPlus)
3
←
Assuming field 'CPlusPlus' is 0→
4
←
Taking true branch→
  return CGObjCGNU::GetEHType(T);
5
←
Calling 'CGObjCGNU::GetEHType'→

// For Objective-C++, we want to provide the ability to catch both C++ and
// Objective-C objects in the same function.

// There's a particular fixed type info for 'id'.
if (T->isObjCIdType() ||
    T->isObjCQualifiedIdType()) {
  llvm::Constant *IDEHType =
    CGM.getModule().getGlobalVariable("__objc_id_type_info");
  if (!IDEHType)
    IDEHType =
      new llvm::GlobalVariable(CGM.getModule(), PtrToInt8Ty,
                               false,
                               llvm::GlobalValue::ExternalLinkage,
                               nullptr, "__objc_id_type_info");
  return llvm::ConstantExpr::getBitCast(IDEHType, PtrToInt8Ty);
}

const ObjCObjectPointerType *PT =
  T->getAs<ObjCObjectPointerType>();
assert(PT && "Invalid @catch type.")((void)0);
const ObjCInterfaceType *IT = PT->getInterfaceType();
assert(IT && "Invalid @catch type.")((void)0);
std::string className =
    std::string(IT->getDecl()->getIdentifier()->getName());

std::string typeinfoName = "__objc_eh_typeinfo_" + className;

// Return the existing typeinfo if it exists
llvm::Constant *typeinfo = TheModule.getGlobalVariable(typeinfoName);
if (typeinfo)
  return llvm::ConstantExpr::getBitCast(typeinfo, PtrToInt8Ty);

// Otherwise create it.

// vtable for gnustep::libobjc::__objc_class_type_info
// It's quite ugly hard-coding this.  Ideally we'd generate it using the host
// platform's name mangling.
const char *vtableName = "_ZTVN7gnustep7libobjc22__objc_class_type_infoE";
auto *Vtable = TheModule.getGlobalVariable(vtableName);
if (!Vtable) {
  Vtable = new llvm::GlobalVariable(TheModule, PtrToInt8Ty, true,
                                    llvm::GlobalValue::ExternalLinkage,
                                    nullptr, vtableName);
}
llvm::Constant *Two = llvm::ConstantInt::get(IntTy, 2);
auto *BVtable = llvm::ConstantExpr::getBitCast(
    llvm::ConstantExpr::getGetElementPtr(Vtable->getValueType(), Vtable, Two),
    PtrToInt8Ty);

llvm::Constant *typeName =
  ExportUniqueString(className, "__objc_eh_typename_");

ConstantInitBuilder builder(CGM);
auto fields = builder.beginStruct();
fields.add(BVtable);
fields.add(typeName);
llvm::Constant *TI =
  fields.finishAndCreateGlobal("__objc_eh_typeinfo_" + className,
                               CGM.getPointerAlign(),
                               /*constant*/ false,
                               llvm::GlobalValue::LinkOnceODRLinkage);
return llvm::ConstantExpr::getBitCast(TI, PtrToInt8Ty);
2468}

2470/// Generate an NSConstantString object.
2471ConstantAddress CGObjCGNU::GenerateConstantString(const StringLiteral *SL) {

std::string Str = SL->getString().str();
CharUnits Align = CGM.getPointerAlign();

// Look for an existing one
llvm::StringMap<llvm::Constant*>::iterator old = ObjCStrings.find(Str);
if (old != ObjCStrings.end())
  return ConstantAddress(old->getValue(), Align);

StringRef StringClass = CGM.getLangOpts().ObjCConstantStringClass;

if (StringClass.empty()) StringClass = "NSConstantString";

std::string Sym = "_OBJC_CLASS_";
Sym += StringClass;

llvm::Constant *isa = TheModule.getNamedGlobal(Sym);

if (!isa)
  isa = new llvm::GlobalVariable(TheModule, IdTy, /* isConstant */false,
          llvm::GlobalValue::ExternalWeakLinkage, nullptr, Sym);
else if (isa->getType() != PtrToIdTy)
  isa = llvm::ConstantExpr::getBitCast(isa, PtrToIdTy);

ConstantInitBuilder Builder(CGM);
auto Fields = Builder.beginStruct();
Fields.add(isa);
Fields.add(MakeConstantString(Str));
Fields.addInt(IntTy, Str.size());
llvm::Constant *ObjCStr =
  Fields.finishAndCreateGlobal(".objc_str", Align);
ObjCStr = llvm::ConstantExpr::getBitCast(ObjCStr, PtrToInt8Ty);
ObjCStrings[Str] = ObjCStr;
ConstantStrings.push_back(ObjCStr);
return ConstantAddress(ObjCStr, Align);
2507}

2509///Generates a message send where the super is the receiver.  This is a message
2510///send to self with special delivery semantics indicating which class's method
2511///should be called.
2512RValue
2513CGObjCGNU::GenerateMessageSendSuper(CodeGenFunction &CGF,
                                  ReturnValueSlot Return,
                                  QualType ResultType,
                                  Selector Sel,
                                  const ObjCInterfaceDecl *Class,
                                  bool isCategoryImpl,
                                  llvm::Value *Receiver,
                                  bool IsClassMessage,
                                  const CallArgList &CallArgs,
                                  const ObjCMethodDecl *Method) {
CGBuilderTy &Builder = CGF.Builder;
if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
  if (Sel == RetainSel || Sel == AutoreleaseSel) {
    return RValue::get(EnforceType(Builder, Receiver,
                CGM.getTypes().ConvertType(ResultType)));
  }
  if (Sel == ReleaseSel) {
    return RValue::get(nullptr);
  }
}

llvm::Value *cmd = GetSelector(CGF, Sel);
CallArgList ActualArgs;

ActualArgs.add(RValue::get(EnforceType(Builder, Receiver, IdTy)), ASTIdTy);
ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
ActualArgs.addFrom(CallArgs);

MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);

llvm::Value *ReceiverClass = nullptr;
bool isV2ABI = isRuntime(ObjCRuntime::GNUstep, 2);
if (isV2ABI) {
  ReceiverClass = GetClassNamed(CGF,
      Class->getSuperClass()->getNameAsString(), /*isWeak*/false);
  if (IsClassMessage)  {
    // Load the isa pointer of the superclass is this is a class method.
    ReceiverClass = Builder.CreateBitCast(ReceiverClass,
                                          llvm::PointerType::getUnqual(IdTy));
    ReceiverClass =
      Builder.CreateAlignedLoad(IdTy, ReceiverClass, CGF.getPointerAlign());
  }
  ReceiverClass = EnforceType(Builder, ReceiverClass, IdTy);
} else {
  if (isCategoryImpl) {
    llvm::FunctionCallee classLookupFunction = nullptr;
    if (IsClassMessage)  {
      classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
            IdTy, PtrTy, true), "objc_get_meta_class");
    } else {
      classLookupFunction = CGM.CreateRuntimeFunction(llvm::FunctionType::get(
            IdTy, PtrTy, true), "objc_get_class");
    }
    ReceiverClass = Builder.CreateCall(classLookupFunction,
        MakeConstantString(Class->getNameAsString()));
  } else {
    // Set up global aliases for the metaclass or class pointer if they do not
    // already exist.  These will are forward-references which will be set to
    // pointers to the class and metaclass structure created for the runtime
    // load function.  To send a message to super, we look up the value of the
    // super_class pointer from either the class or metaclass structure.
    if (IsClassMessage)  {
      if (!MetaClassPtrAlias) {
        MetaClassPtrAlias = llvm::GlobalAlias::create(
            IdTy->getElementType(), 0, llvm::GlobalValue::InternalLinkage,
            ".objc_metaclass_ref" + Class->getNameAsString(), &TheModule);
      }
      ReceiverClass = MetaClassPtrAlias;
    } else {
      if (!ClassPtrAlias) {
        ClassPtrAlias = llvm::GlobalAlias::create(
            IdTy->getElementType(), 0, llvm::GlobalValue::InternalLinkage,
            ".objc_class_ref" + Class->getNameAsString(), &TheModule);
      }
      ReceiverClass = ClassPtrAlias;
    }
  }
  // Cast the pointer to a simplified version of the class structure
  llvm::Type *CastTy = llvm::StructType::get(IdTy, IdTy);
  ReceiverClass = Builder.CreateBitCast(ReceiverClass,
                                        llvm::PointerType::getUnqual(CastTy));
  // Get the superclass pointer
  ReceiverClass = Builder.CreateStructGEP(CastTy, ReceiverClass, 1);
  // Load the superclass pointer
  ReceiverClass =
    Builder.CreateAlignedLoad(IdTy, ReceiverClass, CGF.getPointerAlign());
}
// Construct the structure used to look up the IMP
llvm::StructType *ObjCSuperTy =
    llvm::StructType::get(Receiver->getType(), IdTy);

Address ObjCSuper = CGF.CreateTempAlloca(ObjCSuperTy,
                            CGF.getPointerAlign());

Builder.CreateStore(Receiver, Builder.CreateStructGEP(ObjCSuper, 0));
Builder.CreateStore(ReceiverClass, Builder.CreateStructGEP(ObjCSuper, 1));

ObjCSuper = EnforceType(Builder, ObjCSuper, PtrToObjCSuperTy);

// Get the IMP
llvm::Value *imp = LookupIMPSuper(CGF, ObjCSuper, cmd, MSI);
imp = EnforceType(Builder, imp, MSI.MessengerType);

llvm::Metadata *impMD[] = {
    llvm::MDString::get(VMContext, Sel.getAsString()),
    llvm::MDString::get(VMContext, Class->getSuperClass()->getNameAsString()),
    llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
        llvm::Type::getInt1Ty(VMContext), IsClassMessage))};
llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);

CGCallee callee(CGCalleeInfo(), imp);

llvm::CallBase *call;
RValue msgRet = CGF.EmitCall(MSI.CallInfo, callee, Return, ActualArgs, &call);
call->setMetadata(msgSendMDKind, node);
return msgRet;
2629}

2631/// Generate code for a message send expression.
2632RValue
2633CGObjCGNU::GenerateMessageSend(CodeGenFunction &CGF,
                             ReturnValueSlot Return,
                             QualType ResultType,
                             Selector Sel,
                             llvm::Value *Receiver,
                             const CallArgList &CallArgs,
                             const ObjCInterfaceDecl *Class,
                             const ObjCMethodDecl *Method) {
CGBuilderTy &Builder = CGF.Builder;

// Strip out message sends to retain / release in GC mode
if (CGM.getLangOpts().getGC() == LangOptions::GCOnly) {
  if (Sel == RetainSel || Sel == AutoreleaseSel) {
    return RValue::get(EnforceType(Builder, Receiver,
                CGM.getTypes().ConvertType(ResultType)));
  }
  if (Sel == ReleaseSel) {
    return RValue::get(nullptr);
  }
}

// If the return type is something that goes in an integer register, the
// runtime will handle 0 returns.  For other cases, we fill in the 0 value
// ourselves.
//
// The language spec says the result of this kind of message send is
// undefined, but lots of people seem to have forgotten to read that
// paragraph and insist on sending messages to nil that have structure
// returns.  With GCC, this generates a random return value (whatever happens
// to be on the stack / in those registers at the time) on most platforms,
// and generates an illegal instruction trap on SPARC.  With LLVM it corrupts
// the stack.
bool isPointerSizedReturn = (ResultType->isAnyPointerType() ||
    ResultType->isIntegralOrEnumerationType() || ResultType->isVoidType());

llvm::BasicBlock *startBB = nullptr;
llvm::BasicBlock *messageBB = nullptr;
llvm::BasicBlock *continueBB = nullptr;

if (!isPointerSizedReturn) {
  startBB = Builder.GetInsertBlock();
  messageBB = CGF.createBasicBlock("msgSend");
  continueBB = CGF.createBasicBlock("continue");

  llvm::Value *isNil = Builder.CreateICmpEQ(Receiver,
          llvm::Constant::getNullValue(Receiver->getType()));
  Builder.CreateCondBr(isNil, continueBB, messageBB);
  CGF.EmitBlock(messageBB);
}

IdTy = cast<llvm::PointerType>(CGM.getTypes().ConvertType(ASTIdTy));
llvm::Value *cmd;
if (Method)
  cmd = GetSelector(CGF, Method);
else
  cmd = GetSelector(CGF, Sel);
cmd = EnforceType(Builder, cmd, SelectorTy);
Receiver = EnforceType(Builder, Receiver, IdTy);

llvm::Metadata *impMD[] = {
    llvm::MDString::get(VMContext, Sel.getAsString()),
    llvm::MDString::get(VMContext, Class ? Class->getNameAsString() : ""),
    llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
        llvm::Type::getInt1Ty(VMContext), Class != nullptr))};
llvm::MDNode *node = llvm::MDNode::get(VMContext, impMD);

CallArgList ActualArgs;
ActualArgs.add(RValue::get(Receiver), ASTIdTy);
ActualArgs.add(RValue::get(cmd), CGF.getContext().getObjCSelType());
ActualArgs.addFrom(CallArgs);

MessageSendInfo MSI = getMessageSendInfo(Method, ResultType, ActualArgs);

// Get the IMP to call
llvm::Value *imp;

// If we have non-legacy dispatch specified, we try using the objc_msgSend()
// functions.  These are not supported on all platforms (or all runtimes on a
// given platform), so we
switch (CGM.getCodeGenOpts().getObjCDispatchMethod()) {
  case CodeGenOptions::Legacy:
    imp = LookupIMP(CGF, Receiver, cmd, node, MSI);
    break;
  case CodeGenOptions::Mixed:
  case CodeGenOptions::NonLegacy:
    if (CGM.ReturnTypeUsesFPRet(ResultType)) {
      imp =
          CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
                                    "objc_msgSend_fpret")
              .getCallee();
    } else if (CGM.ReturnTypeUsesSRet(MSI.CallInfo)) {
      // The actual types here don't matter - we're going to bitcast the
      // function anyway
      imp =
          CGM.CreateRuntimeFunction(llvm::FunctionType::get(IdTy, IdTy, true),
                                    "objc_msgSend_stret")
              .getCallee();
    } else {
      imp = CGM.CreateRuntimeFunction(
                   llvm::FunctionType::get(IdTy, IdTy, true), "objc_msgSend")
                .getCallee();
    }
}

// Reset the receiver in case the lookup modified it
ActualArgs[0] = CallArg(RValue::get(Receiver), ASTIdTy);

imp = EnforceType(Builder, imp, MSI.MessengerType);

llvm::CallBase *call;
CGCallee callee(CGCalleeInfo(), imp);
RValue msgRet = CGF.EmitCall(MSI.CallInfo, callee, Return, ActualArgs, &call);
call->setMetadata(msgSendMDKind, node);


if (!isPointerSizedReturn) {
  messageBB = CGF.Builder.GetInsertBlock();
  CGF.Builder.CreateBr(continueBB);
  CGF.EmitBlock(continueBB);
  if (msgRet.isScalar()) {
    llvm::Value *v = msgRet.getScalarVal();
    llvm::PHINode *phi = Builder.CreatePHI(v->getType(), 2);
    phi->addIncoming(v, messageBB);
    phi->addIncoming(llvm::Constant::getNullValue(v->getType()), startBB);
    msgRet = RValue::get(phi);
  } else if (msgRet.isAggregate()) {
    Address v = msgRet.getAggregateAddress();
    llvm::PHINode *phi = Builder.CreatePHI(v.getType(), 2);
    llvm::Type *RetTy = v.getElementType();
    Address NullVal = CGF.CreateTempAlloca(RetTy, v.getAlignment(), "null");
    CGF.InitTempAlloca(NullVal, llvm::Constant::getNullValue(RetTy));
    phi->addIncoming(v.getPointer(), messageBB);
    phi->addIncoming(NullVal.getPointer(), startBB);
    msgRet = RValue::getAggregate(Address(phi, v.getAlignment()));
  } else /* isComplex() */ {
    std::pair<llvm::Value*,llvm::Value*> v = msgRet.getComplexVal();
    llvm::PHINode *phi = Builder.CreatePHI(v.first->getType(), 2);
    phi->addIncoming(v.first, messageBB);
    phi->addIncoming(llvm::Constant::getNullValue(v.first->getType()),
        startBB);
    llvm::PHINode *phi2 = Builder.CreatePHI(v.second->getType(), 2);
    phi2->addIncoming(v.second, messageBB);
    phi2->addIncoming(llvm::Constant::getNullValue(v.second->getType()),
        startBB);
    msgRet = RValue::getComplex(phi, phi2);
  }
}
return msgRet;
2781}

2783/// Generates a MethodList.  Used in construction of a objc_class and
2784/// objc_category structures.
2785llvm::Constant *CGObjCGNU::
2786GenerateMethodList(StringRef ClassName,
                 StringRef CategoryName,
                 ArrayRef<const ObjCMethodDecl*> Methods,
                 bool isClassMethodList) {
if (Methods.empty())
  return NULLPtr;

ConstantInitBuilder Builder(CGM);

auto MethodList = Builder.beginStruct();
MethodList.addNullPointer(CGM.Int8PtrTy);
MethodList.addInt(Int32Ty, Methods.size());

// Get the method structure type.
llvm::StructType *ObjCMethodTy =
  llvm::StructType::get(CGM.getLLVMContext(), {
    PtrToInt8Ty, // Really a selector, but the runtime creates it us.
    PtrToInt8Ty, // Method types
    IMPTy        // Method pointer
  });
bool isV2ABI = isRuntime(ObjCRuntime::GNUstep, 2);
if (isV2ABI) {
  // size_t size;
  llvm::DataLayout td(&TheModule);
  MethodList.addInt(SizeTy, td.getTypeSizeInBits(ObjCMethodTy) /
      CGM.getContext().getCharWidth());
  ObjCMethodTy =
    llvm::StructType::get(CGM.getLLVMContext(), {
      IMPTy,       // Method pointer
      PtrToInt8Ty, // Selector
      PtrToInt8Ty  // Extended type encoding
    });
} else {
  ObjCMethodTy =
    llvm::StructType::get(CGM.getLLVMContext(), {
      PtrToInt8Ty, // Really a selector, but the runtime creates it us.
      PtrToInt8Ty, // Method types
      IMPTy        // Method pointer
    });
}
auto MethodArray = MethodList.beginArray();
ASTContext &Context = CGM.getContext();
for (const auto *OMD : Methods) {
  llvm::Constant *FnPtr =
    TheModule.getFunction(getSymbolNameForMethod(OMD));
  assert(FnPtr && "Can't generate metadata for method that doesn't exist")((void)0);
  auto Method = MethodArray.beginStruct(ObjCMethodTy);
  if (isV2ABI) {
    Method.addBitCast(FnPtr, IMPTy);
    Method.add(GetConstantSelector(OMD->getSelector(),
        Context.getObjCEncodingForMethodDecl(OMD)));
    Method.add(MakeConstantString(Context.getObjCEncodingForMethodDecl(OMD, true)));
  } else {
    Method.add(MakeConstantString(OMD->getSelector().getAsString()));
    Method.add(MakeConstantString(Context.getObjCEncodingForMethodDecl(OMD)));
    Method.addBitCast(FnPtr, IMPTy);
  }
  Method.finishAndAddTo(MethodArray);
}
MethodArray.finishAndAddTo(MethodList);

// Create an instance of the structure
return MethodList.finishAndCreateGlobal(".objc_method_list",
                                        CGM.getPointerAlign());
2850}

2852/// Generates an IvarList.  Used in construction of a objc_class.
2853llvm::Constant *CGObjCGNU::
2854GenerateIvarList(ArrayRef<llvm::Constant *> IvarNames,
               ArrayRef<llvm::Constant *> IvarTypes,
               ArrayRef<llvm::Constant *> IvarOffsets,
               ArrayRef<llvm::Constant *> IvarAlign,
               ArrayRef<Qualifiers::ObjCLifetime> IvarOwnership) {
if (IvarNames.empty())
  return NULLPtr;

ConstantInitBuilder Builder(CGM);

// Structure containing array count followed by array.
auto IvarList = Builder.beginStruct();
IvarList.addInt(IntTy, (int)IvarNames.size());

// Get the ivar structure type.
llvm::StructType *ObjCIvarTy =
    llvm::StructType::get(PtrToInt8Ty, PtrToInt8Ty, IntTy);

// Array of ivar structures.
auto Ivars = IvarList.beginArray(ObjCIvarTy);
for (unsigned int i = 0, e = IvarNames.size() ; i < e ; i++) {
  auto Ivar = Ivars.beginStruct(ObjCIvarTy);
  Ivar.add(IvarNames[i]);
  Ivar.add(IvarTypes[i]);
  Ivar.add(IvarOffsets[i]);
  Ivar.finishAndAddTo(Ivars);
}
Ivars.finishAndAddTo(IvarList);

// Create an instance of the structure
return IvarList.finishAndCreateGlobal(".objc_ivar_list",
                                      CGM.getPointerAlign());
2886}

2888/// Generate a class structure
2889llvm::Constant *CGObjCGNU::GenerateClassStructure(
  llvm::Constant *MetaClass,
  llvm::Constant *SuperClass,
  unsigned info,
  const char *Name,
  llvm::Constant *Version,
  llvm::Constant *InstanceSize,
  llvm::Constant *IVars,
  llvm::Constant *Methods,
  llvm::Constant *Protocols,
  llvm::Constant *IvarOffsets,
  llvm::Constant *Properties,
  llvm::Constant *StrongIvarBitmap,
  llvm::Constant *WeakIvarBitmap,
  bool isMeta) {
// Set up the class structure
// Note:  Several of these are char*s when they should be ids.  This is
// because the runtime performs this translation on load.
//
// Fields marked New ABI are part of the GNUstep runtime.  We emit them
// anyway; the classes will still work with the GNU runtime, they will just
// be ignored.
llvm::StructType *ClassTy = llvm::StructType::get(
    PtrToInt8Ty,        // isa
    PtrToInt8Ty,        // super_class
    PtrToInt8Ty,        // name
    LongTy,             // version
    LongTy,             // info
    LongTy,             // instance_size
    IVars->getType(),   // ivars
    Methods->getType(), // methods
    // These are all filled in by the runtime, so we pretend
    PtrTy, // dtable
    PtrTy, // subclass_list
    PtrTy, // sibling_class
    PtrTy, // protocols
    PtrTy, // gc_object_type
    // New ABI:
    LongTy,                 // abi_version
    IvarOffsets->getType(), // ivar_offsets
    Properties->getType(),  // properties
    IntPtrTy,               // strong_pointers
    IntPtrTy                // weak_pointers
    );

ConstantInitBuilder Builder(CGM);
auto Elements = Builder.beginStruct(ClassTy);

// Fill in the structure

// isa
Elements.addBitCast(MetaClass, PtrToInt8Ty);
// super_class
Elements.add(SuperClass);
// name
Elements.add(MakeConstantString(Name, ".class_name"));
// version
Elements.addInt(LongTy, 0);
// info
Elements.addInt(LongTy, info);
// instance_size
if (isMeta) {
  llvm::DataLayout td(&TheModule);
  Elements.addInt(LongTy,
                  td.getTypeSizeInBits(ClassTy) /
                    CGM.getContext().getCharWidth());
} else
  Elements.add(InstanceSize);
// ivars
Elements.add(IVars);
// methods
Elements.add(Methods);
// These are all filled in by the runtime, so we pretend
// dtable
Elements.add(NULLPtr);
// subclass_list
Elements.add(NULLPtr);
// sibling_class
Elements.add(NULLPtr);
// protocols
Elements.addBitCast(Protocols, PtrTy);
// gc_object_type
Elements.add(NULLPtr);
// abi_version
Elements.addInt(LongTy, ClassABIVersion);
// ivar_offsets
Elements.add(IvarOffsets);
// properties
Elements.add(Properties);
// strong_pointers
Elements.add(StrongIvarBitmap);
// weak_pointers
Elements.add(WeakIvarBitmap);
// Create an instance of the structure
// This is now an externally visible symbol, so that we can speed up class
// messages in the next ABI.  We may already have some weak references to
// this, so check and fix them properly.
std::string ClassSym((isMeta ? "_OBJC_METACLASS_": "_OBJC_CLASS_") +
        std::string(Name));
llvm::GlobalVariable *ClassRef = TheModule.getNamedGlobal(ClassSym);
llvm::Constant *Class =
  Elements.finishAndCreateGlobal(ClassSym, CGM.getPointerAlign(), false,
                                 llvm::GlobalValue::ExternalLinkage);
if (ClassRef) {
  ClassRef->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(Class,
                ClassRef->getType()));
  ClassRef->removeFromParent();
  Class->setName(ClassSym);
}
return Class;
2999}

3001llvm::Constant *CGObjCGNU::
3002GenerateProtocolMethodList(ArrayRef<const ObjCMethodDecl*> Methods) {
// Get the method structure type.
llvm::StructType *ObjCMethodDescTy =
  llvm::StructType::get(CGM.getLLVMContext(), { PtrToInt8Ty, PtrToInt8Ty });
ASTContext &Context = CGM.getContext();
ConstantInitBuilder Builder(CGM);
auto MethodList = Builder.beginStruct();
MethodList.addInt(IntTy, Methods.size());
auto MethodArray = MethodList.beginArray(ObjCMethodDescTy);
for (auto *M : Methods) {
  auto Method = MethodArray.beginStruct(ObjCMethodDescTy);
  Method.add(MakeConstantString(M->getSelector().getAsString()));
  Method.add(MakeConstantString(Context.getObjCEncodingForMethodDecl(M)));
  Method.finishAndAddTo(MethodArray);
}
MethodArray.finishAndAddTo(MethodList);
return MethodList.finishAndCreateGlobal(".objc_method_list",
                                        CGM.getPointerAlign());
3020}

3022// Create the protocol list structure used in classes, categories and so on
3023llvm::Constant *
3024CGObjCGNU::GenerateProtocolList(ArrayRef<std::string> Protocols) {

ConstantInitBuilder Builder(CGM);
auto ProtocolList = Builder.beginStruct();
ProtocolList.add(NULLPtr);
ProtocolList.addInt(LongTy, Protocols.size());

auto Elements = ProtocolList.beginArray(PtrToInt8Ty);
for (const std::string *iter = Protocols.begin(), *endIter = Protocols.end();
    iter != endIter ; iter++) {
  llvm::Constant *protocol = nullptr;
  llvm::StringMap<llvm::Constant*>::iterator value =
    ExistingProtocols.find(*iter);
  if (value == ExistingProtocols.end()) {
    protocol = GenerateEmptyProtocol(*iter);
  } else {
    protocol = value->getValue();
  }
  Elements.addBitCast(protocol, PtrToInt8Ty);
}
Elements.finishAndAddTo(ProtocolList);
return ProtocolList.finishAndCreateGlobal(".objc_protocol_list",
                                          CGM.getPointerAlign());
3047}

3049llvm::Value *CGObjCGNU::GenerateProtocolRef(CodeGenFunction &CGF,
                                          const ObjCProtocolDecl *PD) {
auto protocol = GenerateProtocolRef(PD);
llvm::Type *T =
    CGM.getTypes().ConvertType(CGM.getContext().getObjCProtoType());
return CGF.Builder.CreateBitCast(protocol, llvm::PointerType::getUnqual(T));
3055}

3057llvm::Constant *CGObjCGNU::GenerateProtocolRef(const ObjCProtocolDecl *PD) {
llvm::Constant *&protocol = ExistingProtocols[PD->getNameAsString()];
if (!protocol)
  GenerateProtocol(PD);
assert(protocol && "Unknown protocol")((void)0);
return protocol;
3063}

3065llvm::Constant *
3066CGObjCGNU::GenerateEmptyProtocol(StringRef ProtocolName) {
llvm::Constant *ProtocolList = GenerateProtocolList({});
llvm::Constant *MethodList = GenerateProtocolMethodList({});
MethodList = llvm::ConstantExpr::getBitCast(MethodList, PtrToInt8Ty);
// Protocols are objects containing lists of the methods implemented and
// protocols adopted.
ConstantInitBuilder Builder(CGM);
auto Elements = Builder.beginStruct();

// The isa pointer must be set to a magic number so the runtime knows it's
// the correct layout.
Elements.add(llvm::ConstantExpr::getIntToPtr(
        llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));

Elements.add(MakeConstantString(ProtocolName, ".objc_protocol_name"));
Elements.add(ProtocolList); /* .protocol_list */
Elements.add(MethodList);   /* .instance_methods */
Elements.add(MethodList);   /* .class_methods */
Elements.add(MethodList);   /* .optional_instance_methods */
Elements.add(MethodList);   /* .optional_class_methods */
Elements.add(NULLPtr);      /* .properties */
Elements.add(NULLPtr);      /* .optional_properties */
return Elements.finishAndCreateGlobal(SymbolForProtocol(ProtocolName),
                                      CGM.getPointerAlign());
3090}

3092void CGObjCGNU::GenerateProtocol(const ObjCProtocolDecl *PD) {
if (PD->isNonRuntimeProtocol())
  return;

std::string ProtocolName = PD->getNameAsString();

// Use the protocol definition, if there is one.
if (const ObjCProtocolDecl *Def = PD->getDefinition())
  PD = Def;

SmallVector<std::string, 16> Protocols;
for (const auto *PI : PD->protocols())
  Protocols.push_back(PI->getNameAsString());
SmallVector<const ObjCMethodDecl*, 16> InstanceMethods;
SmallVector<const ObjCMethodDecl*, 16> OptionalInstanceMethods;
for (const auto *I : PD->instance_methods())
  if (I->isOptional())
    OptionalInstanceMethods.push_back(I);
  else
    InstanceMethods.push_back(I);
// Collect information about class methods:
SmallVector<const ObjCMethodDecl*, 16> ClassMethods;
SmallVector<const ObjCMethodDecl*, 16> OptionalClassMethods;
for (const auto *I : PD->class_methods())
  if (I->isOptional())
    OptionalClassMethods.push_back(I);
  else
    ClassMethods.push_back(I);

llvm::Constant *ProtocolList = GenerateProtocolList(Protocols);
llvm::Constant *InstanceMethodList =
  GenerateProtocolMethodList(InstanceMethods);
llvm::Constant *ClassMethodList =
  GenerateProtocolMethodList(ClassMethods);
llvm::Constant *OptionalInstanceMethodList =
  GenerateProtocolMethodList(OptionalInstanceMethods);
llvm::Constant *OptionalClassMethodList =
  GenerateProtocolMethodList(OptionalClassMethods);

// Property metadata: name, attributes, isSynthesized, setter name, setter
// types, getter name, getter types.
// The isSynthesized value is always set to 0 in a protocol.  It exists to
// simplify the runtime library by allowing it to use the same data
// structures for protocol metadata everywhere.

llvm::Constant *PropertyList =
  GeneratePropertyList(nullptr, PD, false, false);
llvm::Constant *OptionalPropertyList =
  GeneratePropertyList(nullptr, PD, false, true);

// Protocols are objects containing lists of the methods implemented and
// protocols adopted.
// The isa pointer must be set to a magic number so the runtime knows it's
// the correct layout.
ConstantInitBuilder Builder(CGM);
auto Elements = Builder.beginStruct();
Elements.add(
    llvm::ConstantExpr::getIntToPtr(
        llvm::ConstantInt::get(Int32Ty, ProtocolVersion), IdTy));
Elements.add(MakeConstantString(ProtocolName));
Elements.add(ProtocolList);
Elements.add(InstanceMethodList);
Elements.add(ClassMethodList);
Elements.add(OptionalInstanceMethodList);
Elements.add(OptionalClassMethodList);
Elements.add(PropertyList);
Elements.add(OptionalPropertyList);
ExistingProtocols[ProtocolName] =
  llvm::ConstantExpr::getBitCast(
    Elements.finishAndCreateGlobal(".objc_protocol", CGM.getPointerAlign()),
    IdTy);
3163}
3164void CGObjCGNU::GenerateProtocolHolderCategory() {
// Collect information about instance methods

ConstantInitBuilder Builder(CGM);
auto Elements = Builder.beginStruct();

const std::string ClassName = "__ObjC_Protocol_Holder_Ugly_Hack";
const std::string CategoryName = "AnotherHack";
Elements.add(MakeConstantString(CategoryName));
Elements.add(MakeConstantString(ClassName));
// Instance method list
Elements.addBitCast(GenerateMethodList(
        ClassName, CategoryName, {}, false), PtrTy);
// Class method list
Elements.addBitCast(GenerateMethodList(
        ClassName, CategoryName, {}, true), PtrTy);

// Protocol list
ConstantInitBuilder ProtocolListBuilder(CGM);
auto ProtocolList = ProtocolListBuilder.beginStruct();
ProtocolList.add(NULLPtr);
ProtocolList.addInt(LongTy, ExistingProtocols.size());
auto ProtocolElements = ProtocolList.beginArray(PtrTy);
for (auto iter = ExistingProtocols.begin(), endIter = ExistingProtocols.end();
     iter != endIter ; iter++) {
  ProtocolElements.addBitCast(iter->getValue(), PtrTy);
}
ProtocolElements.finishAndAddTo(ProtocolList);
Elements.addBitCast(
                 ProtocolList.finishAndCreateGlobal(".objc_protocol_list",
                                                    CGM.getPointerAlign()),
                 PtrTy);
Categories.push_back(llvm::ConstantExpr::getBitCast(
      Elements.finishAndCreateGlobal("", CGM.getPointerAlign()),
      PtrTy));
3199}

3201/// Libobjc2 uses a bitfield representation where small(ish) bitfields are
3202/// stored in a 64-bit value with the low bit set to 1 and the remaining 63
3203/// bits set to their values, LSB first, while larger ones are stored in a
3204/// structure of this / form:
3205///
3206/// struct { int32_t length; int32_t values[length]; };
3207///
3208/// The values in the array are stored in host-endian format, with the least
3209/// significant bit being assumed to come first in the bitfield.  Therefore, a
3210/// bitfield with the 64th bit set will be (int64_t)&{ 2, [0, 1<<31] }, while a
3211/// bitfield / with the 63rd bit set will be 1<<64.
3212llvm::Constant *CGObjCGNU::MakeBitField(ArrayRef<bool> bits) {
int bitCount = bits.size();
int ptrBits = CGM.getDataLayout().getPointerSizeInBits();
if (bitCount < ptrBits) {
  uint64_t val = 1;
  for (int i=0 ; i<bitCount ; ++i) {
    if (bits[i]) val |= 1ULL<<(i+1);
  }
  return llvm::ConstantInt::get(IntPtrTy, val);
}
SmallVector<llvm::Constant *, 8> values;
int v=0;
while (v < bitCount) {
  int32_t word = 0;
  for (int i=0 ; (i<32) && (v<bitCount)  ; ++i) {
    if (bits[v]) word |= 1<<i;
    v++;
  }
  values.push_back(llvm::ConstantInt::get(Int32Ty, word));
}

ConstantInitBuilder builder(CGM);
auto fields = builder.beginStruct();
fields.addInt(Int32Ty, values.size());
auto array = fields.beginArray();
for (auto v : values) array.add(v);
array.finishAndAddTo(fields);

llvm::Constant *GS =
  fields.finishAndCreateGlobal("", CharUnits::fromQuantity(4));
llvm::Constant *ptr = llvm::ConstantExpr::getPtrToInt(GS, IntPtrTy);
return ptr;
3244}

3246llvm::Constant *CGObjCGNU::GenerateCategoryProtocolList(const
  ObjCCategoryDecl *OCD) {
const auto &RefPro = OCD->getReferencedProtocols();
const auto RuntimeProtos =
    GetRuntimeProtocolList(RefPro.begin(), RefPro.end());
SmallVector<std::string, 16> Protocols;
for (const auto *PD : RuntimeProtos)
  Protocols.push_back(PD->getNameAsString());
return GenerateProtocolList(Protocols);
3255}

3257void CGObjCGNU::GenerateCategory(const ObjCCategoryImplDecl *OCD) {
const ObjCInterfaceDecl *Class = OCD->getClassInterface();
std::string ClassName = Class->getNameAsString();
std::string CategoryName = OCD->getNameAsString();

// Collect the names of referenced protocols
const ObjCCategoryDecl *CatDecl = OCD->getCategoryDecl();

ConstantInitBuilder Builder(CGM);
auto Elements = Builder.beginStruct();
Elements.add(MakeConstantString(CategoryName));
Elements.add(MakeConstantString(ClassName));
// Instance method list
SmallVector<ObjCMethodDecl*, 16> InstanceMethods;
InstanceMethods.insert(InstanceMethods.begin(), OCD->instmeth_begin(),
    OCD->instmeth_end());
Elements.addBitCast(
        GenerateMethodList(ClassName, CategoryName, InstanceMethods, false),
        PtrTy);
// Class method list

SmallVector<ObjCMethodDecl*, 16> ClassMethods;
ClassMethods.insert(ClassMethods.begin(), OCD->classmeth_begin(),
    OCD->classmeth_end());
Elements.addBitCast(
        GenerateMethodList(ClassName, CategoryName, ClassMethods, true),
        PtrTy);
// Protocol list
Elements.addBitCast(GenerateCategoryProtocolList(CatDecl), PtrTy);
if (isRuntime(ObjCRuntime::GNUstep, 2)) {
  const ObjCCategoryDecl *Category =
    Class->FindCategoryDeclaration(OCD->getIdentifier());
  if (Category) {
    // Instance properties
    Elements.addBitCast(GeneratePropertyList(OCD, Category, false), PtrTy);
    // Class properties
    Elements.addBitCast(GeneratePropertyList(OCD, Category, true), PtrTy);
  } else {
    Elements.addNullPointer(PtrTy);
    Elements.addNullPointer(PtrTy);
  }
}

Categories.push_back(llvm::ConstantExpr::getBitCast(
      Elements.finishAndCreateGlobal(
        std::string(".objc_category_")+ClassName+CategoryName,
        CGM.getPointerAlign()),
      PtrTy));
3305}

3307llvm::Constant *CGObjCGNU::GeneratePropertyList(const Decl *Container,
  const ObjCContainerDecl *OCD,
  bool isClassProperty,
  bool protocolOptionalProperties) {

SmallVector<const ObjCPropertyDecl *, 16> Properties;
llvm::SmallPtrSet<const IdentifierInfo*, 16> PropertySet;
bool isProtocol = isa<ObjCProtocolDecl>(OCD);
ASTContext &Context = CGM.getContext();

std::function<void(const ObjCProtocolDecl *Proto)> collectProtocolProperties
  = [&](const ObjCProtocolDecl *Proto) {
    for (const auto *P : Proto->protocols())
      collectProtocolProperties(P);
    for (const auto *PD : Proto->properties()) {
      if (isClassProperty != PD->isClassProperty())
        continue;
      // Skip any properties that are declared in protocols that this class
      // conforms to but are not actually implemented by this class.
      if (!isProtocol && !Context.getObjCPropertyImplDeclForPropertyDecl(PD, Container))
        continue;
      if (!PropertySet.insert(PD->getIdentifier()).second)
        continue;
      Properties.push_back(PD);
    }
  };

if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
  for (const ObjCCategoryDecl *ClassExt : OID->known_extensions())
    for (auto *PD : ClassExt->properties()) {
      if (isClassProperty != PD->isClassProperty())
        continue;
      PropertySet.insert(PD->getIdentifier());
      Properties.push_back(PD);
    }

for (const auto *PD : OCD->properties()) {
  if (isClassProperty != PD->isClassProperty())
    continue;
  // If we're generating a list for a protocol, skip optional / required ones
  // when generating the other list.
  if (isProtocol && (protocolOptionalProperties != PD->isOptional()))
    continue;
  // Don't emit duplicate metadata for properties that were already in a
  // class extension.
  if (!PropertySet.insert(PD->getIdentifier()).second)
    continue;

  Properties.push_back(PD);
}

if (const ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(OCD))
  for (const auto *P : OID->all_referenced_protocols())
    collectProtocolProperties(P);
else if (const ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(OCD))
  for (const auto *P : CD->protocols())
    collectProtocolProperties(P);

auto numProperties = Properties.size();

if (numProperties == 0)
  return NULLPtr;

ConstantInitBuilder builder(CGM);
auto propertyList = builder.beginStruct();
auto properties = PushPropertyListHeader(propertyList, numProperties);

// Add all of the property methods need adding to the method list and to the
// property metadata list.
for (auto *property : Properties) {
  bool isSynthesized = false;
  bool isDynamic = false;
  if (!isProtocol) {
    auto *propertyImpl = Context.getObjCPropertyImplDeclForPropertyDecl(property, Container);
    if (propertyImpl) {
      isSynthesized = (propertyImpl->getPropertyImplementation() ==
          ObjCPropertyImplDecl::Synthesize);
      isDynamic = (propertyImpl->getPropertyImplementation() ==
          ObjCPropertyImplDecl::Dynamic);
    }
  }
  PushProperty(properties, property, Container, isSynthesized, isDynamic);
}
properties.finishAndAddTo(propertyList);

return propertyList.finishAndCreateGlobal(".objc_property_list",
                                          CGM.getPointerAlign());
3394}

3396void CGObjCGNU::RegisterAlias(const ObjCCompatibleAliasDecl *OAD) {
// Get the class declaration for which the alias is specified.
ObjCInterfaceDecl *ClassDecl =
  const_cast<ObjCInterfaceDecl *>(OAD->getClassInterface());
ClassAliases.emplace_back(ClassDecl->getNameAsString(),
                          OAD->getNameAsString());
3402}

3404void CGObjCGNU::GenerateClass(const ObjCImplementationDecl *OID) {
ASTContext &Context = CGM.getContext();

// Get the superclass name.
const ObjCInterfaceDecl * SuperClassDecl =
  OID->getClassInterface()->getSuperClass();
std::string SuperClassName;
if (SuperClassDecl) {
  SuperClassName = SuperClassDecl->getNameAsString();
  EmitClassRef(SuperClassName);
}

// Get the class name
ObjCInterfaceDecl *ClassDecl =
    const_cast<ObjCInterfaceDecl *>(OID->getClassInterface());
std::string ClassName = ClassDecl->getNameAsString();

// Emit the symbol that is used to generate linker errors if this class is
// referenced in other modules but not declared.
std::string classSymbolName = "__objc_class_name_" + ClassName;
if (auto *symbol = TheModule.getGlobalVariable(classSymbolName)) {
  symbol->setInitializer(llvm::ConstantInt::get(LongTy, 0));
} else {
  new llvm::GlobalVariable(TheModule, LongTy, false,
                           llvm::GlobalValue::ExternalLinkage,
                           llvm::ConstantInt::get(LongTy, 0),
                           classSymbolName);
}

// Get the size of instances.
int instanceSize =
  Context.getASTObjCImplementationLayout(OID).getSize().getQuantity();

// Collect information about instance variables.
SmallVector<llvm::Constant*, 16> IvarNames;
SmallVector<llvm::Constant*, 16> IvarTypes;
SmallVector<llvm::Constant*, 16> IvarOffsets;
SmallVector<llvm::Constant*, 16> IvarAligns;
SmallVector<Qualifiers::ObjCLifetime, 16> IvarOwnership;

ConstantInitBuilder IvarOffsetBuilder(CGM);
auto IvarOffsetValues = IvarOffsetBuilder.beginArray(PtrToIntTy);
SmallVector<bool, 16> WeakIvars;
SmallVector<bool, 16> StrongIvars;

int superInstanceSize = !SuperClassDecl ? 0 :
  Context.getASTObjCInterfaceLayout(SuperClassDecl).getSize().getQuantity();
// For non-fragile ivars, set the instance size to 0 - {the size of just this
// class}.  The runtime will then set this to the correct value on load.
if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
  instanceSize = 0 - (instanceSize - superInstanceSize);
}

for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
     IVD = IVD->getNextIvar()) {
    // Store the name
    IvarNames.push_back(MakeConstantString(IVD->getNameAsString()));
    // Get the type encoding for this ivar
    std::string TypeStr;
    Context.getObjCEncodingForType(IVD->getType(), TypeStr, IVD);
    IvarTypes.push_back(MakeConstantString(TypeStr));
    IvarAligns.push_back(llvm::ConstantInt::get(IntTy,
          Context.getTypeSize(IVD->getType())));
    // Get the offset
    uint64_t BaseOffset = ComputeIvarBaseOffset(CGM, OID, IVD);
    uint64_t Offset = BaseOffset;
    if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
      Offset = BaseOffset - superInstanceSize;
    }
    llvm::Constant *OffsetValue = llvm::ConstantInt::get(IntTy, Offset);
    // Create the direct offset value
    std::string OffsetName = "__objc_ivar_offset_value_" + ClassName +"." +
        IVD->getNameAsString();

    llvm::GlobalVariable *OffsetVar = TheModule.getGlobalVariable(OffsetName);
    if (OffsetVar) {
      OffsetVar->setInitializer(OffsetValue);
      // If this is the real definition, change its linkage type so that
      // different modules will use this one, rather than their private
      // copy.
      OffsetVar->setLinkage(llvm::GlobalValue::ExternalLinkage);
    } else
      OffsetVar = new llvm::GlobalVariable(TheModule, Int32Ty,
        false, llvm::GlobalValue::ExternalLinkage,
        OffsetValue, OffsetName);
    IvarOffsets.push_back(OffsetValue);
    IvarOffsetValues.add(OffsetVar);
    Qualifiers::ObjCLifetime lt = IVD->getType().getQualifiers().getObjCLifetime();
    IvarOwnership.push_back(lt);
    switch (lt) {
      case Qualifiers::OCL_Strong:
        StrongIvars.push_back(true);
        WeakIvars.push_back(false);
        break;
      case Qualifiers::OCL_Weak:
        StrongIvars.push_back(false);
        WeakIvars.push_back(true);
        break;
      default:
        StrongIvars.push_back(false);
        WeakIvars.push_back(false);
    }
}
llvm::Constant *StrongIvarBitmap = MakeBitField(StrongIvars);
llvm::Constant *WeakIvarBitmap = MakeBitField(WeakIvars);
llvm::GlobalVariable *IvarOffsetArray =
  IvarOffsetValues.finishAndCreateGlobal(".ivar.offsets",
                                         CGM.getPointerAlign());

// Collect information about instance methods
SmallVector<const ObjCMethodDecl*, 16> InstanceMethods;
InstanceMethods.insert(InstanceMethods.begin(), OID->instmeth_begin(),
    OID->instmeth_end());

SmallVector<const ObjCMethodDecl*, 16> ClassMethods;
ClassMethods.insert(ClassMethods.begin(), OID->classmeth_begin(),
    OID->classmeth_end());

llvm::Constant *Properties = GeneratePropertyList(OID, ClassDecl);

// Collect the names of referenced protocols
auto RefProtocols = ClassDecl->protocols();
auto RuntimeProtocols =
    GetRuntimeProtocolList(RefProtocols.begin(), RefProtocols.end());
SmallVector<std::string, 16> Protocols;
for (const auto *I : RuntimeProtocols)
  Protocols.push_back(I->getNameAsString());

// Get the superclass pointer.
llvm::Constant *SuperClass;
if (!SuperClassName.empty()) {
  SuperClass = MakeConstantString(SuperClassName, ".super_class_name");
} else {
  SuperClass = llvm::ConstantPointerNull::get(PtrToInt8Ty);
}
// Empty vector used to construct empty method lists
SmallVector<llvm::Constant*, 1>  empty;
// Generate the method and instance variable lists
llvm::Constant *MethodList = GenerateMethodList(ClassName, "",
    InstanceMethods, false);
llvm::Constant *ClassMethodList = GenerateMethodList(ClassName, "",
    ClassMethods, true);
llvm::Constant *IvarList = GenerateIvarList(IvarNames, IvarTypes,
    IvarOffsets, IvarAligns, IvarOwnership);
// Irrespective of whether we are compiling for a fragile or non-fragile ABI,
// we emit a symbol containing the offset for each ivar in the class.  This
// allows code compiled for the non-Fragile ABI to inherit from code compiled
// for the legacy ABI, without causing problems.  The converse is also
// possible, but causes all ivar accesses to be fragile.

// Offset pointer for getting at the correct field in the ivar list when
// setting up the alias.  These are: The base address for the global, the
// ivar array (second field), the ivar in this list (set for each ivar), and
// the offset (third field in ivar structure)
llvm::Type *IndexTy = Int32Ty;
llvm::Constant *offsetPointerIndexes[] = {Zeros[0],
    llvm::ConstantInt::get(IndexTy, ClassABIVersion > 1 ? 2 : 1), nullptr,
    llvm::ConstantInt::get(IndexTy, ClassABIVersion > 1 ? 3 : 2) };

unsigned ivarIndex = 0;
for (const ObjCIvarDecl *IVD = ClassDecl->all_declared_ivar_begin(); IVD;
     IVD = IVD->getNextIvar()) {
    const std::string Name = GetIVarOffsetVariableName(ClassDecl, IVD);
    offsetPointerIndexes[2] = llvm::ConstantInt::get(IndexTy, ivarIndex);
    // Get the correct ivar field
    llvm::Constant *offsetValue = llvm::ConstantExpr::getGetElementPtr(
        cast<llvm::GlobalVariable>(IvarList)->getValueType(), IvarList,
        offsetPointerIndexes);
    // Get the existing variable, if one exists.
    llvm::GlobalVariable *offset = TheModule.getNamedGlobal(Name);
    if (offset) {
      offset->setInitializer(offsetValue);
      // If this is the real definition, change its linkage type so that
      // different modules will use this one, rather than their private
      // copy.
      offset->setLinkage(llvm::GlobalValue::ExternalLinkage);
    } else
      // Add a new alias if there isn't one already.
      new llvm::GlobalVariable(TheModule, offsetValue->getType(),
              false, llvm::GlobalValue::ExternalLinkage, offsetValue, Name);
    ++ivarIndex;
}
llvm::Constant *ZeroPtr = llvm::ConstantInt::get(IntPtrTy, 0);

//Generate metaclass for class methods
llvm::Constant *MetaClassStruct = GenerateClassStructure(
    NULLPtr, NULLPtr, 0x12L, ClassName.c_str(), nullptr, Zeros[0],
    NULLPtr, ClassMethodList, NULLPtr, NULLPtr,
    GeneratePropertyList(OID, ClassDecl, true), ZeroPtr, ZeroPtr, true);
CGM.setGVProperties(cast<llvm::GlobalValue>(MetaClassStruct),
                    OID->getClassInterface());

// Generate the class structure
llvm::Constant *ClassStruct = GenerateClassStructure(
    MetaClassStruct, SuperClass, 0x11L, ClassName.c_str(), nullptr,
    llvm::ConstantInt::get(LongTy, instanceSize), IvarList, MethodList,
    GenerateProtocolList(Protocols), IvarOffsetArray, Properties,
    StrongIvarBitmap, WeakIvarBitmap);
CGM.setGVProperties(cast<llvm::GlobalValue>(ClassStruct),
                    OID->getClassInterface());

// Resolve the class aliases, if they exist.
if (ClassPtrAlias) {
  ClassPtrAlias->replaceAllUsesWith(
      llvm::ConstantExpr::getBitCast(ClassStruct, IdTy));
  ClassPtrAlias->eraseFromParent();
  ClassPtrAlias = nullptr;
}
if (MetaClassPtrAlias) {
  MetaClassPtrAlias->replaceAllUsesWith(
      llvm::ConstantExpr::getBitCast(MetaClassStruct, IdTy));
  MetaClassPtrAlias->eraseFromParent();
  MetaClassPtrAlias = nullptr;
}

// Add class structure to list to be added to the symtab later
ClassStruct = llvm::ConstantExpr::getBitCast(ClassStruct, PtrToInt8Ty);
Classes.push_back(ClassStruct);
3622}

3624llvm::Function *CGObjCGNU::ModuleInitFunction() {
// Only emit an ObjC load function if no Objective-C stuff has been called
if (Classes.empty() && Categories.empty() && ConstantStrings.empty() &&
    ExistingProtocols.empty() && SelectorTable.empty())
  return nullptr;

// Add all referenced protocols to a category.
GenerateProtocolHolderCategory();

llvm::StructType *selStructTy =
  dyn_cast<llvm::StructType>(SelectorTy->getElementType());
llvm::Type *selStructPtrTy = SelectorTy;
if (!selStructTy) {
  selStructTy = llvm::StructType::get(CGM.getLLVMContext(),
                                      { PtrToInt8Ty, PtrToInt8Ty });
  selStructPtrTy = llvm::PointerType::getUnqual(selStructTy);
}

// Generate statics list:
llvm::Constant *statics = NULLPtr;
if (!ConstantStrings.empty()) {
  llvm::GlobalVariable *fileStatics = [&] {
    ConstantInitBuilder builder(CGM);
    auto staticsStruct = builder.beginStruct();

    StringRef stringClass = CGM.getLangOpts().ObjCConstantStringClass;
    if (stringClass.empty()) stringClass = "NXConstantString";
    staticsStruct.add(MakeConstantString(stringClass,
                                         ".objc_static_class_name"));

    auto array = staticsStruct.beginArray();
    array.addAll(ConstantStrings);
    array.add(NULLPtr);
    array.finishAndAddTo(staticsStruct);

    return staticsStruct.finishAndCreateGlobal(".objc_statics",
                                               CGM.getPointerAlign());
  }();

  ConstantInitBuilder builder(CGM);
  auto allStaticsArray = builder.beginArray(fileStatics->getType());
  allStaticsArray.add(fileStatics);
  allStaticsArray.addNullPointer(fileStatics->getType());

  statics = allStaticsArray.finishAndCreateGlobal(".objc_statics_ptr",
                                                  CGM.getPointerAlign());
  statics = llvm::ConstantExpr::getBitCast(statics, PtrTy);
}

// Array of classes, categories, and constant objects.

SmallVector<llvm::GlobalAlias*, 16> selectorAliases;
unsigned selectorCount;

// Pointer to an array of selectors used in this module.
llvm::GlobalVariable *selectorList = [&] {
  ConstantInitBuilder builder(CGM);
  auto selectors = builder.beginArray(selStructTy);
  auto &table = SelectorTable; // MSVC workaround
  std::vector<Selector> allSelectors;
  for (auto &entry : table)
    allSelectors.push_back(entry.first);
  llvm::sort(allSelectors);

  for (auto &untypedSel : allSelectors) {
    std::string selNameStr = untypedSel.getAsString();
    llvm::Constant *selName = ExportUniqueString(selNameStr, ".objc_sel_name");

    for (TypedSelector &sel : table[untypedSel]) {
      llvm::Constant *selectorTypeEncoding = NULLPtr;
      if (!sel.first.empty())
        selectorTypeEncoding =
          MakeConstantString(sel.first, ".objc_sel_types");

      auto selStruct = selectors.beginStruct(selStructTy);
      selStruct.add(selName);
      selStruct.add(selectorTypeEncoding);
      selStruct.finishAndAddTo(selectors);

      // Store the selector alias for later replacement
      selectorAliases.push_back(sel.second);
    }
  }

  // Remember the number of entries in the selector table.
  selectorCount = selectors.size();

  // NULL-terminate the selector list.  This should not actually be required,
  // because the selector list has a length field.  Unfortunately, the GCC
  // runtime decides to ignore the length field and expects a NULL terminator,
  // and GCC cooperates with this by always setting the length to 0.
  auto selStruct = selectors.beginStruct(selStructTy);
  selStruct.add(NULLPtr);
  selStruct.add(NULLPtr);
  selStruct.finishAndAddTo(selectors);

  return selectors.finishAndCreateGlobal(".objc_selector_list",
                                         CGM.getPointerAlign());
}();

// Now that all of the static selectors exist, create pointers to them.
for (unsigned i = 0; i < selectorCount; ++i) {
  llvm::Constant *idxs[] = {
    Zeros[0],
    llvm::ConstantInt::get(Int32Ty, i)
  };
  // FIXME: We're generating redundant loads and stores here!
  llvm::Constant *selPtr = llvm::ConstantExpr::getGetElementPtr(
      selectorList->getValueType(), selectorList, idxs);
  // If selectors are defined as an opaque type, cast the pointer to this
  // type.
  selPtr = llvm::ConstantExpr::getBitCast(selPtr, SelectorTy);
  selectorAliases[i]->replaceAllUsesWith(selPtr);
  selectorAliases[i]->eraseFromParent();
}

llvm::GlobalVariable *symtab = [&] {
  ConstantInitBuilder builder(CGM);
  auto symtab = builder.beginStruct();

  // Number of static selectors
  symtab.addInt(LongTy, selectorCount);

  symtab.addBitCast(selectorList, selStructPtrTy);

  // Number of classes defined.
  symtab.addInt(CGM.Int16Ty, Classes.size());
  // Number of categories defined
  symtab.addInt(CGM.Int16Ty, Categories.size());

  // Create an array of classes, then categories, then static object instances
  auto classList = symtab.beginArray(PtrToInt8Ty);
  classList.addAll(Classes);
  classList.addAll(Categories);
  //  NULL-terminated list of static object instances (mainly constant strings)
  classList.add(statics);
  classList.add(NULLPtr);
  classList.finishAndAddTo(symtab);

  // Construct the symbol table.
  return symtab.finishAndCreateGlobal("", CGM.getPointerAlign());
}();

// The symbol table is contained in a module which has some version-checking
// constants
llvm::Constant *module = [&] {
  llvm::Type *moduleEltTys[] = {
    LongTy, LongTy, PtrToInt8Ty, symtab->getType(), IntTy
  };
  llvm::StructType *moduleTy =
    llvm::StructType::get(CGM.getLLVMContext(),
       makeArrayRef(moduleEltTys).drop_back(unsigned(RuntimeVersion < 10)));

  ConstantInitBuilder builder(CGM);
  auto module = builder.beginStruct(moduleTy);
  // Runtime version, used for ABI compatibility checking.
  module.addInt(LongTy, RuntimeVersion);
  // sizeof(ModuleTy)
  module.addInt(LongTy, CGM.getDataLayout().getTypeStoreSize(moduleTy));

  // The path to the source file where this module was declared
  SourceManager &SM = CGM.getContext().getSourceManager();
  const FileEntry *mainFile = SM.getFileEntryForID(SM.getMainFileID());
  std::string path =
    (Twine(mainFile->getDir()->getName()) + "/" + mainFile->getName()).str();
  module.add(MakeConstantString(path, ".objc_source_file_name"));
  module.add(symtab);

  if (RuntimeVersion >= 10) {
    switch (CGM.getLangOpts().getGC()) {
    case LangOptions::GCOnly:
      module.addInt(IntTy, 2);
      break;
    case LangOptions::NonGC:
      if (CGM.getLangOpts().ObjCAutoRefCount)
        module.addInt(IntTy, 1);
      else
        module.addInt(IntTy, 0);
      break;
    case LangOptions::HybridGC:
      module.addInt(IntTy, 1);
      break;
    }
  }

  return module.finishAndCreateGlobal("", CGM.getPointerAlign());
}();

// Create the load function calling the runtime entry point with the module
// structure
llvm::Function * LoadFunction = llvm::Function::Create(
    llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext), false),
    llvm::GlobalValue::InternalLinkage, ".objc_load_function",
    &TheModule);
llvm::BasicBlock *EntryBB =
    llvm::BasicBlock::Create(VMContext, "entry", LoadFunction);
CGBuilderTy Builder(CGM, VMContext);
Builder.SetInsertPoint(EntryBB);

llvm::FunctionType *FT =
  llvm::FunctionType::get(Builder.getVoidTy(), module->getType(), true);
llvm::FunctionCallee Register =
    CGM.CreateRuntimeFunction(FT, "__objc_exec_class");
Builder.CreateCall(Register, module);

if (!ClassAliases.empty()) {
  llvm::Type *ArgTypes[2] = {PtrTy, PtrToInt8Ty};
  llvm::FunctionType *RegisterAliasTy =
    llvm::FunctionType::get(Builder.getVoidTy(),
                            ArgTypes, false);
  llvm::Function *RegisterAlias = llvm::Function::Create(
    RegisterAliasTy,
    llvm::GlobalValue::ExternalWeakLinkage, "class_registerAlias_np",
    &TheModule);
  llvm::BasicBlock *AliasBB =
    llvm::BasicBlock::Create(VMContext, "alias", LoadFunction);
  llvm::BasicBlock *NoAliasBB =
    llvm::BasicBlock::Create(VMContext, "no_alias", LoadFunction);

  // Branch based on whether the runtime provided class_registerAlias_np()
  llvm::Value *HasRegisterAlias = Builder.CreateICmpNE(RegisterAlias,
          llvm::Constant::getNullValue(RegisterAlias->getType()));
  Builder.CreateCondBr(HasRegisterAlias, AliasBB, NoAliasBB);

  // The true branch (has alias registration function):
  Builder.SetInsertPoint(AliasBB);
  // Emit alias registration calls:
  for (std::vector<ClassAliasPair>::iterator iter = ClassAliases.begin();
     iter != ClassAliases.end(); ++iter) {
     llvm::Constant *TheClass =
        TheModule.getGlobalVariable("_OBJC_CLASS_" + iter->first, true);
     if (TheClass) {
       TheClass = llvm::ConstantExpr::getBitCast(TheClass, PtrTy);
       Builder.CreateCall(RegisterAlias,
                          {TheClass, MakeConstantString(iter->second)});
     }
  }
  // Jump to end:
  Builder.CreateBr(NoAliasBB);

  // Missing alias registration function, just return from the function:
  Builder.SetInsertPoint(NoAliasBB);
}
Builder.CreateRetVoid();

return LoadFunction;
3870}

3872llvm::Function *CGObjCGNU::GenerateMethod(const ObjCMethodDecl *OMD,
                                        const ObjCContainerDecl *CD) {
CodeGenTypes &Types = CGM.getTypes();
llvm::FunctionType *MethodTy =
  Types.GetFunctionType(Types.arrangeObjCMethodDeclaration(OMD));
std::string FunctionName = getSymbolNameForMethod(OMD);

llvm::Function *Method
  = llvm::Function::Create(MethodTy,
                           llvm::GlobalValue::InternalLinkage,
                           FunctionName,
                           &TheModule);
return Method;
3885}

3887void CGObjCGNU::GenerateDirectMethodPrologue(CodeGenFunction &CGF,
                                           llvm::Function *Fn,
                                           const ObjCMethodDecl *OMD,
                                           const ObjCContainerDecl *CD) {
// GNU runtime doesn't support direct calls at this time
3892}

3894llvm::FunctionCallee CGObjCGNU::GetPropertyGetFunction() {
return GetPropertyFn;
3896}

3898llvm::FunctionCallee CGObjCGNU::GetPropertySetFunction() {
return SetPropertyFn;
3900}

3902llvm::FunctionCallee CGObjCGNU::GetOptimizedPropertySetFunction(bool atomic,
                                                              bool copy) {
return nullptr;
3905}

3907llvm::FunctionCallee CGObjCGNU::GetGetStructFunction() {
return GetStructPropertyFn;
3909}

3911llvm::FunctionCallee CGObjCGNU::GetSetStructFunction() {
return SetStructPropertyFn;
3913}

3915llvm::FunctionCallee CGObjCGNU::GetCppAtomicObjectGetFunction() {
return nullptr;
3917}

3919llvm::FunctionCallee CGObjCGNU::GetCppAtomicObjectSetFunction() {
return nullptr;
3921}

3923llvm::FunctionCallee CGObjCGNU::EnumerationMutationFunction() {
return EnumerationMutationFn;
3925}

3927void CGObjCGNU::EmitSynchronizedStmt(CodeGenFunction &CGF,
                                   const ObjCAtSynchronizedStmt &S) {
EmitAtSynchronizedStmt(CGF, S, SyncEnterFn, SyncExitFn);
3930}


3933void CGObjCGNU::EmitTryStmt(CodeGenFunction &CGF,
                          const ObjCAtTryStmt &S) {
// Unlike the Apple non-fragile runtimes, which also uses
// unwind-based zero cost exceptions, the GNU Objective C runtime's
// EH support isn't a veneer over C++ EH.  Instead, exception
// objects are created by objc_exception_throw and destroyed by
// the personality function; this avoids the need for bracketing
// catch handlers with calls to __blah_begin_catch/__blah_end_catch
// (or even _Unwind_DeleteException), but probably doesn't
// interoperate very well with foreign exceptions.
//
// In Objective-C++ mode, we actually emit something equivalent to the C++
// exception handler.
EmitTryCatchStmt(CGF, S, EnterCatchFn, ExitCatchFn, ExceptionReThrowFn);
3947}

3949void CGObjCGNU::EmitThrowStmt(CodeGenFunction &CGF,
                            const ObjCAtThrowStmt &S,
                            bool ClearInsertionPoint) {
llvm::Value *ExceptionAsObject;
bool isRethrow = false;

if (const Expr *ThrowExpr = S.getThrowExpr()) {
  llvm::Value *Exception = CGF.EmitObjCThrowOperand(ThrowExpr);
  ExceptionAsObject = Exception;
} else {
  assert((!CGF.ObjCEHValueStack.empty() && CGF.ObjCEHValueStack.back()) &&((void)0)
         "Unexpected rethrow outside @catch block.")((void)0);
  ExceptionAsObject = CGF.ObjCEHValueStack.back();
  isRethrow = true;
}
if (isRethrow && usesSEHExceptions) {
  // For SEH, ExceptionAsObject may be undef, because the catch handler is
  // not passed it for catchalls and so it is not visible to the catch
  // funclet.  The real thrown object will still be live on the stack at this
  // point and will be rethrown.  If we are explicitly rethrowing the object
  // that was passed into the `@catch` block, then this code path is not
  // reached and we will instead call `objc_exception_throw` with an explicit
  // argument.
  llvm::CallBase *Throw = CGF.EmitRuntimeCallOrInvoke(ExceptionReThrowFn);
  Throw->setDoesNotReturn();
}
else {
  ExceptionAsObject = CGF.Builder.CreateBitCast(ExceptionAsObject, IdTy);
  llvm::CallBase *Throw =
      CGF.EmitRuntimeCallOrInvoke(ExceptionThrowFn, ExceptionAsObject);
  Throw->setDoesNotReturn();
}
CGF.Builder.CreateUnreachable();
if (ClearInsertionPoint)
  CGF.Builder.ClearInsertionPoint();
3984}

3986llvm::Value * CGObjCGNU::EmitObjCWeakRead(CodeGenFunction &CGF,
                                        Address AddrWeakObj) {
CGBuilderTy &B = CGF.Builder;
AddrWeakObj = EnforceType(B, AddrWeakObj, PtrToIdTy);
return B.CreateCall(WeakReadFn, AddrWeakObj.getPointer());
3991}

3993void CGObjCGNU::EmitObjCWeakAssign(CodeGenFunction &CGF,
                                 llvm::Value *src, Address dst) {
CGBuilderTy &B = CGF.Builder;
src = EnforceType(B, src, IdTy);
dst = EnforceType(B, dst, PtrToIdTy);
B.CreateCall(WeakAssignFn, {src, dst.getPointer()});
3999}

4001void CGObjCGNU::EmitObjCGlobalAssign(CodeGenFunction &CGF,
                                   llvm::Value *src, Address dst,
                                   bool threadlocal) {
CGBuilderTy &B = CGF.Builder;
src = EnforceType(B, src, IdTy);
dst = EnforceType(B, dst, PtrToIdTy);
// FIXME. Add threadloca assign API
assert(!threadlocal && "EmitObjCGlobalAssign - Threal Local API NYI")((void)0);
B.CreateCall(GlobalAssignFn, {src, dst.getPointer()});
4010}

4012void CGObjCGNU::EmitObjCIvarAssign(CodeGenFunction &CGF,
                                 llvm::Value *src, Address dst,
                                 llvm::Value *ivarOffset) {
CGBuilderTy &B = CGF.Builder;
src = EnforceType(B, src, IdTy);
dst = EnforceType(B, dst, IdTy);
B.CreateCall(IvarAssignFn, {src, dst.getPointer(), ivarOffset});
4019}

4021void CGObjCGNU::EmitObjCStrongCastAssign(CodeGenFunction &CGF,
                                       llvm::Value *src, Address dst) {
CGBuilderTy &B = CGF.Builder;
src = EnforceType(B, src, IdTy);
dst = EnforceType(B, dst, PtrToIdTy);
B.CreateCall(StrongCastAssignFn, {src, dst.getPointer()});
4027}

4029void CGObjCGNU::EmitGCMemmoveCollectable(CodeGenFunction &CGF,
                                       Address DestPtr,
                                       Address SrcPtr,
                                       llvm::Value *Size) {
CGBuilderTy &B = CGF.Builder;
DestPtr = EnforceType(B, DestPtr, PtrTy);
SrcPtr = EnforceType(B, SrcPtr, PtrTy);

B.CreateCall(MemMoveFn, {DestPtr.getPointer(), SrcPtr.getPointer(), Size});
4038}

4040llvm::GlobalVariable *CGObjCGNU::ObjCIvarOffsetVariable(
                            const ObjCInterfaceDecl *ID,
                            const ObjCIvarDecl *Ivar) {
const std::string Name = GetIVarOffsetVariableName(ID, Ivar);
// Emit the variable and initialize it with what we think the correct value
// is.  This allows code compiled with non-fragile ivars to work correctly
// when linked against code which isn't (most of the time).
llvm::GlobalVariable *IvarOffsetPointer = TheModule.getNamedGlobal(Name);
if (!IvarOffsetPointer)
  IvarOffsetPointer = new llvm::GlobalVariable(TheModule,
          llvm::Type::getInt32PtrTy(VMContext), false,
          llvm::GlobalValue::ExternalLinkage, nullptr, Name);
return IvarOffsetPointer;
4053}

4055LValue CGObjCGNU::EmitObjCValueForIvar(CodeGenFunction &CGF,
                                     QualType ObjectTy,
                                     llvm::Value *BaseValue,
                                     const ObjCIvarDecl *Ivar,
                                     unsigned CVRQualifiers) {
const ObjCInterfaceDecl *ID =
  ObjectTy->castAs<ObjCObjectType>()->getInterface();
return EmitValueForIvarAtOffset(CGF, ID, BaseValue, Ivar, CVRQualifiers,
                                EmitIvarOffset(CGF, ID, Ivar));
4064}

4066static const ObjCInterfaceDecl *FindIvarInterface(ASTContext &Context,
                                                const ObjCInterfaceDecl *OID,
                                                const ObjCIvarDecl *OIVD) {
for (const ObjCIvarDecl *next = OID->all_declared_ivar_begin(); next;
     next = next->getNextIvar()) {
  if (OIVD == next)
    return OID;
}

// Otherwise check in the super class.
if (const ObjCInterfaceDecl *Super = OID->getSuperClass())
  return FindIvarInterface(Context, Super, OIVD);

return nullptr;
4080}

4082llvm::Value *CGObjCGNU::EmitIvarOffset(CodeGenFunction &CGF,
                       const ObjCInterfaceDecl *Interface,
                       const ObjCIvarDecl *Ivar) {
if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
  Interface = FindIvarInterface(CGM.getContext(), Interface, Ivar);

  // The MSVC linker cannot have a single global defined as LinkOnceAnyLinkage
  // and ExternalLinkage, so create a reference to the ivar global and rely on
  // the definition being created as part of GenerateClass.
  if (RuntimeVersion < 10 ||
      CGF.CGM.getTarget().getTriple().isKnownWindowsMSVCEnvironment())
    return CGF.Builder.CreateZExtOrBitCast(
        CGF.Builder.CreateAlignedLoad(
            Int32Ty, CGF.Builder.CreateAlignedLoad(
                         llvm::Type::getInt32PtrTy(VMContext),
                         ObjCIvarOffsetVariable(Interface, Ivar),
                         CGF.getPointerAlign(), "ivar"),
            CharUnits::fromQuantity(4)),
        PtrDiffTy);
  std::string name = "__objc_ivar_offset_value_" +
    Interface->getNameAsString() +"." + Ivar->getNameAsString();
  CharUnits Align = CGM.getIntAlign();
  llvm::Value *Offset = TheModule.getGlobalVariable(name);
  if (!Offset) {
    auto GV = new llvm::GlobalVariable(TheModule, IntTy,
        false, llvm::GlobalValue::LinkOnceAnyLinkage,
        llvm::Constant::getNullValue(IntTy), name);
    GV->setAlignment(Align.getAsAlign());
    Offset = GV;
  }
  Offset = CGF.Builder.CreateAlignedLoad(IntTy, Offset, Align);
  if (Offset->getType() != PtrDiffTy)
    Offset = CGF.Builder.CreateZExtOrBitCast(Offset, PtrDiffTy);
  return Offset;
}
uint64_t Offset = ComputeIvarBaseOffset(CGF.CGM, Interface, Ivar);
return llvm::ConstantInt::get(PtrDiffTy, Offset, /*isSigned*/true);
4119}

4121CGObjCRuntime *
4122clang::CodeGen::CreateGNUObjCRuntime(CodeGenModule &CGM) {
auto Runtime = CGM.getLangOpts().ObjCRuntime;
switch (Runtime.getKind()) {
case ObjCRuntime::GNUstep:
  if (Runtime.getVersion() >= VersionTuple(2, 0))
    return new CGObjCGNUstep2(CGM);
  return new CGObjCGNUstep(CGM);

case ObjCRuntime::GCC:
  return new CGObjCGCC(CGM);

case ObjCRuntime::ObjFW:
  return new CGObjCObjFW(CGM);

case ObjCRuntime::FragileMacOSX:
case ObjCRuntime::MacOSX:
case ObjCRuntime::iOS:
case ObjCRuntime::WatchOS:
  llvm_unreachable("these runtimes are not GNU runtimes")__builtin_unreachable();
}
llvm_unreachable("bad runtime")__builtin_unreachable();
4143}

←

/usr/src/gnu/usr.bin/clang/libclangCodeGen/../../../llvm/clang/include/clang/AST/Type.h

1	//===- Type.h - C Language Family Type Representation ------------ C++ --===//
2	//
3	// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4	// See https://llvm.org/LICENSE.txt for license information.
5	// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6	//
7	//===----------------------------------------------------------------------===//
8	//
9	/// \file
10	/// C Language Family Type Representation
11	///
12	/// This file defines the clang::Type interface and subclasses, used to
13	/// represent types for languages in the C family.
14	//
15	//===----------------------------------------------------------------------===//
16
17	#ifndef LLVM_CLANG_AST_TYPE_H
18	#define LLVM_CLANG_AST_TYPE_H
19
20	#include "clang/AST/DependenceFlags.h"
21	#include "clang/AST/NestedNameSpecifier.h"
22	#include "clang/AST/TemplateName.h"
23	#include "clang/Basic/AddressSpaces.h"
24	#include "clang/Basic/AttrKinds.h"
25	#include "clang/Basic/Diagnostic.h"
26	#include "clang/Basic/ExceptionSpecificationType.h"
27	#include "clang/Basic/LLVM.h"
28	#include "clang/Basic/Linkage.h"
29	#include "clang/Basic/PartialDiagnostic.h"
30	#include "clang/Basic/SourceLocation.h"
31	#include "clang/Basic/Specifiers.h"
32	#include "clang/Basic/Visibility.h"
33	#include "llvm/ADT/APInt.h"
34	#include "llvm/ADT/APSInt.h"
35	#include "llvm/ADT/ArrayRef.h"
36	#include "llvm/ADT/FoldingSet.h"
37	#include "llvm/ADT/None.h"
38	#include "llvm/ADT/Optional.h"
39	#include "llvm/ADT/PointerIntPair.h"
40	#include "llvm/ADT/PointerUnion.h"
41	#include "llvm/ADT/StringRef.h"
42	#include "llvm/ADT/Twine.h"
43	#include "llvm/ADT/iterator_range.h"
44	#include "llvm/Support/Casting.h"
45	#include "llvm/Support/Compiler.h"
46	#include "llvm/Support/ErrorHandling.h"
47	#include "llvm/Support/PointerLikeTypeTraits.h"
48	#include "llvm/Support/TrailingObjects.h"
49	#include "llvm/Support/type_traits.h"
50	#include <cassert>
51	#include <cstddef>
52	#include <cstdint>
53	#include <cstring>
54	#include <string>
55	#include <type_traits>
56	#include <utility>
57
58	namespace clang {
59
60	class ExtQuals;
61	class QualType;
62	class ConceptDecl;
63	class TagDecl;
64	class TemplateParameterList;
65	class Type;
66
67	enum {
68	TypeAlignmentInBits = 4,
69	TypeAlignment = 1 << TypeAlignmentInBits
70	};
71
72	namespace serialization {
73	template <class T> class AbstractTypeReader;
74	template <class T> class AbstractTypeWriter;
75	}
76
77	} // namespace clang
78
79	namespace llvm {
80
81	template <typename T>
82	struct PointerLikeTypeTraits;
83	template<>
84	struct PointerLikeTypeTraits< ::clang::Type*> {
85	static inline void getAsVoidPointer(::clang::Type P) { return P; }
86
87	static inline ::clang::Type getFromVoidPointer(void P) {
88	return static_cast< ::clang::Type*>(P);
89	}
90
91	static constexpr int NumLowBitsAvailable = clang::TypeAlignmentInBits;
92	};
93
94	template<>
95	struct PointerLikeTypeTraits< ::clang::ExtQuals*> {
96	static inline void getAsVoidPointer(::clang::ExtQuals P) { return P; }
97
98	static inline ::clang::ExtQuals getFromVoidPointer(void P) {
99	return static_cast< ::clang::ExtQuals*>(P);
100	}
101
102	static constexpr int NumLowBitsAvailable = clang::TypeAlignmentInBits;
103	};
104
105	} // namespace llvm
106
107	namespace clang {
108
109	class ASTContext;
110	template <typename> class CanQual;
111	class CXXRecordDecl;
112	class DeclContext;
113	class EnumDecl;
114	class Expr;
115	class ExtQualsTypeCommonBase;
116	class FunctionDecl;
117	class IdentifierInfo;
118	class NamedDecl;
119	class ObjCInterfaceDecl;
120	class ObjCProtocolDecl;
121	class ObjCTypeParamDecl;
122	struct PrintingPolicy;
123	class RecordDecl;
124	class Stmt;
125	class TagDecl;
126	class TemplateArgument;
127	class TemplateArgumentListInfo;
128	class TemplateArgumentLoc;
129	class TemplateTypeParmDecl;
130	class TypedefNameDecl;
131	class UnresolvedUsingTypenameDecl;
132
133	using CanQualType = CanQual<Type>;
134
135	// Provide forward declarations for all of the *Type classes.
136	#define TYPE(Class, Base) class Class##Type;
137	#include "clang/AST/TypeNodes.inc"
138
139	/// The collection of all-type qualifiers we support.
140	/// Clang supports five independent qualifiers:
141	/// * C99: const, volatile, and restrict
142	/// * MS: __unaligned
143	/// * Embedded C (TR18037): address spaces
144	/// * Objective C: the GC attributes (none, weak, or strong)
145	class Qualifiers {
146	public:
147	enum TQ { // NOTE: These flags must be kept in sync with DeclSpec::TQ.
148	Const = 0x1,
149	Restrict = 0x2,
150	Volatile = 0x4,
151	CVRMask = Const \| Volatile \| Restrict
152	};
153
154	enum GC {
155	GCNone = 0,
156	Weak,
157	Strong
158	};
159
160	enum ObjCLifetime {
161	/// There is no lifetime qualification on this type.
162	OCL_None,
163
164	/// This object can be modified without requiring retains or
165	/// releases.
166	OCL_ExplicitNone,
167
168	/// Assigning into this object requires the old value to be
169	/// released and the new value to be retained. The timing of the
170	/// release of the old value is inexact: it may be moved to
171	/// immediately after the last known point where the value is
172	/// live.
173	OCL_Strong,
174
175	/// Reading or writing from this object requires a barrier call.
176	OCL_Weak,
177
178	/// Assigning into this object requires a lifetime extension.
179	OCL_Autoreleasing
180	};
181
182	enum {
183	/// The maximum supported address space number.
184	/// 23 bits should be enough for anyone.
185	MaxAddressSpace = 0x7fffffu,
186
187	/// The width of the "fast" qualifier mask.
188	FastWidth = 3,
189
190	/// The fast qualifier mask.
191	FastMask = (1 << FastWidth) - 1
192	};
193
194	/// Returns the common set of qualifiers while removing them from
195	/// the given sets.
196	static Qualifiers removeCommonQualifiers(Qualifiers &L, Qualifiers &R) {
197	// If both are only CVR-qualified, bit operations are sufficient.
198	if (!(L.Mask & ~CVRMask) && !(R.Mask & ~CVRMask)) {
199	Qualifiers Q;
200	Q.Mask = L.Mask & R.Mask;
201	L.Mask &= ~Q.Mask;
202	R.Mask &= ~Q.Mask;
203	return Q;
204	}
205
206	Qualifiers Q;
207	unsigned CommonCRV = L.getCVRQualifiers() & R.getCVRQualifiers();
208	Q.addCVRQualifiers(CommonCRV);
209	L.removeCVRQualifiers(CommonCRV);
210	R.removeCVRQualifiers(CommonCRV);
211
212	if (L.getObjCGCAttr() == R.getObjCGCAttr()) {
213	Q.setObjCGCAttr(L.getObjCGCAttr());
214	L.removeObjCGCAttr();
215	R.removeObjCGCAttr();
216	}
217
218	if (L.getObjCLifetime() == R.getObjCLifetime()) {
219	Q.setObjCLifetime(L.getObjCLifetime());
220	L.removeObjCLifetime();
221	R.removeObjCLifetime();
222	}
223
224	if (L.getAddressSpace() == R.getAddressSpace()) {
225	Q.setAddressSpace(L.getAddressSpace());
226	L.removeAddressSpace();
227	R.removeAddressSpace();
228	}
229	return Q;
230	}
231
232	static Qualifiers fromFastMask(unsigned Mask) {
233	Qualifiers Qs;
234	Qs.addFastQualifiers(Mask);
235	return Qs;
236	}
237
238	static Qualifiers fromCVRMask(unsigned CVR) {
239	Qualifiers Qs;
240	Qs.addCVRQualifiers(CVR);
241	return Qs;
242	}
243
244	static Qualifiers fromCVRUMask(unsigned CVRU) {
245	Qualifiers Qs;
246	Qs.addCVRUQualifiers(CVRU);
247	return Qs;
248	}
249
250	// Deserialize qualifiers from an opaque representation.
251	static Qualifiers fromOpaqueValue(unsigned opaque) {
252	Qualifiers Qs;
253	Qs.Mask = opaque;
254	return Qs;
255	}
256
257	// Serialize these qualifiers into an opaque representation.
258	unsigned getAsOpaqueValue() const {
259	return Mask;
260	}
261
262	bool hasConst() const { return Mask & Const; }
263	bool hasOnlyConst() const { return Mask == Const; }
264	void removeConst() { Mask &= ~Const; }
265	void addConst() { Mask \|= Const; }
266
267	bool hasVolatile() const { return Mask & Volatile; }
268	bool hasOnlyVolatile() const { return Mask == Volatile; }
269	void removeVolatile() { Mask &= ~Volatile; }
270	void addVolatile() { Mask \|= Volatile; }
271
272	bool hasRestrict() const { return Mask & Restrict; }
273	bool hasOnlyRestrict() const { return Mask == Restrict; }
274	void removeRestrict() { Mask &= ~Restrict; }
275	void addRestrict() { Mask \|= Restrict; }
276
277	bool hasCVRQualifiers() const { return getCVRQualifiers(); }
278	unsigned getCVRQualifiers() const { return Mask & CVRMask; }
279	unsigned getCVRUQualifiers() const { return Mask & (CVRMask \| UMask); }
280
281	void setCVRQualifiers(unsigned mask) {
282	assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")((void)0);
283	Mask = (Mask & ~CVRMask) \| mask;
284	}
285	void removeCVRQualifiers(unsigned mask) {
286	assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")((void)0);
287	Mask &= ~mask;
288	}
289	void removeCVRQualifiers() {
290	removeCVRQualifiers(CVRMask);
291	}
292	void addCVRQualifiers(unsigned mask) {
293	assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")((void)0);
294	Mask \|= mask;
295	}
296	void addCVRUQualifiers(unsigned mask) {
297	assert(!(mask & ~CVRMask & ~UMask) && "bitmask contains non-CVRU bits")((void)0);
298	Mask \|= mask;
299	}
300
301	bool hasUnaligned() const { return Mask & UMask; }
302	void setUnaligned(bool flag) {
303	Mask = (Mask & ~UMask) \| (flag ? UMask : 0);
304	}
305	void removeUnaligned() { Mask &= ~UMask; }
306	void addUnaligned() { Mask \|= UMask; }
307
308	bool hasObjCGCAttr() const { return Mask & GCAttrMask; }
309	GC getObjCGCAttr() const { return GC((Mask & GCAttrMask) >> GCAttrShift); }
310	void setObjCGCAttr(GC type) {
311	Mask = (Mask & ~GCAttrMask) \| (type << GCAttrShift);
312	}
313	void removeObjCGCAttr() { setObjCGCAttr(GCNone); }
314	void addObjCGCAttr(GC type) {
315	assert(type)((void)0);
316	setObjCGCAttr(type);
317	}
318	Qualifiers withoutObjCGCAttr() const {
319	Qualifiers qs = *this;
320	qs.removeObjCGCAttr();
321	return qs;
322	}
323	Qualifiers withoutObjCLifetime() const {
324	Qualifiers qs = *this;
325	qs.removeObjCLifetime();
326	return qs;
327	}
328	Qualifiers withoutAddressSpace() const {
329	Qualifiers qs = *this;
330	qs.removeAddressSpace();
331	return qs;
332	}
333
334	bool hasObjCLifetime() const { return Mask & LifetimeMask; }
335	ObjCLifetime getObjCLifetime() const {
336	return ObjCLifetime((Mask & LifetimeMask) >> LifetimeShift);
337	}
338	void setObjCLifetime(ObjCLifetime type) {
339	Mask = (Mask & ~LifetimeMask) \| (type << LifetimeShift);
340	}
341	void removeObjCLifetime() { setObjCLifetime(OCL_None); }
342	void addObjCLifetime(ObjCLifetime type) {
343	assert(type)((void)0);
344	assert(!hasObjCLifetime())((void)0);
345	Mask \|= (type << LifetimeShift);
346	}
347
348	/// True if the lifetime is neither None or ExplicitNone.
349	bool hasNonTrivialObjCLifetime() const {
350	ObjCLifetime lifetime = getObjCLifetime();
351	return (lifetime > OCL_ExplicitNone);
352	}
353
354	/// True if the lifetime is either strong or weak.
355	bool hasStrongOrWeakObjCLifetime() const {
356	ObjCLifetime lifetime = getObjCLifetime();
357	return (lifetime == OCL_Strong \|\| lifetime == OCL_Weak);
358	}
359
360	bool hasAddressSpace() const { return Mask & AddressSpaceMask; }
361	LangAS getAddressSpace() const {
362	return static_cast<LangAS>(Mask >> AddressSpaceShift);
363	}
364	bool hasTargetSpecificAddressSpace() const {
365	return isTargetAddressSpace(getAddressSpace());
366	}
367	/// Get the address space attribute value to be printed by diagnostics.
368	unsigned getAddressSpaceAttributePrintValue() const {
369	auto Addr = getAddressSpace();
370	// This function is not supposed to be used with language specific
371	// address spaces. If that happens, the diagnostic message should consider
372	// printing the QualType instead of the address space value.
373	assert(Addr == LangAS::Default \|\| hasTargetSpecificAddressSpace())((void)0);
374	if (Addr != LangAS::Default)
375	return toTargetAddressSpace(Addr);
376	// TODO: The diagnostic messages where Addr may be 0 should be fixed
377	// since it cannot differentiate the situation where 0 denotes the default
378	// address space or user specified __attribute__((address_space(0))).
379	return 0;
380	}
381	void setAddressSpace(LangAS space) {
382	assert((unsigned)space <= MaxAddressSpace)((void)0);
383	Mask = (Mask & ~AddressSpaceMask)
384	\| (((uint32_t) space) << AddressSpaceShift);
385	}
386	void removeAddressSpace() { setAddressSpace(LangAS::Default); }
387	void addAddressSpace(LangAS space) {
388	assert(space != LangAS::Default)((void)0);
389	setAddressSpace(space);
390	}
391
392	// Fast qualifiers are those that can be allocated directly
393	// on a QualType object.
394	bool hasFastQualifiers() const { return getFastQualifiers(); }
395	unsigned getFastQualifiers() const { return Mask & FastMask; }
396	void setFastQualifiers(unsigned mask) {
397	assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")((void)0);
398	Mask = (Mask & ~FastMask) \| mask;
399	}
400	void removeFastQualifiers(unsigned mask) {
401	assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")((void)0);
402	Mask &= ~mask;
403	}
404	void removeFastQualifiers() {
405	removeFastQualifiers(FastMask);
406	}
407	void addFastQualifiers(unsigned mask) {
408	assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")((void)0);
409	Mask \|= mask;
410	}
411
412	/// Return true if the set contains any qualifiers which require an ExtQuals
413	/// node to be allocated.
414	bool hasNonFastQualifiers() const { return Mask & ~FastMask; }
415	Qualifiers getNonFastQualifiers() const {
416	Qualifiers Quals = *this;
417	Quals.setFastQualifiers(0);
418	return Quals;
419	}
420
421	/// Return true if the set contains any qualifiers.
422	bool hasQualifiers() const { return Mask; }
423	bool empty() const { return !Mask; }
424
425	/// Add the qualifiers from the given set to this set.
426	void addQualifiers(Qualifiers Q) {
427	// If the other set doesn't have any non-boolean qualifiers, just
428	// bit-or it in.
429	if (!(Q.Mask & ~CVRMask))
430	Mask \|= Q.Mask;
431	else {
432	Mask \|= (Q.Mask & CVRMask);
433	if (Q.hasAddressSpace())
434	addAddressSpace(Q.getAddressSpace());
435	if (Q.hasObjCGCAttr())
436	addObjCGCAttr(Q.getObjCGCAttr());
437	if (Q.hasObjCLifetime())
438	addObjCLifetime(Q.getObjCLifetime());
439	}
440	}
441
442	/// Remove the qualifiers from the given set from this set.
443	void removeQualifiers(Qualifiers Q) {
444	// If the other set doesn't have any non-boolean qualifiers, just
445	// bit-and the inverse in.
446	if (!(Q.Mask & ~CVRMask))
447	Mask &= ~Q.Mask;
448	else {
449	Mask &= ~(Q.Mask & CVRMask);
450	if (getObjCGCAttr() == Q.getObjCGCAttr())
451	removeObjCGCAttr();
452	if (getObjCLifetime() == Q.getObjCLifetime())
453	removeObjCLifetime();
454	if (getAddressSpace() == Q.getAddressSpace())
455	removeAddressSpace();
456	}
457	}
458
459	/// Add the qualifiers from the given set to this set, given that
460	/// they don't conflict.
461	void addConsistentQualifiers(Qualifiers qs) {
462	assert(getAddressSpace() == qs.getAddressSpace() \|\|((void)0)
463	!hasAddressSpace() \|\| !qs.hasAddressSpace())((void)0);
464	assert(getObjCGCAttr() == qs.getObjCGCAttr() \|\|((void)0)
465	!hasObjCGCAttr() \|\| !qs.hasObjCGCAttr())((void)0);
466	assert(getObjCLifetime() == qs.getObjCLifetime() \|\|((void)0)
467	!hasObjCLifetime() \|\| !qs.hasObjCLifetime())((void)0);
468	Mask \|= qs.Mask;
469	}
470
471	/// Returns true if address space A is equal to or a superset of B.
472	/// OpenCL v2.0 defines conversion rules (OpenCLC v2.0 s6.5.5) and notion of
473	/// overlapping address spaces.
474	/// CL1.1 or CL1.2:
475	/// every address space is a superset of itself.
476	/// CL2.0 adds:
477	/// __generic is a superset of any address space except for __constant.
478	static bool isAddressSpaceSupersetOf(LangAS A, LangAS B) {
479	// Address spaces must match exactly.
480	return A == B \|\|
481	// Otherwise in OpenCLC v2.0 s6.5.5: every address space except
482	// for __constant can be used as __generic.
483	(A == LangAS::opencl_generic && B != LangAS::opencl_constant) \|\|
484	// We also define global_device and global_host address spaces,
485	// to distinguish global pointers allocated on host from pointers
486	// allocated on device, which are a subset of __global.
487	(A == LangAS::opencl_global && (B == LangAS::opencl_global_device \|\|
488	B == LangAS::opencl_global_host)) \|\|
489	(A == LangAS::sycl_global && (B == LangAS::sycl_global_device \|\|
490	B == LangAS::sycl_global_host)) \|\|
491	// Consider pointer size address spaces to be equivalent to default.
492	((isPtrSizeAddressSpace(A) \|\| A == LangAS::Default) &&
493	(isPtrSizeAddressSpace(B) \|\| B == LangAS::Default)) \|\|
494	// Default is a superset of SYCL address spaces.
495	(A == LangAS::Default &&
496	(B == LangAS::sycl_private \|\| B == LangAS::sycl_local \|\|
497	B == LangAS::sycl_global \|\| B == LangAS::sycl_global_device \|\|
498	B == LangAS::sycl_global_host));
499	}
500
501	/// Returns true if the address space in these qualifiers is equal to or
502	/// a superset of the address space in the argument qualifiers.
503	bool isAddressSpaceSupersetOf(Qualifiers other) const {
504	return isAddressSpaceSupersetOf(getAddressSpace(), other.getAddressSpace());
505	}
506
507	/// Determines if these qualifiers compatibly include another set.
508	/// Generally this answers the question of whether an object with the other
509	/// qualifiers can be safely used as an object with these qualifiers.
510	bool compatiblyIncludes(Qualifiers other) const {
511	return isAddressSpaceSupersetOf(other) &&
512	// ObjC GC qualifiers can match, be added, or be removed, but can't
513	// be changed.
514	(getObjCGCAttr() == other.getObjCGCAttr() \|\| !hasObjCGCAttr() \|\|
515	!other.hasObjCGCAttr()) &&
516	// ObjC lifetime qualifiers must match exactly.
517	getObjCLifetime() == other.getObjCLifetime() &&
518	// CVR qualifiers may subset.
519	(((Mask & CVRMask) \| (other.Mask & CVRMask)) == (Mask & CVRMask)) &&
520	// U qualifier may superset.
521	(!other.hasUnaligned() \|\| hasUnaligned());
522	}
523
524	/// Determines if these qualifiers compatibly include another set of
525	/// qualifiers from the narrow perspective of Objective-C ARC lifetime.
526	///
527	/// One set of Objective-C lifetime qualifiers compatibly includes the other
528	/// if the lifetime qualifiers match, or if both are non-__weak and the
529	/// including set also contains the 'const' qualifier, or both are non-__weak
530	/// and one is None (which can only happen in non-ARC modes).
531	bool compatiblyIncludesObjCLifetime(Qualifiers other) const {
532	if (getObjCLifetime() == other.getObjCLifetime())
533	return true;
534
535	if (getObjCLifetime() == OCL_Weak \|\| other.getObjCLifetime() == OCL_Weak)
536	return false;
537
538	if (getObjCLifetime() == OCL_None \|\| other.getObjCLifetime() == OCL_None)
539	return true;
540
541	return hasConst();
542	}
543
544	/// Determine whether this set of qualifiers is a strict superset of
545	/// another set of qualifiers, not considering qualifier compatibility.
546	bool isStrictSupersetOf(Qualifiers Other) const;
547
548	bool operator==(Qualifiers Other) const { return Mask == Other.Mask; }
549	bool operator!=(Qualifiers Other) const { return Mask != Other.Mask; }
550
551	explicit operator bool() const { return hasQualifiers(); }
552
553	Qualifiers &operator+=(Qualifiers R) {
554	addQualifiers(R);
555	return *this;
556	}
557
558	// Union two qualifier sets. If an enumerated qualifier appears
559	// in both sets, use the one from the right.
560	friend Qualifiers operator+(Qualifiers L, Qualifiers R) {
561	L += R;
562	return L;
563	}
564
565	Qualifiers &operator-=(Qualifiers R) {
566	removeQualifiers(R);
567	return *this;
568	}
569
570	/// Compute the difference between two qualifier sets.
571	friend Qualifiers operator-(Qualifiers L, Qualifiers R) {
572	L -= R;
573	return L;
574	}
575
576	std::string getAsString() const;
577	std::string getAsString(const PrintingPolicy &Policy) const;
578
579	static std::string getAddrSpaceAsString(LangAS AS);
580
581	bool isEmptyWhenPrinted(const PrintingPolicy &Policy) const;
582	void print(raw_ostream &OS, const PrintingPolicy &Policy,
583	bool appendSpaceIfNonEmpty = false) const;
584
585	void Profile(llvm::FoldingSetNodeID &ID) const {
586	ID.AddInteger(Mask);
587	}
588
589	private:
590	// bits: \|0 1 2\|3\|4 .. 5\|6 .. 8\|9 ... 31\|
591	// \|C R V\|U\|GCAttr\|Lifetime\|AddressSpace\|
592	uint32_t Mask = 0;
593
594	static const uint32_t UMask = 0x8;
595	static const uint32_t UShift = 3;
596	static const uint32_t GCAttrMask = 0x30;
597	static const uint32_t GCAttrShift = 4;
598	static const uint32_t LifetimeMask = 0x1C0;
599	static const uint32_t LifetimeShift = 6;
600	static const uint32_t AddressSpaceMask =
601	~(CVRMask \| UMask \| GCAttrMask \| LifetimeMask);
602	static const uint32_t AddressSpaceShift = 9;
603	};
604
605	/// A std::pair-like structure for storing a qualified type split
606	/// into its local qualifiers and its locally-unqualified type.
607	struct SplitQualType {
608	/// The locally-unqualified type.
609	const Type *Ty = nullptr;
610
611	/// The local qualifiers.
612	Qualifiers Quals;
613
614	SplitQualType() = default;
615	SplitQualType(const Type *ty, Qualifiers qs) : Ty(ty), Quals(qs) {}
616
617	SplitQualType getSingleStepDesugaredType() const; // end of this file
618
619	// Make std::tie work.
620	std::pair<const Type *,Qualifiers> asPair() const {
621	return std::pair<const Type *, Qualifiers>(Ty, Quals);
622	}
623
624	friend bool operator==(SplitQualType a, SplitQualType b) {
625	return a.Ty == b.Ty && a.Quals == b.Quals;
626	}
627	friend bool operator!=(SplitQualType a, SplitQualType b) {
628	return a.Ty != b.Ty \|\| a.Quals != b.Quals;
629	}
630	};
631
632	/// The kind of type we are substituting Objective-C type arguments into.
633	///
634	/// The kind of substitution affects the replacement of type parameters when
635	/// no concrete type information is provided, e.g., when dealing with an
636	/// unspecialized type.
637	enum class ObjCSubstitutionContext {
638	/// An ordinary type.
639	Ordinary,
640
641	/// The result type of a method or function.
642	Result,
643
644	/// The parameter type of a method or function.
645	Parameter,
646
647	/// The type of a property.
648	Property,
649
650	/// The superclass of a type.
651	Superclass,
652	};
653
654	/// A (possibly-)qualified type.
655	///
656	/// For efficiency, we don't store CV-qualified types as nodes on their
657	/// own: instead each reference to a type stores the qualifiers. This
658	/// greatly reduces the number of nodes we need to allocate for types (for
659	/// example we only need one for 'int', 'const int', 'volatile int',
660	/// 'const volatile int', etc).
661	///
662	/// As an added efficiency bonus, instead of making this a pair, we
663	/// just store the two bits we care about in the low bits of the
664	/// pointer. To handle the packing/unpacking, we make QualType be a
665	/// simple wrapper class that acts like a smart pointer. A third bit
666	/// indicates whether there are extended qualifiers present, in which
667	/// case the pointer points to a special structure.
668	class QualType {
669	friend class QualifierCollector;
670
671	// Thankfully, these are efficiently composable.
672	llvm::PointerIntPair<llvm::PointerUnion<const Type , const ExtQuals >,
673	Qualifiers::FastWidth> Value;
674
675	const ExtQuals *getExtQualsUnsafe() const {
676	return Value.getPointer().get<const ExtQuals*>();
677	}
678
679	const Type *getTypePtrUnsafe() const {
680	return Value.getPointer().get<const Type*>();
681	}
682
683	const ExtQualsTypeCommonBase *getCommonPtr() const {
684	assert(!isNull() && "Cannot retrieve a NULL type pointer")((void)0);
685	auto CommonPtrVal = reinterpret_cast<uintptr_t>(Value.getOpaqueValue());
686	CommonPtrVal &= ~(uintptr_t)((1 << TypeAlignmentInBits) - 1);
687	return reinterpret_cast<ExtQualsTypeCommonBase*>(CommonPtrVal);
688	}
689
690	public:
691	QualType() = default;
692	QualType(const Type *Ptr, unsigned Quals) : Value(Ptr, Quals) {}
693	QualType(const ExtQuals *Ptr, unsigned Quals) : Value(Ptr, Quals) {}
694
695	unsigned getLocalFastQualifiers() const { return Value.getInt(); }
696	void setLocalFastQualifiers(unsigned Quals) { Value.setInt(Quals); }
697
698	/// Retrieves a pointer to the underlying (unqualified) type.
699	///
700	/// This function requires that the type not be NULL. If the type might be
701	/// NULL, use the (slightly less efficient) \c getTypePtrOrNull().
702	const Type *getTypePtr() const;
703
704	const Type *getTypePtrOrNull() const;
705
706	/// Retrieves a pointer to the name of the base type.
707	const IdentifierInfo *getBaseTypeIdentifier() const;
708
709	/// Divides a QualType into its unqualified type and a set of local
710	/// qualifiers.
711	SplitQualType split() const;
712
713	void *getAsOpaquePtr() const { return Value.getOpaqueValue(); }
714
715	static QualType getFromOpaquePtr(const void *Ptr) {
716	QualType T;
717	T.Value.setFromOpaqueValue(const_cast<void*>(Ptr));
718	return T;
719	}
720
721	const Type &operator*() const {
722	return *getTypePtr();
723	}
724
725	const Type *operator->() const {
726	return getTypePtr();
727	}
728
729	bool isCanonical() const;
730	bool isCanonicalAsParam() const;
731
732	/// Return true if this QualType doesn't point to a type yet.
733	bool isNull() const {
734	return Value.getPointer().isNull();
735	}
736
737	/// Determine whether this particular QualType instance has the
738	/// "const" qualifier set, without looking through typedefs that may have
739	/// added "const" at a different level.
740	bool isLocalConstQualified() const {
741	return (getLocalFastQualifiers() & Qualifiers::Const);
742	}
743
744	/// Determine whether this type is const-qualified.
745	bool isConstQualified() const;
746
747	/// Determine whether this particular QualType instance has the
748	/// "restrict" qualifier set, without looking through typedefs that may have
749	/// added "restrict" at a different level.
750	bool isLocalRestrictQualified() const {
751	return (getLocalFastQualifiers() & Qualifiers::Restrict);
752	}
753
754	/// Determine whether this type is restrict-qualified.
755	bool isRestrictQualified() const;
756
757	/// Determine whether this particular QualType instance has the
758	/// "volatile" qualifier set, without looking through typedefs that may have
759	/// added "volatile" at a different level.
760	bool isLocalVolatileQualified() const {
761	return (getLocalFastQualifiers() & Qualifiers::Volatile);
762	}
763
764	/// Determine whether this type is volatile-qualified.
765	bool isVolatileQualified() const;
766
767	/// Determine whether this particular QualType instance has any
768	/// qualifiers, without looking through any typedefs that might add
769	/// qualifiers at a different level.
770	bool hasLocalQualifiers() const {
771	return getLocalFastQualifiers() \|\| hasLocalNonFastQualifiers();
772	}
773
774	/// Determine whether this type has any qualifiers.
775	bool hasQualifiers() const;
776
777	/// Determine whether this particular QualType instance has any
778	/// "non-fast" qualifiers, e.g., those that are stored in an ExtQualType
779	/// instance.
780	bool hasLocalNonFastQualifiers() const {
781	return Value.getPointer().is<const ExtQuals*>();
782	}
783
784	/// Retrieve the set of qualifiers local to this particular QualType
785	/// instance, not including any qualifiers acquired through typedefs or
786	/// other sugar.
787	Qualifiers getLocalQualifiers() const;
788
789	/// Retrieve the set of qualifiers applied to this type.
790	Qualifiers getQualifiers() const;
791
792	/// Retrieve the set of CVR (const-volatile-restrict) qualifiers
793	/// local to this particular QualType instance, not including any qualifiers
794	/// acquired through typedefs or other sugar.
795	unsigned getLocalCVRQualifiers() const {
796	return getLocalFastQualifiers();
797	}
798
799	/// Retrieve the set of CVR (const-volatile-restrict) qualifiers
800	/// applied to this type.
801	unsigned getCVRQualifiers() const;
802
803	bool isConstant(const ASTContext& Ctx) const {
804	return QualType::isConstant(*this, Ctx);
805	}
806
807	/// Determine whether this is a Plain Old Data (POD) type (C++ 3.9p10).
808	bool isPODType(const ASTContext &Context) const;
809
810	/// Return true if this is a POD type according to the rules of the C++98
811	/// standard, regardless of the current compilation's language.
812	bool isCXX98PODType(const ASTContext &Context) const;
813
814	/// Return true if this is a POD type according to the more relaxed rules
815	/// of the C++11 standard, regardless of the current compilation's language.
816	/// (C++0x [basic.types]p9). Note that, unlike
817	/// CXXRecordDecl::isCXX11StandardLayout, this takes DRs into account.
818	bool isCXX11PODType(const ASTContext &Context) const;
819
820	/// Return true if this is a trivial type per (C++0x [basic.types]p9)
821	bool isTrivialType(const ASTContext &Context) const;
822
823	/// Return true if this is a trivially copyable type (C++0x [basic.types]p9)
824	bool isTriviallyCopyableType(const ASTContext &Context) const;
825
826
827	/// Returns true if it is a class and it might be dynamic.
828	bool mayBeDynamicClass() const;
829
830	/// Returns true if it is not a class or if the class might not be dynamic.
831	bool mayBeNotDynamicClass() const;
832
833	// Don't promise in the API that anything besides 'const' can be
834	// easily added.
835
836	/// Add the `const` type qualifier to this QualType.
837	void addConst() {
838	addFastQualifiers(Qualifiers::Const);
839	}
840	QualType withConst() const {
841	return withFastQualifiers(Qualifiers::Const);
842	}
843
844	/// Add the `volatile` type qualifier to this QualType.
845	void addVolatile() {
846	addFastQualifiers(Qualifiers::Volatile);
847	}
848	QualType withVolatile() const {
849	return withFastQualifiers(Qualifiers::Volatile);
850	}
851
852	/// Add the `restrict` qualifier to this QualType.
853	void addRestrict() {
854	addFastQualifiers(Qualifiers::Restrict);
855	}
856	QualType withRestrict() const {
857	return withFastQualifiers(Qualifiers::Restrict);
858	}
859
860	QualType withCVRQualifiers(unsigned CVR) const {
861	return withFastQualifiers(CVR);
862	}
863
864	void addFastQualifiers(unsigned TQs) {
865	assert(!(TQs & ~Qualifiers::FastMask)((void)0)
866	&& "non-fast qualifier bits set in mask!")((void)0);
867	Value.setInt(Value.getInt() \| TQs);
868	}
869
870	void removeLocalConst();
871	void removeLocalVolatile();
872	void removeLocalRestrict();
873	void removeLocalCVRQualifiers(unsigned Mask);
874
875	void removeLocalFastQualifiers() { Value.setInt(0); }
876	void removeLocalFastQualifiers(unsigned Mask) {
877	assert(!(Mask & ~Qualifiers::FastMask) && "mask has non-fast qualifiers")((void)0);
878	Value.setInt(Value.getInt() & ~Mask);
879	}
880
881	// Creates a type with the given qualifiers in addition to any
882	// qualifiers already on this type.
883	QualType withFastQualifiers(unsigned TQs) const {
884	QualType T = *this;
885	T.addFastQualifiers(TQs);
886	return T;
887	}
888
889	// Creates a type with exactly the given fast qualifiers, removing
890	// any existing fast qualifiers.
891	QualType withExactLocalFastQualifiers(unsigned TQs) const {
892	return withoutLocalFastQualifiers().withFastQualifiers(TQs);
893	}
894
895	// Removes fast qualifiers, but leaves any extended qualifiers in place.
896	QualType withoutLocalFastQualifiers() const {
897	QualType T = *this;
898	T.removeLocalFastQualifiers();
899	return T;
900	}
901
902	QualType getCanonicalType() const;
903
904	/// Return this type with all of the instance-specific qualifiers
905	/// removed, but without removing any qualifiers that may have been applied
906	/// through typedefs.
907	QualType getLocalUnqualifiedType() const { return QualType(getTypePtr(), 0); }
908
909	/// Retrieve the unqualified variant of the given type,
910	/// removing as little sugar as possible.
911	///
912	/// This routine looks through various kinds of sugar to find the
913	/// least-desugared type that is unqualified. For example, given:
914	///
915	/// \code
916	/// typedef int Integer;
917	/// typedef const Integer CInteger;
918	/// typedef CInteger DifferenceType;
919	/// \endcode
920	///
921	/// Executing \c getUnqualifiedType() on the type \c DifferenceType will
922	/// desugar until we hit the type \c Integer, which has no qualifiers on it.
923	///
924	/// The resulting type might still be qualified if it's sugar for an array
925	/// type. To strip qualifiers even from within a sugared array type, use
926	/// ASTContext::getUnqualifiedArrayType.
927	inline QualType getUnqualifiedType() const;
928
929	/// Retrieve the unqualified variant of the given type, removing as little
930	/// sugar as possible.
931	///
932	/// Like getUnqualifiedType(), but also returns the set of
933	/// qualifiers that were built up.
934	///
935	/// The resulting type might still be qualified if it's sugar for an array
936	/// type. To strip qualifiers even from within a sugared array type, use
937	/// ASTContext::getUnqualifiedArrayType.
938	inline SplitQualType getSplitUnqualifiedType() const;
939
940	/// Determine whether this type is more qualified than the other
941	/// given type, requiring exact equality for non-CVR qualifiers.
942	bool isMoreQualifiedThan(QualType Other) const;
943
944	/// Determine whether this type is at least as qualified as the other
945	/// given type, requiring exact equality for non-CVR qualifiers.
946	bool isAtLeastAsQualifiedAs(QualType Other) const;
947
948	QualType getNonReferenceType() const;
949
950	/// Determine the type of a (typically non-lvalue) expression with the
951	/// specified result type.
952	///
953	/// This routine should be used for expressions for which the return type is
954	/// explicitly specified (e.g., in a cast or call) and isn't necessarily
955	/// an lvalue. It removes a top-level reference (since there are no
956	/// expressions of reference type) and deletes top-level cvr-qualifiers
957	/// from non-class types (in C++) or all types (in C).
958	QualType getNonLValueExprType(const ASTContext &Context) const;
959
960	/// Remove an outer pack expansion type (if any) from this type. Used as part
961	/// of converting the type of a declaration to the type of an expression that
962	/// references that expression. It's meaningless for an expression to have a
963	/// pack expansion type.
964	QualType getNonPackExpansionType() const;
965
966	/// Return the specified type with any "sugar" removed from
967	/// the type. This takes off typedefs, typeof's etc. If the outer level of
968	/// the type is already concrete, it returns it unmodified. This is similar
969	/// to getting the canonical type, but it doesn't remove all typedefs. For
970	/// example, it returns "T" as "T", (not as "int*"), because the pointer is
971	/// concrete.
972	///
973	/// Qualifiers are left in place.
974	QualType getDesugaredType(const ASTContext &Context) const {
975	return getDesugaredType(*this, Context);
976	}
977
978	SplitQualType getSplitDesugaredType() const {
979	return getSplitDesugaredType(*this);
980	}
981
982	/// Return the specified type with one level of "sugar" removed from
983	/// the type.
984	///
985	/// This routine takes off the first typedef, typeof, etc. If the outer level
986	/// of the type is already concrete, it returns it unmodified.
987	QualType getSingleStepDesugaredType(const ASTContext &Context) const {
988	return getSingleStepDesugaredTypeImpl(*this, Context);
989	}
990
991	/// Returns the specified type after dropping any
992	/// outer-level parentheses.
993	QualType IgnoreParens() const {
994	if (isa<ParenType>(*this))
995	return QualType::IgnoreParens(*this);
996	return *this;
997	}
998
999	/// Indicate whether the specified types and qualifiers are identical.
1000	friend bool operator==(const QualType &LHS, const QualType &RHS) {
1001	return LHS.Value == RHS.Value;
1002	}
1003	friend bool operator!=(const QualType &LHS, const QualType &RHS) {
1004	return LHS.Value != RHS.Value;
1005	}
1006	friend bool operator<(const QualType &LHS, const QualType &RHS) {
1007	return LHS.Value < RHS.Value;
1008	}
1009
1010	static std::string getAsString(SplitQualType split,
1011	const PrintingPolicy &Policy) {
1012	return getAsString(split.Ty, split.Quals, Policy);
1013	}
1014	static std::string getAsString(const Type *ty, Qualifiers qs,
1015	const PrintingPolicy &Policy);
1016
1017	std::string getAsString() const;
1018	std::string getAsString(const PrintingPolicy &Policy) const;
1019
1020	void print(raw_ostream &OS, const PrintingPolicy &Policy,
1021	const Twine &PlaceHolder = Twine(),
1022	unsigned Indentation = 0) const;
1023
1024	static void print(SplitQualType split, raw_ostream &OS,
1025	const PrintingPolicy &policy, const Twine &PlaceHolder,
1026	unsigned Indentation = 0) {
1027	return print(split.Ty, split.Quals, OS, policy, PlaceHolder, Indentation);
1028	}
1029
1030	static void print(const Type *ty, Qualifiers qs,
1031	raw_ostream &OS, const PrintingPolicy &policy,
1032	const Twine &PlaceHolder,
1033	unsigned Indentation = 0);
1034
1035	void getAsStringInternal(std::string &Str,
1036	const PrintingPolicy &Policy) const;
1037
1038	static void getAsStringInternal(SplitQualType split, std::string &out,
1039	const PrintingPolicy &policy) {
1040	return getAsStringInternal(split.Ty, split.Quals, out, policy);
1041	}
1042
1043	static void getAsStringInternal(const Type *ty, Qualifiers qs,
1044	std::string &out,
1045	const PrintingPolicy &policy);
1046
1047	class StreamedQualTypeHelper {
1048	const QualType &T;
1049	const PrintingPolicy &Policy;
1050	const Twine &PlaceHolder;
1051	unsigned Indentation;
1052
1053	public:
1054	StreamedQualTypeHelper(const QualType &T, const PrintingPolicy &Policy,
1055	const Twine &PlaceHolder, unsigned Indentation)
1056	: T(T), Policy(Policy), PlaceHolder(PlaceHolder),
1057	Indentation(Indentation) {}
1058
1059	friend raw_ostream &operator<<(raw_ostream &OS,
1060	const StreamedQualTypeHelper &SQT) {
1061	SQT.T.print(OS, SQT.Policy, SQT.PlaceHolder, SQT.Indentation);
1062	return OS;
1063	}
1064	};
1065
1066	StreamedQualTypeHelper stream(const PrintingPolicy &Policy,
1067	const Twine &PlaceHolder = Twine(),
1068	unsigned Indentation = 0) const {
1069	return StreamedQualTypeHelper(*this, Policy, PlaceHolder, Indentation);
1070	}
1071
1072	void dump(const char *s) const;
1073	void dump() const;
1074	void dump(llvm::raw_ostream &OS, const ASTContext &Context) const;
1075
1076	void Profile(llvm::FoldingSetNodeID &ID) const {
1077	ID.AddPointer(getAsOpaquePtr());
1078	}
1079
1080	/// Check if this type has any address space qualifier.
1081	inline bool hasAddressSpace() const;
1082
1083	/// Return the address space of this type.
1084	inline LangAS getAddressSpace() const;
1085
1086	/// Returns true if address space qualifiers overlap with T address space
1087	/// qualifiers.
1088	/// OpenCL C defines conversion rules for pointers to different address spaces
1089	/// and notion of overlapping address spaces.
1090	/// CL1.1 or CL1.2:
1091	/// address spaces overlap iff they are they same.
1092	/// OpenCL C v2.0 s6.5.5 adds:
1093	/// __generic overlaps with any address space except for __constant.
1094	bool isAddressSpaceOverlapping(QualType T) const {
1095	Qualifiers Q = getQualifiers();
1096	Qualifiers TQ = T.getQualifiers();
1097	// Address spaces overlap if at least one of them is a superset of another
1098	return Q.isAddressSpaceSupersetOf(TQ) \|\| TQ.isAddressSpaceSupersetOf(Q);
1099	}
1100
1101	/// Returns gc attribute of this type.
1102	inline Qualifiers::GC getObjCGCAttr() const;
1103
1104	/// true when Type is objc's weak.
1105	bool isObjCGCWeak() const {
1106	return getObjCGCAttr() == Qualifiers::Weak;
1107	}
1108
1109	/// true when Type is objc's strong.
1110	bool isObjCGCStrong() const {
1111	return getObjCGCAttr() == Qualifiers::Strong;
1112	}
1113
1114	/// Returns lifetime attribute of this type.
1115	Qualifiers::ObjCLifetime getObjCLifetime() const {
1116	return getQualifiers().getObjCLifetime();
1117	}
1118
1119	bool hasNonTrivialObjCLifetime() const {
1120	return getQualifiers().hasNonTrivialObjCLifetime();
1121	}
1122
1123	bool hasStrongOrWeakObjCLifetime() const {
1124	return getQualifiers().hasStrongOrWeakObjCLifetime();
1125	}
1126
1127	// true when Type is objc's weak and weak is enabled but ARC isn't.
1128	bool isNonWeakInMRRWithObjCWeak(const ASTContext &Context) const;
1129
1130	enum PrimitiveDefaultInitializeKind {
1131	/// The type does not fall into any of the following categories. Note that
1132	/// this case is zero-valued so that values of this enum can be used as a
1133	/// boolean condition for non-triviality.
1134	PDIK_Trivial,
1135
1136	/// The type is an Objective-C retainable pointer type that is qualified
1137	/// with the ARC __strong qualifier.
1138	PDIK_ARCStrong,
1139
1140	/// The type is an Objective-C retainable pointer type that is qualified
1141	/// with the ARC __weak qualifier.
1142	PDIK_ARCWeak,
1143
1144	/// The type is a struct containing a field whose type is not PCK_Trivial.
1145	PDIK_Struct
1146	};
1147
1148	/// Functions to query basic properties of non-trivial C struct types.
1149
1150	/// Check if this is a non-trivial type that would cause a C struct
1151	/// transitively containing this type to be non-trivial to default initialize
1152	/// and return the kind.
1153	PrimitiveDefaultInitializeKind
1154	isNonTrivialToPrimitiveDefaultInitialize() const;
1155
1156	enum PrimitiveCopyKind {
1157	/// The type does not fall into any of the following categories. Note that
1158	/// this case is zero-valued so that values of this enum can be used as a
1159	/// boolean condition for non-triviality.
1160	PCK_Trivial,
1161
1162	/// The type would be trivial except that it is volatile-qualified. Types
1163	/// that fall into one of the other non-trivial cases may additionally be
1164	/// volatile-qualified.
1165	PCK_VolatileTrivial,
1166
1167	/// The type is an Objective-C retainable pointer type that is qualified
1168	/// with the ARC __strong qualifier.
1169	PCK_ARCStrong,
1170
1171	/// The type is an Objective-C retainable pointer type that is qualified
1172	/// with the ARC __weak qualifier.
1173	PCK_ARCWeak,
1174
1175	/// The type is a struct containing a field whose type is neither
1176	/// PCK_Trivial nor PCK_VolatileTrivial.
1177	/// Note that a C++ struct type does not necessarily match this; C++ copying
1178	/// semantics are too complex to express here, in part because they depend
1179	/// on the exact constructor or assignment operator that is chosen by
1180	/// overload resolution to do the copy.
1181	PCK_Struct
1182	};
1183
1184	/// Check if this is a non-trivial type that would cause a C struct
1185	/// transitively containing this type to be non-trivial to copy and return the
1186	/// kind.
1187	PrimitiveCopyKind isNonTrivialToPrimitiveCopy() const;
1188
1189	/// Check if this is a non-trivial type that would cause a C struct
1190	/// transitively containing this type to be non-trivial to destructively
1191	/// move and return the kind. Destructive move in this context is a C++-style
1192	/// move in which the source object is placed in a valid but unspecified state
1193	/// after it is moved, as opposed to a truly destructive move in which the
1194	/// source object is placed in an uninitialized state.
1195	PrimitiveCopyKind isNonTrivialToPrimitiveDestructiveMove() const;
1196
1197	enum DestructionKind {
1198	DK_none,
1199	DK_cxx_destructor,
1200	DK_objc_strong_lifetime,
1201	DK_objc_weak_lifetime,
1202	DK_nontrivial_c_struct
1203	};
1204
1205	/// Returns a nonzero value if objects of this type require
1206	/// non-trivial work to clean up after. Non-zero because it's
1207	/// conceivable that qualifiers (objc_gc(weak)?) could make
1208	/// something require destruction.
1209	DestructionKind isDestructedType() const {
1210	return isDestructedTypeImpl(*this);
1211	}
1212
1213	/// Check if this is or contains a C union that is non-trivial to
1214	/// default-initialize, which is a union that has a member that is non-trivial
1215	/// to default-initialize. If this returns true,
1216	/// isNonTrivialToPrimitiveDefaultInitialize returns PDIK_Struct.
1217	bool hasNonTrivialToPrimitiveDefaultInitializeCUnion() const;
1218
1219	/// Check if this is or contains a C union that is non-trivial to destruct,
1220	/// which is a union that has a member that is non-trivial to destruct. If
1221	/// this returns true, isDestructedType returns DK_nontrivial_c_struct.
1222	bool hasNonTrivialToPrimitiveDestructCUnion() const;
1223
1224	/// Check if this is or contains a C union that is non-trivial to copy, which
1225	/// is a union that has a member that is non-trivial to copy. If this returns
1226	/// true, isNonTrivialToPrimitiveCopy returns PCK_Struct.
1227	bool hasNonTrivialToPrimitiveCopyCUnion() const;
1228
1229	/// Determine whether expressions of the given type are forbidden
1230	/// from being lvalues in C.
1231	///
1232	/// The expression types that are forbidden to be lvalues are:
1233	/// - 'void', but not qualified void
1234	/// - function types
1235	///
1236	/// The exact rule here is C99 6.3.2.1:
1237	/// An lvalue is an expression with an object type or an incomplete
1238	/// type other than void.
1239	bool isCForbiddenLValueType() const;
1240
1241	/// Substitute type arguments for the Objective-C type parameters used in the
1242	/// subject type.
1243	///
1244	/// \param ctx ASTContext in which the type exists.
1245	///
1246	/// \param typeArgs The type arguments that will be substituted for the
1247	/// Objective-C type parameters in the subject type, which are generally
1248	/// computed via \c Type::getObjCSubstitutions. If empty, the type
1249	/// parameters will be replaced with their bounds or id/Class, as appropriate
1250	/// for the context.
1251	///
1252	/// \param context The context in which the subject type was written.
1253	///
1254	/// \returns the resulting type.
1255	QualType substObjCTypeArgs(ASTContext &ctx,
1256	ArrayRef<QualType> typeArgs,
1257	ObjCSubstitutionContext context) const;
1258
1259	/// Substitute type arguments from an object type for the Objective-C type
1260	/// parameters used in the subject type.
1261	///
1262	/// This operation combines the computation of type arguments for
1263	/// substitution (\c Type::getObjCSubstitutions) with the actual process of
1264	/// substitution (\c QualType::substObjCTypeArgs) for the convenience of
1265	/// callers that need to perform a single substitution in isolation.
1266	///
1267	/// \param objectType The type of the object whose member type we're
1268	/// substituting into. For example, this might be the receiver of a message
1269	/// or the base of a property access.
1270	///
1271	/// \param dc The declaration context from which the subject type was
1272	/// retrieved, which indicates (for example) which type parameters should
1273	/// be substituted.
1274	///
1275	/// \param context The context in which the subject type was written.
1276	///
1277	/// \returns the subject type after replacing all of the Objective-C type
1278	/// parameters with their corresponding arguments.
1279	QualType substObjCMemberType(QualType objectType,
1280	const DeclContext *dc,
1281	ObjCSubstitutionContext context) const;
1282
1283	/// Strip Objective-C "__kindof" types from the given type.
1284	QualType stripObjCKindOfType(const ASTContext &ctx) const;
1285
1286	/// Remove all qualifiers including _Atomic.
1287	QualType getAtomicUnqualifiedType() const;
1288
1289	private:
1290	// These methods are implemented in a separate translation unit;
1291	// "static"-ize them to avoid creating temporary QualTypes in the
1292	// caller.
1293	static bool isConstant(QualType T, const ASTContext& Ctx);
1294	static QualType getDesugaredType(QualType T, const ASTContext &Context);
1295	static SplitQualType getSplitDesugaredType(QualType T);
1296	static SplitQualType getSplitUnqualifiedTypeImpl(QualType type);
1297	static QualType getSingleStepDesugaredTypeImpl(QualType type,
1298	const ASTContext &C);
1299	static QualType IgnoreParens(QualType T);
1300	static DestructionKind isDestructedTypeImpl(QualType type);
1301
1302	/// Check if \param RD is or contains a non-trivial C union.
1303	static bool hasNonTrivialToPrimitiveDefaultInitializeCUnion(const RecordDecl *RD);
1304	static bool hasNonTrivialToPrimitiveDestructCUnion(const RecordDecl *RD);
1305	static bool hasNonTrivialToPrimitiveCopyCUnion(const RecordDecl *RD);
1306	};
1307
1308	} // namespace clang
1309
1310	namespace llvm {
1311
1312	/// Implement simplify_type for QualType, so that we can dyn_cast from QualType
1313	/// to a specific Type class.
1314	template<> struct simplify_type< ::clang::QualType> {
1315	using SimpleType = const ::clang::Type *;
1316
1317	static SimpleType getSimplifiedValue(::clang::QualType Val) {
1318	return Val.getTypePtr();
1319	}
1320	};
1321
1322	// Teach SmallPtrSet that QualType is "basically a pointer".
1323	template<>
1324	struct PointerLikeTypeTraits<clang::QualType> {
1325	static inline void *getAsVoidPointer(clang::QualType P) {
1326	return P.getAsOpaquePtr();
1327	}
1328
1329	static inline clang::QualType getFromVoidPointer(void *P) {
1330	return clang::QualType::getFromOpaquePtr(P);
1331	}
1332
1333	// Various qualifiers go in low bits.
1334	static constexpr int NumLowBitsAvailable = 0;
1335	};
1336
1337	} // namespace llvm
1338
1339	namespace clang {
1340
1341	/// Base class that is common to both the \c ExtQuals and \c Type
1342	/// classes, which allows \c QualType to access the common fields between the
1343	/// two.
1344	class ExtQualsTypeCommonBase {
1345	friend class ExtQuals;
1346	friend class QualType;
1347	friend class Type;
1348
1349	/// The "base" type of an extended qualifiers type (\c ExtQuals) or
1350	/// a self-referential pointer (for \c Type).
1351	///
1352	/// This pointer allows an efficient mapping from a QualType to its
1353	/// underlying type pointer.
1354	const Type *const BaseType;
1355
1356	/// The canonical type of this type. A QualType.
1357	QualType CanonicalType;
1358
1359	ExtQualsTypeCommonBase(const Type *baseType, QualType canon)
1360	: BaseType(baseType), CanonicalType(canon) {}
1361	};
1362
1363	/// We can encode up to four bits in the low bits of a
1364	/// type pointer, but there are many more type qualifiers that we want
1365	/// to be able to apply to an arbitrary type. Therefore we have this
1366	/// struct, intended to be heap-allocated and used by QualType to
1367	/// store qualifiers.
1368	///
1369	/// The current design tags the 'const', 'restrict', and 'volatile' qualifiers
1370	/// in three low bits on the QualType pointer; a fourth bit records whether
1371	/// the pointer is an ExtQuals node. The extended qualifiers (address spaces,
1372	/// Objective-C GC attributes) are much more rare.
1373	class ExtQuals : public ExtQualsTypeCommonBase, public llvm::FoldingSetNode {
1374	// NOTE: changing the fast qualifiers should be straightforward as
1375	// long as you don't make 'const' non-fast.
1376	// 1. Qualifiers:
1377	// a) Modify the bitmasks (Qualifiers::TQ and DeclSpec::TQ).
1378	// Fast qualifiers must occupy the low-order bits.
1379	// b) Update Qualifiers::FastWidth and FastMask.
1380	// 2. QualType:
1381	// a) Update is{Volatile,Restrict}Qualified(), defined inline.
1382	// b) Update remove{Volatile,Restrict}, defined near the end of
1383	// this header.
1384	// 3. ASTContext:
1385	// a) Update get{Volatile,Restrict}Type.
1386
1387	/// The immutable set of qualifiers applied by this node. Always contains
1388	/// extended qualifiers.
1389	Qualifiers Quals;
1390
1391	ExtQuals *this_() { return this; }
1392
1393	public:
1394	ExtQuals(const Type *baseType, QualType canon, Qualifiers quals)
1395	: ExtQualsTypeCommonBase(baseType,
1396	canon.isNull() ? QualType(this_(), 0) : canon),
1397	Quals(quals) {
1398	assert(Quals.hasNonFastQualifiers()((void)0)
1399	&& "ExtQuals created with no fast qualifiers")((void)0);
1400	assert(!Quals.hasFastQualifiers()((void)0)
1401	&& "ExtQuals created with fast qualifiers")((void)0);
1402	}
1403
1404	Qualifiers getQualifiers() const { return Quals; }
1405
1406	bool hasObjCGCAttr() const { return Quals.hasObjCGCAttr(); }
1407	Qualifiers::GC getObjCGCAttr() const { return Quals.getObjCGCAttr(); }
1408
1409	bool hasObjCLifetime() const { return Quals.hasObjCLifetime(); }
1410	Qualifiers::ObjCLifetime getObjCLifetime() const {
1411	return Quals.getObjCLifetime();
1412	}
1413
1414	bool hasAddressSpace() const { return Quals.hasAddressSpace(); }
1415	LangAS getAddressSpace() const { return Quals.getAddressSpace(); }
1416
1417	const Type *getBaseType() const { return BaseType; }
1418
1419	public:
1420	void Profile(llvm::FoldingSetNodeID &ID) const {
1421	Profile(ID, getBaseType(), Quals);
1422	}
1423
1424	static void Profile(llvm::FoldingSetNodeID &ID,
1425	const Type *BaseType,
1426	Qualifiers Quals) {
1427	assert(!Quals.hasFastQualifiers() && "fast qualifiers in ExtQuals hash!")((void)0);
1428	ID.AddPointer(BaseType);
1429	Quals.Profile(ID);
1430	}
1431	};
1432
1433	/// The kind of C++11 ref-qualifier associated with a function type.
1434	/// This determines whether a member function's "this" object can be an
1435	/// lvalue, rvalue, or neither.
1436	enum RefQualifierKind {
1437	/// No ref-qualifier was provided.
1438	RQ_None = 0,
1439
1440	/// An lvalue ref-qualifier was provided (\c &).
1441	RQ_LValue,
1442
1443	/// An rvalue ref-qualifier was provided (\c &&).
1444	RQ_RValue
1445	};
1446
1447	/// Which keyword(s) were used to create an AutoType.
1448	enum class AutoTypeKeyword {
1449	/// auto
1450	Auto,
1451
1452	/// decltype(auto)
1453	DecltypeAuto,
1454
1455	/// __auto_type (GNU extension)
1456	GNUAutoType
1457	};
1458
1459	/// The base class of the type hierarchy.
1460	///
1461	/// A central concept with types is that each type always has a canonical
1462	/// type. A canonical type is the type with any typedef names stripped out
1463	/// of it or the types it references. For example, consider:
1464	///
1465	/// typedef int foo;
1466	/// typedef foo* bar;
1467	/// 'int ' 'foo ' 'bar'
1468	///
1469	/// There will be a Type object created for 'int'. Since int is canonical, its
1470	/// CanonicalType pointer points to itself. There is also a Type for 'foo' (a
1471	/// TypedefType). Its CanonicalType pointer points to the 'int' Type. Next
1472	/// there is a PointerType that represents 'int*', which, like 'int', is
1473	/// canonical. Finally, there is a PointerType type for 'foo*' whose canonical
1474	/// type is 'int*', and there is a TypedefType for 'bar', whose canonical type
1475	/// is also 'int*'.
1476	///
1477	/// Non-canonical types are useful for emitting diagnostics, without losing
1478	/// information about typedefs being used. Canonical types are useful for type
1479	/// comparisons (they allow by-pointer equality tests) and useful for reasoning
1480	/// about whether something has a particular form (e.g. is a function type),
1481	/// because they implicitly, recursively, strip all typedefs out of a type.
1482	///
1483	/// Types, once created, are immutable.
1484	///
1485	class alignas(8) Type : public ExtQualsTypeCommonBase {
1486	public:
1487	enum TypeClass {
1488	#define TYPE(Class, Base) Class,
1489	#define LAST_TYPE(Class) TypeLast = Class
1490	#define ABSTRACT_TYPE(Class, Base)
1491	#include "clang/AST/TypeNodes.inc"
1492	};
1493
1494	private:
1495	/// Bitfields required by the Type class.
1496	class TypeBitfields {
1497	friend class Type;
1498	template <class T> friend class TypePropertyCache;
1499
1500	/// TypeClass bitfield - Enum that specifies what subclass this belongs to.
1501	unsigned TC : 8;
1502
1503	/// Store information on the type dependency.
1504	unsigned Dependence : llvm::BitWidth<TypeDependence>;
1505
1506	/// True if the cache (i.e. the bitfields here starting with
1507	/// 'Cache') is valid.
1508	mutable unsigned CacheValid : 1;
1509
1510	/// Linkage of this type.
1511	mutable unsigned CachedLinkage : 3;
1512
1513	/// Whether this type involves and local or unnamed types.
1514	mutable unsigned CachedLocalOrUnnamed : 1;
1515
1516	/// Whether this type comes from an AST file.
1517	mutable unsigned FromAST : 1;
1518
1519	bool isCacheValid() const {
1520	return CacheValid;
1521	}
1522
1523	Linkage getLinkage() const {
1524	assert(isCacheValid() && "getting linkage from invalid cache")((void)0);
1525	return static_cast<Linkage>(CachedLinkage);
1526	}
1527
1528	bool hasLocalOrUnnamedType() const {
1529	assert(isCacheValid() && "getting linkage from invalid cache")((void)0);
1530	return CachedLocalOrUnnamed;
1531	}
1532	};
1533	enum { NumTypeBits = 8 + llvm::BitWidth<TypeDependence> + 6 };
1534
1535	protected:
1536	// These classes allow subclasses to somewhat cleanly pack bitfields
1537	// into Type.
1538
1539	class ArrayTypeBitfields {
1540	friend class ArrayType;
1541
1542	unsigned : NumTypeBits;
1543
1544	/// CVR qualifiers from declarations like
1545	/// 'int X[static restrict 4]'. For function parameters only.
1546	unsigned IndexTypeQuals : 3;
1547
1548	/// Storage class qualifiers from declarations like
1549	/// 'int X[static restrict 4]'. For function parameters only.
1550	/// Actually an ArrayType::ArraySizeModifier.
1551	unsigned SizeModifier : 3;
1552	};
1553
1554	class ConstantArrayTypeBitfields {
1555	friend class ConstantArrayType;
1556
1557	unsigned : NumTypeBits + 3 + 3;
1558
1559	/// Whether we have a stored size expression.
1560	unsigned HasStoredSizeExpr : 1;
1561	};
1562
1563	class BuiltinTypeBitfields {
1564	friend class BuiltinType;
1565
1566	unsigned : NumTypeBits;
1567
1568	/// The kind (BuiltinType::Kind) of builtin type this is.
1569	unsigned Kind : 8;
1570	};
1571
1572	/// FunctionTypeBitfields store various bits belonging to FunctionProtoType.
1573	/// Only common bits are stored here. Additional uncommon bits are stored
1574	/// in a trailing object after FunctionProtoType.
1575	class FunctionTypeBitfields {
1576	friend class FunctionProtoType;
1577	friend class FunctionType;
1578
1579	unsigned : NumTypeBits;
1580
1581	/// Extra information which affects how the function is called, like
1582	/// regparm and the calling convention.
1583	unsigned ExtInfo : 13;
1584
1585	/// The ref-qualifier associated with a \c FunctionProtoType.
1586	///
1587	/// This is a value of type \c RefQualifierKind.
1588	unsigned RefQualifier : 2;
1589
1590	/// Used only by FunctionProtoType, put here to pack with the
1591	/// other bitfields.
1592	/// The qualifiers are part of FunctionProtoType because...
1593	///
1594	/// C++ 8.3.5p4: The return type, the parameter type list and the
1595	/// cv-qualifier-seq, [...], are part of the function type.
1596	unsigned FastTypeQuals : Qualifiers::FastWidth;
1597	/// Whether this function has extended Qualifiers.
1598	unsigned HasExtQuals : 1;
1599
1600	/// The number of parameters this function has, not counting '...'.
1601	/// According to [implimits] 8 bits should be enough here but this is
1602	/// somewhat easy to exceed with metaprogramming and so we would like to
1603	/// keep NumParams as wide as reasonably possible.
1604	unsigned NumParams : 16;
1605
1606	/// The type of exception specification this function has.
1607	unsigned ExceptionSpecType : 4;
1608
1609	/// Whether this function has extended parameter information.
1610	unsigned HasExtParameterInfos : 1;
1611
1612	/// Whether the function is variadic.
1613	unsigned Variadic : 1;
1614
1615	/// Whether this function has a trailing return type.
1616	unsigned HasTrailingReturn : 1;
1617	};
1618
1619	class ObjCObjectTypeBitfields {
1620	friend class ObjCObjectType;
1621
1622	unsigned : NumTypeBits;
1623
1624	/// The number of type arguments stored directly on this object type.
1625	unsigned NumTypeArgs : 7;
1626
1627	/// The number of protocols stored directly on this object type.
1628	unsigned NumProtocols : 6;
1629
1630	/// Whether this is a "kindof" type.
1631	unsigned IsKindOf : 1;
1632	};
1633
1634	class ReferenceTypeBitfields {
1635	friend class ReferenceType;
1636
1637	unsigned : NumTypeBits;
1638
1639	/// True if the type was originally spelled with an lvalue sigil.
1640	/// This is never true of rvalue references but can also be false
1641	/// on lvalue references because of C++0x [dcl.typedef]p9,
1642	/// as follows:
1643	///
1644	/// typedef int &ref; // lvalue, spelled lvalue
1645	/// typedef int &&rvref; // rvalue
1646	/// ref &a; // lvalue, inner ref, spelled lvalue
1647	/// ref &&a; // lvalue, inner ref
1648	/// rvref &a; // lvalue, inner ref, spelled lvalue
1649	/// rvref &&a; // rvalue, inner ref
1650	unsigned SpelledAsLValue : 1;
1651
1652	/// True if the inner type is a reference type. This only happens
1653	/// in non-canonical forms.
1654	unsigned InnerRef : 1;
1655	};
1656
1657	class TypeWithKeywordBitfields {
1658	friend class TypeWithKeyword;
1659
1660	unsigned : NumTypeBits;
1661
1662	/// An ElaboratedTypeKeyword. 8 bits for efficient access.
1663	unsigned Keyword : 8;
1664	};
1665
1666	enum { NumTypeWithKeywordBits = 8 };
1667
1668	class ElaboratedTypeBitfields {
1669	friend class ElaboratedType;
1670
1671	unsigned : NumTypeBits;
1672	unsigned : NumTypeWithKeywordBits;
1673
1674	/// Whether the ElaboratedType has a trailing OwnedTagDecl.
1675	unsigned HasOwnedTagDecl : 1;
1676	};
1677
1678	class VectorTypeBitfields {
1679	friend class VectorType;
1680	friend class DependentVectorType;
1681
1682	unsigned : NumTypeBits;
1683
1684	/// The kind of vector, either a generic vector type or some
1685	/// target-specific vector type such as for AltiVec or Neon.
1686	unsigned VecKind : 3;
1687	/// The number of elements in the vector.
1688	uint32_t NumElements;
1689	};
1690
1691	class AttributedTypeBitfields {
1692	friend class AttributedType;
1693
1694	unsigned : NumTypeBits;
1695
1696	/// An AttributedType::Kind
1697	unsigned AttrKind : 32 - NumTypeBits;
1698	};
1699
1700	class AutoTypeBitfields {
1701	friend class AutoType;
1702
1703	unsigned : NumTypeBits;
1704
1705	/// Was this placeholder type spelled as 'auto', 'decltype(auto)',
1706	/// or '__auto_type'? AutoTypeKeyword value.
1707	unsigned Keyword : 2;
1708
1709	/// The number of template arguments in the type-constraints, which is
1710	/// expected to be able to hold at least 1024 according to [implimits].
1711	/// However as this limit is somewhat easy to hit with template
1712	/// metaprogramming we'd prefer to keep it as large as possible.
1713	/// At the moment it has been left as a non-bitfield since this type
1714	/// safely fits in 64 bits as an unsigned, so there is no reason to
1715	/// introduce the performance impact of a bitfield.
1716	unsigned NumArgs;
1717	};
1718
1719	class SubstTemplateTypeParmPackTypeBitfields {
1720	friend class SubstTemplateTypeParmPackType;
1721
1722	unsigned : NumTypeBits;
1723
1724	/// The number of template arguments in \c Arguments, which is
1725	/// expected to be able to hold at least 1024 according to [implimits].
1726	/// However as this limit is somewhat easy to hit with template
1727	/// metaprogramming we'd prefer to keep it as large as possible.
1728	/// At the moment it has been left as a non-bitfield since this type
1729	/// safely fits in 64 bits as an unsigned, so there is no reason to
1730	/// introduce the performance impact of a bitfield.
1731	unsigned NumArgs;
1732	};
1733
1734	class TemplateSpecializationTypeBitfields {
1735	friend class TemplateSpecializationType;
1736
1737	unsigned : NumTypeBits;
1738
1739	/// Whether this template specialization type is a substituted type alias.
1740	unsigned TypeAlias : 1;
1741
1742	/// The number of template arguments named in this class template
1743	/// specialization, which is expected to be able to hold at least 1024
1744	/// according to [implimits]. However, as this limit is somewhat easy to
1745	/// hit with template metaprogramming we'd prefer to keep it as large
1746	/// as possible. At the moment it has been left as a non-bitfield since
1747	/// this type safely fits in 64 bits as an unsigned, so there is no reason
1748	/// to introduce the performance impact of a bitfield.
1749	unsigned NumArgs;
1750	};
1751
1752	class DependentTemplateSpecializationTypeBitfields {
1753	friend class DependentTemplateSpecializationType;
1754
1755	unsigned : NumTypeBits;
1756	unsigned : NumTypeWithKeywordBits;
1757
1758	/// The number of template arguments named in this class template
1759	/// specialization, which is expected to be able to hold at least 1024
1760	/// according to [implimits]. However, as this limit is somewhat easy to
1761	/// hit with template metaprogramming we'd prefer to keep it as large
1762	/// as possible. At the moment it has been left as a non-bitfield since
1763	/// this type safely fits in 64 bits as an unsigned, so there is no reason
1764	/// to introduce the performance impact of a bitfield.
1765	unsigned NumArgs;
1766	};
1767
1768	class PackExpansionTypeBitfields {
1769	friend class PackExpansionType;
1770
1771	unsigned : NumTypeBits;
1772
1773	/// The number of expansions that this pack expansion will
1774	/// generate when substituted (+1), which is expected to be able to
1775	/// hold at least 1024 according to [implimits]. However, as this limit
1776	/// is somewhat easy to hit with template metaprogramming we'd prefer to
1777	/// keep it as large as possible. At the moment it has been left as a
1778	/// non-bitfield since this type safely fits in 64 bits as an unsigned, so
1779	/// there is no reason to introduce the performance impact of a bitfield.
1780	///
1781	/// This field will only have a non-zero value when some of the parameter
1782	/// packs that occur within the pattern have been substituted but others
1783	/// have not.
1784	unsigned NumExpansions;
1785	};
1786
1787	union {
1788	TypeBitfields TypeBits;
1789	ArrayTypeBitfields ArrayTypeBits;
1790	ConstantArrayTypeBitfields ConstantArrayTypeBits;
1791	AttributedTypeBitfields AttributedTypeBits;
1792	AutoTypeBitfields AutoTypeBits;
1793	BuiltinTypeBitfields BuiltinTypeBits;
1794	FunctionTypeBitfields FunctionTypeBits;
1795	ObjCObjectTypeBitfields ObjCObjectTypeBits;
1796	ReferenceTypeBitfields ReferenceTypeBits;
1797	TypeWithKeywordBitfields TypeWithKeywordBits;
1798	ElaboratedTypeBitfields ElaboratedTypeBits;
1799	VectorTypeBitfields VectorTypeBits;
1800	SubstTemplateTypeParmPackTypeBitfields SubstTemplateTypeParmPackTypeBits;
1801	TemplateSpecializationTypeBitfields TemplateSpecializationTypeBits;
1802	DependentTemplateSpecializationTypeBitfields
1803	DependentTemplateSpecializationTypeBits;
1804	PackExpansionTypeBitfields PackExpansionTypeBits;
1805	};
1806
1807	private:
1808	template <class T> friend class TypePropertyCache;
1809
1810	/// Set whether this type comes from an AST file.
1811	void setFromAST(bool V = true) const {
1812	TypeBits.FromAST = V;
1813	}
1814
1815	protected:
1816	friend class ASTContext;
1817
1818	Type(TypeClass tc, QualType canon, TypeDependence Dependence)
1819	: ExtQualsTypeCommonBase(this,
1820	canon.isNull() ? QualType(this_(), 0) : canon) {
1821	static_assert(sizeof(*this) <= 8 + sizeof(ExtQualsTypeCommonBase),
1822	"changing bitfields changed sizeof(Type)!");
1823	static_assert(alignof(decltype(this)) % sizeof(void ) == 0,
1824	"Insufficient alignment!");
1825	TypeBits.TC = tc;
1826	TypeBits.Dependence = static_cast<unsigned>(Dependence);
1827	TypeBits.CacheValid = false;
1828	TypeBits.CachedLocalOrUnnamed = false;
1829	TypeBits.CachedLinkage = NoLinkage;
1830	TypeBits.FromAST = false;
1831	}
1832
1833	// silence VC++ warning C4355: 'this' : used in base member initializer list
1834	Type *this_() { return this; }
1835
1836	void setDependence(TypeDependence D) {
1837	TypeBits.Dependence = static_cast<unsigned>(D);
1838	}
1839
1840	void addDependence(TypeDependence D) { setDependence(getDependence() \| D); }
1841
1842	public:
1843	friend class ASTReader;
1844	friend class ASTWriter;
1845	template <class T> friend class serialization::AbstractTypeReader;
1846	template <class T> friend class serialization::AbstractTypeWriter;
1847
1848	Type(const Type &) = delete;
1849	Type(Type &&) = delete;
1850	Type &operator=(const Type &) = delete;
1851	Type &operator=(Type &&) = delete;
1852
1853	TypeClass getTypeClass() const { return static_cast<TypeClass>(TypeBits.TC); }
1854
1855	/// Whether this type comes from an AST file.
1856	bool isFromAST() const { return TypeBits.FromAST; }
1857
1858	/// Whether this type is or contains an unexpanded parameter
1859	/// pack, used to support C++0x variadic templates.
1860	///
1861	/// A type that contains a parameter pack shall be expanded by the
1862	/// ellipsis operator at some point. For example, the typedef in the
1863	/// following example contains an unexpanded parameter pack 'T':
1864	///
1865	/// \code
1866	/// template<typename ...T>
1867	/// struct X {
1868	/// typedef T* pointer_types; // ill-formed; T is a parameter pack.
1869	/// };
1870	/// \endcode
1871	///
1872	/// Note that this routine does not specify which
1873	bool containsUnexpandedParameterPack() const {
1874	return getDependence() & TypeDependence::UnexpandedPack;
1875	}
1876
1877	/// Determines if this type would be canonical if it had no further
1878	/// qualification.
1879	bool isCanonicalUnqualified() const {
1880	return CanonicalType == QualType(this, 0);
1881	}
1882
1883	/// Pull a single level of sugar off of this locally-unqualified type.
1884	/// Users should generally prefer SplitQualType::getSingleStepDesugaredType()
1885	/// or QualType::getSingleStepDesugaredType(const ASTContext&).
1886	QualType getLocallyUnqualifiedSingleStepDesugaredType() const;
1887
1888	/// As an extension, we classify types as one of "sized" or "sizeless";
1889	/// every type is one or the other. Standard types are all sized;
1890	/// sizeless types are purely an extension.
1891	///
1892	/// Sizeless types contain data with no specified size, alignment,
1893	/// or layout.
1894	bool isSizelessType() const;
1895	bool isSizelessBuiltinType() const;
1896
1897	/// Determines if this is a sizeless type supported by the
1898	/// 'arm_sve_vector_bits' type attribute, which can be applied to a single
1899	/// SVE vector or predicate, excluding tuple types such as svint32x4_t.
1900	bool isVLSTBuiltinType() const;
1901
1902	/// Returns the representative type for the element of an SVE builtin type.
1903	/// This is used to represent fixed-length SVE vectors created with the
1904	/// 'arm_sve_vector_bits' type attribute as VectorType.
1905	QualType getSveEltType(const ASTContext &Ctx) const;
1906
1907	/// Types are partitioned into 3 broad categories (C99 6.2.5p1):
1908	/// object types, function types, and incomplete types.
1909
1910	/// Return true if this is an incomplete type.
1911	/// A type that can describe objects, but which lacks information needed to
1912	/// determine its size (e.g. void, or a fwd declared struct). Clients of this
1913	/// routine will need to determine if the size is actually required.
1914	///
1915	/// Def If non-null, and the type refers to some kind of declaration
1916	/// that can be completed (such as a C struct, C++ class, or Objective-C
1917	/// class), will be set to the declaration.
1918	bool isIncompleteType(NamedDecl **Def = nullptr) const;
1919
1920	/// Return true if this is an incomplete or object
1921	/// type, in other words, not a function type.
1922	bool isIncompleteOrObjectType() const {
1923	return !isFunctionType();
1924	}
1925
1926	/// Determine whether this type is an object type.
1927	bool isObjectType() const {
1928	// C++ [basic.types]p8:
1929	// An object type is a (possibly cv-qualified) type that is not a
1930	// function type, not a reference type, and not a void type.
1931	return !isReferenceType() && !isFunctionType() && !isVoidType();
1932	}
1933
1934	/// Return true if this is a literal type
1935	/// (C++11 [basic.types]p10)
1936	bool isLiteralType(const ASTContext &Ctx) const;
1937
1938	/// Determine if this type is a structural type, per C++20 [temp.param]p7.
1939	bool isStructuralType() const;
1940
1941	/// Test if this type is a standard-layout type.
1942	/// (C++0x [basic.type]p9)
1943	bool isStandardLayoutType() const;
1944
1945	/// Helper methods to distinguish type categories. All type predicates
1946	/// operate on the canonical type, ignoring typedefs and qualifiers.
1947
1948	/// Returns true if the type is a builtin type.
1949	bool isBuiltinType() const;
1950
1951	/// Test for a particular builtin type.
1952	bool isSpecificBuiltinType(unsigned K) const;
1953
1954	/// Test for a type which does not represent an actual type-system type but
1955	/// is instead used as a placeholder for various convenient purposes within
1956	/// Clang. All such types are BuiltinTypes.
1957	bool isPlaceholderType() const;
1958	const BuiltinType *getAsPlaceholderType() const;
1959
1960	/// Test for a specific placeholder type.
1961	bool isSpecificPlaceholderType(unsigned K) const;
1962
1963	/// Test for a placeholder type other than Overload; see
1964	/// BuiltinType::isNonOverloadPlaceholderType.
1965	bool isNonOverloadPlaceholderType() const;
1966
1967	/// isIntegerType() does not include complex integers (a GCC extension).
1968	/// isComplexIntegerType() can be used to test for complex integers.
1969	bool isIntegerType() const; // C99 6.2.5p17 (int, char, bool, enum)
1970	bool isEnumeralType() const;
1971
1972	/// Determine whether this type is a scoped enumeration type.
1973	bool isScopedEnumeralType() const;
1974	bool isBooleanType() const;
1975	bool isCharType() const;
1976	bool isWideCharType() const;
1977	bool isChar8Type() const;
1978	bool isChar16Type() const;
1979	bool isChar32Type() const;
1980	bool isAnyCharacterType() const;
1981	bool isIntegralType(const ASTContext &Ctx) const;
1982
1983	/// Determine whether this type is an integral or enumeration type.
1984	bool isIntegralOrEnumerationType() const;
1985
1986	/// Determine whether this type is an integral or unscoped enumeration type.
1987	bool isIntegralOrUnscopedEnumerationType() const;
1988	bool isUnscopedEnumerationType() const;
1989
1990	/// Floating point categories.
1991	bool isRealFloatingType() const; // C99 6.2.5p10 (float, double, long double)
1992	/// isComplexType() does not include complex integers (a GCC extension).
1993	/// isComplexIntegerType() can be used to test for complex integers.
1994	bool isComplexType() const; // C99 6.2.5p11 (complex)
1995	bool isAnyComplexType() const; // C99 6.2.5p11 (complex) + Complex Int.
1996	bool isFloatingType() const; // C99 6.2.5p11 (real floating + complex)
1997	bool isHalfType() const; // OpenCL 6.1.1.1, NEON (IEEE 754-2008 half)
1998	bool isFloat16Type() const; // C11 extension ISO/IEC TS 18661
1999	bool isBFloat16Type() const;
2000	bool isFloat128Type() const;
2001	bool isRealType() const; // C99 6.2.5p17 (real floating + integer)
2002	bool isArithmeticType() const; // C99 6.2.5p18 (integer + floating)
2003	bool isVoidType() const; // C99 6.2.5p19
2004	bool isScalarType() const;