Adding GetComWrappersRCWData cDAC API (#118428)

* adding GetComWrappersRCWData cDAC API

* allow duplicate contract and global names

Author: rcj1

docs/design/datacontracts/ComWrappers.md

@@ -0,0 +1,33 @@
+# Contract ComWrappers
+
+This contract is for getting information related to COM wrappers.
+
+## APIs of contract
+
+``` csharp
+// Get the address of the external COM object
+TargetPointer GetComWrappersIdentity(TargetPointer rcw);
+```
+
+## Version 1
+
+Data descriptors used:
+| Data Descriptor Name | Field | Meaning |
+| --- | --- | --- |
+| `NativeObjectWrapperObject` | `ExternalComObject` | Address of the external COM object |
+
+Global variables used:
+| Global Name | Type | Purpose |
+| --- | --- | --- |
+
+Contracts used:
+| Contract Name |
+| --- |
+
+
+``` csharp
+public TargetPointer GetComWrappersIdentity(TargetPointer address)
+{
+    return _target.ReadPointer(address + /* NativeObjectWrapperObject::ExternalComObject offset */);
+}
+```

src/coreclr/clrdatadescriptors.cmake

@@ -2,7 +2,7 @@
 
 function(generate_data_descriptors)
   set(options EXPORT_VISIBLE)
-  set(oneValueArgs LIBRARY_NAME CONTRACT_FILE CONTRACT_NAME INTERFACE_TARGET)
+  set(oneValueArgs LIBRARY_NAME CONTRACT_NAME INTERFACE_TARGET)
   set(multiValueArgs "")
   cmake_parse_arguments(DATA_DESCRIPTORS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGV})
 
@@ -53,15 +53,14 @@ function(generate_data_descriptors)
     set(CONTRACT_BASELINE_DIR "${CLR_REPO_ROOT_DIR}/docs/design/datacontracts/data")
     set(CONTRACT_DESCRIPTOR_INPUT "${DATA_DESCRIPTOR_SHARED_SOURCE_DIR}/contract-descriptor.c.in")
     set(CONTRACT_DESCRIPTOR_OUTPUT "${GENERATED_CDAC_DESCRIPTOR_DIR}/contract-descriptor.c")
-    set(CONTRACT_FILE "${DATA_DESCRIPTORS_CONTRACT_FILE}")
 
     # generate the contract descriptor by running cdac-build-tool
     # n.b. this just uses `dotnet` from the PATH.  InitializeDotNetCli adds the appropriate directory
     add_custom_command(
       OUTPUT "${CONTRACT_DESCRIPTOR_OUTPUT}"
       VERBATIM
-      COMMAND ${CLR_DOTNET_HOST_PATH} ${CDAC_BUILD_TOOL_BINARY_PATH} compose -i "${CONTRACT_DESCRIPTOR_INPUT}" -o "${CONTRACT_DESCRIPTOR_OUTPUT}" -b "${CONTRACT_BASELINE_DIR}" -c "${CONTRACT_FILE}" $<TARGET_OBJECTS:${INTERMEDIARY_LIBRARY}>
-      DEPENDS ${INTERMEDIARY_LIBRARY} ${DATA_DESCRIPTORS_DEPENDENCIES} $<TARGET_OBJECTS:${INTERMEDIARY_LIBRARY}> "${CONTRACT_FILE}" "${CONTRACT_DESCRIPTOR_INPUT}"
+      COMMAND ${CLR_DOTNET_HOST_PATH} ${CDAC_BUILD_TOOL_BINARY_PATH} compose -i "${CONTRACT_DESCRIPTOR_INPUT}" -o "${CONTRACT_DESCRIPTOR_OUTPUT}" -b "${CONTRACT_BASELINE_DIR}" $<TARGET_OBJECTS:${INTERMEDIARY_LIBRARY}>
+      DEPENDS ${INTERMEDIARY_LIBRARY} ${DATA_DESCRIPTORS_DEPENDENCIES} $<TARGET_OBJECTS:${INTERMEDIARY_LIBRARY}> "${CONTRACT_DESCRIPTOR_INPUT}"
       USES_TERMINAL
     )
 

src/coreclr/debug/datadescriptor-shared/datadescriptor.cpp

@@ -49,13 +49,20 @@ struct GlobalStringSpec
     uint32_t StringValue;
 };
 
