Décoder les blobs d'attributs personnalisés : des octets de #Blob jusqu'à [Cache(30, ...)]
L'application d'un attribut n'est pas stockée sous forme de code source. C'est un blob binaire dans le tas #Blob : un prologue, les arguments positionnels sérialisés selon la signature du constructeur, puis une liste comptée de valeurs de champs et de propriétés nommés. Voici la disposition exacte des octets et comment Glass.NET la reconvertit en un attribut C#.
La plupart des constructions C# se traduisent en instructions IL. Pas les attributs : l”application d”un attribut se compile en données, un enregistrement binaire compact stocké dans le tas #Blob et pointé par une ligne de la table de métadonnées CustomAttribute. Il n”y a pas de code à relire, seulement des octets à décoder, et le décodage est piloté par une signature qui réside dans un tout autre endroit. Se tromper sur l”étiquette champ-ou-propriété d”un argument nommé, ou mal lire le nom de type intégré d”une énumération, produit un attribut qui semble plausible et se lie au mauvais membre. Cet article parcourt la disposition exacte des octets et montre ce que reconstruit Glass.NET.
Le code source
Un seul attribut, portant deux arguments positionnels et deux arguments nommés (l”un une propriété, l”autre un champ), suffit à exercer chaque partie du format :
using System;
[AttributeUsage(AttributeTargets.Class)]
sealed class CacheAttribute : Attribute
{
public CacheAttribute(int seconds, string region)
{
Seconds = seconds;
Region = region;
}
public int Seconds { get; }
public string Region { get; }
public bool SlidingExpiration { get; set; } // property
public int Priority; // field
}
[Cache(30, "catalog", SlidingExpiration = true, Priority = 5)]
sealed class ProductService { }
L”application sur ProductService dit : appelle le constructeur (int, string) avec 30 et "catalog", puis affecte true à la propriété SlidingExpiration et 5 au champ Priority. Aucun de ces noms de membre ni de ces valeurs n”est stocké sous forme de texte dans le code source ; ils sont sérialisés dans un blob dont la forme est fixée par ECMA-335 §II.23.3.
Ce que contiennent réellement les métadonnées
ildasm et la vue IL de Glass restituent tous deux l”application sous la forme d”une référence au constructeur suivie du blob brut :
.custom instance void CacheAttribute::.ctor(int32, string) = (
01 00 1E 00 00 00 07 63 61 74 61 6C 6F 67 02 00
54 02 11 53 6C 69 64 69 6E 67 45 78 70 69 72 61
74 69 6F 6E 01 53 08 08 50 72 69 6F 72 69 74 79
05 00 00 00 )
Cinquante-deux octets. Chaque champ de l”attribut s”y trouve, dans un ordre strict, sans délimiteurs et sans noms pour les arguments positionnels. Voici le même blob, découpé :
| Octets | Signification |
|---|---|
01 00 | Prologue — toujours 0x0001, petit-boutiste |
1E 00 00 00 | Argument fixe 1 : int32 = 30 |
07 + 63 61 74 61 6C 6F 67 | Argument fixe 2 : SerString, longueur 7, UTF-8 “catalog” |
02 00 | NumNamed = 2 arguments nommés suivent |
54 | Étiquette de l”argument nommé 1 : PROPERTY |
02 | Type d”élément BOOLEAN |
11 + 53 6C 69 64 … | Nom SerString, longueur 17, “SlidingExpiration” |
01 | Valeur : true |
53 | Étiquette de l”argument nommé 2 : FIELD |
08 | Type d”élément I4 (int32) |
08 + 50 72 69 6F … | Nom SerString, longueur 8, “Priority” |
05 00 00 00 | Valeur : 5 |
Le prologue et les arguments fixes
Les deux premiers octets sont un prologue de version, toujours 0x0001. Viennent ensuite les arguments fixes (les paramètres positionnels du constructeur), sérialisés bout à bout dans l”ordre de déclaration, sans étiquettes de type et sans noms. Le blob stocke 1E 00 00 00 et 07 catalog ; il n”enregistre pas que le premier est seconds ni que le second est region. La seule façon de savoir que les quatre octets 1E 00 00 00 sont un int32 et que le groupe suivant est une chaîne est de lire la signature du constructeur depuis le MethodDef/MemberRef pointé par la ligne CustomAttribute. Les arguments fixes sont décodés au moyen d”une signature externe ; le blob seul est ambigu.
Les chaînes utilisent l”encodage SerString : une longueur non signée compressée (ici un unique octet 0x07) suivie de ce nombre d”octets UTF-8. Une longueur compressée occupe un, deux ou quatre octets selon sa magnitude (le même schéma utilisé dans tous les tas de métadonnées), et une chaîne nulle est l”unique octet 0xFF, distinct du 0x00 d”une chaîne vide.
Les arguments nommés sont autodescriptifs
Après les arguments fixes vient un compteur de 2 octets —02 00 ici— puis chaque argument nommé, qui, contrairement aux arguments fixes, porte sa propre information de type. Chacun commence par un octet d”étiquette qui est précisément l”information que la syntaxe C# jette :
0x53=FIELD0x54=PROPERTY
Dans le code source, SlidingExpiration = true et Priority = 5 ont la même apparence : les deux sont Name = value. Dans le blob, ils se distinguent à l”octet de décalage zéro de chaque argument nommé. L”étiquette est suivie d”un octet de type d”élément (0x02 pour BOOLEAN, 0x08 pour I4, 0x0E pour STRING, …), d”un SerString pour le nom du membre et de la valeur sérialisée selon ce type d”élément.
L”asymétrie est toute l”histoire : les arguments fixes s”appuient sur une signature externe, les arguments nommés se décrivent eux-mêmes. Un décodeur doit changer de stratégie au milieu du blob.
Les cas délicats : énumérations, Type et tableaux
Trois sortes d”argument compliquent la règle « octet de type d”élément puis valeur », et c”est là que les décodeurs naïfs dérivent.
Énumérations. Un argument d”énumération n”a pas d”octet de type d”élément primitif. Il est encodé comme 0x55 suivi d”un SerString nommant le type de l”énumération, puis la valeur sérialisée comme le type entier sous-jacent de l”énumération. Supposons que CacheAttribute accepte aussi une énumération CachePriority :
[Cache(30, "catalog", Level = CachePriority.High)]
Les octets de l”argument nommé seraient 54 (propriété) 55 (énumération) puis "...CachePriority" comme un SerString, puis 02 00 00 00 pour la valeur int sous-jacente 2. Le blob stocke le nombre, pas le nom du membre High. Pour restituer CachePriority.High, Glass résout le type de l”énumération par son nom intégré et fait correspondre 2 au membre, ou émet (CachePriority)2 lorsqu”aucun membre ne correspond à une combinaison d”indicateurs.
System.Type. Un argument typeof(...) est sérialisé comme le type d”élément 0x50 suivi d”un SerString du nom du type (qualifié par assembly lorsqu”il réside ailleurs). Glass analyse ce nom pour le reconvertir en une expression typeof(T) plutôt que de laisser un littéral de chaîne.
Tableaux. Un argument de tableau est SZARRAY (0x1D), le type d”élément, un compteur d”éléments de 4 octets, puis les éléments empaquetés en séquence (0xFFFFFFFF marque un tableau nul, distinct d”un tableau de longueur zéro). Chaque élément est sérialisé selon le type d”élément, donc un string[] est un compteur suivi de ce nombre de SerString.
Ce que reconstruit Glass
Glass lit la ligne CustomAttribute, résout le constructeur pour récupérer les types des arguments fixes, décode le blob en deux passes (pilotée par la signature pour les arguments fixes, autodescriptive pour les arguments nommés), respecte chaque étiquette FIELD/PROPERTY pour lier le bon membre et résout les noms d”énumérations et de Type. À partir des 52 octets ci-dessus, il produit exactement l”application d”origine :
[Cache(30, "catalog", SlidingExpiration = true, Priority = 5)]
sealed class ProductService { }
Un décodeur qui sauterait l”octet d”étiquette de l”argument nommé, ou qui traiterait la chaîne de type intégrée de l”énumération comme une valeur positionnelle, émettrait quelque chose qui compile mais nomme le mauvais membre ou la mauvaise constante : la même catégorie d”erreur silencieuse et invisible à l”écran que l”abandon d”un suffixe de débordement.
À lire soi-même
Ouvrez n”importe quel assembly dans Glass, sélectionnez un type ou une méthode décoré et basculez sur la vue IL pour voir le blob .custom brut à côté du C# reconstruit. Alignez le prologue 01 00, comptez les arguments fixes face à la signature du constructeur, trouvez le compteur d”arguments nommés 02 00 et observez les étiquettes 53/54 choisir entre champ et propriété. Pour une expérience rapide, ajoutez à un attribut une propriété de type énumération et recompilez : vous verrez apparaître le type d”élément 0x55 et le nom de type intégré dans le blob, avec la valeur numérique stockée là où le nom du membre ne figure jamais.
Glass.NET est un décompilateur .NET gratuit pour inspecter les assemblys que vous avez le droit d”inspecter : vos propres builds, vos dépendances et les binaires tiers que vous êtes autorisé à analyser. Décoder fidèlement un blob d”attribut personnalisé, jusqu”à l”étiquette champ-ou-propriété, fait la différence entre lire les métadonnées et les deviner.
Essayez Nebula.NET
Renforcez votre code .NET en quelques minutes — commencez avec l'édition gratuite.