Инициализация смешанных сборок

Статья
11/05/2008

Обновлен: Ноябрь 2007

В Visual C++ .NET и Visual C++ 2003 библиотеки DLL, которые компилируются с параметром /clr, могут случайным образом создать ситуацию взаимоблокировки при загрузке. Подобная ситуация называется проблемой загрузки смешанных библиотек DLL или блокировки загрузчика. В Visual C++ 2005 почти все недетерминированные ситуации при загрузке смешанных библиотек DLL исключены. Однако остаются несколько определенных случаев, в которых может произойти блокировка загрузчика. Дополнительные сведения см. в статье "Проблема при загрузке смешанных библиотек DLL" библиотеки MSDN.

В среде Visual C++ 2005 по-прежнему существует ограничение, которое заключается в том, что код в функции DllMain не должен обращаться к среде CLR. Это означает, что функция DllMain не должна вызывать управляемые функции напрямую или косвенно; в функции DllMain запрещается объявлять или реализовывать неуправляемый код; также в функции DllMain запрещается выполнять сборку мусора или автоматическую загрузку библиотек.

Примечание.
В Visual C++ 2003 предоставлен файл _vcclrit.h, обеспечивающий средства для инициализации библиотеки DLL с минимальным риском возникновения взаимоблокировки. В среде Visual C++ 2005 нет необходимости использовать файл _vcclrit.h, а если он все же используется, то во время компиляции выдаются предупреждения об устаревшей версии. Рекомендуемая стратегия состоит в удалении зависимостей от этого файла в соответствии с процедурой, описанной в разделе Практическое руководство. Удаление зависимости от _vcclrit.h. Менее подходящее решение заключается в подавлении предупреждений с помощью объявления _CRT_VCCLRIT_NO_DEPRECATE перед включением файла _vcclrit.h или в простом пропуске предупреждений.

В Visual C++ 2003 предоставлен файл _vcclrit.h, обеспечивающий средства для инициализации библиотеки DLL с минимальным риском возникновения взаимоблокировки. В среде Visual C++ 2005 нет необходимости использовать файл _vcclrit.h, а если он все же используется, то во время компиляции выдаются предупреждения об устаревшей версии. Рекомендуемая стратегия состоит в удалении зависимостей от этого файла в соответствии с процедурой, описанной в разделе Практическое руководство. Удаление зависимости от _vcclrit.h. Менее подходящее решение заключается в подавлении предупреждений с помощью объявления _CRT_VCCLRIT_NO_DEPRECATE перед включением файла _vcclrit.h или в простом пропуске предупреждений.

Причины блокировки загрузчика

После введения платформы .NET появились два механизма загрузки исполняемых модулей (EXE или DLL): один для Windows, который используется для неуправляемых модулей, и другой для среды CLR .NET, загружающий сборки .NET. Проблема загрузки смешанных библиотек DLL касается загрузчика ОС Microsoft Windows.

Если в процесс загружается сборка, содержащая только конструкции .NET, загрузчик CLR сам может выполнить все необходимые задачи загрузки и инициализации. Однако для смешанных сборок, так как они могут содержать машинный код и неуправляемые данные, необходимо использовать и загрузчик Windows.

Загрузчик Windows гарантирует, что никакая часть кода не получит доступ к коду или данным в этой библиотеке DLL перед тем, как она будет инициализирована, и что никакая часть кода не сможет загрузить DLL, если она частично инициализирована. Для этого загрузчик Windows используется глобальный для всего процесса критический раздел (часто называемый "блокировкой загрузчика"), предотвращающий небезопасное обращение во время инициализации модуля. В результате процесс загрузки является уязвимым для многих случаев взаимоблокировки. Для смешанных сборок следующие две ситуации повышают риск возникновения взаимоблокировки.

