From 7cd6487a28d036dfd059235b20c3922202fe4214 Mon Sep 17 00:00:00 2001
From: Ingvar Stepanyan <rreverser@google.com>
Date: Thu, 16 Apr 2020 19:34:28 +0100
Subject: [PATCH] Fix and document allocation shim for OxiPNG

---
 codecs/oxipng/pkg/oxipng_bg.wasm | Bin 349600 -> 349604 bytes
 codecs/oxipng/src/malloc_shim.rs |  26 +++++++++++++++++++++++---
 2 files changed, 23 insertions(+), 3 deletions(-)

diff --git a/codecs/oxipng/pkg/oxipng_bg.wasm b/codecs/oxipng/pkg/oxipng_bg.wasm
index 0e15d13eeafe9e81ed97cfff888a14a402a70b1d..7c094e40fe6ff9184577137894877f9c9d5c5a03 100644
GIT binary patch
delta 1702
zcmZ`(dr;I>6y9^sVRiZOSd{gJz{*rGCTdxjQ>kmAD7s>qHoiz}Dz(wdF(0D{3L@r{
z74EX&14AgSuok&G=7Y&sRuGy=%9f@h<VZ43O#Tye?k+kGGwsaox97X(oO`}=?!9{s
z*vbyr4jvN*3jfDsu~=N^L<;1)B5)bFTzQx<q6l~69?ZldT#q?ehDYEQ6k#cI*?3>f
zpIU~OMH%Kn8E(f8k;C6WM3L(@#*Nv*5jS~#*F*kW@j?z3V7oXYu86fF3%sHO3h@hZ
zR{SJ<qDs_?tKv%zDZ`k^h~V$MPP%3V=^bL5Cm8a3HwA&myE6LHdu*j`Y$Uc4w+@d4
znZGa2oBPRf0QvR4*ZDVp-*DHq@+0gvp`v?tkgiSFqrLA}Ug^e6sw&4$Cj96{{>#qZ
zekY#LTR3WNgqusyWLQhQ1M7GCGsU=WUAV^q6Dnf7|6H7>v(0EMXJ_zjB!8l8HX{B=
z3S~&S+mHxS4Ty%L!QfH8csLxyc3~p4qijt9Qtqc<e;89QjRxZUD#Za#jdBd6axv;g
zGK8WLsDTTyTV&}h(OdNx53yXmdO8hqrh$})%b`ERrE<8>Y;6TBF?hc*UdYw^o<9bs
z`!a6348u6NJk<a**e&)~*ugSY)m5-r7|-8?#t#@Pris^Bm;85*n9?a<W~Eb<TAVJX
z2Z39ieM_`Y;e2PRMMMM#G@KP5n%PdR6;(Ww>Ys%~Hr<!SRvwB>XcWJ(+07^3)>SQP
z7TdW~)h%L(Ryed(#ONv}-xG1xV2>6VlpG3%j6sZ59)UHwwpk(ge1DxY0XuqW9EDTE
zz%5%QVGWe1N+(VmY?c@&l0#+d3bZNvYOK)d&t>ufW-+7J;(Rvuuf@-Gsnhc?rw602
z7^ef{vpaE(9?hY>xPd1pD^KD`wdx=)Gg~+-B-3a|WT5pu6&CA?*yEQF_LOy)z;Ln-
zV;Fv~!;7-C7Tdb6C|)@w%vzt-BR{)<kMXXx7jSkk=Njb0G)B3)3GEEKnlPT>OcQ?0
z@JcgIWZ&J*_`Mdi@D7fEN5>*hw_rW{$-gj{TM>H~e>AgSOB+^kopNsn)3RV7ZS-&M
z2=U7}R8KGK9eWuR%aCNyTn4v669Zm-v{$5RH)xzbXJdQP20f%Y8}$=h%<bOP#*<dp
zqN#{^xzbK6c=>NTRU2#`7(_SN+?q(ob(C``HRzJ!htt?@&@2~?q;L3KJUNO6h<sF&
zMp1?CLfd#w!qJOU>D^9&%9lz5g&u)Pk04OHig%J*5AEb+D$ycl&!D}0pk`7eH%Qv%
zkcZ*m98IcM(`lSeTKop>WOKw^zp1k3Q6kf-@=eOtU47;q+N4XZnNRw~Q2iECe6S%g
z1PnVm$m*68mr~#E4=$pt55vB4{Ze|4Q=eE$nGan>r|W|Wv4AL*{ShtXHp<r3)aSuM
zSO!h$LS<yoS6wLQ8cORzu~)RbvW9ka;Rny8DEVn7m2~otyc$AYKMuWAMi%`5j|W77
z1FUW|^o0?I-DHO(K@1{En8NwJlZ)5U`2S6GZykl{V*u+ZUF({=nfib~CQ24;CMOT~
z=4O`XQAu0qj@f^thM5YNP^=nPK&86De-_df-SFi_)BqNX$!>D2T3~%qPA;Ye;rf=C
PP1d{s6sx*osz34{a8N)g

delta 1728
zcmZ`(ZBUd|6y9^sVR3mu76nugSeZ)3BrQkC%8#{36kV|~Y}7ERsTdoFa?Es65JiOi
zWMwZ4_<<penTaiObxf1Vud#xVOj0mS6UUJ>%kodqxx3^zJLAr<59hqkea>^vx$jo*
ziP*6xqV9+=g!f~zSS;u~EmEP<8HP)s#94$1W6E$l?!Y`O!!=ld)p!W5Lm5_aZZ+N)
z*)yy0yr{+^sK(9MBMSJ>ccRRB6XPd3`NTDTzU@K&8}UK`ZozJGQd|)EVkLM)50v6w
zaZ3CkIz+u_5*Ni6e54v<!^473cpP-u3NFuxh%CWSGN3a6+@57I=icKey||q?O5B(n
z4z7}2@t(p@KLT)lx$8ClF4>jr+*EUjX;W(Z^Z}Q1-IW+m&b|wQoJmtP*qaGG+{*tl
z*%S5k6S{=G@oK2K0!@as!ZWO8t5+%3dHw8NJ}{*=*7HwmmR6hHUc+SQC?>DaY7WAF
zO$uR1z1@}wE;S?u4hMl-bqs}r0UWy$p&OxGl|Bu7`*Qr^1RxeysdjK^loKJ1ov5oR
z5Q2u!0K2eRWYt_TK=qppaco^ZlMV$L;F1SxU@*hE8o1Bdrdn8JaIuLVDAYyI9Dx&q
z7&o1VQ7kTxx4~?t#r+IhxJOlg5h5&%XRbl}`;4_2;#F=+{+lUgJXD%|rE}(qi~x}8
z)LWu^28*6-5Mg0_s_m5cz|3)4lc?vdH2f$ea#(g=Y~;1bgm!U>!@v&lwzjtLhS<!r
zYUmOpbekjZh*)i9`dtxk4RY&F15!f3kg<qys$5{BHaIsJpC7C>6R;;z<9M9e7o_Z(
zhK*36_Bk-)DYFaXMM{XgvlJtgZ8_Fz`O|rPg}I{%`Iyb&XZiTKwmPc_3;Hp3RNyRN
z9K98D^>PmE#I?LTx$hW`Qy<si60?O>A%!N`!+k^OudqTpV#ZIw%#_WTz;LV?V;O#F
z##UL?g!lZPD1LHWn00?vx7>XeALFV`XYutQ)*9Y{>5OuDC)yacb>dKllb!ep!z(v%
zDs#8rz;AU!3vS^U@ZU|OJkf<MOqRc6A<rZ3Hhynra@ReqXR~r=52szF!>HKnz#i=F
z<v<I)q{~Jc6vvQc(0qn6gQoge12rpLbsIEE-?*3i(^|c$<_L-s?C9nIy2tBQmt)Ay
zdAZC+OZo9%Hfk_9+%uf6a=0;(j_Om6k<`YP<a6^WO4*ZXcp!Ajh2!Wez9CPJry(#_
zImT119>?F4S%|4QY4mRI8>lX&(J(DzagfprYn)D%+I!|~+R15{L*YCf8JS7t4Er;^
z*_rcbk`}6bgSIk>OY2bOXHlZYx;JUH9_i?JXr0h|CcS6hY}A!(8ly?k3utJN;lf}r
zY-lH|l+zZ|pk7<DE{mdN;bMB0s~lTQc@K!fkI4R`Rl$d}fF~*cSWW}~R|s7}GyGDy
zD`>x8YI-iE`=yu_BQNIC7Qg(6Ic#Zn9#!_{AG#|-UO5VpDt9G)2ao$&0y|hG8v4Z%
zhRtMyBtZ-!Nti<Umrv%bqREdG`g0Za)i*(`p?QH(zSr+jD$&xlo*caF-_~=(Zk4=&
zZkfIJY?MjDB8pR~rBtOSe$z!8^s1M-sSV_u3d)YuuZ`JcE%JiRWF4!ca@ATvEr<RC
Dt-?P-

diff --git a/codecs/oxipng/src/malloc_shim.rs b/codecs/oxipng/src/malloc_shim.rs
index af5154c2..ff199d4b 100644
--- a/codecs/oxipng/src/malloc_shim.rs
+++ b/codecs/oxipng/src/malloc_shim.rs
@@ -2,6 +2,26 @@
 //! These implementations are compatible with the standard signatures
 //! but use Rust allocator instead of including libc one as well.
 //!
+//! Rust allocator APIs requires passing size and alignment to the
+//! `dealloc` function. This is different from C API, which only
+//! expects a pointer in `free` and expects allocators to take care of
+//! storing any necessary information elsewhere.
+//!
+//! In order to simulate C API, we allocate a `size_and_data_ptr`
+//! of size `sizeof(usize) + size` where `size` is the requested number
+//! of bytes. Then, we store `size` at the beginning of the allocated
+//! chunk (within those `sizeof(usize)` bytes) and return
+//! `data_ptr = size_and_data_ptr + sizeof(usize)` to the calleer:
+//!
+//! [`size`][...actual data]
+//! -^------------------ `size_and_data_ptr`
+//! ---------^---------- `data_ptr`
+//!
+//! Then, in `free`, the caller gives us `data_ptr`. We can subtract
+//! `sizeof(usize)` back and get the original `size_and_data_ptr`.
+//! At this point we can read `size` back and call the Rust `dealloc`
+//! for the whole allocated chunk.
+//!
 //! I've raised an upstream issue to hopefully make this easier in
 //! future: https://github.com/ebiggers/libdeflate/issues/62
 
@@ -20,8 +40,8 @@ pub unsafe extern "C" fn malloc(size: usize) -> *mut u8 {
 }
 
 #[no_mangle]
-pub unsafe extern "C" fn free(ptr: *mut u8) {
-    let size_and_data_ptr = ptr.sub(size_of::<usize>());
+pub unsafe extern "C" fn free(data_ptr: *mut u8) {
+    let size_and_data_ptr = data_ptr.sub(size_of::<usize>());
     let size = *(size_and_data_ptr as *const usize);
-    dealloc(ptr, layout_for(size))
+    dealloc(size_and_data_ptr, layout_for(size))
 }