Inizializzazione di assembly misti
Aggiornamento: novembre 2007
In Visual C++ .NET e Visual C++ 2003 le DLL compilate con l'opzione del compilatore /clr potevano causare un deadlock in modo non deterministico. Questo problema era noto come blocco del caricatore o del caricamento di DLL miste. In Visual C++ 2005, questo comportamento non deterministico è stato quasi totalmente rimosso dal processo di caricamento delle DLL miste. Esistono infatti alcuni scenari nei quali il blocco del caricatore può ancora verificarsi (in modo deterministico). Per ulteriori informazioni su questo problema, vedere "Mixed DLL Loading Problem" inMSDN Library.
In Visual C++ 2005 esiste ancora la limitazione secondo la quale il codice all'interno di DllMain non deve accedere a CLR. Questo significa che DllMain non deve chiamare direttamente o indirettamente funzioni gestite; nessun codice gestito deve essere dichiarato o implementato in DllMain; inoltre, all'interno di DllMain non deve aver luogo nessuna procedura di Garbage Collection o caricamento automatico di libreria.
Nota: |
---|
In Visual C++ 2003 era disponibile il file _vcclrit.h per semplificare l'inizializzazione delle DLL e ridurre al minimo la possibilità di un deadlock. Per Visual C++ 2005 non è più necessario l'utilizzo di _vcclrit.h, il quale genera avvisi obsoleti durante la compilazione. La strategia consigliata consiste nel rimuovere le dipendenze su questo file utilizzando la procedura riportata in Procedura: rimuovere la dipendenza da _vcclrit.h. È anche possibile, ma non consigliato, ignorare questi avvisi oppure disattivarli definendo _CRT_VCCLRIT_NO_DEPRECATE prima di includere _vcclrit.h. |
Cause del blocco del caricatore
Con l'introduzione della piattaforma .NET sono stati resi disponibili due distinti meccanismi per il caricamento di un modulo di esecuzione (EXE o DLL): uno per Windows, che viene utilizzato per i moduli non gestiti, e uno per Common Language Runtime (CLR) di .NET, che consente il caricamento di assembly .NET. Il problema del caricamento delle DLL miste verte intorno al caricatore del sistema operativo Microsoft Windows.
Quando in un processo viene caricato un assembly contenente solo costrutti .NET, il caricatore CLR stesso può eseguire tutte le necessarie attività di inizializzazione e caricamento. Tuttavia, per gli assembly misti, è necessario utilizzare anche il caricatore di Windows, in quanto possono contenere codice e dati nativi.
Il caricatore di Windows garantisce che nessun codice possa accedere a codice o dati in quella DLL prima che sia inizializzata e che nessun codice possa caricare in modo ridondante la DLL se parzialmente inizializzata. Per ottenere questo risultato, il caricatore di Windows utilizza una sezione di importanza globale sul processo (spesso chiamata "blocco del caricatore") che impedisce accessi non sicuri durante l'inizializzazione del modulo. Ne deriva che il processo di caricamento è vulnerabile a molti classici scenari di deadlock. Per gli assembly misti, i due scenari riportati di seguito aumentano il rischio di deadlock:
Primo scenario: il deadlock può verificarsi se gli utenti tentano di eseguire funzioni compilate in codice MSIL (Microsoft Intermediate Language) quando il blocco del caricatore è attivo, ad esempio tramite DllMain oppure in inizializzatori statici. Si consideri il caso in cui la funzione MSIL fa riferimento a un tipo in un assembly non caricato. CLR tenterà di caricare automaticamente l'assembly, il quale potrebbe richiedere al caricatore di Windows di attivare il blocco sul blocco del caricatore. Poiché il blocco del caricatore è già stato attivato dal codice in una fase precedente della sequenza di chiamate, si verifica un deadlock. L'esecuzione di codice MSIL con il blocco del caricatore attivo non implica necessariamente il verificarsi di un deadlock. Per questo motivo, questo scenario è difficile da diagnosticare e correggere. In alcune circostanze, ad esempio laddove la DLL del tipo a cui si fa riferimento non contiene alcun costrutto nativo e tutte le relative dipendenze non contengono costrutti nativi, non è necessario utilizzare il caricatore di Windows per caricare l'assembly .NET del tipo a cui si fa riferimento. Inoltre, l'assembly richiesto o le relative dipendenze .NET/native miste possono essere già state caricate da altro codice. Di conseguenza, il verificarsi di un deadlock può essere difficile da prevedere e può variare a seconda della configurazione della macchina di destinazione.
Secondo scenario: quando si caricavano DLL nelle versioni 1.0 e 1.1 di .NET Framework, CLR presupponeva che il blocco del caricatore non fosse attivo ed eseguiva numerose operazioni che non erano valide con il blocco del caricatore attivo. La mancata attivazione del blocco del caricatore è un presupposto valido per le DLL puramente .NET, tuttavia poiché le DLL miste eseguono routine di inizializzazione native, esse richiedono il caricatore di Windows nativo e quindi il blocco del caricatore. Di conseguenza, anche se lo sviluppatore non tentava di eseguire funzioni MSIL durante l'inizializzazione delle DLL, esisteva comunque una piccola possibilità che si verificasse un deadlock non deterministico con le versioni 1.0 e 1.1 di .NET Framework.
In Visual C++ 2005, questo comportamento non deterministico è stato quasi totalmente rimosso dal processo di caricamento delle DLL miste. Questo risultato è stato raggiunto apportando le seguenti modifiche:
CLR non si basa più su falsi presupposti durante il caricamento di DLL miste.
L'inizializzazione gestita e non gestita viene eseguita in due fasi separate e distinte. Ha luogo prima l'inizializzazione non gestita (tramite DllMain), quindi viene eseguita l'inizializzazione gestita, tramite un costrutto supportato da .NET denominato .cctor. L'inizializzazione gestita è completamente trasparente all'utente, a meno che non si utilizzi /Zl o /NODEFAULTLIB. Per ulteriori informazioni, vedere /NODEFAULTLIB (Ignora librerie) e /Zl (Omette il nome della libreria predefinita).
Il blocco del caricatore può comunque ancora verificarsi, ma avviene in modo riproducibile e pertanto è individuabile. Se DllMain contiene istruzioni MSIL, il compilatore genererà l'avviso Avviso del compilatore (livello 1) C4747. Inoltre, CRT o CLR tenteranno di rilevare e segnalare gli eventuali tentativi di eseguire codice MSIL con il blocco del caricatore attivo. Il rilevamento di CRT genererà l'errore R6033 di runtime del linguaggio C.
Di seguito vengono descritti altri scenari nei quali il codice MSIL può essere eseguito con il blocco del caricatore attivo. Vengono inoltre fornite le soluzioni possibili per ciascun scenario e le tecniche di debug.
Scenari e soluzioni alternative
Ci sono diverse situazioni in cui il codice utente può eseguire codice MSIL con il blocco del caricatore attivo. Lo sviluppatore deve garantire che l'implementazione del codice utente non tenti di eseguire istruzioni MSIL in nessuna di queste circostanze. Nelle seguenti sottosezioni vengono descritte tutte le possibilità e viene indicato come risolvere i problemi nei casi più frequenti.
DllMain
Inizializzatori statici
Funzioni fornite dall'utente che influiscono sull'avvio
Impostazioni internazionali personalizzate
DllMain
La funzione DllMain è un punto di ingresso definito dall'utente per una DLL. Salvo diversamente specificato dall'utente, la funzione DllMain viene richiamata ogni volta che un processo o un thread si connette o si disconnette dalla DLL che lo contiene. Poiché questa chiamata può verificarsi mentre il blocco del caricatore è attivo, in MSIL non deve essere compilata nessuna funzione DllMain fornita dall'utente. Inoltre, nessuna funzione nella struttura delle chiamate che ha origine nella funzione DllMain può essere compilata in MSIL. Per risolvere questi problemi, il blocco di codice che definisce DllMain deve essere modificato con un blocco #pragma unmanaged. Lo stesso vale per ciascuna funzione chiamata da DllMain.
Nei casi in cui queste funzioni devono chiamare una funzione che richiede un'implementazione MSIL per altri contesti di chiamata, è possibile utilizzare una strategia di duplicazione in cui vengono create sia una versione .NET che una versione nativa della stessa funzione.
In alternativa, se la funzione DllMain non è necessaria o non richiede l'esecuzione con il blocco del caricatore attivo, è possibile rimuovere l'implementazione di DllMain fornita dall'utente, risolvendo così il problema.
Se la funzione DllMain tenta di eseguire codice MSIL direttamente, verrà restituito un Avviso del compilatore (livello 1) C4747. Il compilatore, tuttavia, non rileva i casi in cui DllMain chiama una funzione in un altro modulo che a sua volta tenta di eseguire codice MSIL.
Per ulteriori informazioni su questo scenario, vedere "Limiti alla diagnosi".
Inizializzazione di oggetti statici
L'inizializzazione di oggetti statici può determinare un deadlock se è richiesto un inizializzatore dinamico. Nei casi semplici, ad esempio quando una variabile statica viene semplicemente assegnata a un valore noto in fase di compilazione, non è necessaria alcuna inizializzazione dinamica, quindi non vi è rischio di deadlock. Per le variabili statiche inizializzate da chiamate di funzioni, chiamate di costruttore o espressioni che non possono essere calcolate in fase di compilazione è tuttavia necessario disporre del codice da eseguire durante l'inizializzazione del modulo.
Nel codice riportato di seguito vengono illustrati esempi di inizializzatori statici che richiedono l'inizializzazione dinamica: una chiamata di funzione, una costruzione di oggetto e l'inizializzazione di un puntatore. Questi esempi non sono statici, ma si presuppone che siano definiti in ambito globale, situazione che produce lo stesso effetto.
// dynamic initializer function generated
int a = init();
CObject o(arg1, arg2);
CObject* op = new CObject(arg1, arg2);
Un deadlock si verifica con maggiori probabilità se il modulo contenente viene compilato con /clr e se verrà eseguito codice MSIL. In particolare, se la variabile statica viene compilata senza /clr (o risiede in un blocco #pragma unmanaged) e l'inizializzatore dinamico richiesto per inizializzarla determina l'esecuzione di istruzioni MSIL, è possibile che si verifichi il deadlock. Questo avviene perché, per moduli compilati senza /clr, l'inizializzazione di variabili statiche viene eseguita da DllMain. Le variabili statiche compilate con /clr, al contrario, vengono inizializzate dal costrutto .cctor dopo il completamento della fase di inizializzazione non gestita e il rilascio del blocco del caricatore.
Esistono numerose soluzioni per il deadlock causato dall'inizializzazione dinamica di variabili statiche (elencate indicativamente in ordine di tempo richiesto per correggere il problema):
Il file di origine contenente la variabile statica può essere compilato con /clr.
Tutte le funzioni chiamate dalla variabile statica possono essere compilate in codice nativo utilizzando la direttiva #pragma unmanaged.
È possibile clonare manualmente il codice da cui dipende la variabile statica, fornendo sia una versione .NET che una versione nativa con nomi diversi. Gli sviluppatori possono quindi chiamare la versione nativa dagli inizializzatori statici nativi e la versione .NET da altri punti.
Funzioni fornite dall'utente che influiscono sull'avvio
Esistono numerose funzioni fornite dall'utente da cui dipendono le librerie per l'inizializzazione durante l'avvio. Ad esempio, durante l'overload globale di operatori in C++, quali gli operatori new e delete, le versioni fornite dall'utente vengono utilizzate ovunque, incluso nell'inizializzazione e nell'eliminazione delle librerie STL. Ne deriva che gli inizializzatori statici forniti dall'utente e STL richiameranno qualsiasi versione fornita dall'utente di questi operatori.
Se le versioni fornite dall'utente sono compilate in codice MSIL, questi inizializzatori tenteranno di eseguire le istruzioni MSIL mentre il blocco del caricatore è attivo. Un malloc fornito dall'utente ha le stesse conseguenze. Per risolvere il problema, tutti questi overload o tutte queste definizioni fornite dell'utente devono essere implementate come codice nativo utilizzando la direttiva #pragma unmanaged.
Per ulteriori informazioni su questo scenario, vedere "Limiti alla diagnosi".
Impostazioni internazionali personalizzate
Le eventuali impostazioni internazionali globali personalizzate fornite dall'utente saranno utilizzate per l'inizializzazione di tutti i flussi I/O futuri, inclusi quelli inizializzati in modo statico. Se l'oggetto impostazioni internazionali globali viene compilato in codice MSIL, è possibile che le funzioni membro dell'oggetto impostazioni internazionali compilate in MSIL siano richiamate mentre il blocco del caricatore è attivo.
Esistono tre soluzioni a questo problema:
I file di origine contenenti tutte le definizioni di flussi I/O globali possono essere compilati utilizzando l'opzione /clr. In questo modo verrà impedita l'esecuzione degli inizializzatori statici con il blocco del caricatore attivo.
Le definizioni di funzione impostazioni internazionali personalizzate possono essere compilate in codice nativo utilizzando la direttiva #pragma unmanaged.
Si consiglia di non impostare le impostazioni internazionali personalizzate come impostazioni internazionali globali fintanto che il blocco del caricatore non viene rilasciato. Configurare quindi in modo esplicito i flussi I/O creati durante l'inizializzazione con le impostazioni internazionali personalizzate.
Limiti alla diagnosi
In alcuni casi è difficile individuare l'origine dei deadlock. Nelle sottosezioni riportate di seguito vengono descritti questi scenari e i modi per ovviare ai problemi.
Implementazione nei file di intestazione
Con Visual C++ .NET, Visual C++ .NET 2003 e in pochi casi con Visual C++ 2005 le implementazioni di funzioni all'interno di file di intestazione possono complicare la diagnosi. Le funzioni inline e il codice di modello richiedono entrambi la specifica di funzioni in un file di intestazione. Il linguaggio C++ specifica la regola di definizione unica, in base alla quale tutte le implementazioni di funzioni con lo stesso nome si equivalgono a livello semantico. Di conseguenza, per il linker di C++ non sono necessarie considerazioni speciali quando si esegue l'unione di file oggetto per i quali sono disponibili implementazioni duplicate di una data funzione.
In Visual C++ .NET e Visual C++ .NET 2003 il linker sceglie semplicemente la più lunga tra le definizioni semanticamente equivalenti in modo da contenere scenari e dichiarazioni con prototipo quando vengono utilizzate opzioni di ottimizzazione differenti per file di origine diversi. Tale situazione implica un problema con le DLL miste .NET e native.
Poiché la stessa intestazione può essere inclusa da un file CPP con l'opzione /clr sia attivata che disattivata,oppure #include può essere incapsulato all'interno di un blocco #pragma unmanaged, è possibile avere versioni sia MSIL che native di funzioni che forniscono implementazioni nelle intestazioni. Le implementazioni MSIL e native hanno una semantica differente in relazione all'inizializzazione con il blocco del caricatore attivo. Questo viola effettivamente la regola di definizione unica. Di conseguenza, quando il linker sceglie l'implementazione più lunga, è possibile che adotti la versione MSIL di una funzione, anche se è stata compilata in modo esplicito in codice nativo in un altro punto utilizzando la direttiva #pragma non gestita. Per assicurarsi che una versione MSIL di una funzione modello o inline non sia mai chiamata con il blocco del caricatore attivo, ciascuna definizione di questo tipo di funzione chiamata con il blocco del caricatore attivo deve essere modificata utilizzando la direttiva #pragma unmanaged. Se il file di intestazione è di altri produttori, il metodo più semplice per ottenere questo risultato consiste spesso nell'inserire e visualizzare la direttiva #pragma non gestita accanto alla direttiva #include per il file di intestazione che crea il problema. Per un esempio, vedere managed, unmanaged. Questa strategia non è tuttavia valida nel caso di intestazioni contenenti altro codice che deve chiamare direttamente le API .NET.
In Visual C++ 2005, per facilitare la gestione del blocco del caricatore da parte degli utenti, il linker sceglierà l'implementazione nativa invece dell'implementazione gestita, se vengono offerte entrambe. In questo modo si evitano i problemi riportati sopra. In questa versione ci sono tuttavia due eccezioni a questa regola a causa di due problemi irrisolti con il compilatore:
- La chiamata di una funzione inline avviene tramite un puntatore a funzione statico globale. Questo scenario è particolarmente degno di nota perché le funzioni virtuali vengono chiamate tramite puntatori a funzione globali. Esempio:
#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();
}
- Con la compilazione dedicata a Itanium, c'è un errore nell'implementazione di tutti i puntatori a funzione. Nel frammento di codice riportato sopra, se foo_p fosse definito localmente all'interno di during_loaderlock(), la chiamata potrebbe risolversi in un'implementazione gestita.
Diagnosi in modalità di debug
Tutte le diagnosi di problemi di blocco del caricatore devono essere eseguite con build di debug. È possibile che le build di rilascio non producano informazioni utili per la diagnostica e che le ottimizzazioni eseguite in modalità di rilascio mascherino codice MSIL in presenza di scenari di blocco del caricatore.
Debug dei problemi di blocco del caricatore
La diagnostica generata da CLR quando viene richiamata una funzione MSIL causa la sospensione dell'esecuzione di CLR. Questo causa a sua volta la sospensione del debugger in modalità mista di Visual C++ 2005 quando viene eseguito l'oggetto del debug all'interno del processo. Tuttavia, nella connessione al processo, non è possibile ottenere uno stack di chiamate gestito per l'oggetto del debug utilizzando il debugger in modalità mista.
Per identificare la funzione MSIL specifica chiamata con il blocco del caricatore attivato, gli sviluppatori devono effettuare quanto riportato di seguito:
Assicurarsi che siano disponibili simboli per mscoree.dll e mscorwks.dll.
Questa operazione può essere eseguita in due modi. È innanzitutto possibile aggiungere i PDB per mscoree.dll e mscorwks.dll al percorso di ricerca dei simboli. A tale scopo, aprire la finestra di dialogo contenente le opzioni del percorso di ricerca dei simboli. Scegliere Opzioni dal menu Strumenti. Nel riquadro di sinistra della finestra di dialogo Opzioni aprire il nodo Debug e fare clic su Simboli. Aggiungere il percorso dei file PDB mscoree.dll e mscorwks.dll all'elenco di ricerca. Questi file PDB sono installati in %VSINSTALLDIR%\SDK\v2.0\symbols. Scegliere OK.
È anche possibile scaricare i PDB per mscoree.dll e mscorwks.dll da Microsoft Symbol Server. Per configurare Microsoft Symbol Server, aprire la finestra di dialogo che contiene le opzioni del percorso di ricerca dei simboli. Scegliere Opzioni dal menu Strumenti. Nel riquadro di sinistra della finestra di dialogo Opzioni aprire il nodo Debug e fare clic su Simboli. Aggiungere all'elenco di ricerca il seguente percorso: http://msdl.microsoft.com/download/symbols. Aggiungere una directory cache per i simboli nella casella di testo relativa alla cache del server di simboli. Scegliere OK.
Impostare la modalità del debugger sulla modalità solo nativa.
In questo caso, aprire la griglia delle proprietà per il progetto di avvio nella soluzione. Nella sottostruttura Proprietà di configurazione selezionare il nodo Debug. Impostare il campo Tipo debugger sull'opzione per il supporto solo nativo.
Avviare il debugger (F5).
Quando viene generata la diagnostica /clr, fare clic su Riprova, quindi su Interrompi.
Aprire la finestra dello stack di chiamate scegliendo Finestre dal menu Debug, quindi Stack di chiamate. La funzione DllMain o l'inizializzatore statico che crea il problema viene identificato con una freccia verde. Se la funzione che crea il problema non viene identificata, è necessario eseguire la procedura riportata di seguito per trovarla.
Aprire la finestra di controllo immediato scegliendo Finestre dal menu Debug, quindi Controllo immediato.
Digitare .load sos.dll nella finestra di controllo immediato per caricare il servizio di debug SOS.
Digitare !dumpstack nella finestra di controllo immediato per visualizzare un elenco completo dello stack /clr interno.
Cercare la prima istanza (la più vicina alla fine dello stack) di _CorDllMain, se è la funzione DllMain a creare il problema, oppure di _VTableBootstrapThunkInitHelperStub o GetTargetForVTableEntry, se è l'inizializzatore statico a creare il problema. La voce riportata sotto questa chiamata corrisponde alla chiamata della funzione implementata MSIL che ha tentato l'esecuzione con il blocco del caricatore attivo.
Passare al file di origine e al numero di riga identificati al passaggio 9 e correggere il problema utilizzando gli scenari e le soluzioni descritti nella sezione Scenari.
Esempio
Descrizione
Nell'esempio riportato di seguito viene illustrato come evitare il blocco del caricatore spostando il codice da DllMain nel costruttore di un oggetto globale.
In questo esempio, c'è un oggetto gestito globale il cui costruttore contiene l'oggetto gestito che era originariamente in DllMain. La seconda parte di questo esempio fa riferimento all'assembly, creando un'istanza dell'oggetto gestito per richiamare il costruttore del modulo che esegue l'inizializzazione.
Codice
// 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;
}
Esempio
Codice
// 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();
}
Output
Module ctor initializing based on global instance of class.
Test called so linker does not throw away unused object.