Первая ситуация возникает, если пользователи пытаются выполнить функции, скомпилированные в код MSIL, во время блокировки загрузчика (например, в функции DllMain или в статических инициализаторах) — это может вызвать взаимоблокировку. Рассмотрим случай, в котором функция MSIL ссылается на тип в еще не загруженной сборке. Среда CLR пытается автоматически загрузить эту сборку, а для этого может потребоваться установить блокировку загрузчика Windows. Так как в коде, вызванном ранее, уже происходит блокировка загрузчика, это вызывает взаимоблокировку. Однако выполнение функции MSIL во время блокировки не обязательно приводит к появлению взаимоблокировки, поэтому данную ситуацию трудно диагностировать и исправить. При некоторых обстоятельствах, например если библиотека DLL ссылочного типа и все зависимые от нее модули не содержат неуправляемых конструкций, для загрузки сборки .NET ссылочного типа загрузчик Windows не требуется. Кроме этого, требуемая сборка или ее зависимые смешанные неуправляемые модули или модули .NET могли быть загружены другим кодом. Следовательно, взаимоблокировку трудно прогнозировать, вероятность ее возникновения зависит от конфигурации целевого компьютера.
Вторая ситуация происходит при загрузке библиотек DLL на платформе .NET Framework версии 1.0 и 1.1, когда среда CLR предполагает, что блокировка загрузчика не используется, и выполняет несколько действий, которые являются недопустимыми во время блокировки загрузчика. Предположение об отсутствии блокировки загрузчика верно только для чистых DLL-библиотек .NET, тогда как смешанные библиотеки DLL выполняют неуправляемые процедуры инициализации, для которых требуется загрузчик Windows и, следовательно, блокировка загрузчика. Как следствие, даже если разработчик не пытается выполнить какие-либо функции MSIL во время инициализации библиотеки DLL, все равно есть небольшая вероятность возникновения взаимоблокировки для платформы .NET Framework версии 1.0 и 1.1.

В среде Visual C++ 2005 все недетерминированные ситуации при загрузке смешанных библиотек DLL исключены. Этого удалось достигнуть за счет следующих изменений.

Среда CLR больше не делает ложных предположений при загрузке смешанных DLL.
Неуправляемая и управляемая инициализация выполняются на двух отдельных этапах. Сначала выполняется неуправляемая инициализация (через DllMain), а управляемая инициализация выполняется после с помощью поддерживаемой .NET конструкции .cctor. Последняя конструкция полностью прозрачная для пользователей, если только не используется параметр /Zl или /NODEFAULTLIB. Дополнительные сведения см. в разделах Параметр /NODEFAULTLIB (пропуск библиотек) и /Zl (Опущенное по умолчанию имя библиотеки).

Блокировка загрузчика все равно может произойти, но теперь эти случаи можно воспроизвести и обнаружить. Если функция DllMain содержит инструкции MSIL, компилятор выдаст предупреждение Предупреждение компилятора (уровень 1) C4747. Кроме того, либо библиотека CRT, либо среда CLR попытаются определить случаи выполнения функций MSIL во время блокировки загрузчика и сообщат о них, если такие были. Если библиотека CRT обнаруживает попытку исполнения кода MSIL, то выдается ошибка во время выполнения C R6033.

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

Ситуации и их решение

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

DllMain
Статические инициализаторы
Пользовательские функции, влияющие на автозагрузку
Пользовательские языковые стандарты

DllMain

Функция DllMain — это определяемая пользователем точка входа для библиотеки DLL. Если пользователь не указывает иное, функция DllMain вызывается каждый раз, когда процесс или поток присоединяется к библиотеке DLL или отсоединяется от нее. Так как подобный вызов может произойти во время блокировки загрузчика, запрещается компилировать пользовательские функции DllMain в код MSIL. Кроме того, никакую функцию в дереве вызовов с корнем DllMain нельзя скомпилировать в MSIL. Для решения этой проблемы блок кода, в котором задается функция 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, пользовательские версии используются повсеместно, включая инициализацию и уничтожение библиотеки STL. В результате STL и пользовательские статически инициализаторы вызывают только пользовательские версии этих операторов.

Если они скомпилированы в код MSIL, эти инициализаторы пытаются выполнить инструкции MSIL во время блокировки загрузчика. Перегрузка функции выделения памяти malloc приводит к тем же результатам. Для решения этой проблемы все подобные перегрузки или пользовательские определения необходимо реализовать в машинном коде с помощью директивы #pragma unmanaged.

