Thread Sanitizer, также известный как TSan, — это инструмент на основе LLVM для проверки проблем многопоточности в вашем коде, написанном на языках Swift и C. Он был впервые представлен в Xcode 8 и может стать отличным инструментом для обнаружения менее заметных ошибок в вашем коде, таких как гонки данных.

В WeTransfer Thread Sanitizer помог нам решить нестабильные тесты и странные сбои, которые мы не могли точно связать с какой-либо причиной. Возможно, вы ранее не использовали TSan, так как может быть не совсем понятно, что делает этот инструмент и как он работает. Поэтому пришло время углубиться и объяснить, как улучшить ваш код с помощью Thread Sanitizer.

Прежде чем мы погрузимся в анализатор, сначала нужно понять, что именно мы ищем. Мы собираемся исправить проблему, называемую гонкой данных.

Гонки данных возникают, когда к одной и той же области памяти осуществляется доступ из нескольких потоков без синхронизации, и по крайней мере одно из обращений — запись. Гонки данных могут приводить к следующим проблемам:

Непредсказуемое поведениеПовреждение памятиНестабильные тестыСтранные сбои

Поскольку гонка данных непредсказуема, она может возникать несистематически при тестировании вашего приложения. Возможно, у вас будет сбой при запуске, который не повторится при следующем запуске приложения. Если это так, вы, возможно, столкнулись с гонкой данных.

Поняв, что такое гонка данных, вы сможете лучше выявлять потенциальные проблемы в своем коде. Однако иногда бывает не так очевидно, что код может привести к гонке данных. Поэтому рассмотрим несколько примеров, чтобы показать, что такое гонка данных.

В следующем фрагменте кода два разных потока получают доступ к одному и тому же свойству типа String:

Пример гонки данных, обнаруженный Thread Sanitizer

Поскольку фоновый поток записывает значение в переменную name, у нас есть как минимум один доступ на запись. Поведение непредсказуемо, так как оно зависит от того, выполнится ли сначала оператор print или запись. Это пример гонки данных, что подтверждает Thread Sanitizer.

Ленивая переменная откладывает инициализацию экземпляра до момента, когда она вызывается впервые. Это означает, что запись данных произойдет в тот момент, когда ленивая переменная будет впервые использована. Если два потока одновременно обращаются к этой ленивой переменной в первый раз, может возникнуть гонка данных:

Приведенные выше примеры показывают, что гонка данных может легко возникнуть. В небольших фрагментах кода вы можете заметить это самостоятельно, но по мере роста вашего проекта задача становится намного сложнее. Поэтому пришло время воспользоваться помощью Thread Sanitizer.

Вы также можете включить его для ваших тестовых схем, что может быть эффективным способом выявления ошибок, связанных с доступом к данным.

Вы можете включить Thread Sanitizer в настройках схемы:

То же самое можно сделать и для ваших тестовых схем, что позволяет эффективно выявлять гонки данных.

После включения Thread Sanitizer ваше приложение будет заново собрано с нуля. Компилятор добавит проверки вокруг каждого обращения к памяти, чтобы определить, участвует ли определенный доступ в гонке. Пример кода выше будет выглядеть следующим образом после преобразования компилятором:

Метод

recordAndCheckWrite

будет сохранять временную метку для каждого обращения и каждого потока, используемого анализатором для обнаружения гонки данных.

Thread Sanitizer имеет несколько ограничений:

- Поддерживается только для 64-битных версий macOS и симуляторов iOS и tvOS.
- watchOS не поддерживается.
- Нельзя использовать TSan на устройстве.

Как указано в документации Apple, использование TSan может привести к снижению производительности:

Запуск вашего кода с этими диагностическими инструментами также вызывает замедление работы приложения в 2–20 раз. Чтобы улучшить использование памяти вашим кодом, скомпилируйте его с оптимизацией    -O1.

После того как вы узнали, что такое гонка данных и как ее обнаружить, пришло время написать решение, чтобы она больше не возникала. Как мы уже узнали, ошибки, связанные с доступом к данным, происходят, когда несколько потоков обращаются к одной и той же области памяти без должной синхронизации. Возьмем пример выше, и мы могли бы написать решение, используя очереди диспетчера:

Используя очередь блокировок, мы синхронизировали доступ и обеспечили, чтобы только один поток одновременно получал доступ к переменной name. Это базовое решение нашей проблемы. Если вы хотите узнать больше о более эффективном решении с улучшенной производительностью, рекомендую прочитать мою статью о Concurrent в Swift, объясняющую многопоточность.

Фреймворк многозадачности, представленный на WWDC 2021, включил акторы для синхронизации доступа к данным. Это лучшее решение для устранения ошибок, связанных с доступом к данным, и оно должно быть проще, чем использование очередей диспетчера.

Чтобы узнать больше об актерах в Swift, рекомендую прочитать мою статью Акторы в Swift: как использовать и предотвращать гонки данных. Пример выше можно переписать с использованием акторов, создав контроллер для name:

Актор NameController отвечает за любой доступ к свойству name. Наш метод updateName будет переписан следующим образом:

Как видно, нам нужно использовать ключевые слова async/await, так как доступ становится асинхронным. Подробнее об этом можно узнать в моей статье Async await в Swift с примерами кода.

Вот и все! Глубокое погружение в гонки данных в Swift. Надеюсь, теперь вы сможете начать находить ошибки и исправлять сбои, которые долгое время присутствовали в вашем коде. Регулярное использование Thread Sanitizer поможет вам предотвратить незаметные ошибки.