Vous souhaitez parfois utiliser une bibliothèque qui n'est disponible qu'en tant que code C ou C++. Traditionnellement, c'est là que vous abandonnez. Mais ce n'est plus le cas, car nous avons désormais Emscripten et WebAssembly (ou Wasm).
La chaîne d'outils
Je me suis fixé pour objectif de découvrir comment compiler du code C existant en Wasm. Il y a eu des rumeurs concernant le backend Wasm de LLVM, alors j'ai commencé à me pencher sur ce sujet. Bien que vous puissiez compiler des programmes simples de cette manière, dès que vous souhaitez utiliser la bibliothèque standard de C ou même compiler plusieurs fichiers, vous rencontrerez probablement des problèmes. Cela m'a conduit à la leçon principale que j'ai apprise:
Bien qu'Emscripten ait été un compilateur C vers asm.js, il a depuis évolué pour cibler Wasm et est en cours de transition vers le backend LLVM officiel en interne. Emscripten fournit également une implémentation compatible avec Wasm de la bibliothèque standard C. Utilisez Emscripten. Il effectue de nombreuses tâches cachées, émule un système de fichiers, fournit une gestion de la mémoire, encapsule OpenGL avec WebGL, etc., de nombreuses choses que vous n'avez pas besoin de développer vous-même.
Bien que cela puisse sembler vous obliger à vous soucier de l'encombrement (j'en ai certainement été préoccupé), le compilateur Emscripten supprime tout ce qui n'est pas nécessaire. Dans mes expériences, les modules Wasm obtenus sont de taille appropriée pour la logique qu'ils contiennent, et les équipes Emscripten et WebAssembly s'efforcent de les rendre encore plus petits à l'avenir.
Vous pouvez obtenir Emscripten en suivant les instructions sur son site Web ou en utilisant Homebrew. Si vous êtes fan des commandes dockerisées comme moi et que vous ne souhaitez pas installer des éléments sur votre système juste pour jouer avec WebAssembly, vous pouvez utiliser une image Docker bien entretenue à la place:
$ docker pull trzeci/emscripten
$ docker run --rm -v $(pwd):/src trzeci/emscripten emcc <emcc options here>
Compiler un programme simple
Prenons l'exemple presque canonique d'écriture d'une fonction en C qui calcule le nth nombre de Fibonacci:
#include <emscripten.h>
EMSCRIPTEN_KEEPALIVE
int fib(int n) {
if(n <= 0){
return 0;
}
int i, t, a = 0, b = 1;
for (i = 1; i < n; i++) {
t = a + b;
a = b;
b = t;
}
return b;
}
Si vous connaissez le langage C, la fonction elle-même ne devrait pas vous surprendre. Même si vous ne connaissez pas le langage C, mais que vous connaissez JavaScript, vous devriez pouvoir comprendre ce qui se passe ici.
emscripten.h est un fichier d'en-tête fourni par Emscripten. Nous n'en avons besoin que pour accéder à la macro EMSCRIPTEN_KEEPALIVE, mais elle fournit beaucoup plus de fonctionnalités.
Cette macro indique au compilateur de ne pas supprimer une fonction, même si elle semble inutilisée. Si nous omettons cette macro, le compilateur éliminera la fonction, car personne ne l'utilise.
Enregistrons tout cela dans un fichier nommé fib.c. Pour le convertir en fichier .wasm, nous devons utiliser la commande de compilation emcc d'Emscripten:
$ emcc -O3 -s WASM=1 -s EXTRA_EXPORTED_RUNTIME_METHODS='["cwrap"]' fib.c
Examinons cette commande. emcc est le compilateur d'Emscripten. fib.c est notre fichier C. Jusque-là, tout va bien. -s WASM=1 indique à Emscripten de nous fournir un fichier Wasm au lieu d'un fichier asm.js.
-s EXTRA_EXPORTED_RUNTIME_METHODS='["cwrap"]' indique au compilateur de laisser la fonction cwrap() disponible dans le fichier JavaScript. Nous reviendrons sur cette fonction plus tard. -O3 indique au compilateur d'optimiser de manière agressive. Vous pouvez choisir des nombres inférieurs pour réduire le temps de compilation, mais cela augmentera également la taille des bundles générés, car le compilateur ne supprimera peut-être pas le code inutilisé.
Après avoir exécuté la commande, vous devriez obtenir un fichier JavaScript appelé a.out.js et un fichier WebAssembly appelé a.out.wasm. Le fichier Wasm (ou "module") contient notre code C compilé et doit être assez petit. Le fichier JavaScript se charge de charger et d'initialiser notre module Wasm, et de fournir une API plus agréable. Si nécessaire, il se chargera également de configurer la pile, la mémoire tampon et d'autres fonctionnalités généralement attendues du système d'exploitation lors de l'écriture de code C. Par conséquent, le fichier JavaScript est un peu plus volumineux et pèse 19 Ko (environ 5 Ko compressés avec gzip).
Exécuter un programme simple
Le moyen le plus simple de charger et d'exécuter votre module consiste à utiliser le fichier JavaScript généré. Une fois ce fichier chargé, vous disposerez d'un Module global. Utilisez cwrap pour créer une fonction native JavaScript qui se charge de convertir les paramètres en éléments compatibles avec C et d'appeler la fonction encapsulée. cwrap utilise le nom de la fonction, le type de retour et les types d'arguments comme arguments, dans cet ordre:
<script src="a.out.js"></script>
<script>
Module.onRuntimeInitialized = _ => {
const fib = Module.cwrap('fib', 'number', ['number']);
console.log(fib(12));
};
</script>
Si vous exécutez ce code, le nombre "144" devrait s'afficher dans la console, ce qui correspond au 12e nombre de Fibonacci.
L'objectif ultime: compiler une bibliothèque C
Jusqu'à présent, le code C que nous avons écrit était conçu pour Wasm. Toutefois, un cas d'utilisation essentiel de WebAssembly consiste à utiliser l'écosystème existant de bibliothèques C et à permettre aux développeurs de les utiliser sur le Web. Ces bibliothèques s'appuient souvent sur la bibliothèque standard de C, un système d'exploitation, un système de fichiers et d'autres éléments. Emscripten fournit la plupart de ces fonctionnalités, mais il présente certaines limites.
Revenons à mon objectif initial: compiler un encodeur WebP vers Wasm. Le code source du codec WebP est écrit en C et disponible sur GitHub, ainsi qu'une documentation API complète. C'est un bon point de départ.
$ git clone https://github.com/webmproject/libwebp
Pour commencer simplement, essayons d'exposer WebPGetEncoderVersion() de encode.h à JavaScript en écrivant un fichier C appelé webp.c:
#include "emscripten.h"
#include "src/webp/encode.h"
EMSCRIPTEN_KEEPALIVE
int version() {
return WebPGetEncoderVersion();
}
Il s'agit d'un bon programme simple pour tester si nous pouvons compiler le code source de libwebp, car nous n'avons besoin d'aucun paramètre ni de structure de données complexe pour appeler cette fonction.
Pour compiler ce programme, nous devons indiquer au compilateur où il peut trouver les fichiers d'en-tête de libwebp à l'aide de l'indicateur -I, et lui transmettre tous les fichiers C de libwebp dont il a besoin. Pour être honnête, je lui ai simplement fourni tous les fichiers C que j'ai pu trouver et j'ai laissé le compilateur supprimer tout ce qui était inutile. Il semble que cela ait fonctionné à merveille !
$ emcc -O3 -s WASM=1 -s EXTRA_EXPORTED_RUNTIME_METHODS='["cwrap"]' \
-I libwebp \
webp.c \
libwebp/src/{dec,dsp,demux,enc,mux,utils}/*.c
Il ne nous reste plus qu'à ajouter du code HTML et JavaScript pour charger notre nouveau module:
<script src="/a.out.js"></script>
<script>
Module.onRuntimeInitialized = async (_) => {
const api = {
version: Module.cwrap('version', 'number', []),
};
console.log(api.version());
};
</script>
Le numéro de version de la correction s'affiche dans la sortie:
Obtenir une image de JavaScript dans Wasm
Obtenir le numéro de version de l'encodeur est bien, mais encoder une image réelle serait plus impressionnant, non ? Allons-y.
La première question à laquelle nous devons répondre est la suivante: comment importer l'image dans le monde Wasm ?
En examinant l'API d'encodage de libwebp, il s'attend à un tableau d'octets au format RVB, RVBA, BGR ou BGRA. Heureusement, l'API Canvas dispose de getImageData(), ce qui nous donne un Uint8ClampedArray contenant les données d'image au format RGBA:
async function loadImage(src) {
// Load image
const imgBlob = await fetch(src).then((resp) => resp.blob());
const img = await createImageBitmap(imgBlob);
// Make canvas same size as image
const canvas = document.createElement('canvas');
canvas.width = img.width;
canvas.height = img.height;
// Draw image onto canvas
const ctx = canvas.getContext('2d');
ctx.drawImage(img, 0, 0);
return ctx.getImageData(0, 0, img.width, img.height);
}
Il ne reste plus qu'à copier les données du monde JavaScript dans le monde Wasm. Pour ce faire, nous devons exposer deux fonctions supplémentaires. L'une qui alloue de la mémoire pour l'image dans l'espace Wasm et l'autre qui la libère à nouveau:
EMSCRIPTEN_KEEPALIVE
uint8_t* create_buffer(int width, int height) {
return malloc(width * height * 4 * sizeof(uint8_t));
}
EMSCRIPTEN_KEEPALIVE
void destroy_buffer(uint8_t* p) {
free(p);
}
create_buffer alloue un tampon pour l'image RGBA, soit 4 octets par pixel.
Le pointeur renvoyé par malloc() est l'adresse de la première cellule de mémoire de ce tampon. Lorsque le pointeur est renvoyé dans l'environnement JavaScript, il est traité comme un simple nombre. Après avoir exposé la fonction à JavaScript à l'aide de cwrap, nous pouvons utiliser ce nombre pour trouver le début de notre tampon et copier les données d'image.
const api = {
version: Module.cwrap('version', 'number', []),
create_buffer: Module.cwrap('create_buffer', 'number', ['number', 'number']),
destroy_buffer: Module.cwrap('destroy_buffer', '', ['number']),
};
const image = await loadImage('/image.jpg');
const p = api.create_buffer(image.width, image.height);
Module.HEAP8.set(image.data, p);
// ... call encoder ...
api.destroy_buffer(p);
Grand final: Encoder l'image
L'image est désormais disponible dans Wasm. Il est temps d'appeler l'encodeur WebP pour qu'il effectue son travail. D'après la documentation WebP, WebPEncodeRGBA semble être la solution idéale. La fonction prend un pointeur vers l'image d'entrée et ses dimensions, ainsi qu'une option de qualité comprise entre 0 et 100. Il nous alloue également un tampon de sortie que nous devons libérer à l'aide de WebPFree() une fois que nous avons terminé avec l'image WebP.
Le résultat de l'opération d'encodage est un tampon de sortie et sa longueur. Étant donné que les fonctions en C ne peuvent pas avoir de tableaux comme types de retour (sauf si nous allouons de la mémoire de manière dynamique), j'ai eu recours à un tableau global statique. Je sais, pas de C propre (en fait, il repose sur le fait que les pointeurs Wasm ont une largeur de 32 bits), mais pour simplifier les choses, je pense que c'est un raccourci acceptable.
int result[2];
EMSCRIPTEN_KEEPALIVE
void encode(uint8_t* img_in, int width, int height, float quality) {
uint8_t* img_out;
size_t size;
size = WebPEncodeRGBA(img_in, width, height, width * 4, quality, &img_out);
result[0] = (int)img_out;
result[1] = size;
}
EMSCRIPTEN_KEEPALIVE
void free_result(uint8_t* result) {
WebPFree(result);
}
EMSCRIPTEN_KEEPALIVE
int get_result_pointer() {
return result[0];
}
EMSCRIPTEN_KEEPALIVE
int get_result_size() {
return result[1];
}
Maintenant que tout cela est en place, nous pouvons appeler la fonction d'encodage, saisir le pointeur et la taille de l'image, les placer dans un tampon JavaScript et libérer tous les tampons Wasm que nous avons alloués au cours du processus.
api.encode(p, image.width, image.height, 100);
const resultPointer = api.get_result_pointer();
const resultSize = api.get_result_size();
const resultView = new Uint8Array(Module.HEAP8.buffer, resultPointer, resultSize);
const result = new Uint8Array(resultView);
api.free_result(resultPointer);
En fonction de la taille de votre image, vous pouvez rencontrer une erreur où Wasm ne peut pas augmenter la mémoire suffisamment pour accueillir à la fois l'image d'entrée et la sortie:
Heureusement, la solution à ce problème se trouve dans le message d'erreur. Il nous suffit d'ajouter -s ALLOW_MEMORY_GROWTH=1 à notre commande de compilation.
Et voilà ! Nous avons compilé un encodeur WebP et transcodé une image JPEG au format WebP. Pour prouver que cela a fonctionné, nous pouvons transformer notre tampon de résultats en blob et l'utiliser sur un élément <img>:
const blob = new Blob([result], { type: 'image/webp' });
const blobURL = URL.createObjectURL(blob);
const img = document.createElement('img');
img.src = blobURL;
document.body.appendChild(img);
Voici la gloire d'une nouvelle image WebP !
Conclusion
Il n'est pas facile de faire fonctionner une bibliothèque C dans le navigateur, mais une fois que vous avez compris le processus global et le fonctionnement du flux de données, cela devient plus facile et les résultats peuvent être époustouflants.
WebAssembly ouvre de nombreuses nouvelles possibilités sur le Web pour le traitement, le calcul et les jeux. Gardez à l'esprit que Wasm n'est pas une solution miracle à appliquer à tout, mais lorsque vous rencontrez l'un de ces goulots d'étranglement, Wasm peut être un outil incroyablement utile.
Contenu bonus: Exécuter une tâche simple de manière difficile
Si vous souhaitez essayer d'éviter le fichier JavaScript généré, vous pouvez peut-être y parvenir. Revenons à l'exemple de Fibonacci. Pour le charger et l'exécuter nous-mêmes, nous pouvons procéder comme suit:
<!DOCTYPE html>
<script>
(async function () {
const imports = {
env: {
memory: new WebAssembly.Memory({ initial: 1 }),
STACKTOP: 0,
},
};
const { instance } = await WebAssembly.instantiateStreaming(
fetch('/a.out.wasm'),
imports,
);
console.log(instance.exports._fib(12));
})();
</script>
Les modules WebAssembly créés par Emscripten n'ont pas de mémoire à utiliser, sauf si vous leur en fournissez. Pour fournir un module Wasm avec n'importe quoi, utilisez l'objet imports, qui est le deuxième paramètre de la fonction instantiateStreaming. Le module Wasm peut accéder à tout ce qui se trouve dans l'objet "imports", mais à rien d'autre en dehors de celui-ci. Par convention, les modules compilés par Emscripting s'attendent à quelques éléments de l'environnement JavaScript de chargement:
- Tout d'abord, il y a
env.memory. Le module Wasm n'est pas conscient du monde extérieur, il doit donc obtenir de la mémoire pour fonctionner. SaisissezWebAssembly.Memory. Il représente un espace de mémoire linéaire (éventuellement extensible). Les paramètres de dimensionnement sont exprimés en "unités de pages WebAssembly", ce qui signifie que le code ci-dessus alloue une page de mémoire, chaque page ayant une taille de 64 KiB. Sans fournir d'optionmaximum, la croissance de la mémoire est théoriquement illimitée (Chrome a actuellement une limite stricte de 2 Go). La plupart des modules WebAssembly ne devraient pas avoir besoin de définir une valeur maximale. env.STACKTOPdéfinit l'emplacement où la pile doit commencer à se développer. La pile est nécessaire pour effectuer des appels de fonction et allouer de la mémoire pour les variables locales. Étant donné que nous n'effectuons aucune manipulation de gestion de mémoire dynamique dans notre petit programme Fibonacci, nous pouvons simplement utiliser l'ensemble de la mémoire comme une pile, d'oùSTACKTOP = 0.