Дополнительные сведения об этой ситуации см. в разделе "Трудности при диагностике".

Пользовательские языковые стандарты

Если пользователь применяет глобальный пользовательский языковой стандарт, он используется для инициализации всех будущих потоков ввода-вывода, включая статически инициализируемые потоки. Если объект глобального языкового стандарта скомпилирован в код MSIL, функции элемента этого объекта, скомпилированные в MSIL, могут быть вызваны во время блокировки загрузчика.

Существует три метода решения этой проблемы.

Исходные файлы, содержащие все глобальные определения потока ввода-вывода, можно скомпилировать с использованием параметра /clr. Это предотвратит выполнение статической инициализации во время блокировки загрузчика.

Определения функций пользовательского языкового стандарта можно скомпилировать в машинный код с помощью директивы #pragma unmanaged.

Рекомендуется устанавливать пользовательский языковой стандарт как глобальный языковой стандарт только после отключения блокировки загрузчика. Затем следует явно настроить потоки ввода-вывода, созданные во время инициализации с использованием пользовательского языкового стандарта.

Трудности при диагностике

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

Реализация в заголовках

При использовании Visual C++ .NET, Visual C++ .NET 2003 и в некоторых случаях Visual C++ 2005 реализация функций в файлах заголовка может затруднить диагностику. Для встроенных функций и кода шаблона требуется, чтобы функции были заданы в файле заголовка. Язык C++ указывает "правило одного определения", которое говорит о том, что все реализации функций с одинаковым именем должны быть семантически эквивалентны. Как следствие, компоновщику C++ не требуются особые предосторожности при слиянии объектных файлов с дублированными реализациями определенной функции.

В Visual C++ .NET и Visual C++ .NET 2003 компоновщик просто выбирает самое большое из этих семантически эквивалентных определений, чтобы использовать упреждающие объявления и различные параметры оптимизации для разных исходных файлов. Это создает проблему для смешанных библиотек DLL.

Так как один и тот же заголовок может быть включен как файлами CPP с включенным параметром /clr, так и с отключенным параметром, или блок директивы #include может быть размещен в блоке #pragma unmanaged, для функций, реализованных в заголовке, возможно одновременное существование версии MSIL и версии в машинном коде. Эти реализации обладают различной семантикой по отношению к инициализации во время блокировки загрузчика, что нарушает правило одного определения. Как следствие, когда компоновщик выбирает самую большую реализацию, он может выбрать MSIL-реализацию функции, даже если она была явно скомпилирована в машинный код в другой части кода с помощью директивы #pragma unmanaged. Для предотвращения вызова MSIL-версии встроенной функции или шаблона во время блокировки загрузчика, в каждое определение подобной функции, вызываемой во время блокировки загрузчика, необходимо добавить директиву #pragma unmanaged. Если файл заголовка предоставлен сторонним поставщиком, самый простой способ сделать это — поместить директиву #pragma unmanaged в стек и восстановить ее из стека вокруг директивы #include файла заголовка, вызывающего проблему. (Пример см. в разделе managed, unmanaged). Однако этот метод не действует для заголовков, содержащих другой код, который напрямую вызывает API-интерфейсы .NET.

В среде Visual C++ 2005 для удобства пользователей, решающих проблему блокировку загрузчика, компоновщик выбирает реализацию на машинном коде, если существует две версии реализации. Это позволяет предотвратить проблемы, описанные выше. Однако в этой версии существуют два исключения из этого правила из-за двух нерешенных проблем компилятора.

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

#include "definesfoo.h"
#include "definesclassC.h"

typedef void (*function_pointer_t)();

function_pointer_t foo_p = &foo;

#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();
    foo_p();
}

В компиляции для платформы Itanium присутствует ошибка в реализации всех указателей функции. В примере кода, приведенном выше, если указатели foo_p определены локально внутри функции during_loaderlock(), вызов также может привести к выполнению управляемой реализации.

