{"id":5021,"date":"2015-11-04T13:00:13","date_gmt":"2015-11-04T13:00:13","guid":{"rendered":"http:\/\/writeasync.net\/?p=5021"},"modified":"2015-11-04T05:16:45","modified_gmt":"2015-11-04T05:16:45","slug":"dry-raii-with-autobuffer","status":"publish","type":"post","link":"http:\/\/writeasync.net\/?p=5021","title":{"rendered":"DRY RAII with AutoBuffer"},"content":{"rendered":"

Don’t Repeat Yourself<\/a> is a good maxim in software design — avoid duplication of information. Today’s sample code will show a small fix to a problem which quite literally involves repeating yourself: those annoying “call twice” Win32 functions like GetVirtualDiskPhysicalPath<\/code><\/a>.<\/p>\n

Here’s an example of how one might call it in “old school” C-style code:<\/p>\n

\r\nULONG size = 16;\r\nWCHAR * path = new WCHAR[size];\r\nDWORD error = GetVirtualDiskPhysicalPath(handle, &size, path);\r\nif (error == ERROR_INSUFFICIENT_BUFFER)\r\n{\r\n    \/\/ Sigh. Call again now that we know the real size to use...\r\n    delete [] path;\r\n    path = new WCHAR[size];\r\n    error = GetVirtualDiskPhysicalPath(handle, &size, path)\r\n}\r\n\r\n\/\/ ... more code here, which will hopefully eventually free the buffer ...\r\n<\/pre>\n
There are multiple problems here. The duplication is ugly. The naked memory management calls leave you prone to leaks if you don’t remember to free on every return path. This “call twice to get buffer size” is also a common pattern for many other Win32 calls, so what you do here has to be structurally repeated in many places.<\/p>\n
With C++11 (or better), you can elegantly solve this problem with judicious use of lambda expressions<\/a>, STL vectors<\/a>, and templating. Here is my stab at it in a class called AutoBuffer<\/code>. It attempts to provide a type-safe and RAII-observant<\/a> solution to the problem above.<\/p>\n
Let’s rewrite the previous sample code using AutoBuffer<\/code>:<\/p>\n
\r\nAutoBuffer<WCHAR> buffer;\r\nDWORD error = buffer.Fill<ULONG>([handle](WCHAR * dataPtr, PULONG sizePtr)\r\n{\r\n    return GetVirtualDiskPhysicalPath(handle, sizePtr, dataPtr);\r\n});\r\n\r\n\/\/ more code here... but no need to free the buffer, since AutoBuffer will destroy it for you!\r\n<\/pre>\n
Much simpler, eh? No more duplication and a lower chance of bugs.<\/p>\n
Below is a reference implementation with unit tests that takes care of the “return error code” variation of this pattern, as demonstrated above. (Note that there are other Win32 functions using the “call twice” semantics such as QueryServiceConfig<\/code><\/a> that instead return BOOL<\/code> and GetLastError<\/code><\/a> must be used; I’ll leave that one as an exercise for the reader….)<\/p>\n
\r\n\/\/ Implementation -- AutoBuffer.h\r\n#pragma once\r\n\r\n#include <Windows.h>\r\n#include <vector>\r\n#include <functional>\r\n\r\ntemplate<typename TData>\r\nclass AutoBuffer\r\n{\r\npublic:\r\n    AutoBuffer()\r\n        : buffer_(sizeof(TData), '\0')\r\n    {\r\n    }\r\n\r\n    ~AutoBuffer()\r\n    {\r\n    }\r\n\r\n    template<typename TSize>\r\n    DWORD Fill(std::function<DWORD(TData *, TSize *)> func)\r\n    {\r\n        TSize size = static_cast<TSize>(get_Size());\r\n        DWORD result = func(Ptr(0), &size);\r\n        if (result == ERROR_INSUFFICIENT_BUFFER)\r\n        {\r\n            buffer_.resize(size);\r\n            result = func(Ptr(0), &size);\r\n        }\r\n\r\n        return result;\r\n    }\r\n\r\n    size_t get_Size() const\r\n    {\r\n        return buffer_.size();\r\n    }\r\n\r\n    TData * operator->()\r\n    {\r\n        return Ptr(0);\r\n    }\r\n\r\n    TData & operator[](int index)\r\n    {\r\n        return *Ptr(index);\r\n    }\r\n\r\nprivate:\r\n    std::vector<unsigned char> buffer_;\r\n\r\n    TData * Ptr(int index)\r\n    {\r\n        return reinterpret_cast<TData *>(&buffer_[index * sizeof(TData)]);\r\n    }\r\n};\r\n<\/pre>\n
\r\n\/\/ Tests -- AutoBufferTest.cpp\r\n#include "CppUnitTest.h"\r\n#include "AutoBuffer.h"\r\n\r\nusing namespace Microsoft::VisualStudio::CppUnitTestFramework;\r\n\r\nnamespace UnitTest1\r\n{\r\n    TEST_CLASS(AutoBufferTest)\r\n    {\r\n    public:\r\n        struct ExampleData\r\n        {\r\n            int Number;\r\n            void * Ptr;\r\n        };\r\n\r\n\r\n        TEST_METHOD(ShouldInitializeWithSizeOfOneItemEmpty)\r\n        {\r\n            AutoBuffer<ExampleData> buffer;\r\n\r\n            Assert::AreEqual(sizeof(ExampleData), buffer.get_Size());\r\n            Assert::AreEqual(0, buffer->Number);\r\n            Assert::IsNull(buffer->Ptr);\r\n        }\r\n\r\n        TEST_METHOD(ShouldFillAndReturnSuccessWhenFirstCallSucceeds)\r\n        {\r\n            AutoBuffer<ExampleData> buffer;\r\n\r\n            DWORD result = buffer.Fill<ULONG>([](ExampleData * dataPtr, PULONG sizePtr)\r\n            {\r\n                dataPtr->Number = *sizePtr;\r\n                return ERROR_SUCCESS;\r\n            });\r\n\r\n            Assert::AreEqual(static_cast<DWORD>(0), result);\r\n            Assert::AreEqual(static_cast<int>(sizeof(ExampleData)), buffer->Number);\r\n        }\r\n\r\n        TEST_METHOD(ShouldReturnInitialErrorWhenFirstCallFails)\r\n        {\r\n            AutoBuffer<ExampleData> buffer;\r\n\r\n            DWORD result = buffer.Fill<ULONG>([](ExampleData * dataPtr, PULONG sizePtr)\r\n            {\r\n                return ERROR_NOT_FOUND;\r\n            });\r\n\r\n            Assert::AreEqual(static_cast<DWORD>(ERROR_NOT_FOUND), result);\r\n            Assert::AreEqual(0, buffer->Number);\r\n        }\r\n\r\n        TEST_METHOD(ShouldCallAgainWithUpdatedSizeIfFirstCallFailsWithInsufficientBuffer)\r\n        {\r\n            AutoBuffer<ExampleData> buffer;\r\n\r\n            DWORD result = buffer.Fill<ULONG>([](ExampleData * dataPtr, PULONG sizePtr)\r\n            {\r\n                if (++dataPtr->Number == 1)\r\n                {\r\n                    *sizePtr *= 2;\r\n                    return ERROR_INSUFFICIENT_BUFFER;\r\n                }\r\n\r\n                dataPtr[1].Number = 1000;\r\n                return ERROR_SUCCESS;\r\n            });\r\n\r\n            Assert::AreEqual(static_cast<DWORD>(0), result);\r\n            Assert::AreEqual(2, buffer->Number);\r\n            Assert::AreEqual(1000, buffer[1].Number);\r\n        }\r\n\r\n        TEST_METHOD(ShouldReturnFinalErrorIfSecondCallFails)\r\n        {\r\n            AutoBuffer<ExampleData> buffer;\r\n\r\n            DWORD result = buffer.Fill<ULONG>([](ExampleData * dataPtr, PULONG sizePtr)\r\n            {\r\n                if (++dataPtr->Number == 1)\r\n                {\r\n                    return ERROR_INSUFFICIENT_BUFFER;\r\n                }\r\n\r\n                return ERROR_NOT_FOUND;\r\n            });\r\n\r\n            Assert::AreEqual(static_cast<DWORD>(ERROR_NOT_FOUND), result);\r\n        }\r\n    };\r\n}\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
Don’t Repeat Yourself is a good maxim in software design — avoid duplication of information. Today’s sample code will show a small fix to a problem which quite literally involves repeating yourself: those annoying “call twice” Win32 functions like GetVirtualDiskPhysicalPath.… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[91,101],"tags":[],"class_list":["post-5021","post","type-post","status-publish","format-standard","hentry","category-design","category-native"],"_links":{"self":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5021","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5021"}],"version-history":[{"count":0,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5021\/revisions"}],"wp:attachment":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5021"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5021"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5021"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}