Add parallel-vectorize prototype.

Add llvm_cbuilder.
This commit is contained in:
Siu Kwan Lam 2012-08-01 19:02:58 -07:00
commit 066480fbb8
6 changed files with 783 additions and 0 deletions

View file

@ -0,0 +1,2 @@
from .builder import CBuilder
from .executor import CExecutor

515
llvm_cbuilder/builder.py Normal file
View file

@ -0,0 +1,515 @@
#
# TODO: Add support for vector.
#
import contextlib
import llvm.core as lc
def _is_int(ty):
return isinstance(ty, lc.IntegerType)
def _is_real(ty):
tys = [ lc.Type.float(),
lc.Type.double(),
lc.Type.x86_fp80(),
lc.Type.fp128(),
lc.Type.ppc_fp128() ]
return any(ty == x for x in tys)
def _is_pointer(ty):
return isinstance(ty, lc.PointerType)
def _is_block_terminated(bb):
instrs = bb.instructions
return len(instrs) > 0 and instrs[-1].is_terminator
@contextlib.contextmanager
def _change_block_temporarily(builder, bb):
origbb = builder.basic_block
builder.position_at_end(bb)
yield
builder.position_at_end(origbb)
class _IfElse(object):
def __init__(self, parent, cond):
self.parent = parent
self.cond = cond
self._to_close = []
@contextlib.contextmanager
def then(self):
self._bbif = self.parent.function.append_basic_block('if.then')
self._bbelse = self.parent.function.append_basic_block('if.else')
builder = self.parent.builder
builder.cbranch(self.cond.value, self._bbif, self._bbelse)
builder.position_at_end(self._bbif)
yield
self._to_close.extend([self._bbif, self._bbelse])
@contextlib.contextmanager
def otherwise(self):
self.parent.builder.position_at_end(self._bbelse)
yield
def close(self):
bbend = self.parent.function.append_basic_block('if.end')
builder = self.parent.builder
for bb in self._to_close:
if not _is_block_terminated(bb):
with _change_block_temporarily(builder, bb):
builder.branch(bbend)
builder.position_at_end(bbend)
class _Loop(object):
def __init__(self, parent):
self.parent = parent
@contextlib.contextmanager
def condition(self):
builder = self.parent.builder
self._bbcond = self.parent.function.append_basic_block('loop.cond')
self._bbbody = self.parent.function.append_basic_block('loop.body')
self._bbend = self.parent.function.append_basic_block('loop.end')
builder.branch(self._bbcond)
builder.position_at_end(self._bbcond)
def setcond(cond):
builder.cbranch(cond.value, self._bbbody, self._bbend)
yield setcond
@contextlib.contextmanager
def body(self):
builder = self.parent.builder
builder.position_at_end(self._bbbody)
yield self
if not _is_block_terminated(builder.basic_block):
builder.branch(self._bbcond)
def break_loop(self):
self.branch(self._bbend)
def continue_loop(self):
self.branch(self._bbcond)
def close(self):
self.parent.builder.position_at_end(self._bbend)
class CBuilder(object):
'''
A wrapper class for features in llvm-py package
to allow user to use C-like high-level language contruct easily.
'''
def __init__(self, function):
self.function = function
self.declare_block = self.function.append_basic_block('decl')
self.first_body_block = self.function.append_basic_block('body')
self.builder = lc.Builder.new(self.first_body_block)
# prepare arguments
self.args = []
for arg in function.args:
var = self.var(arg.type, arg, name=arg.name)
self.args.append(var)
@staticmethod
def new_function(mod, name, ret, args):
functype = lc.Type.function(ret, args)
func = mod.add_function(functype, name=name)
return CBuilder(func)
def var(self, ty, value=None, name=''):
'''
Only allocate in the first block
'''
with _change_block_temporarily(self.builder, self.declare_block):
ptr = self.builder.alloca(ty, name=name)
if value is not None:
if not isinstance(value, lc.Value):
value = self.constant(ty, value).value
self.builder.store(value, ptr)
return CVar(self, ptr)
def array(self, ty, count, name=''):
with _change_block_temporarily(self.builder, self.declare_block):
if not isinstance(count, lc.Value):
count = self.constant(lc.Type.int(), count).value
ptr = self.builder.alloca_array(ty, count, name=name)
return CArray(self, ptr)
def ret(self, val=None):
retty = self.function.type.pointee.return_type
if val is not None:
if val.type != retty:
errmsg = "Return type mismatch"
raise TypeError(errmsg)
self.builder.ret(val.value)
else:
if retty != lc.Type.void():
errmsg = "Cannot return void"
raise TypeError(errmsg)
self.builder.ret_void()
@contextlib.contextmanager
def ifelse(self, cond):
cb = _IfElse(self, cond)
yield cb
cb.close()
@contextlib.contextmanager
def loop(self):
cb = _Loop(self)
yield cb
cb.close()
def position_at_end(self, bb):
self.basic_block = bb
self.builder.position_at_end(bb)
def close(self):
# Close declaration block
with _change_block_temporarily(self.builder, self.declare_block):
self.builder.branch(self.first_body_block)
def constant(self, ty, val):
if isinstance(ty, lc.IntegerType):
res = lc.Constant.int(ty, val)
elif ty==lc.Type.float() or ty==lc.Type.double():
res = lc.Constant.real(ty, val)
else:
raise TypeError("Cannot auto build constant "
"from %s and value %s" % (ty, val))
return CTemp(self, res)
def constant_null(self, ty):
res = lc.Constant.null(ty)
return CTemp(self, res)
def get_intrinsic(self, intrinsic_id, tys):
lfunc = lc.Function.intrinsic(self.function.module, intrinsic_id, tys)
return CFunc(self, lfunc)
def get_function_named(self, name):
m = self.function.module
func = m.get_function_named(name)
return CFunc(self, func)
def is_terminated(self):
'''
Is the current basic-block terminated?
'''
return _is_block_terminated(self.builder.basic_block)
class CValue(object):
'''
= Signess =
Since LLVM type does not provide signess attribute. This information
is provided in the CValue.unsigned attribute. The default value is
`None`, meaning that this attribute is not set.
In casting operation, signess information is passed as an optional arg.
In binary operation, signess of the left operand is used.
'''
# Attribute for for integer values.
unsigned = None
_BINOP_MAP = {
# op-name : (signed int, unsigned int, real)
'add' : (lc.Builder.add, lc.Builder.add, lc.Builder.fadd),
'sub' : (lc.Builder.sub, lc.Builder.sub, lc.Builder.fsub),
'mul' : (lc.Builder.mul, lc.Builder.mul, lc.Builder.fmul),
'div' : (lc.Builder.sdiv, lc.Builder.udiv, lc.Builder.fdiv),
'mod' : (lc.Builder.srem, lc.Builder.urem, lc.Builder.frem),
}
_BITWISE_MAP = {
# op-name : (signed int, unsigned int)
'lshift' : (lc.Builder.shl, lc.Builder.shl),
'rshift' : (lc.Builder.lshr, lc.Builder.ashr),
'and' : (lc.Builder.and_, lc.Builder.and_),
'or' : (lc.Builder.or_, lc.Builder.or_),
'xor' : (lc.Builder.xor, lc.Builder.xor),
}
_CMP_MAP = {
# op-name : (signed int, unsigned int, real)
'eq' : (lc.ICMP_EQ, lc.ICMP_EQ, lc.FCMP_OEQ),
'ne' : (lc.ICMP_NE, lc.ICMP_NE, lc.FCMP_ONE),
'lt' : (lc.ICMP_SLT, lc.ICMP_ULT, lc.FCMP_OLT),
'le' : (lc.ICMP_SLE, lc.ICMP_ULE, lc.FCMP_OLE),
'gt' : (lc.ICMP_SGT, lc.ICMP_UGT, lc.FCMP_OGT),
'ge' : (lc.ICMP_SGE, lc.ICMP_UGE, lc.FCMP_OGE),
}
def __init__(self, parent):
self.parent = parent
def _use_binop(self, op):
def wrapped(rhs):
self._ensure_same_type(rhs)
binop = self._BINOP_MAP[op]
if self.is_int:
if not self.unsigned:
idx = 0
else:
idx = 1
elif self.is_real:
idx = 2
else:
errmsg = "Binary operation %s does not support type %s"
raise TypeError(errmsg % (op, self.type))
res = binop[idx](self.parent.builder, self.value, rhs.value)
return CTemp(self.parent, res)
return wrapped
def _use_bitwise(self, op):
def wrapped(rhs):
self._ensure_same_type(rhs)
if not self.is_int:
errmsg = "Bitwise operation %s does not support type %s"
raise TypeError(op, self.type)
if not self.unsigned:
idx = 0
else:
idx = 1
res = self._BITWISE_MAP[idx](self.parent.builder,
self.value, rhs.value)
return CTemp(self.parent, res)
return wrapped
def __add__(self, rhs):
return self._use_binop('add')(rhs)
def __sub__(self, rhs):
return self._use_binop('sub')(rhs)
def __mul__(self, rhs):
return self._use_binop('mul')(rhs)
def __div__(self, rhs):
return self._use_binop('div')(rhs)
def __mod__(self, rhs):
return self._use_binop('mod')(rhs)
def __lshift__(self, rhs):
return self._use_bitwise('lshift')(rhs)
def __rshift__(self, rhs):
return self._use_bitwise('rshift')(rhs)
def __and__(self, rhs):
return self._use_bitwise('and')(rhs)
def __or__(self, rhs):
return self._use_bitwise('or')(rhs)
def __xor__(self, rhs):
return self._use_bitwise('xor')(rhs)
def _ensure_same_type(self, val):
if self.type != val.type:
errmsg = "Type mismatch: %s != %s"
raise TypeError(errmsg % (self.type, val.type))
@property
def is_int(self):
return _is_int(self.type)
@property
def is_real(self):
return _is_real(self.type)
def cast(self, ty, unsigned=False):
make = lambda X: CTemp(self.parent, X)
if self.type == ty:
return self # pass thru
elif self.is_pointer and _is_pointer(ty):
builder = self.parent.builder
return make(builder.bitcast(self.value, ty))
elif self.is_int:
if _is_int(ty):
if self.type.width > ty.width:
if not unsigned:
return make(self.parent.builder.sext(self.value, ty))
else:
return make(self.parent.builder.zext(self.value, ty))
else:
return make(self.parent.trunc(self.value, ty))
elif _is_real(ty):
if not unsigned:
return make(self.parent.builder.sitofp(self.value, ty))
else:
return make(self.parent.builder.uitofp(self.value, ty))
elif self.is_real:
if not unsigned:
return make(self.parent.builder.fptosi(self.value, ty))
else:
return make(self.parent.builder.fptoui(self.value, ty))
errmsg = "Cast from %s to %s is not possible."
raise TypeError(errmsg % (self.type, ty))
def _cmp_op(self, name):
def wrapped(rhs):
make = lambda X: CTemp(self.parent, X)
self._ensure_same_type(rhs)
flag_bag = self._CMP_MAP[name]
if self.is_int:
comparator = self.parent.builder.icmp
if not self.unsigned:
flag = flag_bag[0]
else:
flag = flag_bag[1]
elif self.is_real:
comparator = self.parent.builder.fcmp
flag = flag_bag[2]
else:
errmsg = "Comparision between %s and %s is not supported."
raise TypeError(errmsg % (self.type, rhs.type))
return CTemp(self.parent, comparator(flag, self.value, rhs.value))
return wrapped
def __eq__(self, rhs):
return self._cmp_op('eq')(rhs)
def __ne__(self, rhs):
return self._cmp_op('ne')(rhs)
def __lt__(self, rhs):
return self._cmp_op('lt')(rhs)
def __le__(self, rhs):
return self._cmp_op('le')(rhs)
def __gt__(self, rhs):
return self._cmp_op('gt')(rhs)
def __ge__(self, rhs):
return self._cmp_op('ge')(rhs)
@property
def is_pointer(self):
return _is_pointer(self.type)
def _ensure_is_pointer(self):
if not self.is_pointer:
raise TypeError("Must be a pointer")
class CFunc(CValue):
def __init__(self, parent, func):
super(CFunc, self).__init__(parent)
self.function = func
def __call__(self, *args):
arg_value = map(lambda x: x.value, args)
res = self.parent.builder.call(self.function, arg_value)
return CTemp(self.parent, res)
@property
def value(self):
return self.function
@property
def type(self):
return self.function.type
class CTemp(CValue):
def __init__(self, parent, value):
super(CTemp, self).__init__(parent)
self.value = value
@property
def type(self):
return self.value.type
class CVar(CValue):
def __init__(self, parent, ptr):
super(CVar, self).__init__(parent)
self.ptr = ptr
def _inplace_op(self, op):
def wrapped(rhs):
res = self._use_binop('add')(rhs)
self.assign(res)
return self
return wrapped
def __iadd__(self, rhs):
return self._inplace_op('add')(rhs)
def __isub__(self, rhs):
return self._inplace_op('sub')(rhs)
def __imul__(self, rhs):
return self._inplace_op('mul')(rhs)
def __idiv__(self, rhs):
return self._inplace_op('div')(rhs)
def __imod__(self, rhs):
return self._inplace_op('mod')(rhs)
@property
def value(self):
return self.parent.builder.load(self.ptr)
def assign(self, val):
self.parent.builder.store(val.value, self.ptr)
@property
def type(self):
return self.ptr.type.pointee
def load(self):
self._ensure_is_pointer()
loaded = self.parent.builder.load(self.value)
return CTemp(self.parent, loaded)
def store(self, val):
self._ensure_is_pointer()
self.parent.builder.store(val.value, self.value)
def reference(self):
return CTemp(self.parent, self.ptr)
class CArray(CValue):
def __init__(self, parent, base):
super(CArray, self).__init__(parent)
self.base_ptr = base
@property
def value(self):
return self.base_ptr
@property
def type(self):
return self.base_ptr.type
def __getitem__(self, idx):
self._ensure_is_pointer()
builder = self.parent.builder
if isinstance(idx, CValue):
idx = idx.value
elif not isinstance(idx, lc.Value):
idx = self.parent.constant(lc.Type.int(), idx).value
ptr = builder.gep(self.value, [idx])
return CVar(self.parent, ptr)

