//===--- ClassMetadataLayout.h - CRTP for class metadata --------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// A CRTP helper class for class metadata.
//
//===----------------------------------------------------------------------===//

#ifndef SWIFT_IRGEN_CLASSMETADATALAYOUT_H
#define SWIFT_IRGEN_CLASSMETADATALAYOUT_H

#include "FunctionRef.h"
#include "IRGen.h"
#include "MetadataLayout.h"

namespace swift {
namespace irgen {

class IRGenModule;

/// The number of fields in a FullHeapMetadata object.
const unsigned NumHeapMetadataFields = 3;

/// Does the given class method require a different dispatch-table
/// entry from from all of the methods it overrides?  The restrictions
/// on overriding generally prevent this, but it can happen when a
/// class overrides a method from a generic class.
bool doesMethodRequireOverrideEntry(IRGenModule &IGM, FuncDecl *fn,
                                    ResilienceExpansion explosionLevel,
                                    unsigned uncurryLevel);

/// A CRTP class for laying out class metadata.  Note that this does
/// *not* handle the metadata template stuff.
template <class Impl> class ClassMetadataLayout : public MetadataLayout<Impl> {
  typedef MetadataLayout<Impl> super;

protected:
  using super::IGM;
  using super::asImpl;

  /// The most-derived class.
  ClassDecl *const TargetClass;

  /// Is the object layout globally resilient at this point?
  bool IsObjectResilient = false;

  /// Is the object layout generically dependent at this point?
  /// Implies IsObjectResilient.
  bool IsObjectGenericallyArranged = false;

  /// Is the metadata layout globally resilient at this point?
  bool IsMetadataResilient = false;

  ClassMetadataLayout(IRGenModule &IGM, ClassDecl *target)
    : super(IGM), TargetClass(target) {}

public:
  void layout() {
    // HeapMetadata header.
    asImpl().addDestructorFunction();

    // Metadata header.
    super::layout();

    // ClassMetadata header.  In ObjCInterop mode, this must be
    // layout-compatible with an Objective-C class.  The superclass
    // pointer is useful regardless of mode, but the rest of the data
    // isn't necessary.
    asImpl().addSuperClass();
    if (IGM.ObjCInterop) {
      asImpl().addClassCacheData();
      asImpl().addClassDataPointer();
    }

    asImpl().addNominalTypeDescriptor();
    asImpl().addInstanceSize();
    asImpl().addInstanceAlignMask();
    
    // Class members.
    addClassMembers(TargetClass);
  }

private:
  /// Add fields associated with the given class and its bases.
  void addClassMembers(ClassDecl *theClass) {
    // Add any fields associated with the superclass.
    // NB: We don't apply superclass substitutions to members because we want
    // consistent metadata layout between generic superclasses and concrete
    // subclasses.
    if (Type superclass = theClass->getSuperclass()) {
      addClassMembers(superclass->getClassOrBoundGenericClass());
    }

    // Add a reference to the parent class, if applicable.
    if (theClass->getDeclContext()->isTypeContext()) {
      asImpl().addParentMetadataRef(theClass);
    }

    // Add space for the generic parameters, if applicable.
    // Note that we only add references for the immediate parameters;
    // parameters for the parent context are handled by the parent.
    if (auto generics = theClass->getGenericParams()) {
      addGenericClassFields(theClass, *generics);
    }

    // If there exists a potential context from which the class is
    // resilient, subsequent fields will require indirect offsets.
    if (IGM.isResilient(theClass, ResilienceScope::Universal)) {
      IsObjectResilient = true;
      IsMetadataResilient = true;
      if (theClass->getGenericParamsOfContext())
        IsObjectGenericallyArranged = true;
    }
    
    // Add entries for the methods.
    for (auto member : theClass->getMembers()) {
      // Add entries for methods.
      if (auto fn = dyn_cast<FuncDecl>(member))
        addMethodEntries(fn);
    }
    
    // Add offset fields if *any* of the fields are generically
    // arranged.  Essentially, we don't want the metadata layout to
    // depend on order of allocation.  In theory, if we only have one
    // generically-sized field, that field itself doesn't need an
    // offset --- but that's really tricky to guarantee.
    for (auto member : theClass->getMembers()) {
      if (auto field = dyn_cast<VarDecl>(member))
        if (field->hasStorage())
          updateForFieldSize(field);
    }

    // Add fields.
    if (IsObjectGenericallyArranged) {
      asImpl().noteStartOfFieldOffsets(theClass);
      for (auto member : theClass->getMembers()) {
        if (auto field = dyn_cast<VarDecl>(member))
          if (field->hasStorage())
            addFieldEntries(field);
      }
      asImpl().noteEndOfFieldOffsets(theClass);
    }
  }
  
  /// Notes the beginning of the field offset vector for a particular ancestor
  /// of a generic-layout class.
  void noteStartOfFieldOffsets(ClassDecl *whichClass) {}

  /// Notes the end of the field offset vector for a particular ancestor
  /// of a generic-layout class.
  void noteEndOfFieldOffsets(ClassDecl *whichClass) {}

private:
  /// Add fields related to the generics of this class declaration.
  /// TODO: don't add new fields that are implied by the superclass.
  /// fields.  e.g., if B<T> extends A<T>, the witness for T in A's
  /// section should be enough.
  void addGenericClassFields(ClassDecl *theClass,
                             const GenericParamList &generics) {
    asImpl().addGenericFields(generics, theClass);
  }

  void addFieldEntries(VarDecl *field) {
    if (IsObjectGenericallyArranged)
      asImpl().addFieldOffset(field);
  }

  void updateForFieldSize(VarDecl *field) {
    assert(field->hasStorage());

    // Update the class layout based on abstract, globally-known
    // characteristics of the type.
    SILType fieldType = IGM.getLoweredType(AbstractionPattern(field->getType()),
                                           field->getType());
    switch (IGM.classifyTypeSize(fieldType, ResilienceScope::Universal)) {
    case ObjectSize::Fixed:
      return;
    case ObjectSize::Resilient:
      IsObjectResilient = true;
      return;
    case ObjectSize::Dependent:
      IsObjectResilient = true;
      IsObjectGenericallyArranged = true;
      return;
    }
    llvm_unreachable("invalid type size classification");
  }

  void addMethodEntries(FuncDecl *fn) {
    // If the method does not have a vtable entry, don't add any.
    if (!hasKnownVTableEntry(IGM, fn))
      return;
    
    // TODO: consider emitting at different explosion levels and
    // uncurryings.
    auto explosionLevel = ResilienceExpansion::Minimal;
    unsigned uncurryLevel = 1; // whether static or not
    
    maybeAddMethod(fn, explosionLevel, uncurryLevel);
  }

  void maybeAddMethod(FuncDecl *fn, ResilienceExpansion explosionLevel,
                      unsigned uncurryLevel) {
    // Ignore getters and setters.  This is probably wrong!
    if (fn->isAccessor())
      return;

    // If the method overrides something, we don't need a new entry.
    if (fn->getOverriddenDecl()) {
      // Except we do if it differs by abstraction from all the
      // methods it overrides.
      if (!doesMethodRequireOverrideEntry(IGM, fn, explosionLevel,
                                          uncurryLevel))
        return;
    }

    // Both static and non-static functions go in the metadata.
    asImpl().addMethod(FunctionRef(fn, explosionLevel, uncurryLevel));
  }
};

/// An "implementation" of ClassMetadataLayout that just scans through
/// the metadata layout, maintaining the next index: the offset (in
/// pointer-sized chunks) into the metadata for the next field.
template <class Impl>
class ClassMetadataScanner : public ClassMetadataLayout<Impl> {
  typedef ClassMetadataLayout<Impl> super;
protected:
  unsigned NextIndex = 0;

  ClassMetadataScanner(IRGenModule &IGM, ClassDecl *target)
    : super(IGM, target) {}

public:
  void addMetadataFlags() { NextIndex++; }
  void addNominalTypeDescriptor() { NextIndex++; }
  void addValueWitnessTable() { NextIndex++; }
  void addDestructorFunction() { NextIndex++; }
  void addParentMetadataRef(ClassDecl *forClass) { NextIndex++; }
  void addSuperClass() { NextIndex++; }
  void addInstanceSize() { NextIndex++; }
  void addInstanceAlignMask() { NextIndex++; }
  void addClassCacheData() { NextIndex += 2; }
  void addClassDataPointer() { NextIndex++; }
  void addMethod(FunctionRef fn) { NextIndex++; }
  void addFieldOffset(VarDecl *var) { NextIndex++; }
  void addGenericArgument(ArchetypeType *argument, ClassDecl *forClass) {
    NextIndex++;
  }
  void addGenericWitnessTable(ArchetypeType *argument,
                              ProtocolDecl *protocol,
                              ClassDecl *forClass) {
    NextIndex++;
  }
};

} // end namespace irgen
} // end namespace swift

#endif