|
| 1 | +# Contract SyncBlock |
| 2 | + |
| 3 | +This contract is for reading sync block table entries and lock state. |
| 4 | + |
| 5 | +## APIs of contract |
| 6 | + |
| 7 | +``` csharp |
| 8 | +TargetPointer GetSyncBlock(uint index); |
| 9 | +TargetPointer GetSyncBlockObject(uint index); |
| 10 | +bool IsSyncBlockFree(uint index); |
| 11 | +uint GetSyncBlockCount(); |
| 12 | +bool TryGetLockInfo(TargetPointer syncBlock, out uint owningThreadId, out uint recursion); |
| 13 | +uint GetAdditionalThreadCount(TargetPointer syncBlock); |
| 14 | +``` |
| 15 | + |
| 16 | +## Version 1 |
| 17 | + |
| 18 | +Data descriptors used: |
| 19 | +| Data Descriptor Name | Field | Meaning | |
| 20 | +| --- | --- | --- | |
| 21 | +| `SyncTableEntry` | `SyncBlock` | Pointer to the sync block for a sync table entry | |
| 22 | +| `SyncTableEntry` | `Object` | Pointer to the object associated with a sync table entry | |
| 23 | +| `SyncBlockCache` | `FreeSyncTableIndex` | One past the highest sync table entry index allocated | |
| 24 | +| `SyncBlock` | `Lock` | Optional pointer to a `System.Threading.Lock` object payload | |
| 25 | +| `SyncBlock` | `ThinLock` | Thin-lock state bits | |
| 26 | +| `SyncBlock` | `LinkNext` | Head pointer for additional waiting threads list | |
| 27 | +| `SLink` | `Next` | Next link for the additional waiting threads list | |
| 28 | + |
| 29 | +Global variables used: |
| 30 | +| Global Name | Type | Purpose | |
| 31 | +| --- | --- | --- | |
| 32 | +| `SyncTableEntries` | TargetPointer | Pointer to the sync table entries array | |
| 33 | +| `SyncBlockCache` | TargetPointer | Pointer to the runtime sync block cache | |
| 34 | +| `SyncBlockMaskLockThreadId` | uint32 | Mask for extracting thread id from `SyncBlock.ThinLock` | |
| 35 | +| `SyncBlockMaskLockRecursionLevel` | uint32 | Mask for extracting recursion level from `SyncBlock.ThinLock` | |
| 36 | +| `SyncBlockRecursionLevelShift` | uint32 | Shift value for `SyncBlock.ThinLock` recursion level | |
| 37 | + |
| 38 | +### Contract Constants: |
| 39 | +| Name | Type | Purpose | Value | |
| 40 | +| --- | --- | --- | --- | |
| 41 | +| `LockStateName` | string | Field name in `System.Threading.Lock` storing monitor-held state bits. | `_state` | |
| 42 | +| `LockOwningThreadIdName` | string | Field name in `System.Threading.Lock` storing owning thread id. | `_owningThreadId` | |
| 43 | +| `LockRecursionCountName` | string | Field name in `System.Threading.Lock` storing monitor recursion count. | `_recursionCount` | |
| 44 | +| `LockName` | string | Type name used to resolve `System.Threading.Lock`. | `Lock` | |
| 45 | +| `LockNamespace` | string | Namespace used to resolve `System.Threading.Lock`. | `System.Threading` | |
| 46 | + |
| 47 | +Contracts used: |
| 48 | +| Contract Name | |
| 49 | +| --- | |
| 50 | +| `Loader` | |
| 51 | +| `RuntimeTypeSystem` | |
| 52 | +| `EcmaMetadata` | |
| 53 | + |
| 54 | +``` csharp |
| 55 | +TargetPointer GetSyncBlock(uint index) |
| 56 | +{ |
| 57 | + TargetPointer syncTableEntries = target.ReadGlobalPointer("SyncTableEntries"); |
| 58 | + ulong offsetInSyncTable = index * /* SyncTableEntry size */; |
| 59 | + return target.ReadPointer(syncTableEntries + offsetInSyncTable + /* SyncTableEntry::SyncBlock offset */); |
| 60 | +} |
| 61 | + |
| 62 | +TargetPointer GetSyncBlockObject(uint index) |
| 63 | +{ |
| 64 | + TargetPointer syncTableEntries = target.ReadGlobalPointer("SyncTableEntries"); |
| 65 | + ulong offsetInSyncTable = index * /* SyncTableEntry size */; |
| 66 | + return target.ReadPointer(syncTableEntries + offsetInSyncTable + /* SyncTableEntry::Object offset */); |
| 67 | +} |
| 68 | + |
| 69 | +bool IsSyncBlockFree(uint index) |
| 70 | +{ |
| 71 | + TargetPointer syncTableEntries = target.ReadGlobalPointer("SyncTableEntries"); |
| 72 | + ulong offsetInSyncTable = index * /* SyncTableEntry size */; |
| 73 | + TargetPointer obj = target.ReadPointer(syncTableEntries + offsetInSyncTable + /* SyncTableEntry::Object offset */); |
| 74 | + return (obj.Value & 1) != 0; |
| 75 | +} |
| 76 | + |
| 77 | +uint GetSyncBlockCount() |
| 78 | +{ |
| 79 | + TargetPointer syncBlockCache = target.ReadPointer(target.ReadGlobalPointer("SyncBlockCache")); |
| 80 | + uint freeSyncTableIndex = target.Read<uint>(syncBlockCache + /* SyncBlockCache::FreeSyncTableIndex offset */); |
| 81 | + return freeSyncTableIndex - 1; |
| 82 | +} |
| 83 | + |
| 84 | +bool TryGetLockInfo(TargetPointer syncBlock, out uint owningThreadId, out uint recursion) |
| 85 | +{ |
| 86 | + owningThreadId = 0; |
| 87 | + recursion = 0; |
| 88 | + |
| 89 | + TargetPointer lockObject = target.ReadPointer(syncBlock + /* SyncBlock::Lock offset */); |
| 90 | + |
| 91 | + if (lockObject != TargetPointer.Null) |
| 92 | + { |
| 93 | + // Resolve System.Threading.Lock in System.Private.CoreLib by name using RuntimeTypeSystem contract, LockName and LockNamespace. |
| 94 | + uint state = ReadUintField(/* Lock type */, "LockStateName", /* RuntimeTypeSystem contract */, /* MetadataReader for SPC */, lockObject); |
| 95 | + bool monitorHeld = (state & 1) != 0; |
| 96 | + if (monitorHeld) |
| 97 | + { |
| 98 | + owningThreadId = ReadUintField(/* Lock type */, "LockOwningThreadIdName", /* contracts */, lockObject); |
| 99 | + recursion = ReadUintField(/* Lock type */, "LockRecursionCountName", /* contracts */, lockObject); |
| 100 | + } |
| 101 | + |
| 102 | + return monitorHeld; |
| 103 | + } |
| 104 | + |
| 105 | + uint thinLock = target.Read<uint>(syncBlock + /* SyncBlock::ThinLock offset */); |
| 106 | + if (thinLock != 0) |
| 107 | + { |
| 108 | + owningThreadId = thinLock & target.ReadGlobal<uint>("SyncBlockMaskLockThreadId"); |
| 109 | + bool monitorHeld = owningThreadId != 0; |
| 110 | + if (monitorHeld) |
| 111 | + { |
| 112 | + recursion = (thinLock & target.ReadGlobal<uint>("SyncBlockMaskLockRecursionLevel")) |
| 113 | + >> (int)target.ReadGlobal<uint>("SyncBlockRecursionLevelShift"); |
| 114 | + } |
| 115 | + |
| 116 | + return monitorHeld; |
| 117 | + } |
| 118 | + |
| 119 | + return false; |
| 120 | +} |
| 121 | + |
| 122 | +private uint ReadUintField(TypeHandle enclosingType, string fieldName, IRuntimeTypeSystem rts, MetadataReader mdReader, TargetPointer dataAddr) |
| 123 | +{ |
| 124 | + TargetPointer field = rts.GetFieldDescByName(enclosingType, fieldName); |
| 125 | + uint token = rts.GetFieldDescMemberDef(field); |
| 126 | + FieldDefinitionHandle fieldHandle = (FieldDefinitionHandle)MetadataTokens.Handle((int)token); |
| 127 | + FieldDefinition fieldDef = mdReader.GetFieldDefinition(fieldHandle); |
| 128 | + uint offset = rts.GetFieldDescOffset(field, fieldDef); |
| 129 | + return _target.Read<uint>(dataAddr + offset); |
| 130 | +} |
| 131 | + |
| 132 | +uint GetAdditionalThreadCount(TargetPointer syncBlock) |
| 133 | +{ |
| 134 | + uint threadCount = 0; |
| 135 | + TargetPointer next = target.ReadPointer(syncBlock + /* SyncBlock::LinkNext offset */); |
| 136 | + while (next != TargetPointer.Null && threadCount < 1000) |
| 137 | + { |
| 138 | + threadCount++; |
| 139 | + next = target.ReadPointer(next + /* SLink::Next offset */); |
| 140 | + } |
| 141 | + |
| 142 | + return threadCount; |
| 143 | +} |
| 144 | +``` |
0 commit comments