50
llvm_cbuilder/executor.py Normal file
View file

@ -0,0 +1,50 @@
from llvm.core import Type, Module
import llvm.ee as le
import ctypes as ct
MAP_CTYPES = {
'void' : None,
'bool' : ct.c_bool,
'char' : ct.c_char,
'uchar' : ct.c_ubyte,
'short' : ct.c_short,
'ushort' : ct.c_ushort,
'int' : ct.c_int,
'uint' : ct.c_uint,
'long' : ct.c_long,
'ulong' : ct.c_ulong,
'int8' : ct.c_int8,
'uint8' : ct.c_uint8,
'int16' : ct.c_int16,
'uint16' : ct.c_uint16,
'int32' : ct.c_int32,
'uint32' : ct.c_uint32,
'int64' : ct.c_int64,
'uint64' : ct.c_uint64,
'float' : ct.c_float,
'double' : ct.c_double,
'longdouble' : ct.c_longdouble,
}
class CExecutor(object):
def __init__(self, mod_or_engine):
if isinstance(mod_or_engine, Module):
self.engine = le.ExecutionEngine.new(mod_or_engine)
else:
self.engine = mod_or_engine
def get_ctype_function(self, fn, typeinfo):
types = [ MAP_CTYPES[s.strip()] for s in typeinfo.split(',') ]
if not types:
retty = None
argtys = []
else:
retty = types[0]
argtys = types[1:]
prototype = ct.CFUNCTYPE(retty, *argtys)
fnptr = self.engine.get_pointer_to_function(fn)
return prototype(fnptr)

