-
Notifications
You must be signed in to change notification settings - Fork 14
Tutorial
SPVM::Document::Tutorial - SPVM Performance Tutorial
This document is SPVM Tutorial. Describes SPVM basic grammers, how to get more performance, how to bind C/C++ libraries.
SPMV Installation is described. SPVM is a programing language, but also SPVM is a CPAN class writen by Perl and C language. You can install SPVM from CPAN using cpan or cpanm command.
Install SPVM using <a href="https://metacpan.org/pod/distribution/App-cpanminus/bin/cpanm">cpanm</a> if you has user Perl in user directory using <a href="https://perlbrew.pl/">perlbrew</a> or <a href="https://github.com/tokuhirom/plenv">plenv</a>.
cpanm SPVM
Install SPVM using cpan command.
cpan SPVM
The Advantages is that you can upgrade by simply installing SPVM from CPAN.
SPVM is a programming language, but also a Perl class, and works with Perl.
Binary compatibility is kept in upgrading unlike Perl in this point.
SPVM has a Native API for operating SPVM in cooperation with C language. In the C language level, SPVM has a way to keep the backward compatibility when upgrading.
If you load SVPM class from Perl, use the following syntax.
use SPVM 'Foo';
Suppose the following SPVM/Foo.spvm is placed on a class search path.
# SPVM/Foo.spvm
class Foo {
static method sum : int ($x1 : int, $x2 : int) {
return $x1 + $x2;
}
}
If you load SPVM Foo::Bar class, do the following.
use SPVM 'Foo::Bar';
Suppose the following SPVM/Foo/Bar.spvm is placed on a class search path.
# SPVM/Foo/Bar.spvm
class Foo::Bar {
static method sum : int ($x1 : int, $x2 : int) {
return $x1 + $x2;
}
}
use SPVM CLASS_NAME compile the SPVM class and the required classes.
Note that at this point a SPVM runtime has not yet been created.
A default SPVM runtime is created the first time you call a method of SPVM class or call a function or method of the Exchange API.
Let's call SPVM class method from Perl.
use SPVM 'Foo';
my $total = SPVM::Foo->sum(1, 2);
The definition of Foo class is the following.
# SPVM/Foo.spvm
class Foo {
static method sum : int ($x1 : int, $x2 : int) {
return $x1 + $x2;
}
}
If the number of arguments does not match the number of arguments of the SPVM method, an exception occurs.
The Perl values of the arguments are converted to the SPVM values by the rule of argument convertion.
If the type is non-conforming, an exception occurs.
The SPVM return value is converted to a Perl return value by the rule of return value convertion.
The SPVM exception is converted to a Perl exception.
Let's call SPVM instance method from Perl.
use SPVM 'Foo';
my $foo = SPVM::Foo->new;
my $total = $foo->sum(1, 2);
The definition of Foo class is the following.
# SPVM/Foo.spvm
class Foo {
static method new : Foo () {
return new Foo;
}
method sum : int ($x1 : int, $x2 : int) (
return $x1 + $x2;
}
}
Let's take SPVM for the first time. Then, let's improve the performance of the SPVM code.
Let's take SPVM for the first time. This is a first simple example. Let's calcurate the sum of numbers.
Create SPVM class. The extension is "spvm". In this example, the name of SPVM class is "SPVM/MyMath.spvm".
Create "SPVM/MyMath.spvm" in the "lib" directory, and you write the following code.
# lib/SPVM/MyMath.spvm
class MyMath {
static method sum : int ($nums : int[]) {
my $total = 0;
for (my $i = 0; $i < @$nums; $i++) {
$total += $nums->[$i];
}
return $total;
}
}
The class
keyword defines a class.
# Class Definition
class MyMath {
}
See also <a href="/language.html#language-class">Class - SPVM Language Specification</a> about Class.
The method
keyword defines a method. If the method doesn't have the instance, you define a static method using a static
attribute.
class MyMath {
# Static method definition
static method sum : int ($nums : int[]) {
}
}
See also <a href="/language.html#language-method">Method - SPVM Language Specification</a> about Method.
int
type in sum return value is signed 32bit integer type. This is same as C99 int32_t.
int
SPVM has the following types as other numeric types.
SPVM numric type th> |
C99 type> th> |
---|---|
byte |
int8_t |
short |
int16_t |
int |
int32_t |
long |
int64_t |
float |
float |
double |
double |
See also <a href="http://59.106.185.196:3000/spvmdoc-public/language.html#language-type">Type - SPVM Language Specification</a> about Type.
int[]
type in sum arguments is array of int type.
int[]
The numeric array type guarantees that the values are consecutive in memory.
In this point, unlike Perl where all value are assigned to the dynamic type SV, SPVM has a static type, so it can represent a efficient sequence of numbers.
See also <a href="http://59.106.185.196:3000/spvmdoc-public/language.html#language-type">Type - SPVM Language Specification</a> about Type.
Write Local Variable Declaration by my
keyword. You can initialize variables at the same time you declare variables.
my $total = 0;
The above declaration has the same meaning as:
my $total : int = 0;
0 on the right side is a signed 32-bit integer, so the type of the variable is automatically determined by type inference.
See also <a href="/language.html#language-local-var">Local Variable - SPVM Language Specification</a> about Local Variable Declaration.
See also <a href="/language.html#language-type-inference">Type Inference - SPVM Language Specification</a> about Type Inference.
0 is Integer Literal.
my $total : int = 0;
SPVM has the following Literal.
- Integer Literal
- Floating Point Literal
- Charater Literal
- String Literal
# Integer Literal
123
123_456_789
# Floating Point Literal
1.32
1.32f
# Character Literal
'a'
'c'
# String Literal
"Hello World!"
See also <a href="/language.html#language-literal">Literal - SPVM Language Specification</a> about Literal.
Let's look at the part where the sum of the arrays is calculated.
for (my $i = 0; $i < @$nums; $i++) {
$total += $nums->[$i];
}
See @$nums.
@$nums
@ is Array Length Operator to get array length.
Unlike Perl, which is context sensitive, Array Length Operator of SPVM always returns the length of the array.
Note that SPVM has no context.
See <a href="/language.html#language-operator-array-length">Array Length Operator - SPVM Language Specification</a> about Array Length Operator
Incremental Operator increment the value.
$i++
See <a href="http://59.106.185.196:3000/spvmdoc-public/language.html#language-operator-inc">Increment Operator - SPVM Language Specification</a> about Incremental Operator.
See <a href="http://59.106.185.196:3000/spvmdoc-public/language.html#language-operator-dec">Decrement Operator - SPVM Language Specification</a> about Decrement Operator.
Array Access can be done by "->" Arrow Operator.
$nums->[$i]
See <a href="http://59.106.185.196:3000/spvmdoc-public/language.html#language-array">Array - SPVM Language Specification</a> about Array operation.
See the following code.
$total += $nums->[$i];
This is same as the following Additon Operator and Assignment Operator.
$total = $total + $nums->[$i];
SPVM has many operators.
See <a href="/language.html#language-operator">Operator - SPVM Language Specification</a> about Opeartor.
Next, see for Statement.
for (my $i = 0; $i < @$nums; $i++) {
$total += $nums->[$i];
}
See <a href="/language.html#language-statement-for">for Statement - SPVM Language Specification</a> about for Statement.
See <a href="/language.html#language-statement">Statement - SPVM Language Specification</a> about Statement like if Statement, while Statement, and switch Statement.
At last, return Statement.
return $total;
See <a href="/language.html#language-statement-return">return Statement - SPVM Language Specification</a> about return Statement.
Create "sum.pl" file and write the following code. This is Perl program.
use strict;
use warnings;
use FindBin;
use lib "$FindBin::Bin/lib";
use SPVM 'MyMath';
# Call method
my $total = SPVM::MyMath->sum([3, 6, 8, 9]);
print "Total: $total\n";
# Call method with packed data
my $nums_packed = pack('l*', 3, 6, 8, 9);
my $api = SPVM::api();
my $sp_nums = $api->new_int_array_from_bin($nums_packed);
my $total_packed = SPVM::MyMath->sum($sp_nums);
print "Total Packed: $total_packed\n";
The followings are the conventions and add current script directry's "lib" directory to library path .
use strict;
use warnings;
use FindBin;
use lib "$FindBin::Bin/lib";
use SPVM class.
use SPVM 'MyMath';
In this place, compilation is not done. Collect SPVM classes.
Call SPVM Method. It's amazing that SPVM method can be called as Perl method.
# Call method
my $total = SPVM::MyMath->sum([3, 6, 8, 9]);
Perl array reference is converted to SPVM int array.
See <a href="/exchange-api.html#exchange-api-perl-data-to-spvm-value">Convert Perl Data to SPVM Value - SPVM Exchange AP_/a_ about Conversion of Perl Data to SPVM Value.
SPVM int return value is converted to Perl Scalar.
See <a href="/exchange-api.html#exchange-api-spvm-value-to-perl-data">Converting SPVM Value to Perl Data - SPVM Exchange AP_/a_ about Conversion of Perl Data to SPVM Value.
you can pass packed binary data. "new_int_array_from_bin" in SPVM::ExchangeAPI create SPVM int array from packed binary data. This is efficient.
# Call method with packed data
my $nums_packed = pack('l*', 3, 6, 8, 9);
my $api = SPVM::api();
my $sp_nums = $api->new_int_array_from_bin($nums_packed);
my $total_packed = SPVM::MyMath->sum($sp_nums);
<h3>How to improve SPVM Performance</h2>
See How to improve SPVM Performance.
If you're searching SPVM for performance reasons, here's what you really want to see.
SPVM Module:
# lib/SPVM/MyMath.spvm
class MyMath {
static method sum : int ($nums : int[]) {
my $total = 0;
for (my $i = 0; $i < @$nums; $i++) {
$total += $nums->[$i];
}
return $total;
}
}
Use SPVM Module from Perl
# sum.pl
use strict;
use warnings;
use FindBin;
use lib "$FindBin::Bin/lib";
use SPVM 'MyMath';
# Call method
my $total = SPVM::MyMath->sum([3, 6, 8, 9]);
print "Total: $total\n";
# Call method with packed data
my $nums_packed = pack('l*', 3, 6, 8, 9);
my $api = SPVM::api();
my $sp_nums = $api->new_int_array_from_bin($nums_packed);
my $total_packed = SPVM::MyMath->sum($sp_nums);
print "Total Packed: $total_packed\n";
Precompiled SPVM Method. This means SPVM code is converted to Machine Code:
# lib/SPVM/MyMath.spvm
class MyMath : precompile {
static method sum_precompile : int ($nums : int[]) {
my $total = 0;
for (my $i = 0; $i < @$nums; $i++) {
$total += $nums->[$i];
}
return $total;
}
}
Call SPVM Precompile Method from Perl
# sum_precompile.pl
use strict;
use warnings;
use FindBin;
use lib "$FindBin::Bin/lib";
use SPVM 'MyMath';
# Call precompile method
my $total_precompile = SPVM::MyMath->sum_precompile([3, 6, 8, 9]);
print "Total Precompile: $total_precompile\n";
SPVM Native Method. This means SPVM method call C/C++ native method:
# lib/SPVM/MyMath.spvm
class MyMath {
native static method sum_native : int ($nums : int[]);
}
// lib/SPVM/MyMath.c
#include "spvm_native.h"
int32_t SPVM__SPVM__MyMath__sum_native(SPVM_ENV* env, SPVM_VALUE* stack) {
void* sv_nums = stack[0].oval;
int32_t length = env->length(env, stack, sv_nums);
int32_t* nums = env->get_elems_int(env, stack, sv_nums);
int32_t total = 0;
for (int32_t i = 0; i < length; i++) {
total += nums[i];
}
stack[0].ival = total;
return 0;
}
# lib/SPVM/MyMath.config
use strict;
use warnings;
use SPVM::Builder::Config;
my $config = SPVM::Builder::Config->new_c99;
$config;
Use SPVM Native Method from Perl
# sum_native.pl
use strict;
use warnings;
use FindBin;
use lib "$FindBin::Bin/lib";
use SPVM 'MyMath';
# Call native method
my $total_native = SPVM::MyMath->sum_native([3, 6, 8, 9]);
print "Total Native: $total_native\n";
Environment Variable "SPVM_BUILD_DIR" must be set for precompile and native method
# bash example
export SPVM_BUILD_DIR=~/.spvm_build
The advantage of SPVM is that you can easily bind C/C++/CUDA.
Methods bound with SPVM can be easily called from Perl.
Before reading this page, you need to understand Native API.
First, let's bind our own C library.
The following source code is the completed source code.
I will explain using this source code.
<a href="https://github.com/yuki-kimoto/SPVM/tree/master/examples/native/bind\_clib">SPVM Native Example - Bind C Library</a>
Create a C language library for summation and call it from Perl.
# bind_clib.pl
use strict;
use warnings;
use FindBin;
use lib "$FindBin::Bin/lib";
use SPVM 'BindCLib';
my $total = SPVM::BindCLib->sum([1, 2, 3, 4]);
print "Total: $total\n";
SPVM Method Definition.
# lib/SPVM/BindCLib.spvm
class BindCLib {
native static method sum : int ($nums : int[]);
}
Native Config.
# lib/SPVM/BindCLib.config
use strict;
use warnings;
use SPVM::Builder::Config;
my $config = SPVM::Builder::Config->new_c99;
$config;
Call C library from C program.
// lib/SPVM/BindCLib.c
#include "spvm_native.h"
#include "bind_clib.h"
int32_t SPVM__SPVM__BindCLib__sum(SPVM_ENV* env, SPVM_VALUE* stack) {
void* sv_nums = stack[0].oval;
int32_t length = env->length(env, stack, sv_nums);
int32_t* nums = env->get_elems_int(env, stack, sv_nums);
int32_t total = bind_clib_sum(nums, length);
stack[0].ival = total;
return 0;
}
Notice the line reading the header.
#include "bind_clib.h"
This header is included from "lib/SPVM/BindCLib.native/include/bind_clib.h". This is pure C header file.
#include <inttypes.h>
int32_t bind_clib_sum(int32_t* nums, int32_t length);
SPVM sets the include directory("SPVM/BindCLib.native/include") as the default header file read path.
C library source file is "lib/SPVM/BindCLib.native/src/bind_clib.c". This is pure C source file.
#include "bind_clib.h"
int32_t bind_clib_sum(int32_t* nums, int32_t length) {
int32_t total = 0;
for (int32_t i = 0; i < length; i++) {
total += nums[i];
}
return total;
}
SPVM compiles all source files in the source directory("SPVM/BindCLib.native/src"). It can contain multiple source files.
See SPVM:Document::NativeAPI about the details of the native APIs.
If you want to know more about the bindings of other C libraries, see the example below.
If you want to know more about the bindings of C++ libraries to SPVM, see the example below.
If you want to know more about the bindings of CUDA to SPVM, see the example below.
Copyright (c) 2023 Yuki Kimoto
MIT License