concurrent-ruby 1.0.5 → 1.1.0.pre1

data/ext/concurrent-ruby/com/concurrent_ruby/ext/JavaSemaphoreLibrary.java

@@ -0,0 +1,159 @@
+package com.concurrent_ruby.ext;
+
+import java.io.IOException;
+import java.util.concurrent.Semaphore;
+import org.jruby.Ruby;
+import org.jruby.RubyClass;
+import org.jruby.RubyFixnum;
+import org.jruby.RubyModule;
+import org.jruby.RubyNumeric;
+import org.jruby.RubyObject;
+import org.jruby.anno.JRubyClass;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.runtime.ObjectAllocator;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+
+public class JavaSemaphoreLibrary {
+
+    public void load(Ruby runtime, boolean wrap) throws IOException {
+        RubyModule concurrentMod = runtime.defineModule("Concurrent");
+        RubyClass atomicCls = concurrentMod.defineClassUnder("JavaSemaphore", runtime.getObject(), JRUBYREFERENCE_ALLOCATOR);
+
+        atomicCls.defineAnnotatedMethods(JavaSemaphore.class);
+    }
+
+    private static final ObjectAllocator JRUBYREFERENCE_ALLOCATOR = new ObjectAllocator() {
+        public IRubyObject allocate(Ruby runtime, RubyClass klazz) {
+            return new JavaSemaphore(runtime, klazz);
+        }
+    };
+
+    @JRubyClass(name = "JavaSemaphore", parent = "Object")
+    public static class JavaSemaphore extends RubyObject {
+
+        private JRubySemaphore semaphore;
+
+        public JavaSemaphore(Ruby runtime, RubyClass metaClass) {
+            super(runtime, metaClass);
+        }
+
+        @JRubyMethod
+        public IRubyObject initialize(ThreadContext context, IRubyObject value) {
+            this.semaphore = new JRubySemaphore(rubyFixnumInt(value, "count"));
+            return context.nil;
+        }
+
+        @JRubyMethod
+        public IRubyObject acquire(ThreadContext context, IRubyObject value) throws InterruptedException {
+            this.semaphore.acquire(rubyFixnumToPositiveInt(value, "permits"));
+            return context.nil;
+        }
+
+        @JRubyMethod(name = "available_permits")
+        public IRubyObject availablePermits(ThreadContext context) {
+            return getRuntime().newFixnum(this.semaphore.availablePermits());
+        }
+
+        @JRubyMethod(name = "drain_permits")
+        public IRubyObject drainPermits(ThreadContext context) {
+            return getRuntime().newFixnum(this.semaphore.drainPermits());
+        }
+
+        @JRubyMethod
+        public IRubyObject acquire(ThreadContext context) throws InterruptedException {
+            this.semaphore.acquire(1);
+            return context.nil;
+        }
+
+        @JRubyMethod(name = "try_acquire")
+        public IRubyObject tryAcquire(ThreadContext context) throws InterruptedException {
+           return getRuntime().newBoolean(semaphore.tryAcquire(1));
+        }
+
+        @JRubyMethod(name = "try_acquire")
+        public IRubyObject tryAcquire(ThreadContext context, IRubyObject permits) throws InterruptedException {
+           return getRuntime().newBoolean(semaphore.tryAcquire(rubyFixnumToPositiveInt(permits, "permits")));
+        }
+
+        @JRubyMethod(name = "try_acquire")
+        public IRubyObject tryAcquire(ThreadContext context, IRubyObject permits, IRubyObject timeout) throws InterruptedException {
+             return getRuntime().newBoolean(
+                        semaphore.tryAcquire(
+                                rubyFixnumToPositiveInt(permits, "permits"),
+                                rubyNumericToLong(timeout, "timeout"),
+                                java.util.concurrent.TimeUnit.SECONDS)
+                );
+        }
+
+        @JRubyMethod
+        public IRubyObject release(ThreadContext context) {
+            this.semaphore.release(1);
+            return getRuntime().newBoolean(true);
+        }
+
+        @JRubyMethod
+        public IRubyObject release(ThreadContext context, IRubyObject value) {
+            this.semaphore.release(rubyFixnumToPositiveInt(value, "permits"));
+            return getRuntime().newBoolean(true);
+        }
+
+        @JRubyMethod(name = "reduce_permits")
+        public IRubyObject reducePermits(ThreadContext context, IRubyObject reduction) throws InterruptedException {
+            this.semaphore.publicReducePermits(rubyFixnumToNonNegativeInt(reduction, "reduction"));
+            return context.nil;
+        }
+
+        private int rubyFixnumInt(IRubyObject value, String paramName) {
+            if (value instanceof RubyFixnum) {
+                RubyFixnum fixNum = (RubyFixnum) value;
+                return (int) fixNum.getLongValue();
+            } else {
+                throw getRuntime().newArgumentError(paramName + " must be integer");
+            }
+        }
+
+        private int rubyFixnumToNonNegativeInt(IRubyObject value, String paramName) {
+            if (value instanceof RubyFixnum && ((RubyFixnum) value).getLongValue() >= 0) {
+                RubyFixnum fixNum = (RubyFixnum) value;
+                return (int) fixNum.getLongValue();
+            } else {
+                throw getRuntime().newArgumentError(paramName + " must be a non-negative integer");
+            }
+        }
+
+        private int rubyFixnumToPositiveInt(IRubyObject value, String paramName) {
+            if (value instanceof RubyFixnum && ((RubyFixnum) value).getLongValue() > 0) {
+                RubyFixnum fixNum = (RubyFixnum) value;
+                return (int) fixNum.getLongValue();
+            } else {
+                throw getRuntime().newArgumentError(paramName + " must be an integer greater than zero");
+            }
+        }
+
+        private long rubyNumericToLong(IRubyObject value, String paramName) {
+            if (value instanceof RubyNumeric && ((RubyNumeric) value).getDoubleValue() > 0) {
+                RubyNumeric fixNum = (RubyNumeric) value;
+                return fixNum.getLongValue();
+            } else {
+                throw getRuntime().newArgumentError(paramName + " must be a float greater than zero");
+            }
+        }
+
+        class JRubySemaphore extends Semaphore {
+
+            public JRubySemaphore(int permits) {
+                super(permits);
+            }
+
+            public JRubySemaphore(int permits, boolean value) {
+                super(permits, value);
+            }
+
+            public void publicReducePermits(int i) {
+                reducePermits(i);
+            }
+
+        }
+    }
+}

