Инициализация смешанных сборок
Разработчики Windows всегда должны опасаться блокировки загрузчика при выполнении кода во время DllMain
. Однако существуют некоторые дополнительные проблемы, которые следует учитывать при работе с сборками смешанного режима C++/CLI.
Код в DllMain не должен получить доступ к среде CLR .NET. Это означает, что DllMain
не следует вызывать управляемые функции, напрямую или косвенно; управляемый код не должен быть объявлен или реализован в DllMain
; и в ней не должно происходить DllMain
сборка мусора или автоматическая загрузка библиотеки.
Причины блокировки загрузчика
При внедрении платформы .NET существует два различных механизма загрузки модуля выполнения (EXE или DLL): один для Windows, который используется для неуправляемых модулей и один для среды CLR, которая загружает сборки .NET. Проблема загрузки смешанных библиотек DLL касается загрузчика ОС Microsoft Windows.
Если сборка, содержащая только конструкции .NET, загружается в процесс, загрузчик CLR может выполнять все необходимые задачи загрузки и инициализации. Однако для загрузки смешанных сборок, которые могут содержать машинный код и данные, необходимо также использовать загрузчик Windows.
Загрузчик Windows гарантирует, что код не может получить доступ к коду или данным в этой библиотеке DLL до его инициализации. И это гарантирует, что код не может избыточно загружать библиотеку DLL во время его частичной инициализации. Для этого загрузчик Windows использует глобальный критический раздел процесса (часто называемый блокировкой загрузчика), который предотвращает небезопасный доступ во время инициализации модуля. В результате процесс загрузки является уязвимым для многих случаев взаимоблокировки. Для смешанных сборок следующие две ситуации повышают риск взаимоблокировки.
Во-первых, если пользователи пытаются выполнить функции, скомпилированные на промежуточном языке Майкрософт (MSIL), когда блокировка загрузчика удерживается (например, из
DllMain
статических инициализаторов), это может привести к взаимоблокировке. Рассмотрим случай, когда функция MSIL ссылается на тип в сборке, которая еще не загружена. Среда CLR пытается автоматически загрузить эту сборку, а для этого может потребоваться установить блокировку загрузчика Windows. Возникает взаимоблокировка, так как блокировка загрузчика уже хранится кодом ранее в последовательности вызовов. Однако выполнение MSIL под блокировкой загрузчика не гарантирует, что взаимоблокировка произойдет. Это то, что делает этот сценарий сложным для диагностики и исправления. В некоторых случаях, например, если библиотека DLL указанного типа не содержит собственных конструкций, а все его зависимости не содержат собственных конструкций, загрузчик Windows не требуется для загрузки сборки .NET ссылочного типа. Кроме того, требуемая сборка или ее зависимые смешанные неуправляемые модули или модули .NET могли быть загружены другим кодом. Следовательно, взаимоблокировку трудно прогнозировать и вероятность ее возникновения зависит от конфигурации целевого компьютера.Во-вторых, при загрузке библиотек DLL в версиях 1.0 и 1.1 платформа .NET Framework среда CLR предположила, что блокировка загрузчика не была проведена, и предприняла несколько действий, недопустимых при блокировке загрузчика. Предположим, что блокировка загрузчика не проводится, является допустимым предположением только для библиотек DLL .NET. Но так как смешанные библиотеки DLL выполняют собственные подпрограммы инициализации, им требуется собственный загрузчик Windows и, следовательно, блокировка загрузчика. Таким образом, даже если разработчик не пытается выполнить какие-либо функции MSIL во время инициализации DLL, в платформа .NET Framework версии 1.0 и 1.1 по-прежнему существует небольшая вероятность недетерминированной взаимоблокировки.
Все недетерминированные ситуации при загрузке смешанных библиотек DLL исключены. Это было сделано с этими изменениями:
Среда CLR больше не делает ложных предположений при загрузке смешанных DLL.
Неуправляемая и управляемая инициализация выполняется на двух отдельных и разных этапах. Неуправляемая инициализация выполняется сначала (через
DllMain
), а затем выполняется управляемая инициализация. Поддерживаемая.cctor
NET конструкция. Последний является полностью прозрачным для пользователя, если/Zl
не используется или/NODEFAULTLIB
не используется. Дополнительные сведения см. в разделе (Пропускать библиотеки) и/Zl
(опустить имя библиотеки по умолчанию)./NODEFAULTLIB
Блокировка загрузчика все равно может произойти, но теперь эти случаи можно воспроизвести и обнаружить. Если DllMain
содержит инструкции MSIL, компилятор создает предупреждение компилятора (уровень 1) C4747. Кроме того, либо библиотека CRT, либо среда CLR попытаются определить случаи выполнения функций MSIL во время блокировки загрузчика и сообщат о них, если такие были. Если библиотека CRT обнаруживает попытку, выдается ошибка во время выполнения C R6033
Остальная часть этой статьи описывает оставшиеся сценарии, для которых MSIL может выполняться под блокировкой загрузчика. В нем показано, как устранить проблему в каждом из этих сценариев и методах отладки.
Ситуации и способы решения проблем
Существует несколько ситуаций, в которых пользовательский код может выполнять функции MSIL во время блокировки загрузчика. Разработчик должен убедиться, что реализация пользовательского кода не пытается выполнить инструкции MSIL в соответствии с каждым из этих обстоятельств. В следующих подразделах описываются все возможные ситуации, а также способы решения распространенных проблем.
DllMain
Функция DllMain
— это определяемая пользователем точка входа для библиотеки DLL. Если пользователь не указывает иное, функция DllMain
вызывается каждый раз, когда процесс или поток присоединяется к библиотеке DLL или отсоединяется от нее. Поскольку подобный вызов может произойти во время блокировки загрузчика, запрещается компилировать пользовательские функции DllMain
в код MSIL. Кроме того, в MSIL нельзя скомпилировать никакую функцию в дереве вызовов с корнем DllMain
. Чтобы устранить проблемы, блок кода, определяющий DllMain
, следует изменить с #pragma unmanaged
помощью . То же необходимо сделать для каждой функции, которая вызывается в DllMain
.
В случаях, когда эти функции должны вызывать функцию, требующую реализации MSIL для других контекстов вызовов, можно использовать стратегию дублирования, в которой создаются как .NET, так и собственная версия одной функции.
В качестве альтернативы, если DllMain
она не требуется или не требуется выполняться при блокировке загрузчика, можно удалить предоставленную DllMain
пользователем реализацию, которая устраняет проблему.
Если DllMain
пытается выполнить MSIL напрямую, появится предупреждение компилятора (уровень 1) C4747 . Однако компилятор не может обнаруживать случаи, когда DllMain
вызывает функцию в другом модуле, который, в свою очередь, пытается выполнить MSIL.
Дополнительные сведения об этом сценарии см. в разделе "Препятствия для диагностики".
Инициализация статических объектов
Инициализация статических объектов может вызвать взаимоблокировку, если требуется динамический инициализатор. Простые случаи (например, при назначении значения, известного во время компиляции статической переменной), не требуют динамической инициализации, поэтому не существует риска взаимоблокировки. Однако некоторые статические переменные инициализированы вызовами функций, вызовами конструктора или выражениями, которые нельзя оценить во время компиляции. Все эти переменные требуют выполнения кода во время инициализации модуля.
В коде, приведенном ниже, показаны примеры статических инициализаторов, для которых требуется динамическая инициализация: вызов функции, конструирование объекта и инициализация указателя. (Эти примеры не являются статическими, но предполагается наличие определений в глобальной области, которая имеет тот же эффект.)
// dynamic initializer function generated
int a = init();
CObject o(arg1, arg2);
CObject* op = new CObject(arg1, arg2);
Этот риск взаимоблокировки зависит от того, компилируется /clr
ли содержащий модуль и будет ли выполняться MSIL. В частности, если статическая переменная компилируется без /clr
(или находится в #pragma unmanaged
блоке), а динамический инициализатор, необходимый для инициализации, приводит к выполнению инструкций MSIL, может возникнуть взаимоблокировка. Это связано с тем, что для модулей, скомпилированных без /clr
, инициализация статических переменных выполняется dllMain. Напротив, статические переменные, скомпилированные с /clr
помощью, инициализированы с помощью .cctor
этапа неуправляемой инициализации, и блокировка загрузчика была выпущена.
Существует ряд решений для взаимоблокировки, вызванных динамической инициализацией статических переменных. Они организованы здесь примерно в порядке времени, необходимого для устранения проблемы:
Исходный файл, содержащий статическую переменную, можно скомпилировать с
/clr
помощью .Все функции, вызываемые статической переменной, можно скомпилировать в машинный код с помощью директивы
#pragma unmanaged
.Можно вручную клонируйте код, от которого зависит статическая переменная, создав версию .NET и неуправляемую версию с разными именами. Разработчики могут затем вызвать собственную версию из неуправляемых статических инициализаторов и вызывать версию .NET в других случаях.
Пользовательские функции, влияющие на автозагрузку
Существует несколько пользовательских функций, от которых зависит инициализация библиотек при автозагрузке. Например, при глобальной перегрузке операторов В C++, таких как new
операторы и delete
операторы, пользовательские версии используются везде, в том числе в инициализации и уничтожении стандартной библиотеки C++. В результате стандартная библиотека C++ и статические инициализаторы, предоставляемые пользователем, вызывают любые версии этих операторов.
Если они скомпилированы в код MSIL, эти инициализаторы пытаются выполнить инструкции MSIL во время блокировки загрузчика. Предоставленный пользователем malloc
результат имеет те же последствия. Чтобы устранить эту проблему, любые из этих перегрузок или пользовательских определений должны быть реализованы как машинный код с помощью директивы #pragma unmanaged
.
Дополнительные сведения об этом сценарии см. в разделе "Препятствия для диагностики".
Пользовательские языковые стандарты
Если пользователь предоставляет пользовательский глобальный языковой стандарт, этот языковой стандарт используется для инициализации всех будущих потоков ввода-вывода, включая потоки, которые статически инициализированы. Если объект глобального языкового стандарта скомпилирован в код MSIL, функции элемента этого объекта, скомпилированные в MSIL, могут быть вызваны во время блокировки загрузчика.
Существует три способа решения этой проблемы.
Исходные файлы, содержащие все глобальные определения потоков ввода-вывода, можно скомпилировать с помощью /clr
параметра. Он предотвращает выполнение статических инициализаторов под блокировкой загрузчика.
Пользовательские определения функции языкового стандарта можно скомпилировать в машинный код с помощью директивы #pragma unmanaged
.
Рекомендуется устанавливать пользовательский языковой стандарт как глобальный языковой стандарт только после отключения блокировки загрузчика. Затем следует явно настроить потоки ввода-вывода, созданные во время инициализации с использованием пользовательского языкового стандарта.
Трудности при диагностике
В некоторых случаях трудно обнаружить источник взаимоблокировок. В следующих подразделах описываются эти случаи и способы решения возникающих проблем.
Реализация в заголовках
В некоторых случаях реализация функций в файлах заголовка может затруднить диагностику. Для встроенных функций и кода шаблона требуется, чтобы функции были заданы в файле заголовка. Язык C++ указывает "правило одного определения", которое говорит о том, что все реализации функций с одинаковым именем должны быть семантически эквивалентны. Как следствие, компоновщику C++ не требуются особые предосторожности при слиянии объектных файлов с дублированными реализациями определенной функции.
В версиях Visual Studio до Visual Studio 2005 компоновщик просто выбирает наибольшее из этих семантических эквивалентных определений. Это делается для размещения объявлений пересылки и сценариев, когда различные варианты оптимизации используются для разных исходных файлов. Он создает проблему для смешанных библиотек DLL и .NET.
Так как один и тот же заголовок может включаться как файлами C++, так и включенными /clr
и отключенными, или #include можно упаковать в #pragma unmanaged
блок, можно использовать как MSIL, так и собственные версии функций, которые предоставляют реализации в заголовках. MsIL и собственные реализации имеют разные семантики для инициализации под блокировкой загрузчика, что фактически нарушает одно правило определения. Следовательно, когда компоновщик выбирает самую большую реализацию, он может выбрать версию функции MSIL, даже если она была явно скомпилирована в машинный код в другом месте с помощью директивы #pragma unmanaged
. Чтобы убедиться, что версия MSIL шаблона или встроенной функции никогда не вызывается под блокировкой загрузчика, каждое определение каждой такой функции, вызываемой под блокировкой загрузчика, необходимо изменить с #pragma unmanaged
помощью директивы. Если файл заголовка получен от стороннего поставщика, самый простой способ сделать это изменение заключается в отправке и появлении #pragma unmanaged
директивы вокруг директивы #include для некорректного файла заголовка. (См . управляемый, неуправляемый пример.) Однако эта стратегия не работает для заголовков, содержащих другой код, который должен напрямую вызывать API .NET.
Для удобства пользователей, решающих проблему блокировку загрузчика, компоновщик выбирает реализацию на машинном, а не управляемом коде, если существует две версии реализации. Это по умолчанию позволяет избежать указанных выше проблем. Однако в этом выпуске существует два исключения из-за двух неразрешенных проблем с компилятором:
- Вызов встроенной функции осуществляется через глобальный указатель статической функции. Этот сценарий является таблицей, так как виртуальные функции вызываются через глобальные указатели функций. Например,
#include "definesmyObject.h"
#include "definesclassC.h"
typedef void (*function_pointer_t)();
function_pointer_t myObject_p = &myObject;
#pragma unmanaged
void DuringLoaderlock(C & c)
{
// Either of these calls could resolve to a managed implementation,
// at link-time, even if a native implementation also exists.
c.VirtualMember();
myObject_p();
}
Диагностика в режиме отладки
Вся диагностика проблем блокировки загрузчика должна проходить в отладочных построениях. Сборки выпуска могут не создавать диагностика. И оптимизации, сделанные в режиме выпуска, могут маскировать некоторые из MSIL в сценариях блокировки загрузчика.
Отладка проблем с блокировкой загрузчика
Диагностика, которую создает среда CLR при вызове функции MSIL, приводит к тому, что CLR приостанавливает выполнение. Это, в свою очередь, приводит к приостановке отладчика смешанного режима Visual C++, а также при запуске отладчика в процессе. Однако при присоединении к процессу невозможно получить управляемый вызов для отладчика с помощью смешанного отладчика.
Чтобы определить конкретную функцию MSIL, вызванную во время блокировки загрузчика, разработчики должны выполнить следующие действия.
Убедитесь, что доступны символы для библиотек mscoree.dll и mscorwks.dll.
Символы можно сделать доступными двумя способами. Первый способ заключается в том, что PDB-файлы для библиотек mscoree.dll и mscorwks.dll можно добавить к пути поиска. Чтобы добавить их, откройте диалоговое окно параметров пути поиска символов. (Из Меню "Сервис" выберите "Параметры". В левой области диалогового окна "Параметры " откройте узел отладки и выберите "Символы".) Добавьте путь к mscoree.dll и mscorwks.dll PDB-файлам в список поиска. Эти файлы устанавливаются в каталог % VSINSTALLDIR%\SDK\v2.0\symbols. Выберите OK.
Второй способ заключается в том, что PDB-файлы для mscoree.dll и mscorwks.dll можно загрузить с сервера символов Майкрософт. Для настройки сервера символов откройте диалоговое окно параметров пути поиска символов. (Из Меню "Сервис" выберите "Параметры". В левой области диалогового окна "Параметры" откройте узел отладки и выберите "Символы".) Добавьте этот путь поиска в список поиска:
https://msdl.microsoft.com/download/symbols
Добавьте каталог кэша символов в текстовом поле кэша сервера символов. Выберите OK.Для отладчика установите режим отладки только машинного кода.
Откройте сетку свойств для запуска проекта в решении. Выберите Свойства конфигурации>Отладка. Задайте свойству "Тип отладчика" значение "Только для машинного кода".
Запустите отладчик (F5).
/clr
При создании диагностики нажмите кнопку "Повторить" и нажмите кнопку "Разрыв".Откройте окно "Стек вызовов". (В строке меню выберите Отладка>стека вызовов Windows>.) Обижающий
DllMain
или статический инициализатор определяется зеленой стрелкой. Если не определена неидентифицируемая функция, необходимо выполнить следующие действия, чтобы найти ее.Откройте окно интерпретации (в строке меню выберите "Отладка>Windows>Интерпретация".)
Введите
.load sos.dll
в окно интерпретации для загрузки службы отладки SOS.Введите
!dumpstack
в окно интерпретации , чтобы получить полный список внутреннего/clr
стека.Найдите первый экземпляр (ближе всего к нижней части стека) либо _CorDllMain (если
DllMain
проблема возникает) или _VTableBootstrapThunkInitHelperStub или GetTargetForVTableEntry (если статический инициализатор вызывает проблему). Запись в стеке сразу под этим вызовом является вызовом функции, реализованной в коде MSIL, которая была вызвана во время блокировки загрузчика.Перейдите к исходному файлу и номеру строки, определенному на предыдущем шаге, и исправьте проблему с помощью сценариев и решений, описанных в разделе "Сценарии".
Пример
Description
В следующем примере показано, как избежать блокировки загрузчика путем перемещения кода из DllMain
конструктора глобального объекта.
В этом примере есть глобальный управляемый объект, конструктор которого содержит управляемый объект, который изначально был в DllMain
. Вторая часть этого примера ссылается на сборку, создав экземпляр управляемого объекта для вызова конструктора модуля, который выполняет инициализацию.
Код
// initializing_mixed_assemblies.cpp
// compile with: /clr /LD
#pragma once
#include <stdio.h>
#include <windows.h>
struct __declspec(dllexport) A {
A() {
System::Console::WriteLine("Module ctor initializing based on global instance of class.\n");
}
void Test() {
printf_s("Test called so linker doesn't throw away unused object.\n");
}
};
#pragma unmanaged
// Global instance of object
A obj;
extern "C"
BOOL WINAPI DllMain(HINSTANCE hInstance, DWORD dwReason, LPVOID lpReserved) {
// Remove all managed code from here and put it in constructor of A.
return true;
}
В этом примере показаны проблемы при инициализации смешанных сборок:
// initializing_mixed_assemblies_2.cpp
// compile with: /clr initializing_mixed_assemblies.lib
#include <windows.h>
using namespace System;
#include <stdio.h>
#using "initializing_mixed_assemblies.dll"
struct __declspec(dllimport) A {
void Test();
};
int main() {
A obj;
obj.Test();
}
Этот код возвращает следующие выходные данные:
Module ctor initializing based on global instance of class.
Test called so linker doesn't throw away unused object.