{"id":106847,"date":"2022-07-08T07:00:00","date_gmt":"2022-07-08T14:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=106847"},"modified":"2022-11-30T06:53:46","modified_gmt":"2022-11-30T14:53:46","slug":"20220708-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20220708-00\/?p=106847","title":{"rendered":"Windows Runtime observable collections don’t mix well with multithreading"},"content":{"rendered":"

The Windows Runtime provides observable collections IObservableVector<T><\/code> and IObservableMap<K, V><\/code>. Observability adds Vector\u00adChanged<\/code> and Map\u00adChanged<\/code> events (respectively) to allow you to be called back when the underlying collection changes.<\/p>\n

These notifications interact poorly with multi-threading: What happens if while the thread is processing the previous change, another thread tries to mutate the collection?<\/p>\n

Different implementations of the observable collection interfaces behave differently.<\/p>\n

C#’s observable collections came first. From reading the reference source<\/a>, we see that mutation methods throw an Invalid\u00adOperation\u00adException<\/code> if they are mutated while a Changed event handler is active. (More detailed discussion in this StackOverflow question<\/a>.) It is apparent that this object was designed for single-threaded use: The reentrancy checks apply to the object as a whole, regardless of thread. Furthermore, the code doesn’t block reentrancy until it’s about to raise the Changed event. Here’s an abbreviated version:<\/p>\n

protected override void InsertItem(int index, T item)\r\n{\r\n    CheckReentrancy();\r\n    base.InsertItem(index, item);\r\n\r\n    using (BlockReentrancy())\r\n    {\r\n        \/* raise the CollectionChanged event *\/\r\n    }\r\n}\r\n<\/pre>\n
That creates this multithreaded race condition:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Thread 1<\/td>\nThread 2<\/td>\n<\/tr>\n
InsertItem<\/td>\n <\/td>\n<\/tr>\n
CheckReentrancy (succeeds)<\/td>\n <\/td>\n<\/tr>\n
base.InsertItem<\/td>\n <\/td>\n<\/tr>\n
\u00a0<\/td>\nInsertItem<\/td>\n<\/tr>\n
\u00a0<\/td>\nCheckReentrancy (succeeds)<\/td>\n<\/tr>\n
\u00a0<\/td>\nbase.InsertItem<\/td>\n<\/tr>\n
BlockReentrancy<\/td>\n<\/tr>\n
Raise the event<\/td>\n<\/tr>\n
Handler sees inconsistent collection<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Note that Thread 1’s Changed event handler is called after the collection has been changed by Thread 2, so when it goes to look at the collection to find the item that got inserted, it may not actually be there because Thread 2 already changed the collection.<\/p>\n
This makes sense because the C# Observable\u00adCollection is explicitly not thread-safe: IsSynchronized<\/code> always returns false<\/code>.<\/p>\n
The Windows Runtime ValueSet and PropertySet are also observable, and they follow roughly the same model as the C# observable collections they were patterned after: Modifications to the collection are disallowed when a change notification is active. The operation will fail with the exception RO_E_CHANGE_NOTIFICATION_IN_PROGRESS<\/code>. The Windows Runtime collections do take a little extra care to avoid the “inconsistent collection” problem: The concurrent call from Thread 2 fails rather than passing the initial concurrency check. (Basically by moving the Block\u00adReentrancy<\/code> to the top of the function.)<\/p>\n
Observable maps created by C++\/WinRT follow yet another pattern: They do not block subsequent operations while the Changed event is being raised. This means that handlers in this case have to be prepared for the case that the collection’s state can change out from under them.<\/p>\n
Oh, and what about C++\/CX? Easy: They simply don’t support concurrency at all!<\/p>\n
The C++\/CX collection types support  the same thread safety guarantees that STL containers support<\/a>.<\/p><\/blockquote>\n
The concurrency policy for STL containers is that concurrent reads are permitted, but no other operation can be concurrent with a write.<\/p>\n
What does this all mean for you?<\/p>\n
Limit your use of observable collections to single-threaded scenarios. Observable collections were originally created for UI data binding, which is single-threaded, and that’s why the observable collection pattern doesn’t extend well to multi-threaded scenarios. Furthermore, do not mutate the collection during the change notification.<\/p>\n
If you cannot avoid using observable collections in multi-threaded scenarios, then you have to understand that it’s not going to be a great experience. We’ve found four patterns so far:<\/p>\n\n\n\n\n\n\n\n\n
Implementation<\/th>\nConcurrent write<\/th>\nWrite during notification<\/th>\n<\/tr>\n
C#<\/td>\nUnprotected<\/td>\nRejected<\/td>\n<\/tr>\n
C++\/CX<\/td>\nUndefined<\/td>\nUndefined<\/td>\n<\/tr>\n
ValueSet \/ PropertySet<\/td>\nAllowed<\/td>\nRejected<\/td>\n<\/tr>\n
C++\/WinRT single_threaded_…<\/td>\nUndefined<\/td>\nUndefined<\/td>\n<\/tr>\n
C++\/WinRT multi_threaded_…<\/td>\nAllowed<\/td>\nAllowed<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
In the bottom row, we see that the C++\/WinRT multi-threaded collections allow a write during a change notification. This means that change notification handlers in the bottom row need to be prepared for the possibility that the collection changes while the change handler is running.<\/p>\n
We’ll look some more at that bottom row next time.<\/p>\n","protected":false},"excerpt":{"rendered":"
Concurrent observation and mutation is a bit of a mess.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-106847","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Concurrent observation and mutation is a bit of a mess.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/106847","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=106847"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/106847\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=106847"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=106847"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=106847"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}