SIL: Introduce sil_property declarations for property descriptors.

This provides SILGen a place to generate the key path component information for an exported property so that it can be linked to from other modules.

Author: jckarter

include/swift/AST/DiagnosticsParse.def

@@ -528,6 +528,8 @@ ERROR(expected_sil_instr_opcode,none,
       "expected SIL instruction opcode", ())
 ERROR(expected_tok_in_sil_instr,none,
       "expected '%0' in SIL instruction", (StringRef))
+ERROR(sil_property_generic_signature_mismatch,none,
+      "sil_property generic signature must match original declaration", ())
 ERROR(sil_string_no_encoding,none,
       "string_literal instruction requires an encoding", ())
 ERROR(sil_string_invalid_encoding,none,

include/swift/AST/GenericSignature.h

@@ -17,6 +17,7 @@
 #ifndef SWIFT_AST_GENERIC_SIGNATURE_H
 #define SWIFT_AST_GENERIC_SIGNATURE_H
 
+#include "swift/AST/PrintOptions.h"
 #include "swift/AST/Requirement.h"
 #include "swift/AST/SubstitutionList.h"
 #include "swift/AST/Types.h"
@@ -338,7 +339,7 @@ class alignas(1 << TypeAlignInBits) GenericSignature final
                       TypeArrayView<GenericTypeParamType> genericParams,
                       ArrayRef<Requirement> requirements);
 
-  void print(raw_ostream &OS) const;
+  void print(raw_ostream &OS, PrintOptions Options = PrintOptions()) const;
   void dump() const;
   std::string getAsString() const;
 };

include/swift/AST/PrintOptions.h

@@ -18,6 +18,7 @@
 #include "swift/AST/Identifier.h"
 #include "swift/AST/TypeOrExtensionDecl.h"
 #include "llvm/ADT/Optional.h"
+#include "llvm/ADT/DenseMap.h"
 #include <limits.h>
 #include <vector>
 

include/swift/Parse/ParseSILSupport.h

@@ -33,6 +33,7 @@ namespace swift {
     virtual bool parseSILWitnessTable(Parser &P) = 0;
     virtual bool parseSILDefaultWitnessTable(Parser &P) = 0;
     virtual bool parseSILCoverageMap(Parser &P) = 0;
+    virtual bool parseSILProperty(Parser &P) = 0;
     virtual bool parseSILScope(Parser &P) = 0;
   };
 

include/swift/SIL/SILModule.h

@@ -32,6 +32,7 @@
 #include "swift/SIL/SILFunction.h"
 #include "swift/SIL/SILGlobalVariable.h"
 #include "swift/SIL/SILPrintContext.h"
+#include "swift/SIL/SILProperty.h"
 #include "swift/SIL/SILType.h"
 #include "swift/SIL/SILVTable.h"
 #include "swift/SIL/SILWitnessTable.h"