+struct GlobalContractSpec
+{
+    uint32_t Name;
+    uint32_t Version;
+};
+
 #define CONCAT(token1,token2) token1 ## token2
 #define CONCAT4(token1, token2, token3, token4) token1 ## token2 ## token3 ## token4
 
 #define MAKE_TYPELEN_NAME(tyname) CONCAT(cdac_string_pool_typename__, tyname)
 #define MAKE_FIELDLEN_NAME(tyname,membername) CONCAT4(cdac_string_pool_membername__, tyname, __, membername)
 #define MAKE_FIELDTYPELEN_NAME(tyname,membername) CONCAT4(cdac_string_pool_membertypename__, tyname, __, membername)
 #define MAKE_GLOBALLEN_NAME(globalname) CONCAT(cdac_string_pool_globalname__, globalname)
+#define MAKE_GLOBALCONTRACTLEN_NAME(globalname) CONCAT(cdac_string_pool_globalcontractname__, globalname)
 #define MAKE_GLOBALTYPELEN_NAME(globalname) CONCAT(cdac_string_pool_globaltypename__, globalname)
 #define MAKE_GLOBALVALUELEN_NAME(globalname) CONCAT(cdac_string_pool_globalvalue__, globalname)
 
@@ -78,6 +85,7 @@ struct CDacStringPoolSizes
     DECL_LEN(MAKE_GLOBALVALUELEN_NAME(name), sizeof(STRINGIFY(stringval)))
 #define CDAC_GLOBAL_POINTER(name,value) DECL_LEN(MAKE_GLOBALLEN_NAME(name), sizeof(#name))
 #define CDAC_GLOBAL_SUB_DESCRIPTOR(name,value) DECL_LEN(MAKE_GLOBALLEN_NAME(name), sizeof(#name))
+#define CDAC_GLOBAL_CONTRACT(name,value) DECL_LEN(MAKE_GLOBALCONTRACTLEN_NAME(name), sizeof(#name))
 #define CDAC_GLOBAL(name,tyname,value) DECL_LEN(MAKE_GLOBALLEN_NAME(name), sizeof(#name)) \
     DECL_LEN(MAKE_GLOBALTYPELEN_NAME(name), sizeof(#tyname))
 #include "wrappeddatadescriptor.inc"
@@ -90,6 +98,7 @@ struct CDacStringPoolSizes
 #define GET_FIELDTYPE_NAME(tyname,membername) offsetof(struct CDacStringPoolSizes, MAKE_FIELDTYPELEN_NAME(tyname,membername))
 #define GET_GLOBAL_NAME(globalname) offsetof(struct CDacStringPoolSizes, MAKE_GLOBALLEN_NAME(globalname))
 #define GET_GLOBALTYPE_NAME(globalname) offsetof(struct CDacStringPoolSizes, MAKE_GLOBALTYPELEN_NAME(globalname))
+#define GET_GLOBALCONTRACT_NAME(globalname) offsetof(struct CDacStringPoolSizes, MAKE_GLOBALCONTRACTLEN_NAME(globalname))
 #define GET_GLOBALSTRING_VALUE(globalname) offsetof(struct CDacStringPoolSizes, MAKE_GLOBALVALUELEN_NAME(globalname))
 
 // count the types
@@ -148,6 +157,15 @@ enum
 #include "wrappeddatadescriptor.inc"
 };
 
+// count the contracts
+enum
+{
+    CDacBlobGlobalContractsCount =
+#define CDAC_GLOBALS_BEGIN() 0
+#define CDAC_GLOBAL_CONTRACT(name,value) + 1
+#include "wrappeddatadescriptor.inc"
+};
+
 
 #define MAKE_TYPEFIELDS_TYNAME(tyname) CONCAT(CDacFieldsPoolTypeStart__, tyname)
 
@@ -226,6 +244,7 @@ struct BinaryBlobDataDescriptor
         uint32_t GlobalStringValuesStart;
 
         uint32_t GlobalSubDescriptorsStart;
+        uint32_t GlobalContractsStart;
         uint32_t NamesPoolStart;
 
         uint32_t TypeCount;
@@ -235,6 +254,7 @@ struct BinaryBlobDataDescriptor
         uint32_t GlobalPointerValuesCount;
         uint32_t GlobalStringValuesCount;
         uint32_t GlobalSubDescriptorsCount;
+        uint32_t GlobalContractsCount;
 
         uint32_t NamesPoolCount;
 
@@ -253,6 +273,7 @@ struct BinaryBlobDataDescriptor
     struct GlobalPointerSpec GlobalPointerValues[CDacBlobGlobalPointersCount + 1];
     struct GlobalStringSpec GlobalStringValues[CDacBlobGlobalStringsCount + 1];
     struct GlobalPointerSpec GlobalSubDescriptorValues[CDacBlobGlobalSubDescriptorsCount + 1];
+    struct GlobalContractSpec GlobalContractValues[CDacBlobGlobalContractsCount + 1];
     uint8_t NamesPool[sizeof(struct CDacStringPoolSizes)];
     uint8_t EndMagic[4];
 };
