From 3149cd14efacf81cc30fdf3c69c4cd3459865f92 Mon Sep 17 00:00:00 2001
From: Mohanson <mohanson@outlook.com>
Date: Wed, 21 Aug 2024 14:22:57 +0800
Subject: [PATCH] Add a sample for showing how to build binary with clang
 (#439)

* Add a sample for showing how to build binary with clang

* CCFLAGS => CFLAGS

* Using tweakable variables in bash script
---
 .gitignore                            |   1 +
 tests/programs/_build_clang.sh        |   7 ++++++
 tests/programs/_build_clang_native.sh |  27 +++++++++++++++++++++++
 tests/programs/clang_sample           | Bin 0 -> 8392 bytes
 tests/programs/clang_sample.c         |   3 +++
 tests/test_misc.rs                    |  30 ++++++++++++++++++++++++++
 6 files changed, 68 insertions(+)
 create mode 100644 tests/programs/_build_clang.sh
 create mode 100644 tests/programs/_build_clang_native.sh
 create mode 100755 tests/programs/clang_sample
 create mode 100644 tests/programs/clang_sample.c

diff --git a/.gitignore b/.gitignore
index 978349dd..7a23bd9e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,4 @@ Cargo.lock
 .deps/
 /examples/is13
 *.DS_Store
+tests/programs/deps
diff --git a/tests/programs/_build_clang.sh b/tests/programs/_build_clang.sh
new file mode 100644
index 00000000..5d64e671
--- /dev/null
+++ b/tests/programs/_build_clang.sh
@@ -0,0 +1,7 @@
+set -ex
+
+DOCKER="${DOCKER:-docker}"
+# docker pull docker.io/cryptape/llvm-n-rust:20240630
+DOCKER_IMAGE="${DOCKER_IMAGE:-docker.io/cryptape/llvm-n-rust@sha256:bafaf76d4f342a69b8691c08e77a330b7740631f3d1d9c9bee4ead521b29ee55}"
+
+$DOCKER run --rm -e UID=`id -u` -e GID=`id -g` $DOCKER_RUN_ARGS -v `pwd`:/code $DOCKER_IMAGE bash _build_clang_native.sh
diff --git a/tests/programs/_build_clang_native.sh b/tests/programs/_build_clang_native.sh
new file mode 100644
index 00000000..b9d3dba0
--- /dev/null
+++ b/tests/programs/_build_clang_native.sh
@@ -0,0 +1,27 @@
+set -ex
+
+ROOT_DIR=$(pwd)
+CLANG="${CLANG:-clang-18}"
+LD="${CLANG/clang/ld.lld}"
+CFLAGS="--target=riscv64 -march=rv64imac_zba_zbb_zbc_zbs -nostdinc -isystem $ROOT_DIR/deps/musl/release/include -c -fdata-sections -ffunction-sections"
+LDFLAGS="--gc-sections -nostdlib --sysroot $ROOT_DIR/deps/musl/release -L$ROOT_DIR/deps/musl/release/lib -lc -lgcc"
+
+if [ ! -d deps ]; then
+	mkdir deps
+fi
+
+if [ ! -d deps/musl ]; then
+	cd deps
+	git clone https://github.com/xxuejie/musl
+	cd musl
+	git checkout 603d5e9
+	cd ../..
+fi
+
+if [ ! -d deps/musl/release ]; then
+	cd deps/musl
+	CLANG=$CLANG ./ckb/build.sh
+	cd -
+fi
+
+$CLANG $CFLAGS clang_sample.c -o clang_sample.o && $LD $LDFLAGS clang_sample.o -o clang_sample && rm clang_sample.o
diff --git a/tests/programs/clang_sample b/tests/programs/clang_sample
new file mode 100755
index 0000000000000000000000000000000000000000..9d523ae417e6e9fc5b35475a258847f46e22fdad
GIT binary patch
literal 8392
zcmbuE4RBP|y}<u>le<|k+QcQGZHI<j%}6@UWOwrgMJF4wOJI<BrC`fU+ndeJ0t@+K
zcN0lxqDeNp2{vGGNeN2lB>}19d$m>u#eS&RCTKsVj@3v%-YWvBX^VzTiK3(C{m;4o
zlWfjr-%Q6lvwP0{o&WiN-T%4w+}#H~o4poA0dZL1U%<{zWt*&m2C7$@9Y!ml9IW`g
z6l~Z6q;qDDSMb?P#+?5jW&@(NnPPmD&6__+kmmK%sc0d~lw?@NkKp~}r)aNbm~x^`
zoX33aSYnQMtTqjZmej*V;Rb=PO@!;%ynpvd188RPJx})J`5Op`R+v??tyl9VAxrUS
z`6oZUR8v`}`no!ft^$a64u7&VdUWQ~*?3f)u<ui5mkgQG`B$DRRUqwI>#^rb6o~vP
zdJNpBGhV8&_gtT~@46q_A71-??d;fK=ar~e>w9yMNyVel9}jzvOxvxkxA-27TeEWd
z-!=T>prKzgFUHfOP=-==HTvij<mOC4O{TF;<)e&ind(zh0Q>Tyr=p5?>e^qg7j#=*
zwyUqHahn@Pkac>M4V@d5>M3~1d8?;oI&OPS&5MRm``a(Nv#nRkn8zjL@mTbjD`Ti4
z-t+!!{2lJ^fL4BLu=8&!`a3%3?<#Nqv|Vkv#dpk({`R83qvY?ruQf}jU`UaD9jS3E
zT^%A@1>Lr{F|y1lxcE7vO0{NBu=!DsmU-r>B_7)wmY3OiJbm<-T?H$Ph($Rc(a@cb
zcn(j*vH0_OM7GyV`|9cHt9G?J<F1d{d89;rRPkh9g)1<bJ=DIPUCR-EHQV-CujgIM
zzq)C1%ayGcpJTRS(I59W_O-e)Mj?KFX4duhcX9`V@r;gtb?-UwaQlk(hfgn=fPq)+
z4;{!nq&f#&>1Qf>!&?XJ>db?xYP;AQ?yKwHy>$SuQ(kw?s`Qy_<iRsq(et1^z53=Y
z(UE3L_)=YEU?gDK<H4FL=u$jg9ZyEHd~s{d&F$NbW#g9q_Fg~pCvrv|jCz;7eEX|L
z^%*cpbkO+2<IujntD`X5)sgA5TQA;h42*)UJ?hCk$9R@+#{0>3W97Id%hOW&;eAE`
zdm9IKJ{Bu=8+PnBbb8`eP_?XanDA=Z<M6!K)~?-(Rc9Xu)thyWX|^lM^ICDXS1aoD
zYU>VHY2~XtTCu~U6}dgyy05L*%6;p#;(hCJd_9i4wen#%^CmaFeTNYrwPku{O4{x-
z-W#=MwP)VTqA<Skw6$}ivN3I~s{HIB)n>m5D&jXygX;f6W=`+wq3Du=V@7O;8b7`f
zUO%38rVrZRRI2O;`!Elgpd38C&41Gf=6V|PV^dI(>54vvb*JL$n1)NetftdSZif6L
zmjfq1-u|MpaZ@yczNZx{-bit$CvA=5iLB|YN?WT`Mb>t%Py4E}KJwMh%CvP#Wn^8a
zJMC`8jWKWN>iG7)*p-4Sg_F*!rPtP8zvo8f$72`of~jk>6ET0E`zLR+{)>~WAAOhg
z|MOkeADCeM2a)%?)k}FhF~e58nqL@)O26vuKd0rY(Cc=U3_*L&sTv<%`S|-KF#T(F
z%-)j&YW0)7kuepX>4~aZ#|4Pm;;m)SzWnf*nsNC^#%%V`lfCf|%HhrPsMlgVFb?Ou
z`2EFrYYdD>toiX)FBk*Xf)7s)x(|AdLvLjs@EV8TTBdbOLj1lSIDtA3*xHt#Q$5v@
zQ=Zw!wq_{tqgEyDhtb*7?|cKap&Rhn>sBScB14Is8a3GnGLjo~bE%U^#!adJIi#Js
z0OxFO)OmT=D<8d@bIyA?F#i6r5%l!_5*VIE5B=koyQ?E3D*VMg=y}7V4Sf?d)T*7F
z1U_5E*|y6yuY5Y}HTI0d5%&eRHgo}HCSlk%tn#Q1Syvw6^sw!)`pF23C~9j*s~ahj
z9*7@}Ns+`LzM@Bp#FR^n#FUaF8D){wjsN4!6N%Z2-<P3iofqJstp#nng>B4Y3>IcF
zhFR=^g<0(3atmy8DcSb#nC+e8msl;NozH>D`8$Et!wHN!GFAdw=MCf@<lEr{dJ`G*
zgVr?(C%PDK0WHE<6vqePL}U`#<Dhlp{O%jb&wv(XY!t`egcDIFI{{h@=f~Lm8PIz0
znyT@bO*zps3D5Sj`nud@{nKah2d`tSmwUtXdEwyL|EKM+YVWD$vHcXK^8uee52=^B
zI>a27jRUChE}oNTd)0?pUXP5bn5DDO)iM8c!L>MBmV?jEboF-D#<4X%=!V`J%fN8@
z<#)UJQ{8+Lbam8xSv>iR_>RD+_ciXyZS@C3fu_b>M|q*6upD4>pmDE1xHfn5<|@J5
zUX%|8LPjen>#&=ir3PC|iv!MPhu+|9F4BFhXRzLPYkdyh)S8W9HX&@d&BeZ$SLrZ4
zE03AmA_c^LON{66jtXWgD8T1=H(Ae@kT0e`pUW$A`%j_CnSz%Qf137zLVi7VaEAf?
zw9ga!&Mm|TiHq#-AU)S5JwD>gZxxapK!A9b#P=arFtR5|zu5P-le|-sj}qS`@q@%q
zN_>F$n8bfT{3VG$PW*o*{v*!k^TSW^>lxme_h0bmcqjS#{+#pV>-zz2fGrjU!en<p
zDJo=}cMF{)H0Q9tSUtSLWzykB!NUCij`L)HUgtd7pAEPfS1j{-c5^v^x3FEz?iD_+
zz*Q-4e<!}%zR;g(;#m^^ka(5E%~vi3_DFmQSBrU*_$|aQN_;u-pGtfs=V@@9>X5sE
zUmEAhdAp1A<h=c!uA|69FDd#Xa>X*QU%bm*71y2oiIMzQ$j^@?Kb<M;ZbyZzeq{MF
zlwa(6RU@~scgJO1A-<uS$2NXC&k4g0;!ctm+(*1v;sN4C65ofM*)1o&j1)aU^3{@j
zjN~^HXLoUS93lBblKgR!e}wo)ra1f;$#26aOyY5x_*RMkjCiKRe@Q%D;=dujQsRFg
z{+`7Dj9kG?i1%r6zx^kdpXb8YYb4)G^(o}ddqZ-4s{EdjT%W^KCw=6PSl1T3&#?ND
z`BK!gSpC?!eg&>eaotAzx8_0<?!zkLc@keuJYC`r;&(`V4e>W5UP-(_;+u$XlK9t&
zXWhmVKIiARh?h(9b;O4x`3B+@l6))i_aylTi7&r>q1|5M1uGWv!^FQY@kfc*OLk8X
z2TA_FiT_2CKSO-EB>w{OQi-1@{*1(5Bc3P4^+)3ONc<A<T#5ga^W=KI#(8o*&mdo{
zKJiwIM;Z)C_wx+Sll5nEo~-|FTrcdtE%b<WmyPm^+09L%|IQTp3sUI02RXY>R#Sd>
z_!v<Y*E7#W;cg`PO(b7T13O4wa3TL4;$bQOJBja+cq8Y@c?)r#oHrZYXM|nh&wi9&
zEN`7D^v6=@|6U3`M^orIo<h%X3O!FCXZe3X%KuYb&pa3TJk5D>e$H~9oS)BAeq{Z>
zK>5Y;GnzvGuT$v%BHuUSbHuUmezK19<oA(#Q}CJ;d|wKVTSmxRq;3m{%kdVa;9HR2
zih9KJWgCwZU>9-md%MVgBk>pLedJjhxF7kdMV_;L#O3GdS>()rd0+G@ae3eJXX5gH
zV~V)EZ&`tPV{wW1!R6#<8S*T=^7HSvG*B4!?+-&^sLmJmVN)9lK_UM#ni?AXjX1<#
zY72ega4=BY687VGsI4LFtHpMAC>%6<W()jvSr7Rdn(O_A2Hdf~un6v`D|E0gCm6x7
z18L#rW+UjY*LMeSkV(t~2Q>Hsje58~gmdP)PL!yuEYd|=Oy@4BZ3)ze%?ZRxsV(EJ
zgXTDNbB;rI5id>f3!QVZ(_*L()Edn1IhXm6t_K<eVeS>hWcnj)nL3N~k~!NLmV*ol
z!%n7^o8hL*5|Xn!u*YZY)kAF|!&hIA_UrsReJ%B2y*9X4WQfHt^b5PibAk;GzUH}r
z#q2<n5w7RdiQx-+e=rdCw{q;#*HBwdt!cqU*>dS-7K`=Lx#{SV-VkUsQzUe9=-baA
zh1uY5Fq+#$37F|}2){)fB5#5_OmjtKwn%rFNi5P`tVmc2OotJO5r-IYiRy3(wN6nd
zPNCN^N5m|LQ0NrXox(e(nH01o{BsFCu9Acj!6e|73pDO*GAk#s;zfek>RC`%y3R^X
z4~2cfu+9pdUG<iRhBothCk(REW6+GsMFs8B`I;(ceyjn^cE}%=4EP&c1HmSy7-eV$
z`u7KzSb`-{l*OQX%)xnSQTNTD>*3u&zpoCx4u$plCSxxmqp7)#Eeh<4^#QzxKn_6H
zceXSdA-$<lXFh<w6Q`hDC|nn4BE%K|OCwEZQDF@+AwMoY)4mVA05fgW=mts{du#D_
z!dH<f&}4`ODz3-E6_=!7A>fN^fjU}43z)gu79d*C{6>Z<chxu5`s(%Ora)uZAG`zf
zsvTS0_ikJdy1%gw$9WQc!Jw}#8Sp|u8J0FZQ6>SHGUAE#*;@8gXCEu65ziCxKkwZC
zxil{Jk8}#`Z(lZ_9;<Wjq2m8u^LI-j4fxOX!s8Y^WlYQ$zZ>?`|F^d-6i=GZ-un~h
zi{Jmm{IkrtghRG}JB~3C`4?F+e|5rK))neRn}-a2Z<fU7{(lz#GmCLCPn@&;tejIm
zw$zkpW(mTBrK1l&!hew$_7k+o9d_rAW)fh(yCxp8efB%ZV)I|1`Q2=PmT<`P{|^Ty
B&nf@_

literal 0
HcmV?d00001

diff --git a/tests/programs/clang_sample.c b/tests/programs/clang_sample.c
new file mode 100644
index 00000000..33c14ce1
--- /dev/null
+++ b/tests/programs/clang_sample.c
@@ -0,0 +1,3 @@
+int main() {
+    return 0;
+}
diff --git a/tests/test_misc.rs b/tests/test_misc.rs
index 8719d0bc..b4c9874d 100644
--- a/tests/test_misc.rs
+++ b/tests/test_misc.rs
@@ -13,6 +13,7 @@ use rand::{thread_rng, Rng};
 use std::fs;
 use std::sync::atomic::{AtomicU8, Ordering};
 use std::sync::Arc;
+pub mod machine_build;
 
 #[test]
 pub fn test_andi() {
@@ -431,3 +432,32 @@ pub fn test_outofcycles_in_syscall() {
     assert_eq!(machine.cycles(), 108);
     assert_eq!(machine.registers()[A0], 39);
 }
+
+#[test]
+pub fn test_clang() {
+    {
+        let mut machine = machine_build::int_v1_imcb("tests/programs/clang_sample");
+        let ret = machine.run();
+        assert!(ret.is_ok());
+    }
+
+    #[cfg(has_asm)]
+    {
+        let mut machine_asm = machine_build::asm_v1_imcb("tests/programs/clang_sample");
+        let ret_asm = machine_asm.run();
+        assert!(ret_asm.is_ok());
+    }
+
+    {
+        let mut machine = machine_build::int_v2_imacb("tests/programs/clang_sample");
+        let ret = machine.run();
+        assert!(ret.is_ok());
+    }
+
+    #[cfg(has_asm)]
+    {
+        let mut machine_asm = machine_build::asm_v2_imacb("tests/programs/clang_sample");
+        let ret_asm = machine_asm.run();
+        assert!(ret_asm.is_ok());
+    }
+}