View file

@ -0,0 +1,17 @@
from llvm.core import Type
void = Type.void()
char = Type.int(8)
short = Type.int(16)
int = Type.int(32)
int16 = short
int32 = int
int64 = Type.int(64)
float = Type.float()
double = Type.double()
# pointers
pointer = Type.pointer
void_p = pointer(char)

120
tests/test_isprime.py Normal file
View file

@ -0,0 +1,120 @@
from llvm.core import *
from llvm.passes import *
from llvm.ee import *
from llvm_cbuilder import *
import llvm_cbuilder.shortnames as C
import unittest, logging
def is_prime(x):
if x <= 2:
return True
if (x % 2) == 0:
return False
for y in range(2, int(1 + x**0.5)):
if (x % y) == 0:
return False
return True
def gen_is_prime(mod):
functype = Type.function(C.int, [C.int])
func = mod.add_function(functype, 'isprime')
cb = CBuilder(func)
arg = cb.args[0]
two = cb.constant(C.int, 2)
true = one = cb.constant(C.int, 1)
false = zero = cb.constant(C.int, 0)
with cb.ifelse( arg <= two ) as ifelse:
with ifelse.then():
cb.ret(true)
with cb.ifelse( (arg % two) == zero ) as ifelse:
with ifelse.then():
cb.ret(false)
idx = cb.var(C.int, 3, name='idx')
with cb.loop() as loop:
with loop.condition() as setcond:
setcond( idx < arg )
with loop.body():
with cb.ifelse( (arg % idx) == zero ) as ifelse:
with ifelse.then():
cb.ret(false)
# increment
idx += two
cb.ret(true)
cb.close()
return func
def gen_is_prime_fast(mod):
functype = Type.function(C.int, [C.int])
func = mod.add_function(functype, 'isprime')
cb = CBuilder(func)
arg = cb.args[0]
two = cb.constant(C.int, 2)
true = one = cb.constant(C.int, 1)
false = zero = cb.constant(C.int, 0)
with cb.ifelse( arg <= two ) as ifelse:
with ifelse.then():
cb.ret(true)
with cb.ifelse( (arg % two) == zero ) as ifelse:
with ifelse.then():
cb.ret(false)
idx = cb.var(C.int, 3, name='idx')
sqrt = cb.get_intrinsic(INTR_SQRT, [C.float])
looplimit = one + sqrt(arg.cast(C.float)).cast(C.int)
with cb.loop() as loop:
with loop.condition() as setcond:
setcond( idx < looplimit )
with loop.body():
with cb.ifelse( (arg % idx) == zero ) as ifelse:
with ifelse.then():
cb.ret(false)
# increment
idx += two
cb.ret(true)
cb.close()
return func
class TestIsPrime(unittest.TestCase):
def test_isprime(self):
mod = Module.new(__name__)
lf_isprime = gen_is_prime(mod)
logging.debug(mod)
mod.verify()
exe = CExecutor(mod)
func = exe.get_ctype_function(lf_isprime, 'bool, int')
for x in range(2, 1000):
msg = "Failed at x = %d" % x
self.assertEqual(func(x), is_prime(x), msg)
def test_isprime_fast(self):
mod = Module.new(__name__)
lf_isprime = gen_is_prime_fast(mod)
logging.debug(mod)
mod.verify()
exe = CExecutor(mod)
func = exe.get_ctype_function(lf_isprime, 'bool, int')
for x in range(2, 1000):
msg = "Failed at x = %d" % x
self.assertEqual(func(x), is_prime(x), msg)
if __name__ == '__main__':
unittest.main()