Диагностика в режиме отладки

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

Отладка проблем при блокировке загрузчика

Диагностика, которую создает среда CLR при вызове функции MSIL, приводит к тому, что CLR приостанавливает выполнение. Это, в свою очередь, приводит к тому, что отладчик смешанного режима Visual C++ 2005 также приостанавливает выполнение отлаживаемого кода. Однако при присоединении к процессу невозможно получить управляемый стек вызовов для отлаживаемого кода с помощью смешанного отладчика.

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

Убедиться, что доступны символы для библиотек mscoree.dll и mscorwks.dll.

Это можно сделать двумя способами. Способ первый заключает в том, что PDB-файлы для библиотек mscoree.dll и mscorwks.dll можно добавить к пути поиска символов. Для этого откройте диалоговое окно пути поиска символов. (В меню "Сервис" выберите "Параметры". В левой части диалогового окна "Параметры" раскройте узел "Отладка" и выберите "Символы"). Добавьте путь к PDB-файлам библиотек mscoree.dll и mscorwks.dll в список поиска. Эти файлы устанавливаются в каталог %VSINSTALLDIR%\SDK\v2.0\symbols. Нажмите кнопку "ОК".

Второй способ заключается в том, что PDB-файлы для mscoree.dll и mscorwks.dll можно загрузить с сервера символов Майкрософт. Для настройки сервера символов откройте диалоговое окно параметров пути поиска символов. (В меню "Сервис" выберите "Параметры". В левой части диалогового окна "Параметры" раскройте узел "Отладка" и выберите "Символы"). Добавьте следующий путь в список поиска: http://msdl.microsoft.com/download/symbols. Добавьте каталог кэша символов в текстовом поле кэша сервера символов. Нажмите кнопку "ОК".
Для отладчика установите режим отладки только машинного кода.

Для этого откройте сетку "Свойства" для автозагружаемого проекта в решении. В поддереве "Свойства конфигурации" выберите узел "Отладка". В поле "Тип отладчика" выберите пункт "Только машинный код".
Запустите отладчик (F5).
После создания диагностики /clr нажмите кнопку "Повторить", а затем нажмите кнопку "Прервать".
Откройте окно "Стек вызовов". (В меню "Отладка" выделите пункт "Окна" и выберите команду "Стек вызовов"). Если функция DllMain или статический инициализатор вызывают неполадки, они отмечаются зеленой стрелкой. Если функция, вызывающая неполадки, не определена, необходимо выполнить следующие действия, чтобы найти ее.
Откройте окно интерпретации (в меню "Отладка" выделите пункт "Окна", а затем выберите "Интерпретация").
Введите ".load.sos.dll" в окне интерпретации, чтобы загрузить службу отладки SOS.
Введите "!dumpstack" в окне интерпретации, чтобы получить полный текст стека /clr.
Найдите первый экземпляр (самый близкий ко дну стека) _CorDllMain (если проблему вызывает функция DllMain) или первый экземпляр _VTableBootstrapThunkInitHelperStub или GetTargetForVTableEntry (если проблему вызывает статический инициализатор). Запись в стека сразу под этим вызовом является вызовом функции, реализованной в коде MSIL, которая была вызвана во время блокировки загрузчика.
Перейдите к строке файла исходного кода, определенной на шаге 9, и исправьте проблему, как описано в разделе "Ситуации".

Пример

Описание

В следующем примере показано, как избежать блокировки загрузчика, переместив код из функции 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 does not 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 does not throw away unused object.

См. также

Основные понятия

Смешанные (собственные и управляемые) сборки

Share via

Инициализация смешанных сборок

Причины блокировки загрузчика

Ситуации и их решение

DllMain

Инициализация статических объектов

Пользовательские функции, влияющие на автозагрузку

Пользовательские языковые стандарты

Трудности при диагностике

Реализация в заголовках

Диагностика в режиме отладки

Отладка проблем при блокировке загрузчика

Пример

Описание

Код

Пример

Код

Результат

См. также

Основные понятия

Дополнительные ресурсы