First round of examples!

Author: chrisarg

.gitignore

@@ -0,0 +1,8 @@
+# Ignore all .csv files
+*.csv
+
+# Ignore specific directory
+./_Inline
+
+# Ignore specific file
+addArrayofIntegers_C.pl

README.md

@@ -1 +1,42 @@
 # perlAssembly
+
+This is probably one of the things that should never be allowed to exist, but why not use Perl and its capabilities to inline foreign code, to FAFO with assembly without a build system? Everything in a single file! In the process one may find ways to use Perl to enhance NASM and vice versa. But for now, I make no such claims : I am just using the perlAssembly git repo to illustrate how one can use Perl to drive (and learn to code!) assembly programs from a single file. 
+
+## x86-64 examples
+
+### addIntegers.pl
+Simple integer addition in Perl
+
+### addArrayofIntegers.pl
+Explore multiple equivalent ways to add *large* arrays in Perl:
+* ASM\_blank : test the speed of calling ASM from Perl (no computations are done)
+* ASM\_doubles : pass the array as a packed string of doubles and do scalar double floating addition in assembly
+* ASM\_doubles\_AVX: pass the array as a packed string of doubles and do packed floating point addition in assembly
+* ForLoop : standard for loop in Perl
+* ListUtil: sum function from list utilities
+* PDL : uses summation in PDL
+
+Varieties w\_alloc : allocate memory for each iteration to test the speed of pack, those marked
+as wo\_alloc, use a pre-computed data structure to pass the array to the underlying code. 
+The first benchmark gives the true cost of offloading summation to of a Perl array to a given 
+function when the source data are in Perl. The second, just benchmarks the calculation speed. 
+For the example considered here, it makes ZERO senso to offload the calculation as ListUtil is
+already within 15% of the assembly solution. If however, one was managing the array, not as a 
+Perl array, but as an area in memory through a Perl object, then one COULD consider offloading.
+
+#### Results
+                              mean    median    stddev
+ASM\_blank                  2.3e-06   2.0e-06   1.1e-06
+ASM\_doubles\_AVX\_w\_alloc    3.6e-03   3.5e-03   4.2e-04
+ASM\_doubles\_AVX\_wo\_alloc   3.0e-04   2.9e-04   2.7e-05
+ASM\_doubles\_w\_alloc        4.3e-03   4.1e-03   4.5e-04
+ASM\_doubles\_wo\_alloc       8.9e-04   8.7e-04   3.0e-05
+ASM\_w\_alloc                4.3e-03   4.2e-03   4.5e-04
+ASM\_wo\_alloc               9.2e-04   9.1e-04   4.1e-05
+ForLoop                    1.9e-02   1.9e-02   2.6e-04
+ListUtil                   4.5e-03   4.5e-03   1.4e-04
+PDL\_w\_alloc                2.1e-02   2.1e-02   6.7e-04
+PDL\_wo\_alloc               9.2e-04   9.0e-04   3.9e-05
+
+### Disclaimer
+The code here is NOT meant to be portable. I code in Linux and in x86-64, so if you are looking into Window's ABI or ARM, you will be disappointed. But as my knowledge of ARM assembly grows, I intend to rewrite some examples in Arm assembly!

_Inline/config-x86_64-linux-5.038000

@@ -0,0 +1,42 @@
+version : 0.86
+languages : %
+    AS : ASM
+    ASM : ASM
+    C : C
+    C++ : CPP
+    CPP : CPP
+    CXX : CPP
+    Cplusplus : CPP
+    Foo : Foo
+    GASP : ASM
+    NASM : ASM
+    PDLPP : Pdlpp
+    Pdlpp : Pdlpp
+    as : ASM
+    asm : ASM
+    c++ : CPP
+    cplusplus : CPP
+    cpp : CPP
+    cxx : CPP
+    foo : Foo
+    gasp : ASM
+    nasm : ASM
+    pdlpp : Pdlpp
+types : %
+    ASM : compiled
+    C : compiled
+    CPP : compiled
+    Foo : interpreted
+    Pdlpp : compiled
+modules : %
+    ASM : Inline::ASM
+    C : Inline::C
+    CPP : Inline::CPP
+    Foo : Inline::Foo
+    Pdlpp : Inline::Pdlpp
+suffixes : %
+    ASM : so
+    C : so
+    CPP : so
+    Foo : foo
+    Pdlpp : so