data/ext/concurrent-ruby/com/concurrent_ruby/ext/SynchronizationLibrary.java

@@ -0,0 +1,304 @@
+package com.concurrent_ruby.ext;
+
+import org.jruby.Ruby;
+import org.jruby.RubyBasicObject;
+import org.jruby.RubyClass;
+import org.jruby.RubyModule;
+import org.jruby.RubyObject;
+import org.jruby.RubyThread;
+import org.jruby.anno.JRubyClass;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.runtime.Block;
+import org.jruby.runtime.ObjectAllocator;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.Visibility;
+import org.jruby.runtime.builtin.IRubyObject;
+import org.jruby.runtime.load.Library;
+import sun.misc.Unsafe;
+
+import java.io.IOException;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+
+public class SynchronizationLibrary implements Library {
+
+    private static final Unsafe UNSAFE = loadUnsafe();
+
+    private static Unsafe loadUnsafe() {
+        try {
+            Class ncdfe = Class.forName("sun.misc.Unsafe");
+            Field f = ncdfe.getDeclaredField("theUnsafe");
+            f.setAccessible(true);
+            return (Unsafe) f.get((java.lang.Object) null);
+        } catch (Exception var2) {
+            return null;
+        } catch (NoClassDefFoundError var3) {
+            return null;
+        }
+    }
+
+    private static boolean supportsFences() {
+        if (UNSAFE == null) {
+            return false;
+        } else {
+            try {
+                Method m = UNSAFE.getClass().getDeclaredMethod("fullFence", new Class[0]);
+                if (m != null) {
+                    return true;
+                }
+            } catch (Exception var1) {
+                // nothing
+            }
+
+            return false;
+        }
+    }
+
+    private static final ObjectAllocator JRUBY_OBJECT_ALLOCATOR = new ObjectAllocator() {
+        public IRubyObject allocate(Ruby runtime, RubyClass klazz) {
+            return new JRubyObject(runtime, klazz);
+        }
+    };
+
+    private static final ObjectAllocator OBJECT_ALLOCATOR = new ObjectAllocator() {
+        public IRubyObject allocate(Ruby runtime, RubyClass klazz) {
+            return new Object(runtime, klazz);
+        }
+    };
+
+    private static final ObjectAllocator ABSTRACT_LOCKABLE_OBJECT_ALLOCATOR = new ObjectAllocator() {
+        public IRubyObject allocate(Ruby runtime, RubyClass klazz) {
+            return new AbstractLockableObject(runtime, klazz);
+        }
+    };
+
+    private static final ObjectAllocator JRUBY_LOCKABLE_OBJECT_ALLOCATOR = new ObjectAllocator() {
+        public IRubyObject allocate(Ruby runtime, RubyClass klazz) {
+            return new JRubyLockableObject(runtime, klazz);
+        }
+    };
+
+    public void load(Ruby runtime, boolean wrap) throws IOException {
+        RubyModule synchronizationModule = runtime.
+                defineModule("Concurrent").
+                defineModuleUnder("Synchronization");
+
+        RubyModule jrubyAttrVolatileModule = synchronizationModule.defineModuleUnder("JRubyAttrVolatile");
+        jrubyAttrVolatileModule.defineAnnotatedMethods(JRubyAttrVolatile.class);
+
+        defineClass(runtime, synchronizationModule, "AbstractObject", "JRubyObject",
+                JRubyObject.class, JRUBY_OBJECT_ALLOCATOR);
+
+        defineClass(runtime, synchronizationModule, "JRubyObject", "Object",
+                Object.class, OBJECT_ALLOCATOR);
+
+        defineClass(runtime, synchronizationModule, "Object", "AbstractLockableObject",
+                AbstractLockableObject.class, ABSTRACT_LOCKABLE_OBJECT_ALLOCATOR);
+
+        defineClass(runtime, synchronizationModule, "AbstractLockableObject", "JRubyLockableObject",
+                JRubyLockableObject.class, JRUBY_LOCKABLE_OBJECT_ALLOCATOR);
+
+        defineClass(runtime, synchronizationModule, "Object", "JRuby",
+                JRuby.class, new ObjectAllocator() {
+                    @Override
+                    public IRubyObject allocate(Ruby runtime, RubyClass klazz) {
+                        return new JRuby(runtime, klazz);
+                    }
+                });
+    }
+
+    private RubyClass defineClass(
+            Ruby runtime,
+            RubyModule namespace,
+            String parentName,
+            String name,
+            Class javaImplementation,
+            ObjectAllocator allocator) {
+        final RubyClass parentClass = namespace.getClass(parentName);
+
+        if (parentClass == null) {
+            System.out.println("not found " + parentName);
+            throw runtime.newRuntimeError(namespace.toString() + "::" + parentName + " is missing");
+        }
+
+        final RubyClass newClass = namespace.defineClassUnder(name, parentClass, allocator);
+        newClass.defineAnnotatedMethods(javaImplementation);
+        return newClass;
+    }
+
+    // Facts:
+    // - all ivar reads are without any synchronisation of fences see
+    //   https://github.com/jruby/jruby/blob/master/core/src/main/java/org/jruby/runtime/ivars/VariableAccessor.java#L110-110
+    // - writes depend on UnsafeHolder.U, null -> SynchronizedVariableAccessor, !null -> StampedVariableAccessor
+    //   SynchronizedVariableAccessor wraps with synchronized block, StampedVariableAccessor uses fullFence or
+    //   volatilePut
+    // TODO (pitr 16-Sep-2015): what do we do in Java 9 ?
+
+    // module JRubyAttrVolatile
+    public static class JRubyAttrVolatile {
+
+        // volatile threadContext is used as a memory barrier per the JVM memory model happens-before semantic
+        // on volatile fields. any volatile field could have been used but using the thread context is an
+        // attempt to avoid code elimination.
+        private static volatile ThreadContext threadContext = null;
+
+        @JRubyMethod(name = "full_memory_barrier", visibility = Visibility.PUBLIC)
+        public static IRubyObject fullMemoryBarrier(ThreadContext context, IRubyObject self) {
+            // Prevent reordering of ivar writes with publication of this instance
+            if (!supportsFences()) {
+                // Assuming that following volatile read and write is not eliminated it simulates fullFence.
+                // If it's eliminated it'll cause problems only on non-x86 platforms.
+                // http://shipilev.net/blog/2014/jmm-pragmatics/#_happens_before_test_your_understanding
+                final ThreadContext oldContext = threadContext;
+                threadContext = context;
+            } else {
+                UNSAFE.fullFence();
+            }
+            return context.nil;
+        }
+
+        @JRubyMethod(name = "instance_variable_get_volatile", visibility = Visibility.PUBLIC)
+        public static IRubyObject instanceVariableGetVolatile(
+                ThreadContext context,
+                IRubyObject self,
+                IRubyObject name) {
+            // Ensure we ses latest value with loadFence
+            if (!supportsFences()) {
+                // piggybacking on volatile read, simulating loadFence
+                final ThreadContext oldContext = threadContext;
+                return ((RubyBasicObject) self).instance_variable_get(context, name);
+            } else {
+                UNSAFE.loadFence();
+                return ((RubyBasicObject) self).instance_variable_get(context, name);
+            }
+        }
+
+        @JRubyMethod(name = "instance_variable_set_volatile", visibility = Visibility.PUBLIC)
+        public static IRubyObject InstanceVariableSetVolatile(
+                ThreadContext context,
+                IRubyObject self,
+                IRubyObject name,
+                IRubyObject value) {
+            // Ensure we make last update visible
+            if (!supportsFences()) {
+                // piggybacking on volatile write, simulating storeFence
+                final IRubyObject result = ((RubyBasicObject) self).instance_variable_set(name, value);
+                threadContext = context;
+                return result;
+            } else {
+                // JRuby uses StampedVariableAccessor which calls fullFence
+                // so no additional steps needed.
+                // See https://github.com/jruby/jruby/blob/master/core/src/main/java/org/jruby/runtime/ivars/StampedVariableAccessor.java#L151-L159
+                return ((RubyBasicObject) self).instance_variable_set(name, value);
+            }
+        }
+    }
+
+    @JRubyClass(name = "JRubyObject", parent = "AbstractObject")
+    public static class JRubyObject extends RubyObject {
+
+        public JRubyObject(Ruby runtime, RubyClass metaClass) {
+            super(runtime, metaClass);
+        }
+    }
+
+    @JRubyClass(name = "Object", parent = "JRubyObject")
+    public static class Object extends JRubyObject {
+
+        public Object(Ruby runtime, RubyClass metaClass) {
+            super(runtime, metaClass);
+        }
+    }
+
+    @JRubyClass(name = "AbstractLockableObject", parent = "Object")
+    public static class AbstractLockableObject extends Object {
+
+        public AbstractLockableObject(Ruby runtime, RubyClass metaClass) {
+            super(runtime, metaClass);
+        }
+    }
+
+    @JRubyClass(name = "JRubyLockableObject", parent = "AbstractLockableObject")
+    public static class JRubyLockableObject extends JRubyObject {
+
+        public JRubyLockableObject(Ruby runtime, RubyClass metaClass) {
+            super(runtime, metaClass);
+        }
+
+        @JRubyMethod(name = "synchronize", visibility = Visibility.PROTECTED)
+        public IRubyObject rubySynchronize(ThreadContext context, Block block) {
+            synchronized (this) {
+                return block.yield(context, null);
+            }
+        }
+
+        @JRubyMethod(name = "ns_wait", optional = 1, visibility = Visibility.PROTECTED)
+        public IRubyObject nsWait(ThreadContext context, IRubyObject[] args) {
+            Ruby runtime = context.runtime;
+            if (args.length > 1) {
+                throw runtime.newArgumentError(args.length, 1);
+            }
+            Double timeout = null;
+            if (args.length > 0 && !args[0].isNil()) {
+                timeout = args[0].convertToFloat().getDoubleValue();
+                if (timeout < 0) {
+                    throw runtime.newArgumentError("time interval must be positive");
+                }
+            }
+            if (Thread.interrupted()) {
+                throw runtime.newConcurrencyError("thread interrupted");
+            }
+            boolean success = false;
+            try {
+                success = context.getThread().wait_timeout(this, timeout);
+            } catch (InterruptedException ie) {
+                throw runtime.newConcurrencyError(ie.getLocalizedMessage());
+            } finally {
+                // An interrupt or timeout may have caused us to miss
+                // a notify that we consumed, so do another notify in
+                // case someone else is available to pick it up.
+                if (!success) {
+                    this.notify();
+                }
+            }
+            return this;
+        }
+
+        @JRubyMethod(name = "ns_signal", visibility = Visibility.PROTECTED)
+        public IRubyObject nsSignal(ThreadContext context) {
+            notify();
+            return this;
+        }
+
+        @JRubyMethod(name = "ns_broadcast", visibility = Visibility.PROTECTED)
+        public IRubyObject nsBroadcast(ThreadContext context) {
+            notifyAll();
+            return this;
+        }
+    }
+
+    @JRubyClass(name = "JRuby")
+    public static class JRuby extends RubyObject {
+        public JRuby(Ruby runtime, RubyClass metaClass) {
+            super(runtime, metaClass);
+        }
+
+        @JRubyMethod(name = "sleep_interruptibly", visibility = Visibility.PUBLIC, module = true)
+        public static IRubyObject sleepInterruptibly(ThreadContext context, IRubyObject receiver, Block block) {
+            try {
+                return context.getThread().executeTask(context, block,
+                        new RubyThread.Task<Block, IRubyObject>() {
+                            public IRubyObject run(ThreadContext context, Block block1) throws InterruptedException {
+                                return block1.call(context);
+                            }
+
+                            public void wakeup(RubyThread thread, Block block1) {
+                                thread.getNativeThread().interrupt();
+                            }
+                        });
+            } catch (InterruptedException e) {
+                throw context.runtime.newThreadError("interrupted in Concurrent::Synchronization::JRuby.sleep_interruptibly");
+            }
+        }
+    }
+}