Terkadang Anda ingin menggunakan library yang hanya tersedia sebagai kode C atau C++. Biasanya, ini adalah saat Anda menyerah. Sekarang tidak lagi, karena sekarang kita memiliki Emscripten dan WebAssembly (atau Wasm).
Toolchain
Saya menetapkan sasaran untuk mencari tahu cara mengompilasi beberapa kode C yang ada ke Wasm. Ada beberapa rumor seputar backend Wasm LLVM, jadi saya mulai mempelajarinya. Meskipun Anda bisa mendapatkan program sederhana untuk dikompilasi dengan cara ini, begitu Anda ingin menggunakan library standar C atau bahkan mengompilasi beberapa file, Anda mungkin akan mengalami masalah. Hal ini membawa saya pada pelajaran utama yang saya pelajari:
Meskipun Emscripten dulunya adalah compiler C-ke-asm.js, Emscripten telah berkembang untuk menargetkan Wasm dan sedang dalam proses beralih ke backend LLVM resmi secara internal. Emscripten juga menyediakan implementasi library standar C yang kompatibel dengan Wasm. Gunakan Emscripten. Emscripten melakukan banyak pekerjaan tersembunyi, mengemulasi sistem file, menyediakan manajemen memori, menggabungkan OpenGL dengan WebGL — banyak hal yang benar-benar tidak perlu Anda alami saat mengembangkannya sendiri.
Meskipun hal itu mungkin terdengar seperti Anda harus khawatir tentang bloatware — saya tentu khawatir — compiler Emscripten menghapus semua yang tidak diperlukan. Dalam eksperimen saya, modul Wasm yang dihasilkan memiliki ukuran yang sesuai untuk logika yang dimuatnya, dan tim Emscripten serta WebAssembly sedang berupaya membuatnya lebih kecil lagi di masa mendatang.
Anda bisa mendapatkan Emscripten dengan mengikuti petunjuk di situs mereka atau menggunakan Homebrew. Jika Anda adalah penggemar perintah docker seperti saya dan tidak ingin menginstal berbagai hal di sistem hanya untuk bermain dengan WebAssembly, ada image Docker yang dikelola dengan baik yang dapat Anda gunakan:
$ docker pull trzeci/emscripten
$ docker run --rm -v $(pwd):/src trzeci/emscripten emcc <emcc options here>
Mengompilasi sesuatu yang sederhana
Mari kita ambil contoh yang hampir kanonis dalam menulis fungsi di C yang menghitung bilangan fibonacci ke-nth:
#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;
}
Jika Anda memahami C, fungsi itu sendiri seharusnya tidak terlalu mengejutkan. Meskipun Anda tidak tahu C, tetapi tahu JavaScript, semoga Anda dapat memahami apa yang terjadi di sini.
emscripten.h adalah file header yang disediakan oleh Emscripten. Kita hanya membutuhkannya agar
memiliki akses ke makro EMSCRIPTEN_KEEPALIVE, tetapi
makro ini menyediakan lebih banyak fungsi.
Makro ini memberi tahu compiler untuk tidak menghapus fungsi meskipun tampaknya tidak digunakan. Jika kita menghilangkan makro tersebut, compiler akan mengoptimalkan fungsi tersebut
— lagipula tidak ada yang menggunakannya.
Mari kita simpan semua itu dalam file bernama fib.c. Untuk mengubahnya menjadi file .wasm, kita
perlu beralih ke perintah compiler Emscripten emcc:
$ emcc -O3 -s WASM=1 -s EXTRA_EXPORTED_RUNTIME_METHODS='["cwrap"]' fib.c
Mari kita bahas perintah ini secara mendetail. emcc adalah compiler Emscripten. fib.c adalah file C
kita. Sejauh ini, hasilnya bagus. -s WASM=1 memberi tahu Emscripten untuk memberi kita file Wasm,
bukan file asm.js.
-s EXTRA_EXPORTED_RUNTIME_METHODS='["cwrap"]' memberi tahu compiler untuk membiarkan
fungsi cwrap() tersedia dalam file JavaScript — selengkapnya tentang fungsi ini
nanti. -O3 memberi tahu compiler untuk mengoptimalkan secara agresif. Anda dapat memilih angka yang lebih rendah untuk mengurangi waktu build, tetapi hal ini juga akan membuat paket yang dihasilkan lebih besar karena compiler mungkin tidak menghapus kode yang tidak digunakan.
Setelah menjalankan perintah, Anda akan mendapatkan file JavaScript bernama
a.out.js dan file WebAssembly bernama a.out.wasm. File Wasm (atau
"modul") berisi kode C yang telah dikompilasi dan ukurannya seharusnya cukup kecil. File JavaScript menangani pemuatan dan inisialisasi modul Wasm serta menyediakan API yang lebih baik. Jika diperlukan, library ini juga akan menangani penyiapan stack, heap, dan fungsi lain yang biasanya diharapkan disediakan oleh sistem operasi saat menulis kode C. Oleh karena itu, file JavaScript sedikit lebih besar, dengan ukuran 19 KB (sekitar 5 KB setelah di-gzip).
Menjalankan sesuatu yang sederhana
Cara termudah untuk memuat dan menjalankan modul Anda adalah dengan menggunakan file JavaScript yang dihasilkan. Setelah memuat file tersebut, Anda akan memiliki
Module global
yang dapat Anda gunakan. Gunakan
cwrap
untuk membuat fungsi native JavaScript yang menangani konversi parameter
menjadi sesuatu yang kompatibel dengan C dan memanggil fungsi gabungan. cwrap menggunakan nama fungsi, jenis nilai yang ditampilkan, dan jenis argumen sebagai argumen, dalam urutan tersebut:
<script src="a.out.js"></script>
<script>
Module.onRuntimeInitialized = _ => {
const fib = Module.cwrap('fib', 'number', ['number']);
console.log(fib(12));
};
</script>
Jika Anda menjalankan kode ini, Anda akan melihat "144" di konsol, yang merupakan angka Fibonacci ke-12.
Tujuan utama: Mengompilasi library C
Hingga saat ini, kode C yang telah kita tulis ditulis dengan mempertimbangkan Wasm. Namun, kasus penggunaan inti untuk WebAssembly adalah mengambil ekosistem library C yang ada dan memungkinkan developer menggunakannya di web. Library ini sering kali bergantung pada library standar C, sistem operasi, sistem file, dan hal lainnya. Emscripten menyediakan sebagian besar fitur ini, meskipun ada beberapa batasan.
Mari kita kembali ke tujuan awal saya: mengompilasi encoder untuk WebP ke Wasm. Sumber untuk codec WebP ditulis dalam C dan tersedia di GitHub serta beberapa dokumentasi API yang ekstensif. Itu adalah titik awal yang cukup baik.
$ git clone https://github.com/webmproject/libwebp
Untuk memulai dengan cara yang sederhana, mari kita coba mengekspos WebPGetEncoderVersion() dari
encode.h ke JavaScript dengan menulis file C bernama webp.c:
#include "emscripten.h"
#include "src/webp/encode.h"
EMSCRIPTEN_KEEPALIVE
int version() {
return WebPGetEncoderVersion();
}
Ini adalah program sederhana yang bagus untuk menguji apakah kita bisa mendapatkan kode sumber libwebp untuk dikompilasi, karena kita tidak memerlukan parameter atau struktur data yang kompleks untuk memanggil fungsi ini.
Untuk mengompilasi program ini, kita perlu memberi tahu compiler tempat ia dapat menemukan
file header libwebp menggunakan flag -I dan juga meneruskan semua file C
libwebp yang diperlukan. Sejujurnya: Saya hanya memberikan semua file C
yang dapat saya temukan dan mengandalkan compiler untuk menghapus semua yang
tidak diperlukan. Sepertinya berhasil dengan baik.
$ emcc -O3 -s WASM=1 -s EXTRA_EXPORTED_RUNTIME_METHODS='["cwrap"]' \
-I libwebp \
webp.c \
libwebp/src/{dec,dsp,demux,enc,mux,utils}/*.c
Sekarang kita hanya memerlukan beberapa HTML dan JavaScript untuk memuat modul baru kita yang keren:
<script src="/a.out.js"></script>
<script>
Module.onRuntimeInitialized = async (_) => {
const api = {
version: Module.cwrap('version', 'number', []),
};
console.log(api.version());
};
</script>
Kita akan melihat nomor versi yang benar di output:
Mendapatkan gambar dari JavaScript ke Wasm
Mendapatkan nomor versi encoder memang bagus, tetapi mengenkode gambar yang sebenarnya akan lebih mengesankan, bukan? Mari kita lakukan.
Pertanyaan pertama yang harus kita jawab adalah: Bagaimana cara memasukkan gambar ke dalam lingkungan Wasm?
Melihat
API encoding libwebp, API ini mengharapkan
array byte dalam RGB, RGBA, BGR, atau BGRA. Untungnya, Canvas API memiliki
getImageData(),
yang memberi kita
Uint8ClampedArray
yang berisi data gambar dalam 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);
}
Sekarang, ini "hanya" masalah menyalin data dari JavaScript ke Wasm. Untuk itu, kita perlu mengekspos dua fungsi tambahan. Satu yang mengalokasikan memori untuk gambar di dalam Wasm dan satu yang mengosongkannya lagi:
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 mengalokasikan buffer untuk gambar RGBA — sehingga 4 byte per piksel.
Pointer yang ditampilkan oleh malloc() adalah alamat sel memori pertama dari
buffer tersebut. Saat pointer ditampilkan ke JavaScript, pointer tersebut diperlakukan sebagai
angka saja. Setelah mengekspos fungsi ke JavaScript menggunakan cwrap, kita dapat
menggunakan angka tersebut untuk menemukan awal buffer dan menyalin data gambar.
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 finale: Mengenkode gambar
Gambar kini tersedia di Wasm. Saatnya memanggil encoder WebP untuk
melakukan tugasnya. Melihat
dokumentasi WebP, WebPEncodeRGBA
tampaknya sangat cocok. Fungsi ini menggunakan pointer ke gambar input dan
dimensinya, serta opsi kualitas antara 0 dan 100. Fungsi ini juga mengalokasikan
buffer output untuk kita, yang perlu kita kosongkan menggunakan WebPFree() setelah kita
selesai dengan gambar WebP.
Hasil operasi encoding adalah buffer output dan panjangnya. Karena fungsi di C tidak dapat memiliki array sebagai jenis nilai yang ditampilkan (kecuali jika kita mengalokasikan memori secara dinamis), saya menggunakan array global statis. Saya tahu, ini bukan C yang bersih (bahkan, ini mengandalkan fakta bahwa pointer Wasm memiliki lebar 32 bit), tetapi untuk menjaga semuanya tetap sederhana, saya rasa ini adalah pintasan yang adil.
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];
}
Sekarang, setelah semuanya siap, kita dapat memanggil fungsi encoding, mengambil pointer dan ukuran gambar, memasukkannya ke dalam buffer JavaScript-land kita sendiri, dan merilis semua buffer Wasm-land yang telah kita alokasikan dalam prosesnya.
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);
Bergantung pada ukuran gambar, Anda mungkin mengalami error saat Wasm tidak dapat menambah memori yang cukup untuk mengakomodasi gambar input dan output:
Untungnya, solusi untuk masalah ini ada dalam pesan error. Kita hanya perlu
menambahkan -s ALLOW_MEMORY_GROWTH=1 ke perintah kompilasi.
Jadi itulah. Kita telah mengompilasi encoder WebP dan mentranskode gambar JPEG ke
WebP. Untuk membuktikan bahwa cara ini berhasil, kita dapat mengubah buffering hasil menjadi blob dan menggunakannya
pada elemen <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);
Lihat, keindahan gambar WebP baru!
Kesimpulan
Tidak mudah untuk membuat library C berfungsi di browser, tetapi setelah Anda memahami proses keseluruhan dan cara kerja aliran data, hal ini akan menjadi lebih mudah dan hasilnya bisa sangat menakjubkan.
WebAssembly membuka banyak kemungkinan baru di web untuk pemrosesan, penghitungan angka, dan game. Perlu diingat bahwa Wasm bukanlah solusi ajaib yang harus diterapkan pada semua hal, tetapi saat Anda mengalami salah satu bottleneck tersebut, Wasm dapat menjadi alat yang sangat membantu.
Konten bonus: Menjalankan sesuatu yang sederhana dengan cara yang sulit
Jika ingin mencoba dan menghindari file JavaScript yang dihasilkan, Anda mungkin dapat melakukannya. Mari kita kembali ke contoh Fibonacci. Untuk memuat dan menjalankannya sendiri, kita dapat melakukan hal berikut:
<!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>
Modul WebAssembly yang telah dibuat oleh Emscripten tidak memiliki memori untuk digunakan, kecuali jika Anda menyediakan memori untuk modul tersebut. Cara Anda menyediakan modul Wasm dengan
apa pun adalah dengan menggunakan objek imports — parameter kedua dari
fungsi instantiateStreaming. Modul Wasm dapat mengakses semua yang ada di dalam objek impor, tetapi tidak dapat mengakses apa pun di luar objek tersebut. Berdasarkan konvensi, modul yang dikompilasi oleh Emscripting mengharapkan beberapa hal dari lingkungan JavaScript pemuatan:
- Pertama, ada
env.memory. Modul Wasm tidak mengetahui dunia luar, jadi modul ini perlu mendapatkan memori untuk digunakan. MasukkanWebAssembly.Memory. Memori ini mewakili bagian memori linear (yang dapat dikembangkan secara opsional). Parameter ukuran berada dalam "satuan halaman WebAssembly", yang berarti kode di atas mengalokasikan 1 halaman memori, dengan setiap halaman memiliki ukuran 64 KiB. Tanpa memberikan opsimaximum, memori secara teoritis tidak terbatas dalam pertumbuhannya (Chrome saat ini memiliki batas ketat 2 GB). Sebagian besar modul WebAssembly tidak perlu menetapkan maksimum. env.STACKTOPmenentukan tempat stack seharusnya mulai bertambah. Stack diperlukan untuk melakukan panggilan fungsi dan mengalokasikan memori untuk variabel lokal. Karena kita tidak melakukan trik manajemen memori dinamis apa pun dalam program Fibonacci kecil kita, kita dapat menggunakan seluruh memori sebagai stack, sehinggaSTACKTOP = 0.