@@ -279,13 +300,15 @@ struct MagicAndBlob BlobDataDescriptor = {
             /* .GlobalPointersStart = */ offsetof(struct BinaryBlobDataDescriptor, GlobalPointerValues),
             /* .GlobalStringValuesStart = */ offsetof(struct BinaryBlobDataDescriptor, GlobalStringValues),
             /* .GlobalSubDescriptorsStart = */ offsetof(struct BinaryBlobDataDescriptor, GlobalSubDescriptorValues),
+            /* .GlobalContractsStart = */ offsetof(struct BinaryBlobDataDescriptor, GlobalContractValues),
             /* .NamesPoolStart = */ offsetof(struct BinaryBlobDataDescriptor, NamesPool),
             /* .TypeCount = */ CDacBlobTypesCount,
             /* .FieldsPoolCount = */ CDacBlobFieldsPoolCount,
             /* .GlobalLiteralValuesCount = */ CDacBlobGlobalLiteralsCount,
             /* .GlobalPointerValuesCount = */ CDacBlobGlobalPointersCount,
             /* .GlobalStringValuesCount = */ CDacBlobGlobalStringsCount,
             /* .GlobalSubDescriptorsCount = */ CDacBlobGlobalSubDescriptorsCount,
+            /* .GlobalContractsCount = */ CDacBlobGlobalContractsCount,
             /* .NamesPoolCount = */ sizeof(struct CDacStringPoolSizes),
             /* .TypeSpecSize = */ sizeof(struct TypeSpec),
             /* .FieldSpecSize = */ sizeof(struct FieldSpec),
@@ -337,13 +360,19 @@ struct MagicAndBlob BlobDataDescriptor = {
 #include "wrappeddatadescriptor.inc"
         },
 
+        /* .GlobalContractValues = */ {
+#define CDAC_GLOBAL_CONTRACT(name,value) { /* .Name = */ GET_GLOBALCONTRACT_NAME(name), /* .Version = */ value },
+#include "wrappeddatadescriptor.inc"
+        },
+
         /* .NamesPool = */ ("\0" // starts with a nul
 #define CDAC_BASELINE(name) name "\0"
 #define CDAC_TYPE_BEGIN(name) #name "\0"
 #define CDAC_TYPE_FIELD(tyname,membertyname,membername,offset) #membername "\0" #membertyname "\0"
 #define CDAC_GLOBAL_STRING(name,value) #name "\0" STRINGIFY(value) "\0"
 #define CDAC_GLOBAL_POINTER(name,value) #name "\0"
 #define CDAC_GLOBAL_SUB_DESCRIPTOR(name,value) #name "\0"
+#define CDAC_GLOBAL_CONTRACT(name,value) #name "\0"
 #define CDAC_GLOBAL(name,tyname,value) #name "\0" #tyname "\0"
 #include "wrappeddatadescriptor.inc"
                   ),

src/coreclr/debug/datadescriptor-shared/wrappeddatadescriptor.inc

@@ -43,6 +43,9 @@
 #ifndef CDAC_GLOBAL_SUB_DESCRIPTOR
 #define CDAC_GLOBAL_SUB_DESCRIPTOR(globalname,addr)
 #endif
+#ifndef CDAC_GLOBAL_CONTRACT
+#define CDAC_GLOBAL_CONTRACT(name,value)
+#endif
 #ifndef CDAC_GLOBALS_END
 #define CDAC_GLOBALS_END()
 #endif
@@ -62,4 +65,5 @@
 #undef CDAC_GLOBAL_POINTER
 #undef CDAC_GLOBAL_STRING
 #undef CDAC_GLOBAL_SUB_DESCRIPTOR
+#undef CDAC_GLOBAL_CONTRACT
 #undef CDAC_GLOBALS_END

src/coreclr/gc/datadescriptor/CMakeLists.txt

@@ -13,7 +13,6 @@ add_dependencies(gc_dll_wks_descriptor_interface eventing_headers)
 generate_data_descriptors(
     LIBRARY_NAME gc_dll_wks_descriptor
     CONTRACT_NAME "GCContractDescriptorWKS"
-    CONTRACT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/contracts.jsonc"
     INTERFACE_TARGET gc_dll_wks_descriptor_interface)
 
 if (FEATURE_SVR_GC)
@@ -25,7 +24,6 @@ if (FEATURE_SVR_GC)
   generate_data_descriptors(
       LIBRARY_NAME gc_dll_svr_descriptor
       CONTRACT_NAME "GCContractDescriptorSVR"
-      CONTRACT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/contracts.jsonc"
       INTERFACE_TARGET gc_dll_svr_descriptor_interface)
 endif()
 
@@ -38,7 +36,6 @@ if(BUILD_EXP_GC)
   generate_data_descriptors(
       LIBRARY_NAME gcexp_dll_wks_descriptor
       CONTRACT_NAME "GCContractDescriptorWKS"
-      CONTRACT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/contracts.jsonc"
       INTERFACE_TARGET gcexp_dll_wks_descriptor_interface)
 
   if (FEATURE_SVR_GC)
@@ -51,7 +48,6 @@ if(BUILD_EXP_GC)
     generate_data_descriptors(
         LIBRARY_NAME gcexp_dll_svr_descriptor
         CONTRACT_NAME "GCContractDescriptorSVR"
-        CONTRACT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/contracts.jsonc"
         INTERFACE_TARGET gcexp_dll_svr_descriptor_interface)
   endif()
 endif()

src/coreclr/gc/datadescriptor/contracts.jsonc

@@ -100,4 +100,6 @@ CDAC_GLOBAL_POINTER(Heaps, cdac_data<GC_NAMESPACE::gc_heap>::Heaps)
 CDAC_GLOBAL_POINTER(CurrentGCState, cdac_data<GC_NAMESPACE::gc_heap>::CurrentGCState)
 #endif // BACKGROUND_GC
 
+CDAC_GLOBAL_CONTRACT(GC, 1)
+
 CDAC_GLOBALS_END()

src/coreclr/gc/datadescriptor/datadescriptor.inc

@@ -12,7 +12,6 @@ internal sealed class ComposeCommand : Command
 {
     private readonly Argument<string[]> inputFiles = new("INPUT [INPUTS...]") { Arity = ArgumentArity.OneOrMore, Description = "One or more input files" };
     private readonly Option<string> outputFile = new("-o") { Arity = ArgumentArity.ExactlyOne, HelpName = "OUTPUT", Required = true, Description = "Output file" };
-    private readonly Option<string[]> contractFile = new("-c") { Arity = ArgumentArity.ZeroOrMore, HelpName = "CONTRACT", Description = "Contract file (may be specified multiple times)" };
     private readonly Option<string> baselinePath = new("-b", "--baseline") { Arity = ArgumentArity.ExactlyOne, HelpName = "BASELINEPATH", Description = "Directory containing the baseline contracts"};
     private readonly Option<string> templateFile = new("-i", "--input-template") { Arity = ArgumentArity.ExactlyOne, HelpName = "TEMPLATE", Description = "Contract descriptor template to be filled in" };
     private readonly Option<bool> _verboseOption;
@@ -21,7 +20,6 @@ public ComposeCommand(Option<bool> verboseOption) : base("compose")
         _verboseOption = verboseOption;
         Add(inputFiles);
         Add(outputFile);
-        Add(contractFile);
         Add(baselinePath);
         Add(templateFile);
         SetAction(Run);
@@ -65,7 +63,6 @@ private async Task<int> Run(ParseResult parse, CancellationToken token = default
             Console.Error.WriteLine($"Template file {templateFilePath} does not exist");
             return 1;
         }
-        var contracts = parse.GetValue(contractFile);
         var verbose = parse.GetValue(_verboseOption);
         var builder = new DataDescriptorModel.Builder(baselinesDir);
         var scraper = new ObjectFileScraper(verbose, builder);
@@ -78,18 +75,6 @@ private async Task<int> Run(ParseResult parse, CancellationToken token = default
                 return 1;
             }
         }
-        if (contracts != null)
-        {
-            var contractReader = new ContractReader(builder);
-            foreach (var contract in contracts)
-            {
-                if (!await contractReader.ParseContracts(contract, token).ConfigureAwait(false))
-                {
-                    Console.Error.WriteLine($"could not parse contracts in {contract}");
-                    return 1;
-                }
-            }
-        }
 
         var model = builder.Build();
         if (verbose)

src/coreclr/tools/cdac-build-tool/ComposeCommand.cs

@@ -165,14 +165,6 @@ public void AddOrUpdateContract(string name, int version)
             contract.Version = version;
         }
 
-        public void AddOrupdateContracts(IEnumerable<KeyValuePair<string, int>> contracts)
-        {
-            foreach (var (name, version) in contracts)
-            {
-                AddOrUpdateContract(name, version);
-            }
-        }
-
         public void SetBaseline(string baseline)
         {
             if (_baseline != string.Empty && _baseline != baseline)