Skip to content

Commit 8a71039

Browse files
csyonghecsyonghe
authored
Improve robustness of gfx lifetime management. (shader-slang#1788)
* Improve robustness of gfx lifetime management. * fix clang error * fix clang error * Fix clang warning
1 parent d27557d commit 8a71039

23 files changed

+892
-565
lines changed

‎build/visual-studio/core/core.vcxproj

+1
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@
179179
<ClInclude Include="..\..\..\source\core\slang-byte-encode-util.h" />
180180
<ClInclude Include="..\..\..\source\core\slang-char-util.h" />
181181
<ClInclude Include="..\..\..\source\core\slang-chunked-list.h" />
182+
<ClInclude Include="..\..\..\source\core\slang-com-object.h" />
182183
<ClInclude Include="..\..\..\source\core\slang-common.h" />
183184
<ClInclude Include="..\..\..\source\core\slang-compression-system.h" />
184185
<ClInclude Include="..\..\..\source\core\slang-deflate-compression-system.h" />

‎build/visual-studio/core/core.vcxproj.filters

+3
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@
3636
<ClInclude Include="..\..\..\source\core\slang-chunked-list.h">
3737
<Filter>Header Files</Filter>
3838
</ClInclude>
39+
<ClInclude Include="..\..\..\source\core\slang-com-object.h">
40+
<Filter>Header Files</Filter>
41+
</ClInclude>
3942
<ClInclude Include="..\..\..\source\core\slang-common.h">
4043
<Filter>Header Files</Filter>
4144
</ClInclude>

‎premake5.lua

+1-1
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ workspace "slang"
262262
optimize "Off"
263263
symbols "On"
264264
defines { "_DEBUG" }
265-
265+
-- staticruntime "Off"
266266
-- For the release configuration we will turn optimizations on
267267
-- (we do not yet micro-manage the optimization settings)
268268
-- and set the preprocessor definition that VS would add by default.

‎slang-com-helper.h

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
#ifndef SLANG_COM_HELPER_H
1+
#ifndef SLANG_COM_HELPER_H
22
#define SLANG_COM_HELPER_H
33

44
/** \file slang-com-helper.h
55
*/
66

77
#include "slang.h"
8+
#include <atomic>
89

910
/* !!!!!!!!!!!!!!!!!!!!! Macros to help checking SlangResult !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!*/
1011

@@ -110,7 +111,7 @@ SLANG_NO_THROW uint32_t SLANG_MCALL release() \
110111
#define SLANG_REF_OBJECT_IUNKNOWN_QUERY_INTERFACE \
111112
SLANG_NO_THROW SlangResult SLANG_MCALL queryInterface(SlangUUID const& uuid, void** outObject) SLANG_OVERRIDE \
112113
{ \
113-
ISlangUnknown* intf = getInterface(uuid); \
114+
void* intf = getInterface(uuid); \
114115
if (intf) \
115116
{ \
116117
addReference(); \
@@ -123,10 +124,10 @@ SLANG_NO_THROW SlangResult SLANG_MCALL queryInterface(SlangUUID const& uuid, voi
123124
#define SLANG_REF_OBJECT_IUNKNOWN_ADD_REF SLANG_NO_THROW uint32_t SLANG_MCALL addRef() SLANG_OVERRIDE { return (uint32_t)addReference(); }
124125
#define SLANG_REF_OBJECT_IUNKNOWN_RELEASE SLANG_NO_THROW uint32_t SLANG_MCALL release() SLANG_OVERRIDE { return (uint32_t)releaseReference(); }
125126

126-
#define SLANG_REF_OBJECT_IUNKNOWN_ALL \
127-
SLANG_REF_OBJECT_IUNKNOWN_QUERY_INTERFACE \
128-
SLANG_REF_OBJECT_IUNKNOWN_ADD_REF \
129-
SLANG_REF_OBJECT_IUNKNOWN_RELEASE
127+
# define SLANG_REF_OBJECT_IUNKNOWN_ALL \
128+
SLANG_REF_OBJECT_IUNKNOWN_QUERY_INTERFACE \
129+
SLANG_REF_OBJECT_IUNKNOWN_ADD_REF \
130+
SLANG_REF_OBJECT_IUNKNOWN_RELEASE
130131

131132
#endif // defined(__cplusplus)
132133

‎source/core/slang-chunked-list.h

+4-2
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ class ChunkedList
165165

166166
T* add(T&& obj)
167167
{
168-
auto chunk = _maybeReserveForAdd();
168+
auto chunk = _maybeReserveForAdd(1);
169169
auto result = chunk->begin() + chunk->size;
170170
chunk->begin()[chunk->size] = static_cast<T&&>(obj);
171171
chunk->size++;
@@ -175,7 +175,7 @@ class ChunkedList
175175

176176
T* add(const T& obj)
177177
{
178-
auto chunk = _maybeReserveForAdd();
178+
auto chunk = _maybeReserveForAdd(1);
179179
auto result = chunk->begin() + chunk->size;
180180
chunk->begin()[chunk->size] = obj;
181181
chunk->size++;
@@ -226,6 +226,8 @@ class ChunkedList
226226
{
227227
_deallocateBuffer();
228228
m_count = 0;
229+
for (auto& item : m_firstChunk.elements)
230+
item = T();
229231
}
230232

231233
private:

‎source/core/slang-com-object.h

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
#ifndef SLANG_COM_OBJECT_H
2+
#define SLANG_COM_OBJECT_H
3+
4+
#include "slang-basic.h"
5+
#include <atomic>
6+
7+
namespace Slang
8+
{
9+
class ComObject : public RefObject
10+
{
11+
protected:
12+
std::atomic<uint32_t> comRefCount;
13+
14+
public:
15+
ComObject()
16+
: comRefCount(0)
17+
{}
18+
ComObject(const ComObject&) : comRefCount(0) {}
19+
ComObject& operator=(const ComObject&)
20+
{
21+
comRefCount = 0;
22+
return *this;
23+
};
24+
virtual void comFree() {}
25+
26+
uint32_t addRefImpl()
27+
{
28+
auto oldRefCount = comRefCount++;
29+
if (oldRefCount == 0)
30+
addReference();
31+
return oldRefCount + 1;
32+
}
33+
34+
uint32_t releaseImpl()
35+
{
36+
auto oldRefCount = comRefCount--;
37+
if (oldRefCount == 1)
38+
{
39+
comFree();
40+
releaseReference();
41+
}
42+
return oldRefCount - 1;
43+
}
44+
};
45+
46+
#define SLANG_COM_OBJECT_IUNKNOWN_QUERY_INTERFACE \
47+
SLANG_NO_THROW SlangResult SLANG_MCALL queryInterface(SlangUUID const& uuid, void** outObject) \
48+
SLANG_OVERRIDE \
49+
{ \
50+
void* intf = getInterface(uuid); \
51+
if (intf) \
52+
{ \
53+
addRef(); \
54+
*outObject = intf; \
55+
return SLANG_OK; \
56+
} \
57+
return SLANG_E_NO_INTERFACE; \
58+
}
59+
#define SLANG_COM_OBJECT_IUNKNOWN_ADD_REF \
60+
SLANG_NO_THROW uint32_t SLANG_MCALL addRef() SLANG_OVERRIDE { return addRefImpl(); }
61+
#define SLANG_COM_OBJECT_IUNKNOWN_RELEASE \
62+
SLANG_NO_THROW uint32_t SLANG_MCALL release() SLANG_OVERRIDE { return releaseImpl(); }
63+
#define SLANG_COM_OBJECT_IUNKNOWN_ALL \
64+
SLANG_COM_OBJECT_IUNKNOWN_QUERY_INTERFACE \
65+
SLANG_COM_OBJECT_IUNKNOWN_ADD_REF \
66+
SLANG_COM_OBJECT_IUNKNOWN_RELEASE
67+
68+
} // namespace Slang
69+
70+
#endif

‎tools/gfx/cpu/render-cpu.cpp

+28-18
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ class CPUTextureResource : public TextureResource
191191
{}
192192
~CPUTextureResource()
193193
{
194+
free(m_data);
194195
}
195196

196197
Result init(ITextureResource::SubresourceData const* initData)
@@ -341,7 +342,7 @@ class CPUTextureResource : public TextureResource
341342
void* m_data = nullptr;
342343
};
343344

344-
class CPUResourceView : public IResourceView, public RefObject
345+
class CPUResourceView : public IResourceView, public ComObject
345346
{
346347
public:
347348
enum class Kind
@@ -350,7 +351,7 @@ class CPUResourceView : public IResourceView, public RefObject
350351
Texture,
351352
};
352353

353-
SLANG_REF_OBJECT_IUNKNOWN_ALL
354+
SLANG_COM_OBJECT_IUNKNOWN_ALL
354355
IResourceView* getInterface(const Guid& guid)
355356
{
356357
if (guid == GfxGUID::IID_ISlangUnknown || guid == GfxGUID::IID_IResourceView)
@@ -799,9 +800,9 @@ class CPUShaderObject : public ShaderObjectBase
799800

800801
auto& bindingRange = layout->m_bindingRanges[bindingRangeIndex];
801802
auto subObjectIndex = bindingRange.baseIndex + offset.bindingArrayIndex;
802-
CPUShaderObject* subObject = m_objects[subObjectIndex];
803+
auto& subObject = m_objects[subObjectIndex];
803804

804-
*outObject = ComPtr<IShaderObject>(subObject).detach();
805+
returnComPtr(outObject, subObject);
805806

806807
return SLANG_OK;
807808
}
@@ -1043,6 +1044,12 @@ class CPUEntryPointShaderObject : public CPUShaderObject
10431044

10441045
class CPURootShaderObject : public CPUShaderObject
10451046
{
1047+
public:
1048+
// Override default reference counting behavior to disable lifetime management via ComPtr.
1049+
// Root objects are managed by command buffer and does not need to be freed by the user.
1050+
SLANG_NO_THROW uint32_t SLANG_MCALL addRef() override { return 1; }
1051+
SLANG_NO_THROW uint32_t SLANG_MCALL release() override { return 1; }
1052+
10461053
public:
10471054
SlangResult init(IDevice* device, CPUProgramLayout* programLayout);
10481055

@@ -1056,7 +1063,7 @@ class CPURootShaderObject : public CPUShaderObject
10561063
virtual SLANG_NO_THROW Result SLANG_MCALL
10571064
getEntryPoint(UInt index, IShaderObject** outEntryPoint) override
10581065
{
1059-
*outEntryPoint = ComPtr<IShaderObject>(m_entryPoints[index]).detach();
1066+
returnComPtr(outEntryPoint, m_entryPoints[index]);
10601067
return SLANG_OK;
10611068
}
10621069
virtual Result collectSpecializationArgs(ExtendedShaderObjectTypeList& args) override
@@ -1083,7 +1090,7 @@ class CPUShaderProgram : public ShaderProgramBase
10831090
class CPUPipelineState : public PipelineStateBase
10841091
{
10851092
public:
1086-
CPUShaderProgram* getProgram() { return static_cast<CPUShaderProgram*>(m_program.get()); }
1093+
CPUShaderProgram* getProgram() { return static_cast<CPUShaderProgram*>(m_program.Ptr()); }
10871094

10881095
void init(const ComputePipelineStateDesc& inDesc)
10891096
{
@@ -1194,11 +1201,14 @@ class CPUDevice : public ImmediateComputeDeviceBase
11941201
const ITextureResource::SubresourceData* initData,
11951202
ITextureResource** outResource) override
11961203
{
1197-
RefPtr<CPUTextureResource> texture = new CPUTextureResource(desc);
1204+
TextureResource::Desc srcDesc(desc);
1205+
srcDesc.setDefaults(initialUsage);
1206+
1207+
RefPtr<CPUTextureResource> texture = new CPUTextureResource(srcDesc);
11981208

11991209
SLANG_RETURN_ON_FAIL(texture->init(initData));
12001210

1201-
*outResource = texture.detach();
1211+
returnComPtr(outResource, texture);
12021212
return SLANG_OK;
12031213
}
12041214

@@ -1214,7 +1224,7 @@ class CPUDevice : public ImmediateComputeDeviceBase
12141224
{
12151225
SLANG_RETURN_ON_FAIL(resource->setData(0, desc.sizeInBytes, initData));
12161226
}
1217-
*outResource = resource.detach();
1227+
returnComPtr(outResource, resource);
12181228
return SLANG_OK;
12191229
}
12201230

@@ -1223,7 +1233,7 @@ class CPUDevice : public ImmediateComputeDeviceBase
12231233
{
12241234
auto texture = static_cast<CPUTextureResource*>(inTexture);
12251235
RefPtr<CPUTextureView> view = new CPUTextureView(desc, texture);
1226-
*outView = view.detach();
1236+
returnComPtr(outView, view);
12271237
return SLANG_OK;
12281238
}
12291239

@@ -1232,7 +1242,7 @@ class CPUDevice : public ImmediateComputeDeviceBase
12321242
{
12331243
auto buffer = static_cast<CPUBufferResource*>(inBuffer);
12341244
RefPtr<CPUBufferView> view = new CPUBufferView(desc, buffer);
1235-
*outView = view.detach();
1245+
returnComPtr(outView, view);
12361246
return SLANG_OK;
12371247
}
12381248

@@ -1241,7 +1251,7 @@ class CPUDevice : public ImmediateComputeDeviceBase
12411251
ShaderObjectLayoutBase** outLayout) override
12421252
{
12431253
RefPtr<CPUShaderObjectLayout> cpuLayout = new CPUShaderObjectLayout(this, typeLayout);
1244-
*outLayout = cpuLayout.detach();
1254+
returnRefPtrMove(outLayout, cpuLayout);
12451255

12461256
return SLANG_OK;
12471257
}
@@ -1254,19 +1264,19 @@ class CPUDevice : public ImmediateComputeDeviceBase
12541264

12551265
RefPtr<CPUShaderObject> result = new CPUShaderObject();
12561266
SLANG_RETURN_ON_FAIL(result->init(this, cpuLayout));
1257-
*outObject = result.detach();
1267+
returnComPtr(outObject, result);
12581268

12591269
return SLANG_OK;
12601270
}
12611271

1262-
virtual Result createRootShaderObject(IShaderProgram* program, IShaderObject** outObject) override
1272+
virtual Result createRootShaderObject(IShaderProgram* program, ShaderObjectBase** outObject) override
12631273
{
12641274
auto cpuProgram = static_cast<CPUShaderProgram*>(program);
12651275
auto cpuProgramLayout = cpuProgram->layout;
12661276

12671277
RefPtr<CPURootShaderObject> result = new CPURootShaderObject();
12681278
SLANG_RETURN_ON_FAIL(result->init(this, cpuProgramLayout));
1269-
*outObject = result.detach();
1279+
returnRefPtrMove(outObject, result);
12701280
return SLANG_OK;
12711281
}
12721282

@@ -1292,7 +1302,7 @@ class CPUDevice : public ImmediateComputeDeviceBase
12921302
cpuProgram->layout = cpuProgramLayout;
12931303
}
12941304

1295-
*outProgram = cpuProgram.detach();
1305+
returnComPtr(outProgram, cpuProgram);
12961306
return SLANG_OK;
12971307
}
12981308

@@ -1301,7 +1311,7 @@ class CPUDevice : public ImmediateComputeDeviceBase
13011311
{
13021312
RefPtr<CPUPipelineState> state = new CPUPipelineState();
13031313
state->init(desc);
1304-
*outState = state.detach();
1314+
returnComPtr(outState, state);
13051315
return Result();
13061316
}
13071317

@@ -1410,7 +1420,7 @@ SlangResult SLANG_MCALL createCPUDevice(const IDevice::Desc* desc, IDevice** out
14101420
{
14111421
RefPtr<CPUDevice> result = new CPUDevice();
14121422
SLANG_RETURN_ON_FAIL(result->initialize(*desc));
1413-
*outDevice = result.detach();
1423+
returnComPtr(outDevice, result);
14141424
return SLANG_OK;
14151425
}
14161426

0 commit comments

Comments
 (0)