@@ -103,6 +104,7 @@ class SILModule {
   using FunctionListType = llvm::ilist<SILFunction>;
   using GlobalListType = llvm::ilist<SILGlobalVariable>;
   using VTableListType = llvm::ilist<SILVTable>;
+  using PropertyListType = llvm::ilist<SILProperty>;
   using WitnessTableListType = llvm::ilist<SILWitnessTable>;
   using DefaultWitnessTableListType = llvm::ilist<SILDefaultWitnessTable>;
   using CoverageMapListType = llvm::ilist<SILCoverageMap>;
@@ -119,6 +121,7 @@ class SILModule {
   friend SILLayout;
   friend SILType;
   friend SILVTable;
+  friend SILProperty;
   friend SILUndef;
   friend SILWitnessTable;
   friend Lowering::SILGenModule;
@@ -184,6 +187,9 @@ class SILModule {
 
   // The list of SILCoverageMaps in the module.
   CoverageMapListType coverageMaps;
+  
+  // The list of SILProperties in the module.
+  PropertyListType properties;
 
   /// This is the underlying raw stream of OptRecordStream.
   ///
@@ -458,10 +464,13 @@ class SILModule {
   void setOptRecordStream(std::unique_ptr<llvm::yaml::Output> &&Stream,
                           std::unique_ptr<llvm::raw_ostream> &&RawStream);
 
+  PropertyListType &getPropertyList() { return properties; }
+  const PropertyListType &getPropertyList() const { return properties; }
+  
   /// Look for a global variable by name.
   ///
   /// \return null if this module has no such global variable
- SILGlobalVariable *lookUpGlobalVariable(StringRef name) const {
+  SILGlobalVariable *lookUpGlobalVariable(StringRef name) const {
     return GlobalVariableMap.lookup(name);
   }
 

include/swift/SIL/SILProperty.h

@@ -0,0 +1,90 @@
+//===--- SILProperty.h - Defines the SILProperty class ----------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines the SILProperty class, which is used to capture the
+// metadata about a property definition necessary for it to be resiliently
+// included in KeyPaths across modules.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_SIL_SILPROPERTY_H
+#define SWIFT_SIL_SILPROPERTY_H
+
+#include "swift/AST/GenericSignature.h"
+#include "swift/SIL/SILAllocated.h"
+#include "swift/SIL/SILInstruction.h"
+#include "llvm/ADT/ilist_node.h"
+#include "llvm/ADT/ilist.h"
+
+namespace swift {
+
+class SILPrintContext;
+  
+/// A descriptor for a public property or subscript that can be resiliently
+/// referenced from key paths in external modules.
+class SILProperty : public llvm::ilist_node<SILProperty>,
+                    public SILAllocated<SILProperty>
+{
+private:
+  /// True if serialized.
+  bool Serialized;
+  
+  /// The declaration the descriptor represents.
+  AbstractStorageDecl *Decl;
+  
+  /// The key path component that represents its implementation.
+  KeyPathPatternComponent Component;
+
+  SILProperty(bool Serialized,
+              AbstractStorageDecl *Decl,
+              KeyPathPatternComponent Component)
+    : Serialized(Serialized), Decl(Decl), Component(Component)
+  {}
+
+public:
+  static SILProperty *create(SILModule &M,
+                             bool Serialized,
+                             AbstractStorageDecl *Decl,
+                             KeyPathPatternComponent Component);
+  
+  bool isSerialized() const { return Serialized; }
+  
+  AbstractStorageDecl *getDecl() const { return Decl; }
+  
+  const KeyPathPatternComponent &getComponent() const { return Component; }
+  
+  void print(SILPrintContext &Ctx) const;
+};
+  
+} // end namespace swift
+
+namespace llvm {
+
+//===----------------------------------------------------------------------===//
+// ilist_traits for SILProperty
+//===----------------------------------------------------------------------===//
+
+template <>
+struct ilist_traits<::swift::SILProperty>
+    : public ilist_default_traits<::swift::SILProperty> {
+  typedef ::swift::SILProperty SILProperty;
+
+public:
+  static void deleteNode(SILProperty *VT) { VT->~SILProperty(); }
+
+private:
+  void createNode(const SILProperty &);
+};
+
+} // namespace llvm
+
+#endif

include/swift/Serialization/ModuleFormat.h

@@ -55,7 +55,7 @@ const uint16_t VERSION_MAJOR = 0;
 /// describe what change you made. The content of this comment isn't important;
 /// it just ensures a conflict if two people change the module format.
 /// Don't worry about adhering to the 80-column limit for this line.
-const uint16_t VERSION_MINOR = 399; // Last change: @_weakLinked
+const uint16_t VERSION_MINOR = 400; // Last change: sil_property
 
 using DeclIDField = BCFixed<31>;
 

include/swift/Serialization/SerializedSILLoader.h

@@ -132,6 +132,9 @@ class SerializedSILLoader {
   /// Deserialize all DefaultWitnessTables in all SILModules.
   void getAllDefaultWitnessTables();
 
+  /// Deserialize all Properties in all SILModules.
+  void getAllProperties();
+
   SerializedSILLoader(const SerializedSILLoader &) = delete;
   SerializedSILLoader(SerializedSILLoader &&) = delete;
   SerializedSILLoader &operator=(const SerializedSILLoader &) = delete;

include/swift/Syntax/TokenKinds.def

@@ -172,6 +172,7 @@ DECL_KEYWORD(static)
 SIL_KEYWORD(undef)
 SIL_KEYWORD(sil)
 SIL_KEYWORD(sil_stage)
+SIL_KEYWORD(sil_property)
 SIL_KEYWORD(sil_vtable)
 SIL_KEYWORD(sil_global)
 SIL_KEYWORD(sil_witness_table)

lib/AST/ASTPrinter.cpp

@@ -3961,9 +3961,9 @@ void LayoutConstraintInfo::print(ASTPrinter &Printer,
   }
 }
 
-void GenericSignature::print(raw_ostream &OS) const {
+void GenericSignature::print(raw_ostream &OS, PrintOptions Opts) const {
   StreamPrinter Printer(OS);
-  PrintAST(Printer, PrintOptions())
+  PrintAST(Printer, Opts)
       .printGenericSignature(this,
                              PrintAST::PrintParams |
                              PrintAST::PrintRequirements);