scwhittle commented on code in PR #38767:
URL: https://github.com/apache/beam/pull/38767#discussion_r3361689569
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/BoundedQueueExecutor.java:
##########
@@ -78,14 +80,18 @@ private static class Budget {
@GuardedBy("this")
private long totalTimeMaxActiveThreadsUsed;
+ private final @Nullable KeyGroupWorkQueue keyGroupWorkQueue;
Review Comment:
add comment,
// If set the keyGroupWorkQueue is used by the underlying executor.
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/streaming/Work.java:
##########
@@ -416,4 +431,57 @@ private Optional<KeyedGetDataResponse>
fetchKeyedState(KeyedGetDataRequest reque
return Optional.ofNullable(getDataClient().getStateData(computationId(),
request));
}
}
+
+ /**
+ * WorkItems with same key group and computation are eligible to be executed
together in a
+ * multi-key bundle.
+ */
+ public static final class KeyGroup {
+
+ // The default 0 key group. Work items with 0 keyGroup will always be
executed
Review Comment:
remove the 0s from the comment , don't think it clarifies anything
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/BoundedQueueExecutor.java:
##########
@@ -378,6 +384,21 @@ BoundedQueueExecutorWorkHandleImpl createBudgetHandle(int
elements, long bytes)
return new BoundedQueueExecutorWorkHandleImpl(elements, bytes);
}
+ public @Nullable ExecutableWork pollWork(
+ String computationId, Work.KeyGroup keyGroup,
BoundedQueueExecutorWorkHandle handle) {
Review Comment:
could we also enforce the key group is not the default group?
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/KeyGroupWorkQueue.java:
##########
@@ -0,0 +1,463 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.runners.dataflow.worker.util;
+
+import static org.apache.beam.sdk.util.Preconditions.checkStateNotNull;
+
+import java.util.AbstractQueue;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
+import org.apache.beam.runners.dataflow.worker.streaming.Work;
+import
org.apache.beam.runners.dataflow.worker.util.BoundedQueueExecutor.QueuedWork;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+/**
+ * A custom, thread-safe doubly-linked BlockingQueue. In addition to global
FIFO ordering, the queue
+ * supports polling work by computation + key group in FIFO order
+ */
+class KeyGroupWorkQueue extends AbstractQueue<Runnable> implements
BlockingQueue<Runnable> {
+
+ static class Node {
+ final @Nullable Runnable task;
+ final @Nullable String computationId;
+ final Work.@Nullable KeyGroup keyGroup;
+
+ // prevNode, nextNode are used for the global order across all queued
Runnables
+ @Nullable Node prevNode;
+ @Nullable Node nextNode;
+
+ // prevKeyGroupNode and nextKeyGroupNode are used for the keyGroup level
lists linking
+ // QueuedWork with same keyGroup
+ @Nullable Node prevKeyGroupNode;
+ @Nullable Node nextKeyGroupNode;
+
+ Node(@Nullable Runnable task) {
+ this.task = task;
+ if (task instanceof QueuedWork) {
+ this.computationId = ((QueuedWork) task).getWork().getComputationId();
+ this.keyGroup = ((QueuedWork)
task).getWork().getKeyGroup().orElse(null);
Review Comment:
should we leave computationId unset if there is no keygroup? less possible
states to worry about.
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/KeyGroupWorkQueue.java:
##########
@@ -0,0 +1,463 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.runners.dataflow.worker.util;
+
+import static org.apache.beam.sdk.util.Preconditions.checkStateNotNull;
+
+import java.util.AbstractQueue;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
+import org.apache.beam.runners.dataflow.worker.streaming.Work;
+import
org.apache.beam.runners.dataflow.worker.util.BoundedQueueExecutor.QueuedWork;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+/**
+ * A custom, thread-safe doubly-linked BlockingQueue. In addition to global
FIFO ordering, the queue
+ * supports polling work by computation + key group in FIFO order
+ */
+class KeyGroupWorkQueue extends AbstractQueue<Runnable> implements
BlockingQueue<Runnable> {
+
+ static class Node {
+ final @Nullable Runnable task;
+ final @Nullable String computationId;
+ final Work.@Nullable KeyGroup keyGroup;
+
+ // prevNode, nextNode are used for the global order across all queued
Runnables
+ @Nullable Node prevNode;
+ @Nullable Node nextNode;
+
+ // prevKeyGroupNode and nextKeyGroupNode are used for the keyGroup level
lists linking
+ // QueuedWork with same keyGroup
+ @Nullable Node prevKeyGroupNode;
+ @Nullable Node nextKeyGroupNode;
+
+ Node(@Nullable Runnable task) {
+ this.task = task;
+ if (task instanceof QueuedWork) {
+ this.computationId = ((QueuedWork) task).getWork().getComputationId();
+ this.keyGroup = ((QueuedWork)
task).getWork().getKeyGroup().orElse(null);
+ } else {
+ this.computationId = null;
+ this.keyGroup = null;
+ }
+ }
+ }
+
+ /** Double linked list implementing key group level queue */
+ private static class KeyGroupWorkList {
+ final Node head;
+ final Node tail;
+
+ KeyGroupWorkList() {
+ head = new Node(null);
+ tail = new Node(null);
+ head.nextKeyGroupNode = tail;
+ tail.prevKeyGroupNode = head;
+ }
+
+ boolean isEmpty() {
+ return head.nextKeyGroupNode == tail;
+ }
+
+ void append(Node node) {
+ @Nullable Node last = tail.prevKeyGroupNode;
+ if (last == null) {
+ throw new NullPointerException("tail.prevComp is null");
+ }
+ node.prevKeyGroupNode = last;
+ node.nextKeyGroupNode = tail;
+ last.nextKeyGroupNode = node;
+ tail.prevKeyGroupNode = node;
+ }
+
+ void remove(Node node) {
+ @Nullable Node prev = node.prevKeyGroupNode;
+ @Nullable Node next = node.nextKeyGroupNode;
+ if (prev != null && next != null) {
+ prev.nextKeyGroupNode = next;
+ next.prevKeyGroupNode = prev;
+ node.prevKeyGroupNode = null;
+ node.nextKeyGroupNode = null;
+ }
+ }
+ }
+
+ private final ReentrantLock lock = new ReentrantLock();
+ private final Condition notEmpty = lock.newCondition();
+
+ // Sentinels for the global list
+ private final Node globalHead = new Node(null);
+ private final Node globalTail = new Node(null);
+
+ private final Map<QueueKey, KeyGroupWorkList> keyGroupQueueMap = new
HashMap<>();
+
+ private int size = 0;
+
+ public KeyGroupWorkQueue() {
+ globalHead.nextNode = globalTail;
+ globalTail.prevNode = globalHead;
+ }
+
+ private void unlinkNode(Node node) {
+ // 1. Unlink from global list
+ Node prevG = node.prevNode;
+ Node nextG = node.nextNode;
+ if (prevG != null && nextG != null) {
+ prevG.nextNode = nextG;
+ nextG.prevNode = prevG;
+ }
+ node.prevNode = null;
+ node.nextNode = null;
+
+ // 2. Unlink from key group list
+ if (node.computationId != null) {
+ QueueKey key = QueueKey.create(node.computationId, node.keyGroup);
+ KeyGroupWorkList keyGroupQueue = keyGroupQueueMap.get(key);
+ if (keyGroupQueue != null) {
+ keyGroupQueue.remove(node);
+ if (keyGroupQueue.isEmpty()) {
+ keyGroupQueueMap.remove(key);
+ }
+ }
+ }
+ --size;
+ }
+
+ private @Nullable Node removeFirstGlobal() {
+ @Nullable Node first = globalHead.nextNode;
+ if (first == null || first == globalTail) {
+ return null;
+ }
+ unlinkNode(first);
+ return first;
+ }
+
+ /**
+ * Remove and Return QueuedWork for the computationId, keyGroup in the FIFO
order Returns null, if
+ * there are no matches.
+ */
+ public @Nullable QueuedWork pollWork(String computationId, Work.KeyGroup
keyGroup) {
+ if (computationId == null || keyGroup == null) {
+ return null;
+ }
+ lock.lock();
+ try {
+ QueueKey key = QueueKey.create(computationId, keyGroup);
+ KeyGroupWorkList keyGroupWorkList = keyGroupQueueMap.get(key);
+ if (keyGroupWorkList == null || keyGroupWorkList.isEmpty()) {
+ return null;
+ }
+
+ // Retrieve the first pending task for this computation and keyGroup in
O(1)
+ @Nullable Node firstNode = keyGroupWorkList.head.nextKeyGroupNode;
+ if (firstNode == null || firstNode == keyGroupWorkList.tail) {
+ return null;
+ }
+ unlinkNode(firstNode);
+
+ Runnable task = firstNode.task;
+ if (task == null) {
+ return null;
+ }
+ return (QueuedWork) task;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean offer(Runnable runnable) {
+ if (runnable == null) throw new NullPointerException();
+ lock.lock();
+ try {
+ Node node = new Node(runnable);
+
+ // Append to global list tail
+ @Nullable Node lastG = globalTail.prevNode;
+ if (lastG == null) {
+ throw new NullPointerException("globalTail.prevNode is null");
+ }
+ node.prevNode = lastG;
+ node.nextNode = globalTail;
+ lastG.nextNode = node;
+ globalTail.prevNode = node;
+
+ // Append to key group list if applicable
+ if (node.computationId != null) {
+ QueueKey key = QueueKey.create(node.computationId, node.keyGroup);
+ KeyGroupWorkList keyGroupWorkList =
+ keyGroupQueueMap.computeIfAbsent(key, k -> new KeyGroupWorkList());
+ keyGroupWorkList.append(node);
+ }
+
+ ++size;
+ notEmpty.signal();
+ return true;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public void put(Runnable e) throws InterruptedException {
+ offer(e); // Unbounded queue
+ }
+
+ @Override
+ public boolean offer(Runnable e, long timeout, TimeUnit unit) throws
InterruptedException {
+ return offer(e); // Unbounded queue
+ }
+
+ @Override
+ public @Nullable Runnable poll() {
+ lock.lock();
+ try {
+ @Nullable Node node = removeFirstGlobal();
+ return (node != null) ? node.task : null;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public Runnable take() throws InterruptedException {
+ lock.lockInterruptibly();
+ try {
+ while (size == 0) {
+ notEmpty.await();
+ }
+ @Nullable Node node = removeFirstGlobal();
+ checkStateNotNull(node, "Queue is empty but size was " + size);
+ Runnable task = node.task;
+ checkStateNotNull(task, "Encountered null task in queue");
+ return task;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public @Nullable Runnable poll(long timeout, TimeUnit unit) throws
InterruptedException {
+ long nanos = unit.toNanos(timeout);
+ lock.lockInterruptibly();
+ try {
+ while (size == 0) {
+ if (nanos <= 0) {
+ return null;
+ }
+ nanos = notEmpty.awaitNanos(nanos);
+ }
+ @Nullable Node node = removeFirstGlobal();
+ return (node != null) ? node.task : null;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public @Nullable Runnable peek() {
+ lock.lock();
+ try {
+ @Nullable Node first = globalHead.nextNode;
+ if (first == null || first == globalTail) {
+ return null;
+ }
+ return first.task;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public int size() {
+ lock.lock();
+ try {
+ return size;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean isEmpty() {
+ lock.lock();
+ try {
+ return size == 0;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean remove(Object o) {
+ if (o == null) return false;
+ lock.lock();
+ try {
+ // Walk the global queue in O(N) to find and unlink the node
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail) {
+ if (o.equals(curr.task)) {
+ unlinkNode(curr);
+ return true;
+ }
+ curr = curr.nextNode;
+ }
+ return false;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean contains(Object o) {
+ if (o == null) return false;
+ lock.lock();
+ try {
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail) {
+ if (o.equals(curr.task)) {
+ return true;
+ }
+ curr = curr.nextNode;
+ }
+ return false;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public int remainingCapacity() {
+ return Integer.MAX_VALUE;
+ }
+
+ @Override
+ public int drainTo(Collection<? super Runnable> c) {
+ return drainTo(c, Integer.MAX_VALUE);
+ }
+
+ @Override
+ public int drainTo(Collection<? super Runnable> c, int maxElements) {
+ if (c == null) throw new NullPointerException();
+ if (c == this) throw new IllegalArgumentException();
+ if (maxElements <= 0) return 0;
+ lock.lock();
+ try {
+ int added = 0;
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail && added < maxElements) {
+ @Nullable Node next = curr.nextNode;
+ unlinkNode(curr);
+ Runnable task = curr.task;
+ if (task != null) {
Review Comment:
see above, if task is non-null then we can simplify throughout
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/KeyGroupWorkQueue.java:
##########
@@ -0,0 +1,463 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.runners.dataflow.worker.util;
+
+import static org.apache.beam.sdk.util.Preconditions.checkArgumentNotNull;
+import static org.apache.beam.sdk.util.Preconditions.checkStateNotNull;
+
+import java.util.AbstractQueue;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
+import javax.annotation.concurrent.GuardedBy;
+import org.apache.beam.runners.dataflow.worker.streaming.Work;
+import
org.apache.beam.runners.dataflow.worker.util.BoundedQueueExecutor.QueuedWork;
+import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.base.Preconditions;
+import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableList;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jspecify.annotations.NonNull;
+
+/**
+ * A custom, thread-safe doubly-linked BlockingQueue. In addition to global
FIFO ordering, the queue
+ * supports polling work by computation + key group in FIFO order
+ */
+class KeyGroupWorkQueue extends AbstractQueue<Runnable> implements
BlockingQueue<Runnable> {
+
+ static class Node {
+ final @Nullable Runnable task;
+ final @Nullable String computationId;
+ final Work.@Nullable KeyGroup keyGroup;
+ // cached keyGroupList if the Node is part of one.
+ @Nullable KeyGroupWorkList keyGroupList;
+
+ // prevNode, nextNode are used for the global order across all queued
Runnables
+ @Nullable Node prevNode;
+ @Nullable Node nextNode;
+
+ // prevKeyGroupNode and nextKeyGroupNode are used for the keyGroup level
lists linking
+ // QueuedWork with same keyGroup
+ @Nullable Node prevKeyGroupNode;
+ @Nullable Node nextKeyGroupNode;
+
+ Node(@Nullable Runnable task) {
+ this.task = task;
+ if (task instanceof QueuedWork) {
+ this.computationId = ((QueuedWork) task).getWork().getComputationId();
+ this.keyGroup = ((QueuedWork) task).getWork().getKeyGroup();
+ } else {
+ this.computationId = null;
+ this.keyGroup = null;
+ }
+ }
+ }
+
+ /** Double linked list implementing key group level queue */
+ private static class KeyGroupWorkList {
+ final Node head = new Node(null);
+ final Node tail = new Node(null);
+
+ KeyGroupWorkList() {
+ head.nextKeyGroupNode = tail;
+ tail.prevKeyGroupNode = head;
+ }
+
+ boolean isEmpty() {
+ return head.nextKeyGroupNode == tail;
+ }
+
+ void append(Node node) {
+ @Nullable Node last = tail.prevKeyGroupNode;
+ if (last == null) {
+ throw new NullPointerException("tail.prevComp is null");
+ }
+ node.prevKeyGroupNode = last;
+ node.nextKeyGroupNode = tail;
+ last.nextKeyGroupNode = node;
+ tail.prevKeyGroupNode = node;
+ }
+
+ void remove(Node node) {
+ @Nullable Node prev = node.prevKeyGroupNode;
+ @Nullable Node next = node.nextKeyGroupNode;
+ if (prev != null && next != null) {
+ prev.nextKeyGroupNode = next;
+ next.prevKeyGroupNode = prev;
+ node.prevKeyGroupNode = null;
+ node.nextKeyGroupNode = null;
+ }
+ }
+ }
+
+ private final ReentrantLock lock;
+ private final Condition notEmpty;
+
+ // Sentinels for the global list
+ @GuardedBy("lock")
+ private final Node globalHead = new Node(null);
+
+ @GuardedBy("lock")
+ private final Node globalTail = new Node(null);
+
+ @GuardedBy("lock")
+ private final Map<QueueKey, KeyGroupWorkList> keyGroupQueueMap = new
HashMap<>();
+
+ @GuardedBy("lock")
+ private int size = 0;
+
+ public KeyGroupWorkQueue(boolean fair) {
+ this.lock = new ReentrantLock(fair);
+ this.notEmpty = lock.newCondition();
+ globalHead.nextNode = globalTail;
+ globalTail.prevNode = globalHead;
+ }
+
+ @GuardedBy("lock")
+ private void unlinkNode(Node node) {
+ // An existing node should always have previous and next since we have
sentinels
+ // 1. Unlink from global list
+ Node prevG = checkArgumentNotNull(node.prevNode);
+ Node nextG = checkArgumentNotNull(node.nextNode);
+ prevG.nextNode = nextG;
+ nextG.prevNode = prevG;
+ node.prevNode = null;
+ node.nextNode = null;
+
+ // 2. Unlink from key group list
+ KeyGroupWorkList list = node.keyGroupList;
+ if (list != null) {
+ list.remove(node);
+ if (list.isEmpty()) {
+ String compId = checkStateNotNull(node.computationId);
+ Work.KeyGroup keyGroup = checkStateNotNull(node.keyGroup);
+ QueueKey key = new QueueKey(compId, keyGroup);
+ keyGroupQueueMap.remove(key);
+ }
+ node.keyGroupList = null;
+ }
+ --size;
+ }
+
+ @GuardedBy("lock")
+ private @Nullable Node removeFirstGlobal() {
+ @Nullable Node first = globalHead.nextNode;
+ if (first == null || first == globalTail) {
+ return null;
+ }
+ unlinkNode(first);
+ return first;
+ }
+
+ /**
+ * Remove and Return QueuedWork for the computationId, keyGroup in the FIFO
order Returns null, if
Review Comment:
missing period
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/KeyGroupWorkQueue.java:
##########
@@ -0,0 +1,463 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.runners.dataflow.worker.util;
+
+import static org.apache.beam.sdk.util.Preconditions.checkStateNotNull;
+
+import java.util.AbstractQueue;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
+import org.apache.beam.runners.dataflow.worker.streaming.Work;
+import
org.apache.beam.runners.dataflow.worker.util.BoundedQueueExecutor.QueuedWork;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+/**
+ * A custom, thread-safe doubly-linked BlockingQueue. In addition to global
FIFO ordering, the queue
+ * supports polling work by computation + key group in FIFO order
+ */
+class KeyGroupWorkQueue extends AbstractQueue<Runnable> implements
BlockingQueue<Runnable> {
+
+ static class Node {
+ final @Nullable Runnable task;
Review Comment:
instead of nullable how about singleton exception throwing runnable for the
sentinels? Seems like it will simplify logic below
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/streaming/Work.java:
##########
@@ -416,4 +431,57 @@ private Optional<KeyedGetDataResponse>
fetchKeyedState(KeyedGetDataRequest reque
return Optional.ofNullable(getDataClient().getStateData(computationId(),
request));
}
}
+
+ /**
+ * WorkItems with same key group and computation are eligible to be executed
together in a
+ * multi-key bundle.
+ */
+ public static final class KeyGroup {
+
+ // The default 0 key group. Work items with 0 keyGroup will always be
executed
+ // separately and not in a multi-key bundle
+ public static final KeyGroup DEFAULT = new KeyGroup(0, 0);
+
+ private final long high;
+ private final long low;
+
+ private KeyGroup(long high, long low) {
+ this.high = high;
+ this.low = low;
+ }
+
+ public static KeyGroup create(long high, long low) {
+ return new KeyGroup(high, low);
Review Comment:
make sure high and low aren't both 0?
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/KeyGroupWorkQueue.java:
##########
@@ -0,0 +1,463 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.runners.dataflow.worker.util;
+
+import static org.apache.beam.sdk.util.Preconditions.checkArgumentNotNull;
+import static org.apache.beam.sdk.util.Preconditions.checkStateNotNull;
+
+import java.util.AbstractQueue;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
+import javax.annotation.concurrent.GuardedBy;
+import org.apache.beam.runners.dataflow.worker.streaming.Work;
+import
org.apache.beam.runners.dataflow.worker.util.BoundedQueueExecutor.QueuedWork;
+import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.base.Preconditions;
+import
org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableList;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jspecify.annotations.NonNull;
+
+/**
+ * A custom, thread-safe doubly-linked BlockingQueue. In addition to global
FIFO ordering, the queue
+ * supports polling work by computation + key group in FIFO order
+ */
+class KeyGroupWorkQueue extends AbstractQueue<Runnable> implements
BlockingQueue<Runnable> {
+
+ static class Node {
+ final @Nullable Runnable task;
+ final @Nullable String computationId;
+ final Work.@Nullable KeyGroup keyGroup;
+ // cached keyGroupList if the Node is part of one.
+ @Nullable KeyGroupWorkList keyGroupList;
+
+ // prevNode, nextNode are used for the global order across all queued
Runnables
+ @Nullable Node prevNode;
+ @Nullable Node nextNode;
+
+ // prevKeyGroupNode and nextKeyGroupNode are used for the keyGroup level
lists linking
+ // QueuedWork with same keyGroup
+ @Nullable Node prevKeyGroupNode;
+ @Nullable Node nextKeyGroupNode;
+
+ Node(@Nullable Runnable task) {
+ this.task = task;
+ if (task instanceof QueuedWork) {
+ this.computationId = ((QueuedWork) task).getWork().getComputationId();
+ this.keyGroup = ((QueuedWork) task).getWork().getKeyGroup();
+ } else {
+ this.computationId = null;
+ this.keyGroup = null;
+ }
+ }
+ }
+
+ /** Double linked list implementing key group level queue */
+ private static class KeyGroupWorkList {
+ final Node head = new Node(null);
+ final Node tail = new Node(null);
+
+ KeyGroupWorkList() {
+ head.nextKeyGroupNode = tail;
+ tail.prevKeyGroupNode = head;
+ }
+
+ boolean isEmpty() {
+ return head.nextKeyGroupNode == tail;
+ }
+
+ void append(Node node) {
+ @Nullable Node last = tail.prevKeyGroupNode;
+ if (last == null) {
+ throw new NullPointerException("tail.prevComp is null");
+ }
+ node.prevKeyGroupNode = last;
+ node.nextKeyGroupNode = tail;
+ last.nextKeyGroupNode = node;
+ tail.prevKeyGroupNode = node;
+ }
+
+ void remove(Node node) {
+ @Nullable Node prev = node.prevKeyGroupNode;
+ @Nullable Node next = node.nextKeyGroupNode;
+ if (prev != null && next != null) {
+ prev.nextKeyGroupNode = next;
+ next.prevKeyGroupNode = prev;
+ node.prevKeyGroupNode = null;
+ node.nextKeyGroupNode = null;
+ }
+ }
+ }
+
+ private final ReentrantLock lock;
+ private final Condition notEmpty;
+
+ // Sentinels for the global list
+ @GuardedBy("lock")
+ private final Node globalHead = new Node(null);
+
+ @GuardedBy("lock")
+ private final Node globalTail = new Node(null);
+
+ @GuardedBy("lock")
+ private final Map<QueueKey, KeyGroupWorkList> keyGroupQueueMap = new
HashMap<>();
+
+ @GuardedBy("lock")
+ private int size = 0;
+
+ public KeyGroupWorkQueue(boolean fair) {
+ this.lock = new ReentrantLock(fair);
+ this.notEmpty = lock.newCondition();
+ globalHead.nextNode = globalTail;
+ globalTail.prevNode = globalHead;
+ }
+
+ @GuardedBy("lock")
+ private void unlinkNode(Node node) {
+ // An existing node should always have previous and next since we have
sentinels
+ // 1. Unlink from global list
+ Node prevG = checkArgumentNotNull(node.prevNode);
+ Node nextG = checkArgumentNotNull(node.nextNode);
+ prevG.nextNode = nextG;
+ nextG.prevNode = prevG;
+ node.prevNode = null;
+ node.nextNode = null;
+
+ // 2. Unlink from key group list
+ KeyGroupWorkList list = node.keyGroupList;
+ if (list != null) {
+ list.remove(node);
+ if (list.isEmpty()) {
+ String compId = checkStateNotNull(node.computationId);
+ Work.KeyGroup keyGroup = checkStateNotNull(node.keyGroup);
+ QueueKey key = new QueueKey(compId, keyGroup);
+ keyGroupQueueMap.remove(key);
+ }
+ node.keyGroupList = null;
+ }
+ --size;
+ }
+
+ @GuardedBy("lock")
+ private @Nullable Node removeFirstGlobal() {
+ @Nullable Node first = globalHead.nextNode;
+ if (first == null || first == globalTail) {
+ return null;
+ }
+ unlinkNode(first);
+ return first;
+ }
+
+ /**
+ * Remove and Return QueuedWork for the computationId, keyGroup in the FIFO
order Returns null, if
+ * there are no matches.
+ */
+ public @Nullable QueuedWork pollWork(String computationId, Work.KeyGroup
keyGroup) {
+ Preconditions.checkArgument(computationId != null && keyGroup != null);
+ if (keyGroup.equals(Work.KeyGroup.DEFAULT)) {
Review Comment:
use == ?
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/KeyGroupWorkQueue.java:
##########
@@ -0,0 +1,463 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.runners.dataflow.worker.util;
+
+import static org.apache.beam.sdk.util.Preconditions.checkStateNotNull;
+
+import java.util.AbstractQueue;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
+import org.apache.beam.runners.dataflow.worker.streaming.Work;
+import
org.apache.beam.runners.dataflow.worker.util.BoundedQueueExecutor.QueuedWork;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+/**
+ * A custom, thread-safe doubly-linked BlockingQueue. In addition to global
FIFO ordering, the queue
Review Comment:
Can we add to the comment here that it is specialized for usage in
BoundedQueueExecutor?
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/KeyGroupWorkQueue.java:
##########
@@ -0,0 +1,463 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.runners.dataflow.worker.util;
+
+import static org.apache.beam.sdk.util.Preconditions.checkStateNotNull;
+
+import java.util.AbstractQueue;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
+import org.apache.beam.runners.dataflow.worker.streaming.Work;
+import
org.apache.beam.runners.dataflow.worker.util.BoundedQueueExecutor.QueuedWork;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+/**
+ * A custom, thread-safe doubly-linked BlockingQueue. In addition to global
FIFO ordering, the queue
+ * supports polling work by computation + key group in FIFO order
+ */
+class KeyGroupWorkQueue extends AbstractQueue<Runnable> implements
BlockingQueue<Runnable> {
+
+ static class Node {
+ final @Nullable Runnable task;
Review Comment:
// If keyGroup is non-null, task is an instance of QueuedWork
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/KeyGroupWorkQueue.java:
##########
@@ -0,0 +1,463 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.runners.dataflow.worker.util;
+
+import static org.apache.beam.sdk.util.Preconditions.checkStateNotNull;
+
+import java.util.AbstractQueue;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
+import org.apache.beam.runners.dataflow.worker.streaming.Work;
+import
org.apache.beam.runners.dataflow.worker.util.BoundedQueueExecutor.QueuedWork;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+/**
+ * A custom, thread-safe doubly-linked BlockingQueue. In addition to global
FIFO ordering, the queue
+ * supports polling work by computation + key group in FIFO order
+ */
+class KeyGroupWorkQueue extends AbstractQueue<Runnable> implements
BlockingQueue<Runnable> {
+
+ static class Node {
+ final @Nullable Runnable task;
+ final @Nullable String computationId;
+ final Work.@Nullable KeyGroup keyGroup;
+
+ // prevNode, nextNode are used for the global order across all queued
Runnables
+ @Nullable Node prevNode;
+ @Nullable Node nextNode;
+
+ // prevKeyGroupNode and nextKeyGroupNode are used for the keyGroup level
lists linking
+ // QueuedWork with same keyGroup
+ @Nullable Node prevKeyGroupNode;
+ @Nullable Node nextKeyGroupNode;
+
+ Node(@Nullable Runnable task) {
+ this.task = task;
+ if (task instanceof QueuedWork) {
+ this.computationId = ((QueuedWork) task).getWork().getComputationId();
+ this.keyGroup = ((QueuedWork)
task).getWork().getKeyGroup().orElse(null);
+ } else {
+ this.computationId = null;
+ this.keyGroup = null;
+ }
+ }
+ }
+
+ /** Double linked list implementing key group level queue */
+ private static class KeyGroupWorkList {
+ final Node head;
+ final Node tail;
+
+ KeyGroupWorkList() {
+ head = new Node(null);
+ tail = new Node(null);
+ head.nextKeyGroupNode = tail;
+ tail.prevKeyGroupNode = head;
+ }
+
+ boolean isEmpty() {
+ return head.nextKeyGroupNode == tail;
+ }
+
+ void append(Node node) {
+ @Nullable Node last = tail.prevKeyGroupNode;
+ if (last == null) {
+ throw new NullPointerException("tail.prevComp is null");
+ }
+ node.prevKeyGroupNode = last;
+ node.nextKeyGroupNode = tail;
+ last.nextKeyGroupNode = node;
+ tail.prevKeyGroupNode = node;
+ }
+
+ void remove(Node node) {
+ @Nullable Node prev = node.prevKeyGroupNode;
+ @Nullable Node next = node.nextKeyGroupNode;
+ if (prev != null && next != null) {
+ prev.nextKeyGroupNode = next;
+ next.prevKeyGroupNode = prev;
+ node.prevKeyGroupNode = null;
+ node.nextKeyGroupNode = null;
+ }
+ }
+ }
+
+ private final ReentrantLock lock = new ReentrantLock();
+ private final Condition notEmpty = lock.newCondition();
+
+ // Sentinels for the global list
+ private final Node globalHead = new Node(null);
+ private final Node globalTail = new Node(null);
+
+ private final Map<QueueKey, KeyGroupWorkList> keyGroupQueueMap = new
HashMap<>();
+
+ private int size = 0;
+
+ public KeyGroupWorkQueue() {
+ globalHead.nextNode = globalTail;
+ globalTail.prevNode = globalHead;
+ }
+
+ private void unlinkNode(Node node) {
+ // 1. Unlink from global list
+ Node prevG = node.prevNode;
+ Node nextG = node.nextNode;
+ if (prevG != null && nextG != null) {
+ prevG.nextNode = nextG;
+ nextG.prevNode = prevG;
+ }
+ node.prevNode = null;
+ node.nextNode = null;
+
+ // 2. Unlink from key group list
+ if (node.computationId != null) {
+ QueueKey key = QueueKey.create(node.computationId, node.keyGroup);
+ KeyGroupWorkList keyGroupQueue = keyGroupQueueMap.get(key);
+ if (keyGroupQueue != null) {
+ keyGroupQueue.remove(node);
+ if (keyGroupQueue.isEmpty()) {
+ keyGroupQueueMap.remove(key);
+ }
+ }
+ }
+ --size;
+ }
+
+ private @Nullable Node removeFirstGlobal() {
+ @Nullable Node first = globalHead.nextNode;
+ if (first == null || first == globalTail) {
+ return null;
+ }
+ unlinkNode(first);
+ return first;
+ }
+
+ /**
+ * Remove and Return QueuedWork for the computationId, keyGroup in the FIFO
order Returns null, if
+ * there are no matches.
+ */
+ public @Nullable QueuedWork pollWork(String computationId, Work.KeyGroup
keyGroup) {
+ if (computationId == null || keyGroup == null) {
+ return null;
+ }
+ lock.lock();
+ try {
+ QueueKey key = QueueKey.create(computationId, keyGroup);
+ KeyGroupWorkList keyGroupWorkList = keyGroupQueueMap.get(key);
+ if (keyGroupWorkList == null || keyGroupWorkList.isEmpty()) {
+ return null;
+ }
+
+ // Retrieve the first pending task for this computation and keyGroup in
O(1)
+ @Nullable Node firstNode = keyGroupWorkList.head.nextKeyGroupNode;
+ if (firstNode == null || firstNode == keyGroupWorkList.tail) {
+ return null;
+ }
+ unlinkNode(firstNode);
+
+ Runnable task = firstNode.task;
+ if (task == null) {
+ return null;
+ }
+ return (QueuedWork) task;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean offer(Runnable runnable) {
+ if (runnable == null) throw new NullPointerException();
+ lock.lock();
+ try {
+ Node node = new Node(runnable);
+
+ // Append to global list tail
+ @Nullable Node lastG = globalTail.prevNode;
+ if (lastG == null) {
+ throw new NullPointerException("globalTail.prevNode is null");
+ }
+ node.prevNode = lastG;
+ node.nextNode = globalTail;
+ lastG.nextNode = node;
+ globalTail.prevNode = node;
+
+ // Append to key group list if applicable
+ if (node.computationId != null) {
+ QueueKey key = QueueKey.create(node.computationId, node.keyGroup);
+ KeyGroupWorkList keyGroupWorkList =
+ keyGroupQueueMap.computeIfAbsent(key, k -> new KeyGroupWorkList());
+ keyGroupWorkList.append(node);
+ }
+
+ ++size;
+ notEmpty.signal();
+ return true;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public void put(Runnable e) throws InterruptedException {
+ offer(e); // Unbounded queue
+ }
+
+ @Override
+ public boolean offer(Runnable e, long timeout, TimeUnit unit) throws
InterruptedException {
+ return offer(e); // Unbounded queue
+ }
+
+ @Override
+ public @Nullable Runnable poll() {
+ lock.lock();
+ try {
+ @Nullable Node node = removeFirstGlobal();
+ return (node != null) ? node.task : null;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public Runnable take() throws InterruptedException {
+ lock.lockInterruptibly();
+ try {
+ while (size == 0) {
+ notEmpty.await();
+ }
+ @Nullable Node node = removeFirstGlobal();
+ checkStateNotNull(node, "Queue is empty but size was " + size);
+ Runnable task = node.task;
+ checkStateNotNull(task, "Encountered null task in queue");
+ return task;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public @Nullable Runnable poll(long timeout, TimeUnit unit) throws
InterruptedException {
+ long nanos = unit.toNanos(timeout);
+ lock.lockInterruptibly();
+ try {
+ while (size == 0) {
+ if (nanos <= 0) {
+ return null;
+ }
+ nanos = notEmpty.awaitNanos(nanos);
+ }
+ @Nullable Node node = removeFirstGlobal();
+ return (node != null) ? node.task : null;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public @Nullable Runnable peek() {
+ lock.lock();
+ try {
+ @Nullable Node first = globalHead.nextNode;
+ if (first == null || first == globalTail) {
+ return null;
+ }
+ return first.task;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public int size() {
+ lock.lock();
+ try {
+ return size;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean isEmpty() {
+ lock.lock();
+ try {
+ return size == 0;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean remove(Object o) {
+ if (o == null) return false;
+ lock.lock();
+ try {
+ // Walk the global queue in O(N) to find and unlink the node
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail) {
+ if (o.equals(curr.task)) {
+ unlinkNode(curr);
+ return true;
+ }
+ curr = curr.nextNode;
+ }
+ return false;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean contains(Object o) {
+ if (o == null) return false;
+ lock.lock();
+ try {
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail) {
+ if (o.equals(curr.task)) {
+ return true;
+ }
+ curr = curr.nextNode;
+ }
+ return false;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public int remainingCapacity() {
+ return Integer.MAX_VALUE;
+ }
+
+ @Override
+ public int drainTo(Collection<? super Runnable> c) {
+ return drainTo(c, Integer.MAX_VALUE);
+ }
+
+ @Override
+ public int drainTo(Collection<? super Runnable> c, int maxElements) {
+ if (c == null) throw new NullPointerException();
+ if (c == this) throw new IllegalArgumentException();
+ if (maxElements <= 0) return 0;
+ lock.lock();
+ try {
+ int added = 0;
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail && added < maxElements) {
+ @Nullable Node next = curr.nextNode;
+ unlinkNode(curr);
+ Runnable task = curr.task;
+ if (task != null) {
+ c.add(task);
+ ++added;
+ }
+ curr = next;
+ }
+ return added;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public void clear() {
+ lock.lock();
+ try {
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail) {
+ @Nullable Node next = curr.nextNode;
+ unlinkNode(curr);
+ curr = next;
+ }
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public Iterator<Runnable> iterator() {
+ lock.lock();
+ try {
+ List<Runnable> snapshot = new ArrayList<>(size);
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail) {
+ if (curr.task != null) {
+ snapshot.add(curr.task);
+ }
+ curr = curr.nextNode;
+ }
+ return Collections.unmodifiableList(snapshot).iterator();
Review Comment:
still the same
##########
runners/google-cloud-dataflow-java/worker/src/main/java/org/apache/beam/runners/dataflow/worker/util/KeyGroupWorkQueue.java:
##########
@@ -0,0 +1,463 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.beam.runners.dataflow.worker.util;
+
+import static org.apache.beam.sdk.util.Preconditions.checkStateNotNull;
+
+import java.util.AbstractQueue;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Condition;
+import java.util.concurrent.locks.ReentrantLock;
+import org.apache.beam.runners.dataflow.worker.streaming.Work;
+import
org.apache.beam.runners.dataflow.worker.util.BoundedQueueExecutor.QueuedWork;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+/**
+ * A custom, thread-safe doubly-linked BlockingQueue. In addition to global
FIFO ordering, the queue
+ * supports polling work by computation + key group in FIFO order
+ */
+class KeyGroupWorkQueue extends AbstractQueue<Runnable> implements
BlockingQueue<Runnable> {
+
+ static class Node {
+ final @Nullable Runnable task;
+ final @Nullable String computationId;
+ final Work.@Nullable KeyGroup keyGroup;
+
+ // prevNode, nextNode are used for the global order across all queued
Runnables
+ @Nullable Node prevNode;
+ @Nullable Node nextNode;
+
+ // prevKeyGroupNode and nextKeyGroupNode are used for the keyGroup level
lists linking
+ // QueuedWork with same keyGroup
+ @Nullable Node prevKeyGroupNode;
+ @Nullable Node nextKeyGroupNode;
+
+ Node(@Nullable Runnable task) {
+ this.task = task;
+ if (task instanceof QueuedWork) {
+ this.computationId = ((QueuedWork) task).getWork().getComputationId();
+ this.keyGroup = ((QueuedWork)
task).getWork().getKeyGroup().orElse(null);
+ } else {
+ this.computationId = null;
+ this.keyGroup = null;
+ }
+ }
+ }
+
+ /** Double linked list implementing key group level queue */
+ private static class KeyGroupWorkList {
+ final Node head;
+ final Node tail;
+
+ KeyGroupWorkList() {
+ head = new Node(null);
+ tail = new Node(null);
+ head.nextKeyGroupNode = tail;
+ tail.prevKeyGroupNode = head;
+ }
+
+ boolean isEmpty() {
+ return head.nextKeyGroupNode == tail;
+ }
+
+ void append(Node node) {
+ @Nullable Node last = tail.prevKeyGroupNode;
+ if (last == null) {
+ throw new NullPointerException("tail.prevComp is null");
+ }
+ node.prevKeyGroupNode = last;
+ node.nextKeyGroupNode = tail;
+ last.nextKeyGroupNode = node;
+ tail.prevKeyGroupNode = node;
+ }
+
+ void remove(Node node) {
+ @Nullable Node prev = node.prevKeyGroupNode;
+ @Nullable Node next = node.nextKeyGroupNode;
+ if (prev != null && next != null) {
+ prev.nextKeyGroupNode = next;
+ next.prevKeyGroupNode = prev;
+ node.prevKeyGroupNode = null;
+ node.nextKeyGroupNode = null;
+ }
+ }
+ }
+
+ private final ReentrantLock lock = new ReentrantLock();
+ private final Condition notEmpty = lock.newCondition();
+
+ // Sentinels for the global list
+ private final Node globalHead = new Node(null);
+ private final Node globalTail = new Node(null);
+
+ private final Map<QueueKey, KeyGroupWorkList> keyGroupQueueMap = new
HashMap<>();
+
+ private int size = 0;
+
+ public KeyGroupWorkQueue() {
+ globalHead.nextNode = globalTail;
+ globalTail.prevNode = globalHead;
+ }
+
+ private void unlinkNode(Node node) {
+ // 1. Unlink from global list
+ Node prevG = node.prevNode;
+ Node nextG = node.nextNode;
+ if (prevG != null && nextG != null) {
+ prevG.nextNode = nextG;
+ nextG.prevNode = prevG;
+ }
+ node.prevNode = null;
+ node.nextNode = null;
+
+ // 2. Unlink from key group list
+ if (node.computationId != null) {
+ QueueKey key = QueueKey.create(node.computationId, node.keyGroup);
+ KeyGroupWorkList keyGroupQueue = keyGroupQueueMap.get(key);
+ if (keyGroupQueue != null) {
+ keyGroupQueue.remove(node);
+ if (keyGroupQueue.isEmpty()) {
+ keyGroupQueueMap.remove(key);
+ }
+ }
+ }
+ --size;
+ }
+
+ private @Nullable Node removeFirstGlobal() {
+ @Nullable Node first = globalHead.nextNode;
+ if (first == null || first == globalTail) {
+ return null;
+ }
+ unlinkNode(first);
+ return first;
+ }
+
+ /**
+ * Remove and Return QueuedWork for the computationId, keyGroup in the FIFO
order Returns null, if
+ * there are no matches.
+ */
+ public @Nullable QueuedWork pollWork(String computationId, Work.KeyGroup
keyGroup) {
+ if (computationId == null || keyGroup == null) {
+ return null;
+ }
+ lock.lock();
+ try {
+ QueueKey key = QueueKey.create(computationId, keyGroup);
+ KeyGroupWorkList keyGroupWorkList = keyGroupQueueMap.get(key);
+ if (keyGroupWorkList == null || keyGroupWorkList.isEmpty()) {
+ return null;
+ }
+
+ // Retrieve the first pending task for this computation and keyGroup in
O(1)
+ @Nullable Node firstNode = keyGroupWorkList.head.nextKeyGroupNode;
+ if (firstNode == null || firstNode == keyGroupWorkList.tail) {
+ return null;
+ }
+ unlinkNode(firstNode);
+
+ Runnable task = firstNode.task;
+ if (task == null) {
+ return null;
+ }
+ return (QueuedWork) task;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean offer(Runnable runnable) {
+ if (runnable == null) throw new NullPointerException();
+ lock.lock();
+ try {
+ Node node = new Node(runnable);
+
+ // Append to global list tail
+ @Nullable Node lastG = globalTail.prevNode;
+ if (lastG == null) {
+ throw new NullPointerException("globalTail.prevNode is null");
+ }
+ node.prevNode = lastG;
+ node.nextNode = globalTail;
+ lastG.nextNode = node;
+ globalTail.prevNode = node;
+
+ // Append to key group list if applicable
+ if (node.computationId != null) {
+ QueueKey key = QueueKey.create(node.computationId, node.keyGroup);
+ KeyGroupWorkList keyGroupWorkList =
+ keyGroupQueueMap.computeIfAbsent(key, k -> new KeyGroupWorkList());
+ keyGroupWorkList.append(node);
+ }
+
+ ++size;
+ notEmpty.signal();
+ return true;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public void put(Runnable e) throws InterruptedException {
+ offer(e); // Unbounded queue
+ }
+
+ @Override
+ public boolean offer(Runnable e, long timeout, TimeUnit unit) throws
InterruptedException {
+ return offer(e); // Unbounded queue
+ }
+
+ @Override
+ public @Nullable Runnable poll() {
+ lock.lock();
+ try {
+ @Nullable Node node = removeFirstGlobal();
+ return (node != null) ? node.task : null;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public Runnable take() throws InterruptedException {
+ lock.lockInterruptibly();
+ try {
+ while (size == 0) {
+ notEmpty.await();
+ }
+ @Nullable Node node = removeFirstGlobal();
+ checkStateNotNull(node, "Queue is empty but size was " + size);
+ Runnable task = node.task;
+ checkStateNotNull(task, "Encountered null task in queue");
+ return task;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public @Nullable Runnable poll(long timeout, TimeUnit unit) throws
InterruptedException {
+ long nanos = unit.toNanos(timeout);
+ lock.lockInterruptibly();
+ try {
+ while (size == 0) {
+ if (nanos <= 0) {
+ return null;
+ }
+ nanos = notEmpty.awaitNanos(nanos);
+ }
+ @Nullable Node node = removeFirstGlobal();
+ return (node != null) ? node.task : null;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public @Nullable Runnable peek() {
+ lock.lock();
+ try {
+ @Nullable Node first = globalHead.nextNode;
+ if (first == null || first == globalTail) {
+ return null;
+ }
+ return first.task;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public int size() {
+ lock.lock();
+ try {
+ return size;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean isEmpty() {
+ lock.lock();
+ try {
+ return size == 0;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean remove(Object o) {
+ if (o == null) return false;
+ lock.lock();
+ try {
+ // Walk the global queue in O(N) to find and unlink the node
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail) {
+ if (o.equals(curr.task)) {
+ unlinkNode(curr);
+ return true;
+ }
+ curr = curr.nextNode;
+ }
+ return false;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public boolean contains(Object o) {
+ if (o == null) return false;
+ lock.lock();
+ try {
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail) {
+ if (o.equals(curr.task)) {
+ return true;
+ }
+ curr = curr.nextNode;
+ }
+ return false;
+ } finally {
+ lock.unlock();
+ }
+ }
+
+ @Override
+ public int remainingCapacity() {
+ return Integer.MAX_VALUE;
+ }
+
+ @Override
+ public int drainTo(Collection<? super Runnable> c) {
+ return drainTo(c, Integer.MAX_VALUE);
+ }
+
+ @Override
+ public int drainTo(Collection<? super Runnable> c, int maxElements) {
+ if (c == null) throw new NullPointerException();
+ if (c == this) throw new IllegalArgumentException();
+ if (maxElements <= 0) return 0;
+ lock.lock();
+ try {
+ int added = 0;
+ @Nullable Node curr = globalHead.nextNode;
+ while (curr != null && curr != globalTail && added < maxElements) {
Review Comment:
throw exception if curr is null? ditto for others
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