79
tests/test_pthread.py Normal file
View file

@ -0,0 +1,79 @@
from llvm.core import *
from llvm.passes import *
from llvm.ee import *
from llvm_cbuilder import *
import llvm_cbuilder.shortnames as C
import unittest, logging
logging.basicConfig(level=logging.DEBUG)
NUM_OF_THREAD = 4
def gen_test_worker(mod):
cb = CBuilder.new_function(mod, 'worker', C.void, [C.pointer(C.int)])
pval = cb.args[0]
val = pval.load()
one = cb.constant(val.type, 1)
pval.store(val + one)
cb.ret()
cb.close()
def gen_test_pthread(mod):
cb = CBuilder.new_function(mod, 'manager', C.int, [C.int])
arg = cb.args[0]
worker_func = cb.get_function_named('worker')
pthread_create = cb.get_function_named('pthread_create')
pthread_join = cb.get_function_named('pthread_join')
NULL = cb.constant_null(C.void_p)
cast_to_null = lambda x: x.cast(C.void_p)
threads = cb.array(C.void_p, NUM_OF_THREAD)
for tid in range(NUM_OF_THREAD):
pthread_create_args = [threads[tid].reference(),
NULL,
worker_func,
arg.reference()]
pthread_create(*map(cast_to_null, pthread_create_args))
for tid in range(NUM_OF_THREAD):
pthread_join_args = threads[tid], NULL
pthread_join(*map(cast_to_null, pthread_join_args))
worker_func(arg.reference())
cb.ret(arg)
cb.close()
return cb.function
class TestPThread(unittest.TestCase):
def test_pthread(self):
mod = Module.new(__name__)
# add pthread functions
mod.add_function(Type.function(C.int,
[C.void_p, C.void_p, C.void_p, C.void_p]),
'pthread_create')
mod.add_function(Type.function(C.int,
[C.void_p, C.void_p]),
'pthread_join')
gen_test_worker(mod)
lf_test_pthread = gen_test_pthread(mod)
logging.debug(mod)
mod.verify()
exe = CExecutor(mod)
exe.engine.get_pointer_to_function(mod.get_function_named('worker'))
func = exe.get_ctype_function(lf_test_pthread, 'int, int')
inarg = 1234
self.assertEqual(func(inarg), inarg+NUM_OF_THREAD+1)
if __name__ == '__main__':
unittest.main()