ReentrantReadWriteLock

目录

ReadWriteLock 接口:

属性:

构造方法:

内部类sync


实现了ReadWriteLock 接口

ReadWriteLock 接口:

代码块

public interface ReadWriteLock {
    /**
     * Returns the lock used for reading.
     *
     * @return the lock used for reading
     */
    // 阻塞式获取读锁
    Lock readLock();
​
    /**
     * Returns the lock used for writing.
     *
     * @return the lock used for writing
     */
    // 阻塞式获取写锁
    Lock writeLock();
}
 

 

属性:

代码块

// 内部类ReadLock  的引用
    private final ReentrantReadWriteLock.ReadLock readerLock;
    // WriteLock  的引用
    private final ReentrantReadWriteLock.WriteLock writerLock;

    // 内部类Sync  提供了所有同步的 能力
    final Sync sync;

    public ReentrantReadWriteLock.WriteLock writeLock() { return writerLock; }
    public ReentrantReadWriteLock.ReadLock  readLock()  { return readerLock; }
    
 

 

构造方法:

代码块

// 默认构造方法 使用非公平锁实现
    public ReentrantReadWriteLock() {
        this(false);
    }
​
    public ReentrantReadWriteLock(boolean fair) {
        // 公平锁以及非公平锁 通过  FairSync以及NonfairSync 实现
        sync = fair ? new FairSync() : new NonfairSync();
        readerLock = new ReadLock(this);
        writerLock = new WriteLock(this);
    }
    
 

 

内部类sync