_Inline/lib/auto/addArrayofIntegers_pl_0e80/addArrayofIntegers_pl_0e80.inl

@@ -0,0 +1,22 @@
+md5 : 0e807e0d0019302e8463d90c1263be38
+name : addArrayofIntegers_pl_0e80
+version : ""
+language : ASM
+language_id : ASM
+installed : 0
+date_compiled : Mon Jun 17 21:07:29 2024
+inline_version : 0.86
+ILSM : %
+    module : Inline::ASM
+    suffix : so
+    type : compiled
+Config : %
+    apiversion : ?
+    archname : x86_64-linux
+    cc : cc
+    ccflags : -fwrapv -fno-strict-aliasing -pipe -fstack-protector-strong -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64
+    ld : cc
+    osname : linux
+    osvers : 5.19.0-38-generic
+    so : so
+    version : 5.38.0

_Inline/lib/auto/addArrayofIntegers_pl_0e80/addArrayofIntegers_pl_0e80.so

@@ -0,0 +1,22 @@
+md5 : 170c9874a28ebeb75479e4559340ebb7
+name : addArrayofIntegers_pl_170c
+version : ""
+language : ASM
+language_id : ASM
+installed : 0
+date_compiled : Mon Jun 17 18:42:56 2024
+inline_version : 0.86
+ILSM : %
+    module : Inline::ASM
+    suffix : so
+    type : compiled
+Config : %
+    apiversion : ?
+    archname : x86_64-linux
+    cc : cc
+    ccflags : -fwrapv -fno-strict-aliasing -pipe -fstack-protector-strong -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64
+    ld : cc
+    osname : linux
+    osvers : 5.19.0-38-generic
+    so : so
+    version : 5.38.0

_Inline/lib/auto/addArrayofIntegers_pl_170c/addArrayofIntegers_pl_170c.inl

@@ -0,0 +1,22 @@
+md5 : 17d480c17d771567a50e3aa433dd0dba
+name : addArrayofIntegers_pl_17d4
+version : ""
+language : ASM
+language_id : ASM
+installed : 0
+date_compiled : Mon Jun 17 19:30:17 2024
+inline_version : 0.86
+ILSM : %
+    module : Inline::ASM
+    suffix : so
+    type : compiled
+Config : %
+    apiversion : ?
+    archname : x86_64-linux
+    cc : cc
+    ccflags : -fwrapv -fno-strict-aliasing -pipe -fstack-protector-strong -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64
+    ld : cc
+    osname : linux
+    osvers : 5.19.0-38-generic
+    so : so
+    version : 5.38.0

_Inline/lib/auto/addArrayofIntegers_pl_170c/addArrayofIntegers_pl_170c.so

@@ -0,0 +1,22 @@
+md5 : 27699279c9b6a585f3dec726636eb04b
+name : addArrayofIntegers_pl_2769
+version : ""
+language : ASM
+language_id : ASM
+installed : 0
+date_compiled : Mon Jun 17 19:06:01 2024
+inline_version : 0.86
+ILSM : %
+    module : Inline::ASM
+    suffix : so
+    type : compiled
+Config : %
+    apiversion : ?
+    archname : x86_64-linux
+    cc : cc
+    ccflags : -fwrapv -fno-strict-aliasing -pipe -fstack-protector-strong -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64
+    ld : cc
+    osname : linux
+    osvers : 5.19.0-38-generic
+    so : so
+    version : 5.38.0