tree f7df1ab0620add7547a8589c264a6d6d6d34f9b5
parent f680eb1df6293b58f3f9a4d215b4681dbac9d1be
author Ewout van Bekkum <ewout@google.com> 1609374582 -0800
committer CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> 1609968977 +0000

pw_sync/mutex: add preconditions to pw::sync::Mutex

Adds documented preconditions to pw::sync::Mutex to make it clear
that recursive locking results in undefined behavior. Although we
recommend detecting recursion through the use of an assert, this
can be complicated and come with real overhead as as such we
explicitly define it as UB.

Change-Id: I386e904de3a4b63d9f39dbe3d3bd92cbd0736d9c
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/28580
Commit-Queue: Ewout van Bekkum <ewout@google.com>
Reviewed-by: Wyatt Hepler <hepler@google.com>