代码块

 abstract static class Sync extends AbstractQueuedSynchronizer {
        private static final long serialVersionUID = 6317671515068378041L;
​
        // 共享锁的偏移位数
        static final int SHARED_SHIFT   = 16;
        // 共享锁的单位基数
        static final int SHARED_UNIT    = (1 << SHARED_SHIFT);
        // 独占/共享锁 最大持有数目
        static final int MAX_COUNT      = (1 << SHARED_SHIFT) - 1;
        // 辅助根据state 获取独占锁持有数目
        static final int EXCLUSIVE_MASK = (1 << SHARED_SHIFT) - 1;
​
        // 返回共享锁目前持有的数目 state 高16位表示共享锁
        static int sharedCount(int c)    { return c >>> SHARED_SHIFT; }
        // 返回独占锁目前持有的数目 state 低16位表示共享锁
        static int exclusiveCount(int c) { return c & EXCLUSIVE_MASK; }
​
        // 每个线程特定的 read 持有计数。存放在ThreadLocal,缓存在cachedHoldCounter
        // 不需要是线程安全的。
        static final class HoldCounter {
            int count = 0;
            // Use id, not reference, to avoid garbage retention
            // 存储线程id而不是引用 有利于垃圾回收
            final long tid = getThreadId(Thread.currentThread());
        }
​
        /**
         * ThreadLocal subclass. Easiest to explicitly define for sake
         * of deserialization mechanics.
         */
        // 采用继承是为了重写 initialValue 方法,这样就不用进行这样的处理:
        // 如果ThreadLocal没有当前线程的计数,则new一个,再放进ThreadLocal里。
        // 可以直接调用 get
        static final class ThreadLocalHoldCounter
            extends ThreadLocal<HoldCounter> {
            // 返回HoldCounter 新实例对象
            public HoldCounter initialValue() {
                return new HoldCounter();
            }
        }
​
        // 保存当前线程重入读锁的次数的容器。在读锁重入次数为 0 时移除
        private transient ThreadLocalHoldCounter readHolds;
​
        /**
        * 最近一个成功获取读锁的线程的计数。这省却了ThreadLocal查找,
        * 通常情况下,下一个要释放的线程是最后一个获取的线程。
        * 这不是 volatile 的,因为它仅用于试探的,线程进行缓存也是极好的
        * (因为判断是否是当前线程是通过线程id来比较的)。
        */
        private transient HoldCounter cachedHoldCounter;
​
        /**
         * firstReader是第一个获取读锁的线程,更加确切地说是最后的一个线程把 共享计数 从 0 改为 1 的(在锁空闲的时候),而且在那之后还没有释放读锁的独特的线程!
         * 如果不存在这样的线程则为null
         * firstReaderHoldCount 是 firstReader 的重入计数。
         *
         * firstReader 不会导致垃圾存留,因此在 tryReleaseShared 里设置为null,
         * 除非线程异常终止,没有释放读锁
         *
         * 这使得在跟踪无竞争的读锁计数时代价非常低
         *
         * firstReader及其计数firstReaderHoldCount是不会放入 readHolds 的
         */
        private transient Thread firstReader = null;
        // firstReaderHoldCount 是 firstReader 的重入计数。
        private transient int firstReaderHoldCount;
​
        Sync() {
            // 初始化 ThreadLocalHoldCounter
            readHolds = new ThreadLocalHoldCounter();
            // 初始化 state
            setState(getState()); // ensures visibility of readHolds
        }
​
        /*
         * Acquires and releases use the same code for fair and
         * nonfair locks, but differ in whether/how they allow barging
         * when queues are non-empty.
         */
​
        /**
         * Returns true if the current thread, when trying to acquire
         * the read lock, and otherwise eligible to do so, should block
         * because of policy for overtaking other waiting threads.
         */
        abstract boolean readerShouldBlock();
​
        /**
         * Returns true if the current thread, when trying to acquire
         * the write lock, and otherwise eligible to do so, should block
         * because of policy for overtaking other waiting threads.
         */
        abstract boolean writerShouldBlock();
​
        /*
         * Note that tryRelease and tryAcquire can be called by
         * Conditions. So it is possible that their arguments contain
         * both read and write holds that are all released during a
         * condition wait and re-established in tryAcquire.
         */
​
        protected final boolean tryRelease(int releases) {
            if (!isHeldExclusively())
                throw new IllegalMonitorStateException();
            int nextc = getState() - releases;
            boolean free = exclusiveCount(nextc) == 0;
            if (free)
                setExclusiveOwnerThread(null);
            setState(nextc);
            return free;
        }
​
        protected final boolean tryAcquire(int acquires) {
            /*
             * Walkthrough:
             * 1. If read count nonzero or write count nonzero
             *    and owner is a different thread, fail.
             * 2. If count would saturate, fail. (This can only
             *    happen if count is already nonzero.)
             * 3. Otherwise, this thread is eligible for lock if
             *    it is either a reentrant acquire or
             *    queue policy allows it. If so, update state
             *    and set owner.
             */
            Thread current = Thread.currentThread();
            int c = getState();
            int w = exclusiveCount(c);
            if (c != 0) {
                // (Note: if c != 0 and w == 0 then shared count != 0)
                if (w == 0 || current != getExclusiveOwnerThread())
                    return false;
                if (w + exclusiveCount(acquires) > MAX_COUNT)
                    throw new Error("Maximum lock count exceeded");
                // Reentrant acquire
                setState(c + acquires);
                return true;
            }
            if (writerShouldBlock() ||
                !compareAndSetState(c, c + acquires))
                return false;
            setExclusiveOwnerThread(current);
            return true;
        }
​
        protected final boolean tryReleaseShared(int unused) {
            Thread current = Thread.currentThread();
            if (firstReader == current) {
                // assert firstReaderHoldCount > 0;
                if (firstReaderHoldCount == 1)
                    firstReader = null;
                else
                    firstReaderHoldCount--;
            } else {
                HoldCounter rh = cachedHoldCounter;
                if (rh == null || rh.tid != getThreadId(current))
                    rh = readHolds.get();
                int count = rh.count;
                if (count <= 1) {
                    readHolds.remove();
                    if (count <= 0)
                        throw unmatchedUnlockException();
                }
                --rh.count;
            }
            for (;;) {
                int c = getState();
                int nextc = c - SHARED_UNIT;
                if (compareAndSetState(c, nextc))
                    // Releasing the read lock has no effect on readers,
                    // but it may allow waiting writers to proceed if
                    // both read and write locks are now free.
                    return nextc == 0;
            }
        }
​
        private IllegalMonitorStateException unmatchedUnlockException() {
            return new IllegalMonitorStateException(
                "attempt to unlock read lock, not locked by current thread");
        }
​
        protected final int tryAcquireShared(int unused) {
            /*
             * Walkthrough:
             * 1. If write lock held by another thread, fail.
             * 2. Otherwise, this thread is eligible for
             *    lock wrt state, so ask if it should block
             *    because of queue policy. If not, try
             *    to grant by CASing state and updating count.
             *    Note that step does not check for reentrant
             *    acquires, which is postponed to full version
             *    to avoid having to check hold count in
             *    the more typical non-reentrant case.
             * 3. If step 2 fails either because thread
             *    apparently not eligible or CAS fails or count
             *    saturated, chain to version with full retry loop.
             */
            Thread current = Thread.currentThread();
            int c = getState();
            if (exclusiveCount(c) != 0 &&
                getExclusiveOwnerThread() != current)
                return -1;
            int r = sharedCount(c);
            if (!readerShouldBlock() &&
                r < MAX_COUNT &&
                compareAndSetState(c, c + SHARED_UNIT)) {
                if (r == 0) {
                    firstReader = current;
                    firstReaderHoldCount = 1;
                } else if (firstReader == current) {
                    firstReaderHoldCount++;
                } else {
                    HoldCounter rh = cachedHoldCounter;
                    if (rh == null || rh.tid != getThreadId(current))
                        cachedHoldCounter = rh = readHolds.get();
                    else if (rh.count == 0)
                        readHolds.set(rh);
                    rh.count++;
                }
                return 1;
            }
            return fullTryAcquireShared(current);
        }
​
        /**
         * Full version of acquire for reads, that handles CAS misses
         * and reentrant reads not dealt with in tryAcquireShared.
         */
        final int fullTryAcquireShared(Thread current) {
            /*
             * This code is in part redundant with that in
             * tryAcquireShared but is simpler overall by not
             * complicating tryAcquireShared with interactions between
             * retries and lazily reading hold counts.
             */
            HoldCounter rh = null;
            for (;;) {
                int c = getState();
                if (exclusiveCount(c) != 0) {
                    if (getExclusiveOwnerThread() != current)
                        return -1;
                    // else we hold the exclusive lock; blocking here
                    // would cause deadlock.
                } else if (readerShouldBlock()) {
                    // Make sure we're not acquiring read lock reentrantly
                    if (firstReader == current) {
                        // assert firstReaderHoldCount > 0;
                    } else {
                        if (rh == null) {
                            rh = cachedHoldCounter;
                            if (rh == null || rh.tid != getThreadId(current)) {
                                rh = readHolds.get();
                                if (rh.count == 0)
                                    readHolds.remove();
                            }
                        }
                        if (rh.count == 0)
                            return -1;
                    }
                }
                if (sharedCount(c) == MAX_COUNT)
                    throw new Error("Maximum lock count exceeded");
                if (compareAndSetState(c, c + SHARED_UNIT)) {
                    if (sharedCount(c) == 0) {
                        firstReader = current;
                        firstReaderHoldCount = 1;
                    } else if (firstReader == current) {
                        firstReaderHoldCount++;
                    } else {
                        if (rh == null)
                            rh = cachedHoldCounter;
                        if (rh == null || rh.tid != getThreadId(current))
                            rh = readHolds.get();
                        else if (rh.count == 0)
                            readHolds.set(rh);
                        rh.count++;
                        cachedHoldCounter = rh; // cache for release
                    }
                    return 1;
                }
            }
        }
​
        /**
         * Performs tryLock for write, enabling barging in both modes.
         * This is identical in effect to tryAcquire except for lack
         * of calls to writerShouldBlock.
         */
        final boolean tryWriteLock() {
            Thread current = Thread.currentThread();
            int c = getState();
            if (c != 0) {
                int w = exclusiveCount(c);
                if (w == 0 || current != getExclusiveOwnerThread())
                    return false;
                if (w == MAX_COUNT)
                    throw new Error("Maximum lock count exceeded");
            }
            if (!compareAndSetState(c, c + 1))
                return false;
            setExclusiveOwnerThread(current);
            return true;
        }
​
        /**
         * Performs tryLock for read, enabling barging in both modes.
         * This is identical in effect to tryAcquireShared except for
         * lack of calls to readerShouldBlock.
         */
        final boolean tryReadLock() {
            Thread current = Thread.currentThread();
            for (;;) {
                int c = getState();
                if (exclusiveCount(c) != 0 &&
                    getExclusiveOwnerThread() != current)
                    return false;
                int r = sharedCount(c);
                if (r == MAX_COUNT)
                    throw new Error("Maximum lock count exceeded");
                if (compareAndSetState(c, c + SHARED_UNIT)) {
                    if (r == 0) {
                        firstReader = current;
                        firstReaderHoldCount = 1;
                    } else if (firstReader == current) {
                        firstReaderHoldCount++;
                    } else {
                        HoldCounter rh = cachedHoldCounter;
                        if (rh == null || rh.tid != getThreadId(current))
                            cachedHoldCounter = rh = readHolds.get();
                        else if (rh.count == 0)
                            readHolds.set(rh);
                        rh.count++;
                    }
                    return true;
                }
            }
        }
​
        protected final boolean isHeldExclusively() {
            // While we must in general read state before owner,
            // we don't need to do so to check if current thread is owner
            return getExclusiveOwnerThread() == Thread.currentThread();
        }
​
        // Methods relayed to outer class
​
        final ConditionObject newCondition() {
            return new ConditionObject();
        }
​
        final Thread getOwner() {
            // Must read state before owner to ensure memory consistency
            return ((exclusiveCount(getState()) == 0) ?
                    null :
                    getExclusiveOwnerThread());
        }
​
        final int getReadLockCount() {
            return sharedCount(getState());
        }
​
        final boolean isWriteLocked() {
            return exclusiveCount(getState()) != 0;
        }
​
        final int getWriteHoldCount() {
            return isHeldExclusively() ? exclusiveCount(getState()) : 0;
        }
​
        final int getReadHoldCount() {
            if (getReadLockCount() == 0)
                return 0;
​
            Thread current = Thread.currentThread();
            if (firstReader == current)
                return firstReaderHoldCount;
​
            HoldCounter rh = cachedHoldCounter;
            if (rh != null && rh.tid == getThreadId(current))
                return rh.count;
​
            int count = readHolds.get().count;
            if (count == 0) readHolds.remove();
            return count;
        }
​
        /**
         * Reconstitutes the instance from a stream (that is, deserializes it).
         */
        private void readObject(java.io.ObjectInputStream s)
            throws java.io.IOException, ClassNotFoundException {
            s.defaultReadObject();
            readHolds = new ThreadLocalHoldCounter();
            setState(0); // reset to unlocked state
        }
​
        final int getCount() { return getState(); }
    }
   
 

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值