http://git-wip-us.apache.org/repos/asf/hbase-site/blob/74f60271/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/ProcedureExecutor.WorkerThread.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/ProcedureExecutor.WorkerThread.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/ProcedureExecutor.WorkerThread.html index d11176a..2c14c50 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/ProcedureExecutor.WorkerThread.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/ProcedureExecutor.WorkerThread.html @@ -982,1050 +982,1168 @@ <span class="sourceLineNo">974</span> }<a name="line.974"></a> <span class="sourceLineNo">975</span><a name="line.975"></a> <span class="sourceLineNo">976</span> /**<a name="line.976"></a> -<span class="sourceLineNo">977</span> * Add a new root-procedure to the executor.<a name="line.977"></a> -<span class="sourceLineNo">978</span> * @param proc the new procedure to execute.<a name="line.978"></a> -<span class="sourceLineNo">979</span> * @param nonceKey the registered unique identifier for this operation from the client or process.<a name="line.979"></a> -<span class="sourceLineNo">980</span> * @return the procedure id, that can be used to monitor the operation<a name="line.980"></a> -<span class="sourceLineNo">981</span> */<a name="line.981"></a> -<span class="sourceLineNo">982</span> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="NP_NULL_ON_SOME_PATH",<a name="line.982"></a> -<span class="sourceLineNo">983</span> justification = "FindBugs is blind to the check-for-null")<a name="line.983"></a> -<span class="sourceLineNo">984</span> public long submitProcedure(Procedure<TEnvironment> proc, NonceKey nonceKey) {<a name="line.984"></a> -<span class="sourceLineNo">985</span> Preconditions.checkArgument(lastProcId.get() >= 0);<a name="line.985"></a> -<span class="sourceLineNo">986</span><a name="line.986"></a> -<span class="sourceLineNo">987</span> prepareProcedure(proc);<a name="line.987"></a> -<span class="sourceLineNo">988</span><a name="line.988"></a> -<span class="sourceLineNo">989</span> final Long currentProcId;<a name="line.989"></a> -<span class="sourceLineNo">990</span> if (nonceKey != null) {<a name="line.990"></a> -<span class="sourceLineNo">991</span> currentProcId = nonceKeysToProcIdsMap.get(nonceKey);<a name="line.991"></a> -<span class="sourceLineNo">992</span> Preconditions.checkArgument(currentProcId != null,<a name="line.992"></a> -<span class="sourceLineNo">993</span> "Expected nonceKey=" + nonceKey + " to be reserved, use registerNonce(); proc=" + proc);<a name="line.993"></a> -<span class="sourceLineNo">994</span> } else {<a name="line.994"></a> -<span class="sourceLineNo">995</span> currentProcId = nextProcId();<a name="line.995"></a> -<span class="sourceLineNo">996</span> }<a name="line.996"></a> -<span class="sourceLineNo">997</span><a name="line.997"></a> -<span class="sourceLineNo">998</span> // Initialize the procedure<a name="line.998"></a> -<span class="sourceLineNo">999</span> proc.setNonceKey(nonceKey);<a name="line.999"></a> -<span class="sourceLineNo">1000</span> proc.setProcId(currentProcId.longValue());<a name="line.1000"></a> -<span class="sourceLineNo">1001</span><a name="line.1001"></a> -<span class="sourceLineNo">1002</span> // Commit the transaction<a name="line.1002"></a> -<span class="sourceLineNo">1003</span> store.insert(proc, null);<a name="line.1003"></a> -<span class="sourceLineNo">1004</span> LOG.debug("Stored {}", proc);<a name="line.1004"></a> -<span class="sourceLineNo">1005</span><a name="line.1005"></a> -<span class="sourceLineNo">1006</span> // Add the procedure to the executor<a name="line.1006"></a> -<span class="sourceLineNo">1007</span> return pushProcedure(proc);<a name="line.1007"></a> -<span class="sourceLineNo">1008</span> }<a name="line.1008"></a> -<span class="sourceLineNo">1009</span><a name="line.1009"></a> -<span class="sourceLineNo">1010</span> /**<a name="line.1010"></a> -<span class="sourceLineNo">1011</span> * Add a set of new root-procedure to the executor.<a name="line.1011"></a> -<span class="sourceLineNo">1012</span> * @param procs the new procedures to execute.<a name="line.1012"></a> -<span class="sourceLineNo">1013</span> */<a name="line.1013"></a> -<span class="sourceLineNo">1014</span> // TODO: Do we need to take nonces here?<a name="line.1014"></a> -<span class="sourceLineNo">1015</span> public void submitProcedures(Procedure<TEnvironment>[] procs) {<a name="line.1015"></a> -<span class="sourceLineNo">1016</span> Preconditions.checkArgument(lastProcId.get() >= 0);<a name="line.1016"></a> -<span class="sourceLineNo">1017</span> if (procs == null || procs.length <= 0) {<a name="line.1017"></a> -<span class="sourceLineNo">1018</span> return;<a name="line.1018"></a> -<span class="sourceLineNo">1019</span> }<a name="line.1019"></a> -<span class="sourceLineNo">1020</span><a name="line.1020"></a> -<span class="sourceLineNo">1021</span> // Prepare procedure<a name="line.1021"></a> -<span class="sourceLineNo">1022</span> for (int i = 0; i < procs.length; ++i) {<a name="line.1022"></a> -<span class="sourceLineNo">1023</span> prepareProcedure(procs[i]).setProcId(nextProcId());<a name="line.1023"></a> -<span class="sourceLineNo">1024</span> }<a name="line.1024"></a> -<span class="sourceLineNo">1025</span><a name="line.1025"></a> -<span class="sourceLineNo">1026</span> // Commit the transaction<a name="line.1026"></a> -<span class="sourceLineNo">1027</span> store.insert(procs);<a name="line.1027"></a> -<span class="sourceLineNo">1028</span> if (LOG.isDebugEnabled()) {<a name="line.1028"></a> -<span class="sourceLineNo">1029</span> LOG.debug("Stored " + Arrays.toString(procs));<a name="line.1029"></a> -<span class="sourceLineNo">1030</span> }<a name="line.1030"></a> -<span class="sourceLineNo">1031</span><a name="line.1031"></a> -<span class="sourceLineNo">1032</span> // Add the procedure to the executor<a name="line.1032"></a> -<span class="sourceLineNo">1033</span> for (int i = 0; i < procs.length; ++i) {<a name="line.1033"></a> -<span class="sourceLineNo">1034</span> pushProcedure(procs[i]);<a name="line.1034"></a> -<span class="sourceLineNo">1035</span> }<a name="line.1035"></a> -<span class="sourceLineNo">1036</span> }<a name="line.1036"></a> -<span class="sourceLineNo">1037</span><a name="line.1037"></a> -<span class="sourceLineNo">1038</span> private Procedure<TEnvironment> prepareProcedure(Procedure<TEnvironment> proc) {<a name="line.1038"></a> -<span class="sourceLineNo">1039</span> Preconditions.checkArgument(proc.getState() == ProcedureState.INITIALIZING);<a name="line.1039"></a> -<span class="sourceLineNo">1040</span> Preconditions.checkArgument(!proc.hasParent(), "unexpected parent", proc);<a name="line.1040"></a> -<span class="sourceLineNo">1041</span> if (this.checkOwnerSet) {<a name="line.1041"></a> -<span class="sourceLineNo">1042</span> Preconditions.checkArgument(proc.hasOwner(), "missing owner");<a name="line.1042"></a> -<span class="sourceLineNo">1043</span> }<a name="line.1043"></a> -<span class="sourceLineNo">1044</span> return proc;<a name="line.1044"></a> -<span class="sourceLineNo">1045</span> }<a name="line.1045"></a> -<span class="sourceLineNo">1046</span><a name="line.1046"></a> -<span class="sourceLineNo">1047</span> private long pushProcedure(Procedure<TEnvironment> proc) {<a name="line.1047"></a> -<span class="sourceLineNo">1048</span> final long currentProcId = proc.getProcId();<a name="line.1048"></a> +<span class="sourceLineNo">977</span> * Bypass a procedure. If the procedure is set to bypass, all the logic in<a name="line.977"></a> +<span class="sourceLineNo">978</span> * execute/rollback will be ignored and it will return success, whatever.<a name="line.978"></a> +<span class="sourceLineNo">979</span> * It is used to recover buggy stuck procedures, releasing the lock resources<a name="line.979"></a> +<span class="sourceLineNo">980</span> * and letting other procedures to run. Bypassing one procedure (and its ancestors will<a name="line.980"></a> +<span class="sourceLineNo">981</span> * be bypassed automatically) may leave the cluster in a middle state, e.g. region<a name="line.981"></a> +<span class="sourceLineNo">982</span> * not assigned, or some hdfs files left behind. After getting rid of those stuck procedures,<a name="line.982"></a> +<span class="sourceLineNo">983</span> * the operators may have to do some clean up on hdfs or schedule some assign procedures<a name="line.983"></a> +<span class="sourceLineNo">984</span> * to let region online. DO AT YOUR OWN RISK.<a name="line.984"></a> +<span class="sourceLineNo">985</span> * <p><a name="line.985"></a> +<span class="sourceLineNo">986</span> * A procedure can be bypassed only if<a name="line.986"></a> +<span class="sourceLineNo">987</span> * 1. The procedure is in state of RUNNABLE, WAITING, WAITING_TIMEOUT<a name="line.987"></a> +<span class="sourceLineNo">988</span> * or it is a root procedure without any child.<a name="line.988"></a> +<span class="sourceLineNo">989</span> * 2. No other worker thread is executing it<a name="line.989"></a> +<span class="sourceLineNo">990</span> * 3. No child procedure has been submitted<a name="line.990"></a> +<span class="sourceLineNo">991</span> *<a name="line.991"></a> +<span class="sourceLineNo">992</span> * <p><a name="line.992"></a> +<span class="sourceLineNo">993</span> * If all the requirements are meet, the procedure and its ancestors will be<a name="line.993"></a> +<span class="sourceLineNo">994</span> * bypassed and persisted to WAL.<a name="line.994"></a> +<span class="sourceLineNo">995</span> *<a name="line.995"></a> +<span class="sourceLineNo">996</span> * <p><a name="line.996"></a> +<span class="sourceLineNo">997</span> * If the procedure is in WAITING state, will set it to RUNNABLE add it to run queue.<a name="line.997"></a> +<span class="sourceLineNo">998</span> * TODO: What about WAITING_TIMEOUT?<a name="line.998"></a> +<span class="sourceLineNo">999</span> * @param id the procedure id<a name="line.999"></a> +<span class="sourceLineNo">1000</span> * @param lockWait time to wait lock<a name="line.1000"></a> +<span class="sourceLineNo">1001</span> * @param force if force set to true, we will bypass the procedure even if it is executing.<a name="line.1001"></a> +<span class="sourceLineNo">1002</span> * This is for procedures which can't break out during executing(due to bug, mostly)<a name="line.1002"></a> +<span class="sourceLineNo">1003</span> * In this case, bypassing the procedure is not enough, since it is already stuck<a name="line.1003"></a> +<span class="sourceLineNo">1004</span> * there. We need to restart the master after bypassing, and letting the problematic<a name="line.1004"></a> +<span class="sourceLineNo">1005</span> * procedure to execute wth bypass=true, so in that condition, the procedure can be<a name="line.1005"></a> +<span class="sourceLineNo">1006</span> * successfully bypassed.<a name="line.1006"></a> +<span class="sourceLineNo">1007</span> * @return true if bypass success<a name="line.1007"></a> +<span class="sourceLineNo">1008</span> * @throws IOException IOException<a name="line.1008"></a> +<span class="sourceLineNo">1009</span> */<a name="line.1009"></a> +<span class="sourceLineNo">1010</span> public boolean bypassProcedure(long id, long lockWait, boolean force) throws IOException {<a name="line.1010"></a> +<span class="sourceLineNo">1011</span> Procedure<TEnvironment> procedure = getProcedure(id);<a name="line.1011"></a> +<span class="sourceLineNo">1012</span> if (procedure == null) {<a name="line.1012"></a> +<span class="sourceLineNo">1013</span> LOG.debug("Procedure with id={} does not exist, skipping bypass", id);<a name="line.1013"></a> +<span class="sourceLineNo">1014</span> return false;<a name="line.1014"></a> +<span class="sourceLineNo">1015</span> }<a name="line.1015"></a> +<span class="sourceLineNo">1016</span><a name="line.1016"></a> +<span class="sourceLineNo">1017</span> LOG.debug("Begin bypass {} with lockWait={}, force={}", procedure, lockWait, force);<a name="line.1017"></a> +<span class="sourceLineNo">1018</span><a name="line.1018"></a> +<span class="sourceLineNo">1019</span> IdLock.Entry lockEntry = procExecutionLock.tryLockEntry(procedure.getProcId(), lockWait);<a name="line.1019"></a> +<span class="sourceLineNo">1020</span> if (lockEntry == null && !force) {<a name="line.1020"></a> +<span class="sourceLineNo">1021</span> LOG.debug("Waited {} ms, but {} is still running, skipping bypass with force={}",<a name="line.1021"></a> +<span class="sourceLineNo">1022</span> lockWait, procedure, force);<a name="line.1022"></a> +<span class="sourceLineNo">1023</span> return false;<a name="line.1023"></a> +<span class="sourceLineNo">1024</span> } else if (lockEntry == null) {<a name="line.1024"></a> +<span class="sourceLineNo">1025</span> LOG.debug("Waited {} ms, but {} is still running, begin bypass with force={}",<a name="line.1025"></a> +<span class="sourceLineNo">1026</span> lockWait, procedure, force);<a name="line.1026"></a> +<span class="sourceLineNo">1027</span> }<a name="line.1027"></a> +<span class="sourceLineNo">1028</span> try {<a name="line.1028"></a> +<span class="sourceLineNo">1029</span> // check whether the procedure is already finished<a name="line.1029"></a> +<span class="sourceLineNo">1030</span> if (procedure.isFinished()) {<a name="line.1030"></a> +<span class="sourceLineNo">1031</span> LOG.debug("{} is already finished, skipping bypass", procedure);<a name="line.1031"></a> +<span class="sourceLineNo">1032</span> return false;<a name="line.1032"></a> +<span class="sourceLineNo">1033</span> }<a name="line.1033"></a> +<span class="sourceLineNo">1034</span><a name="line.1034"></a> +<span class="sourceLineNo">1035</span> if (procedure.hasChildren()) {<a name="line.1035"></a> +<span class="sourceLineNo">1036</span> LOG.debug("{} has children, skipping bypass", procedure);<a name="line.1036"></a> +<span class="sourceLineNo">1037</span> return false;<a name="line.1037"></a> +<span class="sourceLineNo">1038</span> }<a name="line.1038"></a> +<span class="sourceLineNo">1039</span><a name="line.1039"></a> +<span class="sourceLineNo">1040</span> // If the procedure has no parent or no child, we are safe to bypass it in whatever state<a name="line.1040"></a> +<span class="sourceLineNo">1041</span> if (procedure.hasParent() && procedure.getState() != ProcedureState.RUNNABLE<a name="line.1041"></a> +<span class="sourceLineNo">1042</span> && procedure.getState() != ProcedureState.WAITING<a name="line.1042"></a> +<span class="sourceLineNo">1043</span> && procedure.getState() != ProcedureState.WAITING_TIMEOUT) {<a name="line.1043"></a> +<span class="sourceLineNo">1044</span> LOG.debug("Bypassing procedures in RUNNABLE, WAITING and WAITING_TIMEOUT states "<a name="line.1044"></a> +<span class="sourceLineNo">1045</span> + "(with no parent), {}",<a name="line.1045"></a> +<span class="sourceLineNo">1046</span> procedure);<a name="line.1046"></a> +<span class="sourceLineNo">1047</span> return false;<a name="line.1047"></a> +<span class="sourceLineNo">1048</span> }<a name="line.1048"></a> <span class="sourceLineNo">1049</span><a name="line.1049"></a> -<span class="sourceLineNo">1050</span> // Update metrics on start of a procedure<a name="line.1050"></a> -<span class="sourceLineNo">1051</span> proc.updateMetricsOnSubmit(getEnvironment());<a name="line.1051"></a> -<span class="sourceLineNo">1052</span><a name="line.1052"></a> -<span class="sourceLineNo">1053</span> // Create the rollback stack for the procedure<a name="line.1053"></a> -<span class="sourceLineNo">1054</span> RootProcedureState<TEnvironment> stack = new RootProcedureState<>();<a name="line.1054"></a> -<span class="sourceLineNo">1055</span> rollbackStack.put(currentProcId, stack);<a name="line.1055"></a> -<span class="sourceLineNo">1056</span><a name="line.1056"></a> -<span class="sourceLineNo">1057</span> // Submit the new subprocedures<a name="line.1057"></a> -<span class="sourceLineNo">1058</span> assert !procedures.containsKey(currentProcId);<a name="line.1058"></a> -<span class="sourceLineNo">1059</span> procedures.put(currentProcId, proc);<a name="line.1059"></a> -<span class="sourceLineNo">1060</span> sendProcedureAddedNotification(currentProcId);<a name="line.1060"></a> -<span class="sourceLineNo">1061</span> scheduler.addBack(proc);<a name="line.1061"></a> -<span class="sourceLineNo">1062</span> return proc.getProcId();<a name="line.1062"></a> -<span class="sourceLineNo">1063</span> }<a name="line.1063"></a> -<span class="sourceLineNo">1064</span><a name="line.1064"></a> -<span class="sourceLineNo">1065</span> /**<a name="line.1065"></a> -<span class="sourceLineNo">1066</span> * Send an abort notification the specified procedure.<a name="line.1066"></a> -<span class="sourceLineNo">1067</span> * Depending on the procedure implementation the abort can be considered or ignored.<a name="line.1067"></a> -<span class="sourceLineNo">1068</span> * @param procId the procedure to abort<a name="line.1068"></a> -<span class="sourceLineNo">1069</span> * @return true if the procedure exists and has received the abort, otherwise false.<a name="line.1069"></a> -<span class="sourceLineNo">1070</span> */<a name="line.1070"></a> -<span class="sourceLineNo">1071</span> public boolean abort(long procId) {<a name="line.1071"></a> -<span class="sourceLineNo">1072</span> return abort(procId, true);<a name="line.1072"></a> -<span class="sourceLineNo">1073</span> }<a name="line.1073"></a> -<span class="sourceLineNo">1074</span><a name="line.1074"></a> -<span class="sourceLineNo">1075</span> /**<a name="line.1075"></a> -<span class="sourceLineNo">1076</span> * Send an abort notification to the specified procedure.<a name="line.1076"></a> -<span class="sourceLineNo">1077</span> * Depending on the procedure implementation, the abort can be considered or ignored.<a name="line.1077"></a> -<span class="sourceLineNo">1078</span> * @param procId the procedure to abort<a name="line.1078"></a> -<span class="sourceLineNo">1079</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.1079"></a> -<span class="sourceLineNo">1080</span> * @return true if the procedure exists and has received the abort, otherwise false.<a name="line.1080"></a> -<span class="sourceLineNo">1081</span> */<a name="line.1081"></a> -<span class="sourceLineNo">1082</span> public boolean abort(long procId, boolean mayInterruptIfRunning) {<a name="line.1082"></a> -<span class="sourceLineNo">1083</span> Procedure<TEnvironment> proc = procedures.get(procId);<a name="line.1083"></a> -<span class="sourceLineNo">1084</span> if (proc != null) {<a name="line.1084"></a> -<span class="sourceLineNo">1085</span> if (!mayInterruptIfRunning && proc.wasExecuted()) {<a name="line.1085"></a> -<span class="sourceLineNo">1086</span> return false;<a name="line.1086"></a> -<span class="sourceLineNo">1087</span> }<a name="line.1087"></a> -<span class="sourceLineNo">1088</span> return proc.abort(getEnvironment());<a name="line.1088"></a> -<span class="sourceLineNo">1089</span> }<a name="line.1089"></a> -<span class="sourceLineNo">1090</span> return false;<a name="line.1090"></a> -<span class="sourceLineNo">1091</span> }<a name="line.1091"></a> -<span class="sourceLineNo">1092</span><a name="line.1092"></a> -<span class="sourceLineNo">1093</span> // ==========================================================================<a name="line.1093"></a> -<span class="sourceLineNo">1094</span> // Executor query helpers<a name="line.1094"></a> -<span class="sourceLineNo">1095</span> // ==========================================================================<a name="line.1095"></a> -<span class="sourceLineNo">1096</span> public Procedure<TEnvironment> getProcedure(final long procId) {<a name="line.1096"></a> -<span class="sourceLineNo">1097</span> return procedures.get(procId);<a name="line.1097"></a> -<span class="sourceLineNo">1098</span> }<a name="line.1098"></a> +<span class="sourceLineNo">1050</span> // Now, the procedure is not finished, and no one can execute it since we take the lock now<a name="line.1050"></a> +<span class="sourceLineNo">1051</span> // And we can be sure that its ancestor is not running too, since their child has not<a name="line.1051"></a> +<span class="sourceLineNo">1052</span> // finished yet<a name="line.1052"></a> +<span class="sourceLineNo">1053</span> Procedure current = procedure;<a name="line.1053"></a> +<span class="sourceLineNo">1054</span> while (current != null) {<a name="line.1054"></a> +<span class="sourceLineNo">1055</span> LOG.debug("Bypassing {}", current);<a name="line.1055"></a> +<span class="sourceLineNo">1056</span> current.bypass();<a name="line.1056"></a> +<span class="sourceLineNo">1057</span> store.update(procedure);<a name="line.1057"></a> +<span class="sourceLineNo">1058</span> long parentID = current.getParentProcId();<a name="line.1058"></a> +<span class="sourceLineNo">1059</span> current = getProcedure(parentID);<a name="line.1059"></a> +<span class="sourceLineNo">1060</span> }<a name="line.1060"></a> +<span class="sourceLineNo">1061</span><a name="line.1061"></a> +<span class="sourceLineNo">1062</span> //wake up waiting procedure, already checked there is no child<a name="line.1062"></a> +<span class="sourceLineNo">1063</span> if (procedure.getState() == ProcedureState.WAITING) {<a name="line.1063"></a> +<span class="sourceLineNo">1064</span> procedure.setState(ProcedureState.RUNNABLE);<a name="line.1064"></a> +<span class="sourceLineNo">1065</span> store.update(procedure);<a name="line.1065"></a> +<span class="sourceLineNo">1066</span> }<a name="line.1066"></a> +<span class="sourceLineNo">1067</span><a name="line.1067"></a> +<span class="sourceLineNo">1068</span> // If we don't have the lock, we can't re-submit the queue,<a name="line.1068"></a> +<span class="sourceLineNo">1069</span> // since it is already executing. To get rid of the stuck situation, we<a name="line.1069"></a> +<span class="sourceLineNo">1070</span> // need to restart the master. With the procedure set to bypass, the procedureExecutor<a name="line.1070"></a> +<span class="sourceLineNo">1071</span> // will bypass it and won't get stuck again.<a name="line.1071"></a> +<span class="sourceLineNo">1072</span> if (lockEntry != null) {<a name="line.1072"></a> +<span class="sourceLineNo">1073</span> // add the procedure to run queue,<a name="line.1073"></a> +<span class="sourceLineNo">1074</span> scheduler.addFront(procedure);<a name="line.1074"></a> +<span class="sourceLineNo">1075</span> LOG.debug("Bypassing {} and its ancestors successfully, adding to queue", procedure);<a name="line.1075"></a> +<span class="sourceLineNo">1076</span> } else {<a name="line.1076"></a> +<span class="sourceLineNo">1077</span> LOG.debug("Bypassing {} and its ancestors successfully, but since it is already running, "<a name="line.1077"></a> +<span class="sourceLineNo">1078</span> + "skipping add to queue", procedure);<a name="line.1078"></a> +<span class="sourceLineNo">1079</span> }<a name="line.1079"></a> +<span class="sourceLineNo">1080</span> return true;<a name="line.1080"></a> +<span class="sourceLineNo">1081</span><a name="line.1081"></a> +<span class="sourceLineNo">1082</span> } finally {<a name="line.1082"></a> +<span class="sourceLineNo">1083</span> if (lockEntry != null) {<a name="line.1083"></a> +<span class="sourceLineNo">1084</span> procExecutionLock.releaseLockEntry(lockEntry);<a name="line.1084"></a> +<span class="sourceLineNo">1085</span> }<a name="line.1085"></a> +<span class="sourceLineNo">1086</span> }<a name="line.1086"></a> +<span class="sourceLineNo">1087</span> }<a name="line.1087"></a> +<span class="sourceLineNo">1088</span><a name="line.1088"></a> +<span class="sourceLineNo">1089</span> /**<a name="line.1089"></a> +<span class="sourceLineNo">1090</span> * Add a new root-procedure to the executor.<a name="line.1090"></a> +<span class="sourceLineNo">1091</span> * @param proc the new procedure to execute.<a name="line.1091"></a> +<span class="sourceLineNo">1092</span> * @param nonceKey the registered unique identifier for this operation from the client or process.<a name="line.1092"></a> +<span class="sourceLineNo">1093</span> * @return the procedure id, that can be used to monitor the operation<a name="line.1093"></a> +<span class="sourceLineNo">1094</span> */<a name="line.1094"></a> +<span class="sourceLineNo">1095</span> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="NP_NULL_ON_SOME_PATH",<a name="line.1095"></a> +<span class="sourceLineNo">1096</span> justification = "FindBugs is blind to the check-for-null")<a name="line.1096"></a> +<span class="sourceLineNo">1097</span> public long submitProcedure(Procedure<TEnvironment> proc, NonceKey nonceKey) {<a name="line.1097"></a> +<span class="sourceLineNo">1098</span> Preconditions.checkArgument(lastProcId.get() >= 0);<a name="line.1098"></a> <span class="sourceLineNo">1099</span><a name="line.1099"></a> -<span class="sourceLineNo">1100</span> public <T extends Procedure<TEnvironment>> T getProcedure(Class<T> clazz, long procId) {<a name="line.1100"></a> -<span class="sourceLineNo">1101</span> Procedure<TEnvironment> proc = getProcedure(procId);<a name="line.1101"></a> -<span class="sourceLineNo">1102</span> if (clazz.isInstance(proc)) {<a name="line.1102"></a> -<span class="sourceLineNo">1103</span> return clazz.cast(proc);<a name="line.1103"></a> -<span class="sourceLineNo">1104</span> }<a name="line.1104"></a> -<span class="sourceLineNo">1105</span> return null;<a name="line.1105"></a> -<span class="sourceLineNo">1106</span> }<a name="line.1106"></a> -<span class="sourceLineNo">1107</span><a name="line.1107"></a> -<span class="sourceLineNo">1108</span> public Procedure<TEnvironment> getResult(long procId) {<a name="line.1108"></a> -<span class="sourceLineNo">1109</span> CompletedProcedureRetainer<TEnvironment> retainer = completed.get(procId);<a name="line.1109"></a> -<span class="sourceLineNo">1110</span> if (retainer == null) {<a name="line.1110"></a> -<span class="sourceLineNo">1111</span> return null;<a name="line.1111"></a> -<span class="sourceLineNo">1112</span> } else {<a name="line.1112"></a> -<span class="sourceLineNo">1113</span> return retainer.getProcedure();<a name="line.1113"></a> -<span class="sourceLineNo">1114</span> }<a name="line.1114"></a> -<span class="sourceLineNo">1115</span> }<a name="line.1115"></a> -<span class="sourceLineNo">1116</span><a name="line.1116"></a> -<span class="sourceLineNo">1117</span> /**<a name="line.1117"></a> -<span class="sourceLineNo">1118</span> * Return true if the procedure is finished.<a name="line.1118"></a> -<span class="sourceLineNo">1119</span> * The state may be "completed successfully" or "failed and rolledback".<a name="line.1119"></a> -<span class="sourceLineNo">1120</span> * Use getResult() to check the state or get the result data.<a name="line.1120"></a> -<span class="sourceLineNo">1121</span> * @param procId the ID of the procedure to check<a name="line.1121"></a> -<span class="sourceLineNo">1122</span> * @return true if the procedure execution is finished, otherwise false.<a name="line.1122"></a> -<span class="sourceLineNo">1123</span> */<a name="line.1123"></a> -<span class="sourceLineNo">1124</span> public boolean isFinished(final long procId) {<a name="line.1124"></a> -<span class="sourceLineNo">1125</span> return !procedures.containsKey(procId);<a name="line.1125"></a> -<span class="sourceLineNo">1126</span> }<a name="line.1126"></a> -<span class="sourceLineNo">1127</span><a name="line.1127"></a> -<span class="sourceLineNo">1128</span> /**<a name="line.1128"></a> -<span class="sourceLineNo">1129</span> * Return true if the procedure is started.<a name="line.1129"></a> -<span class="sourceLineNo">1130</span> * @param procId the ID of the procedure to check<a name="line.1130"></a> -<span class="sourceLineNo">1131</span> * @return true if the procedure execution is started, otherwise false.<a name="line.1131"></a> -<span class="sourceLineNo">1132</span> */<a name="line.1132"></a> -<span class="sourceLineNo">1133</span> public boolean isStarted(long procId) {<a name="line.1133"></a> -<span class="sourceLineNo">1134</span> Procedure<?> proc = procedures.get(procId);<a name="line.1134"></a> -<span class="sourceLineNo">1135</span> if (proc == null) {<a name="line.1135"></a> -<span class="sourceLineNo">1136</span> return completed.get(procId) != null;<a name="line.1136"></a> +<span class="sourceLineNo">1100</span> prepareProcedure(proc);<a name="line.1100"></a> +<span class="sourceLineNo">1101</span><a name="line.1101"></a> +<span class="sourceLineNo">1102</span> final Long currentProcId;<a name="line.1102"></a> +<span class="sourceLineNo">1103</span> if (nonceKey != null) {<a name="line.1103"></a> +<span class="sourceLineNo">1104</span> currentProcId = nonceKeysToProcIdsMap.get(nonceKey);<a name="line.1104"></a> +<span class="sourceLineNo">1105</span> Preconditions.checkArgument(currentProcId != null,<a name="line.1105"></a> +<span class="sourceLineNo">1106</span> "Expected nonceKey=" + nonceKey + " to be reserved, use registerNonce(); proc=" + proc);<a name="line.1106"></a> +<span class="sourceLineNo">1107</span> } else {<a name="line.1107"></a> +<span class="sourceLineNo">1108</span> currentProcId = nextProcId();<a name="line.1108"></a> +<span class="sourceLineNo">1109</span> }<a name="line.1109"></a> +<span class="sourceLineNo">1110</span><a name="line.1110"></a> +<span class="sourceLineNo">1111</span> // Initialize the procedure<a name="line.1111"></a> +<span class="sourceLineNo">1112</span> proc.setNonceKey(nonceKey);<a name="line.1112"></a> +<span class="sourceLineNo">1113</span> proc.setProcId(currentProcId.longValue());<a name="line.1113"></a> +<span class="sourceLineNo">1114</span><a name="line.1114"></a> +<span class="sourceLineNo">1115</span> // Commit the transaction<a name="line.1115"></a> +<span class="sourceLineNo">1116</span> store.insert(proc, null);<a name="line.1116"></a> +<span class="sourceLineNo">1117</span> LOG.debug("Stored {}", proc);<a name="line.1117"></a> +<span class="sourceLineNo">1118</span><a name="line.1118"></a> +<span class="sourceLineNo">1119</span> // Add the procedure to the executor<a name="line.1119"></a> +<span class="sourceLineNo">1120</span> return pushProcedure(proc);<a name="line.1120"></a> +<span class="sourceLineNo">1121</span> }<a name="line.1121"></a> +<span class="sourceLineNo">1122</span><a name="line.1122"></a> +<span class="sourceLineNo">1123</span> /**<a name="line.1123"></a> +<span class="sourceLineNo">1124</span> * Add a set of new root-procedure to the executor.<a name="line.1124"></a> +<span class="sourceLineNo">1125</span> * @param procs the new procedures to execute.<a name="line.1125"></a> +<span class="sourceLineNo">1126</span> */<a name="line.1126"></a> +<span class="sourceLineNo">1127</span> // TODO: Do we need to take nonces here?<a name="line.1127"></a> +<span class="sourceLineNo">1128</span> public void submitProcedures(Procedure<TEnvironment>[] procs) {<a name="line.1128"></a> +<span class="sourceLineNo">1129</span> Preconditions.checkArgument(lastProcId.get() >= 0);<a name="line.1129"></a> +<span class="sourceLineNo">1130</span> if (procs == null || procs.length <= 0) {<a name="line.1130"></a> +<span class="sourceLineNo">1131</span> return;<a name="line.1131"></a> +<span class="sourceLineNo">1132</span> }<a name="line.1132"></a> +<span class="sourceLineNo">1133</span><a name="line.1133"></a> +<span class="sourceLineNo">1134</span> // Prepare procedure<a name="line.1134"></a> +<span class="sourceLineNo">1135</span> for (int i = 0; i < procs.length; ++i) {<a name="line.1135"></a> +<span class="sourceLineNo">1136</span> prepareProcedure(procs[i]).setProcId(nextProcId());<a name="line.1136"></a> <span class="sourceLineNo">1137</span> }<a name="line.1137"></a> -<span class="sourceLineNo">1138</span> return proc.wasExecuted();<a name="line.1138"></a> -<span class="sourceLineNo">1139</span> }<a name="line.1139"></a> -<span class="sourceLineNo">1140</span><a name="line.1140"></a> -<span class="sourceLineNo">1141</span> /**<a name="line.1141"></a> -<span class="sourceLineNo">1142</span> * Mark the specified completed procedure, as ready to remove.<a name="line.1142"></a> -<span class="sourceLineNo">1143</span> * @param procId the ID of the procedure to remove<a name="line.1143"></a> -<span class="sourceLineNo">1144</span> */<a name="line.1144"></a> -<span class="sourceLineNo">1145</span> public void removeResult(long procId) {<a name="line.1145"></a> -<span class="sourceLineNo">1146</span> CompletedProcedureRetainer<TEnvironment> retainer = completed.get(procId);<a name="line.1146"></a> -<span class="sourceLineNo">1147</span> if (retainer == null) {<a name="line.1147"></a> -<span class="sourceLineNo">1148</span> assert !procedures.containsKey(procId) : "pid=" + procId + " is still running";<a name="line.1148"></a> -<span class="sourceLineNo">1149</span> LOG.debug("pid={} already removed by the cleaner.", procId);<a name="line.1149"></a> -<span class="sourceLineNo">1150</span> return;<a name="line.1150"></a> -<span class="sourceLineNo">1151</span> }<a name="line.1151"></a> -<span class="sourceLineNo">1152</span><a name="line.1152"></a> -<span class="sourceLineNo">1153</span> // The CompletedProcedureCleaner will take care of deletion, once the TTL is expired.<a name="line.1153"></a> -<span class="sourceLineNo">1154</span> retainer.setClientAckTime(EnvironmentEdgeManager.currentTime());<a name="line.1154"></a> -<span class="sourceLineNo">1155</span> }<a name="line.1155"></a> -<span class="sourceLineNo">1156</span><a name="line.1156"></a> -<span class="sourceLineNo">1157</span> public Procedure<TEnvironment> getResultOrProcedure(long procId) {<a name="line.1157"></a> -<span class="sourceLineNo">1158</span> CompletedProcedureRetainer<TEnvironment> retainer = completed.get(procId);<a name="line.1158"></a> -<span class="sourceLineNo">1159</span> if (retainer == null) {<a name="line.1159"></a> -<span class="sourceLineNo">1160</span> return procedures.get(procId);<a name="line.1160"></a> -<span class="sourceLineNo">1161</span> } else {<a name="line.1161"></a> -<span class="sourceLineNo">1162</span> return retainer.getProcedure();<a name="line.1162"></a> -<span class="sourceLineNo">1163</span> }<a name="line.1163"></a> -<span class="sourceLineNo">1164</span> }<a name="line.1164"></a> +<span class="sourceLineNo">1138</span><a name="line.1138"></a> +<span class="sourceLineNo">1139</span> // Commit the transaction<a name="line.1139"></a> +<span class="sourceLineNo">1140</span> store.insert(procs);<a name="line.1140"></a> +<span class="sourceLineNo">1141</span> if (LOG.isDebugEnabled()) {<a name="line.1141"></a> +<span class="sourceLineNo">1142</span> LOG.debug("Stored " + Arrays.toString(procs));<a name="line.1142"></a> +<span class="sourceLineNo">1143</span> }<a name="line.1143"></a> +<span class="sourceLineNo">1144</span><a name="line.1144"></a> +<span class="sourceLineNo">1145</span> // Add the procedure to the executor<a name="line.1145"></a> +<span class="sourceLineNo">1146</span> for (int i = 0; i < procs.length; ++i) {<a name="line.1146"></a> +<span class="sourceLineNo">1147</span> pushProcedure(procs[i]);<a name="line.1147"></a> +<span class="sourceLineNo">1148</span> }<a name="line.1148"></a> +<span class="sourceLineNo">1149</span> }<a name="line.1149"></a> +<span class="sourceLineNo">1150</span><a name="line.1150"></a> +<span class="sourceLineNo">1151</span> private Procedure<TEnvironment> prepareProcedure(Procedure<TEnvironment> proc) {<a name="line.1151"></a> +<span class="sourceLineNo">1152</span> Preconditions.checkArgument(proc.getState() == ProcedureState.INITIALIZING);<a name="line.1152"></a> +<span class="sourceLineNo">1153</span> Preconditions.checkArgument(!proc.hasParent(), "unexpected parent", proc);<a name="line.1153"></a> +<span class="sourceLineNo">1154</span> if (this.checkOwnerSet) {<a name="line.1154"></a> +<span class="sourceLineNo">1155</span> Preconditions.checkArgument(proc.hasOwner(), "missing owner");<a name="line.1155"></a> +<span class="sourceLineNo">1156</span> }<a name="line.1156"></a> +<span class="sourceLineNo">1157</span> return proc;<a name="line.1157"></a> +<span class="sourceLineNo">1158</span> }<a name="line.1158"></a> +<span class="sourceLineNo">1159</span><a name="line.1159"></a> +<span class="sourceLineNo">1160</span> private long pushProcedure(Procedure<TEnvironment> proc) {<a name="line.1160"></a> +<span class="sourceLineNo">1161</span> final long currentProcId = proc.getProcId();<a name="line.1161"></a> +<span class="sourceLineNo">1162</span><a name="line.1162"></a> +<span class="sourceLineNo">1163</span> // Update metrics on start of a procedure<a name="line.1163"></a> +<span class="sourceLineNo">1164</span> proc.updateMetricsOnSubmit(getEnvironment());<a name="line.1164"></a> <span class="sourceLineNo">1165</span><a name="line.1165"></a> -<span class="sourceLineNo">1166</span> /**<a name="line.1166"></a> -<span class="sourceLineNo">1167</span> * Check if the user is this procedure's owner<a name="line.1167"></a> -<span class="sourceLineNo">1168</span> * @param procId the target procedure<a name="line.1168"></a> -<span class="sourceLineNo">1169</span> * @param user the user<a name="line.1169"></a> -<span class="sourceLineNo">1170</span> * @return true if the user is the owner of the procedure,<a name="line.1170"></a> -<span class="sourceLineNo">1171</span> * false otherwise or the owner is unknown.<a name="line.1171"></a> -<span class="sourceLineNo">1172</span> */<a name="line.1172"></a> -<span class="sourceLineNo">1173</span> public boolean isProcedureOwner(long procId, User user) {<a name="line.1173"></a> -<span class="sourceLineNo">1174</span> if (user == null) {<a name="line.1174"></a> -<span class="sourceLineNo">1175</span> return false;<a name="line.1175"></a> -<span class="sourceLineNo">1176</span> }<a name="line.1176"></a> -<span class="sourceLineNo">1177</span> final Procedure<TEnvironment> runningProc = procedures.get(procId);<a name="line.1177"></a> -<span class="sourceLineNo">1178</span> if (runningProc != null) {<a name="line.1178"></a> -<span class="sourceLineNo">1179</span> return runningProc.getOwner().equals(user.getShortName());<a name="line.1179"></a> -<span class="sourceLineNo">1180</span> }<a name="line.1180"></a> -<span class="sourceLineNo">1181</span><a name="line.1181"></a> -<span class="sourceLineNo">1182</span> final CompletedProcedureRetainer<TEnvironment> retainer = completed.get(procId);<a name="line.1182"></a> -<span class="sourceLineNo">1183</span> if (retainer != null) {<a name="line.1183"></a> -<span class="sourceLineNo">1184</span> return retainer.getProcedure().getOwner().equals(user.getShortName());<a name="line.1184"></a> -<span class="sourceLineNo">1185</span> }<a name="line.1185"></a> -<span class="sourceLineNo">1186</span><a name="line.1186"></a> -<span class="sourceLineNo">1187</span> // Procedure either does not exist or has already completed and got cleaned up.<a name="line.1187"></a> -<span class="sourceLineNo">1188</span> // At this time, we cannot check the owner of the procedure<a name="line.1188"></a> -<span class="sourceLineNo">1189</span> return false;<a name="line.1189"></a> -<span class="sourceLineNo">1190</span> }<a name="line.1190"></a> -<span class="sourceLineNo">1191</span><a name="line.1191"></a> -<span class="sourceLineNo">1192</span> /**<a name="line.1192"></a> -<span class="sourceLineNo">1193</span> * Should only be used when starting up, where the procedure workers have not been started.<a name="line.1193"></a> -<span class="sourceLineNo">1194</span> * <p/><a name="line.1194"></a> -<span class="sourceLineNo">1195</span> * If the procedure works has been started, the return values maybe changed when you are<a name="line.1195"></a> -<span class="sourceLineNo">1196</span> * processing it so usually this is not safe. Use {@link #getProcedures()} below for most cases as<a name="line.1196"></a> -<span class="sourceLineNo">1197</span> * it will do a copy, and also include the finished procedures.<a name="line.1197"></a> -<span class="sourceLineNo">1198</span> */<a name="line.1198"></a> -<span class="sourceLineNo">1199</span> public Collection<Procedure<TEnvironment>> getActiveProceduresNoCopy() {<a name="line.1199"></a> -<span class="sourceLineNo">1200</span> return procedures.values();<a name="line.1200"></a> -<span class="sourceLineNo">1201</span> }<a name="line.1201"></a> -<span class="sourceLineNo">1202</span><a name="line.1202"></a> -<span class="sourceLineNo">1203</span> /**<a name="line.1203"></a> -<span class="sourceLineNo">1204</span> * Get procedures.<a name="line.1204"></a> -<span class="sourceLineNo">1205</span> * @return the procedures in a list<a name="line.1205"></a> -<span class="sourceLineNo">1206</span> */<a name="line.1206"></a> -<span class="sourceLineNo">1207</span> public List<Procedure<TEnvironment>> getProcedures() {<a name="line.1207"></a> -<span class="sourceLineNo">1208</span> List<Procedure<TEnvironment>> procedureList =<a name="line.1208"></a> -<span class="sourceLineNo">1209</span> new ArrayList<>(procedures.size() + completed.size());<a name="line.1209"></a> -<span class="sourceLineNo">1210</span> procedureList.addAll(procedures.values());<a name="line.1210"></a> -<span class="sourceLineNo">1211</span> // Note: The procedure could show up twice in the list with different state, as<a name="line.1211"></a> -<span class="sourceLineNo">1212</span> // it could complete after we walk through procedures list and insert into<a name="line.1212"></a> -<span class="sourceLineNo">1213</span> // procedureList - it is ok, as we will use the information in the Procedure<a name="line.1213"></a> -<span class="sourceLineNo">1214</span> // to figure it out; to prevent this would increase the complexity of the logic.<a name="line.1214"></a> -<span class="sourceLineNo">1215</span> completed.values().stream().map(CompletedProcedureRetainer::getProcedure)<a name="line.1215"></a> -<span class="sourceLineNo">1216</span> .forEach(procedureList::add);<a name="line.1216"></a> -<span class="sourceLineNo">1217</span> return procedureList;<a name="line.1217"></a> -<span class="sourceLineNo">1218</span> }<a name="line.1218"></a> -<span class="sourceLineNo">1219</span><a name="line.1219"></a> -<span class="sourceLineNo">1220</span> // ==========================================================================<a name="line.1220"></a> -<span class="sourceLineNo">1221</span> // Listeners helpers<a name="line.1221"></a> -<span class="sourceLineNo">1222</span> // ==========================================================================<a name="line.1222"></a> -<span class="sourceLineNo">1223</span> public void registerListener(ProcedureExecutorListener listener) {<a name="line.1223"></a> -<span class="sourceLineNo">1224</span> this.listeners.add(listener);<a name="line.1224"></a> -<span class="sourceLineNo">1225</span> }<a name="line.1225"></a> -<span class="sourceLineNo">1226</span><a name="line.1226"></a> -<span class="sourceLineNo">1227</span> public boolean unregisterListener(ProcedureExecutorListener listener) {<a name="line.1227"></a> -<span class="sourceLineNo">1228</span> return this.listeners.remove(listener);<a name="line.1228"></a> -<span class="sourceLineNo">1229</span> }<a name="line.1229"></a> -<span class="sourceLineNo">1230</span><a name="line.1230"></a> -<span class="sourceLineNo">1231</span> private void sendProcedureLoadedNotification(final long procId) {<a name="line.1231"></a> -<span class="sourceLineNo">1232</span> if (!this.listeners.isEmpty()) {<a name="line.1232"></a> -<span class="sourceLineNo">1233</span> for (ProcedureExecutorListener listener: this.listeners) {<a name="line.1233"></a> -<span class="sourceLineNo">1234</span> try {<a name="line.1234"></a> -<span class="sourceLineNo">1235</span> listener.procedureLoaded(procId);<a name="line.1235"></a> -<span class="sourceLineNo">1236</span> } catch (Throwable e) {<a name="line.1236"></a> -<span class="sourceLineNo">1237</span> LOG.error("Listener " + listener + " had an error: " + e.getMessage(), e);<a name="line.1237"></a> -<span class="sourceLineNo">1238</span> }<a name="line.1238"></a> -<span class="sourceLineNo">1239</span> }<a name="line.1239"></a> -<span class="sourceLineNo">1240</span> }<a name="line.1240"></a> -<span class="sourceLineNo">1241</span> }<a name="line.1241"></a> -<span class="sourceLineNo">1242</span><a name="line.1242"></a> -<span class="sourceLineNo">1243</span> private void sendProcedureAddedNotification(final long procId) {<a name="line.1243"></a> -<span class="sourceLineNo">1244</span> if (!this.listeners.isEmpty()) {<a name="line.1244"></a> -<span class="sourceLineNo">1245</span> for (ProcedureExecutorListener listener: this.listeners) {<a name="line.1245"></a> -<span class="sourceLineNo">1246</span> try {<a name="line.1246"></a> -<span class="sourceLineNo">1247</span> listener.procedureAdded(procId);<a name="line.1247"></a> -<span class="sourceLineNo">1248</span> } catch (Throwable e) {<a name="line.1248"></a> -<span class="sourceLineNo">1249</span> LOG.error("Listener " + listener + " had an error: " + e.getMessage(), e);<a name="line.1249"></a> -<span class="sourceLineNo">1250</span> }<a name="line.1250"></a> -<span class="sourceLineNo">1251</span> }<a name="line.1251"></a> -<span class="sourceLineNo">1252</span> }<a name="line.1252"></a> -<span class="sourceLineNo">1253</span> }<a name="line.1253"></a> -<span class="sourceLineNo">1254</span><a name="line.1254"></a> -<span class="sourceLineNo">1255</span> private void sendProcedureFinishedNotification(final long procId) {<a name="line.1255"></a> -<span class="sourceLineNo">1256</span> if (!this.listeners.isEmpty()) {<a name="line.1256"></a> -<span class="sourceLineNo">1257</span> for (ProcedureExecutorListener listener: this.listeners) {<a name="line.1257"></a> -<span class="sourceLineNo">1258</span> try {<a name="line.1258"></a> -<span class="sourceLineNo">1259</span> listener.procedureFinished(procId);<a name="line.1259"></a> -<span class="sourceLineNo">1260</span> } catch (Throwable e) {<a name="line.1260"></a> -<span class="sourceLineNo">1261</span> LOG.error("Listener " + listener + " had an error: " + e.getMessage(), e);<a name="line.1261"></a> -<span class="sourceLineNo">1262</span> }<a name="line.1262"></a> -<span class="sourceLineNo">1263</span> }<a name="line.1263"></a> +<span class="sourceLineNo">1166</span> // Create the rollback stack for the procedure<a name="line.1166"></a> +<span class="sourceLineNo">1167</span> RootProcedureState<TEnvironment> stack = new RootProcedureState<>();<a name="line.1167"></a> +<span class="sourceLineNo">1168</span> rollbackStack.put(currentProcId, stack);<a name="line.1168"></a> +<span class="sourceLineNo">1169</span><a name="line.1169"></a> +<span class="sourceLineNo">1170</span> // Submit the new subprocedures<a name="line.1170"></a> +<span class="sourceLineNo">1171</span> assert !procedures.containsKey(currentProcId);<a name="line.1171"></a> +<span class="sourceLineNo">1172</span> procedures.put(currentProcId, proc);<a name="line.1172"></a> +<span class="sourceLineNo">1173</span> sendProcedureAddedNotification(currentProcId);<a name="line.1173"></a> +<span class="sourceLineNo">1174</span> scheduler.addBack(proc);<a name="line.1174"></a> +<span class="sourceLineNo">1175</span> return proc.getProcId();<a name="line.1175"></a> +<span class="sourceLineNo">1176</span> }<a name="line.1176"></a> +<span class="sourceLineNo">1177</span><a name="line.1177"></a> +<span class="sourceLineNo">1178</span> /**<a name="line.1178"></a> +<span class="sourceLineNo">1179</span> * Send an abort notification the specified procedure.<a name="line.1179"></a> +<span class="sourceLineNo">1180</span> * Depending on the procedure implementation the abort can be considered or ignored.<a name="line.1180"></a> +<span class="sourceLineNo">1181</span> * @param procId the procedure to abort<a name="line.1181"></a> +<span class="sourceLineNo">1182</span> * @return true if the procedure exists and has received the abort, otherwise false.<a name="line.1182"></a> +<span class="sourceLineNo">1183</span> */<a name="line.1183"></a> +<span class="sourceLineNo">1184</span> public boolean abort(long procId) {<a name="line.1184"></a> +<span class="sourceLineNo">1185</span> return abort(procId, true);<a name="line.1185"></a> +<span class="sourceLineNo">1186</span> }<a name="line.1186"></a> +<span class="sourceLineNo">1187</span><a name="line.1187"></a> +<span class="sourceLineNo">1188</span> /**<a name="line.1188"></a> +<span class="sourceLineNo">1189</span> * Send an abort notification to the specified procedure.<a name="line.1189"></a> +<span class="sourceLineNo">1190</span> * Depending on the procedure implementation, the abort can be considered or ignored.<a name="line.1190"></a> +<span class="sourceLineNo">1191</span> * @param procId the procedure to abort<a name="line.1191"></a> +<span class="sourceLineNo">1192</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.1192"></a> +<span class="sourceLineNo">1193</span> * @return true if the procedure exists and has received the abort, otherwise false.<a name="line.1193"></a> +<span class="sourceLineNo">1194</span> */<a name="line.1194"></a> +<span class="sourceLineNo">1195</span> public boolean abort(long procId, boolean mayInterruptIfRunning) {<a name="line.1195"></a> +<span class="sourceLineNo">1196</span> Procedure<TEnvironment> proc = procedures.get(procId);<a name="line.1196"></a> +<span class="sourceLineNo">1197</span> if (proc != null) {<a name="line.1197"></a> +<span class="sourceLineNo">1198</span> if (!mayInterruptIfRunning && proc.wasExecuted()) {<a name="line.1198"></a> +<span class="sourceLineNo">1199</span> return false;<a name="line.1199"></a> +<span class="sourceLineNo">1200</span> }<a name="line.1200"></a> +<span class="sourceLineNo">1201</span> return proc.abort(getEnvironment());<a name="line.1201"></a> +<span class="sourceLineNo">1202</span> }<a name="line.1202"></a> +<span class="sourceLineNo">1203</span> return false;<a name="line.1203"></a> +<span class="sourceLineNo">1204</span> }<a name="line.1204"></a> +<span class="sourceLineNo">1205</span><a name="line.1205"></a> +<span class="sourceLineNo">1206</span> // ==========================================================================<a name="line.1206"></a> +<span class="sourceLineNo">1207</span> // Executor query helpers<a name="line.1207"></a> +<span class="sourceLineNo">1208</span> // ==========================================================================<a name="line.1208"></a> +<span class="sourceLineNo">1209</span> public Procedure<TEnvironment> getProcedure(final long procId) {<a name="line.1209"></a> +<span class="sourceLineNo">1210</span> return procedures.get(procId);<a name="line.1210"></a> +<span class="sourceLineNo">1211</span> }<a name="line.1211"></a> +<span class="sourceLineNo">1212</span><a name="line.1212"></a> +<span class="sourceLineNo">1213</span> public <T extends Procedure<TEnvironment>> T getProcedure(Class<T> clazz, long procId) {<a name="line.1213"></a> +<span class="sourceLineNo">1214</span> Procedure<TEnvironment> proc = getProcedure(procId);<a name="line.1214"></a> +<span class="sourceLineNo">1215</span> if (clazz.isInstance(proc)) {<a name="line.1215"></a> +<span class="sourceLineNo">1216</span> return clazz.cast(proc);<a name="line.1216"></a> +<span class="sourceLineNo">1217</span> }<a name="line.1217"></a> +<span class="sourceLineNo">1218</span> return null;<a name="line.1218"></a> +<span class="sourceLineNo">1219</span> }<a name="line.1219"></a> +<span class="sourceLineNo">1220</span><a name="line.1220"></a> +<span class="sourceLineNo">1221</span> public Procedure<TEnvironment> getResult(long procId) {<a name="line.1221"></a> +<span class="sourceLineNo">1222</span> CompletedProcedureRetainer<TEnvironment> retainer = completed.get(procId);<a name="line.1222"></a> +<span class="sourceLineNo">1223</span> if (retainer == null) {<a name="line.1223"></a> +<span class="sourceLineNo">1224</span> return null;<a name="line.1224"></a> +<span class="sourceLineNo">1225</span> } else {<a name="line.1225"></a> +<span class="sourceLineNo">1226</span> return retainer.getProcedure();<a name="line.1226"></a> +<span class="sourceLineNo">1227</span> }<a name="line.1227"></a> +<span class="sourceLineNo">1228</span> }<a name="line.1228"></a> +<span class="sourceLineNo">1229</span><a name="line.1229"></a> +<span class="sourceLineNo">1230</span> /**<a name="line.1230"></a> +<span class="sourceLineNo">1231</span> * Return true if the procedure is finished.<a name="line.1231"></a> +<span class="sourceLineNo">1232</span> * The state may be "completed successfully" or "failed and rolledback".<a name="line.1232"></a> +<span class="sourceLineNo">1233</span> * Use getResult() to check the state or get the result data.<a name="line.1233"></a> +<span class="sourceLineNo">1234</span> * @param procId the ID of the procedure to check<a name="line.1234"></a> +<span class="sourceLineNo">1235</span> * @return true if the procedure execution is finished, otherwise false.<a name="line.1235"></a> +<span class="sourceLineNo">1236</span> */<a name="line.1236"></a> +<span class="sourceLineNo">1237</span> public boolean isFinished(final long procId) {<a name="line.1237"></a> +<span class="sourceLineNo">1238</span> return !procedures.containsKey(procId);<a name="line.1238"></a> +<span class="sourceLineNo">1239</span> }<a name="line.1239"></a> +<span class="sourceLineNo">1240</span><a name="line.1240"></a> +<span class="sourceLineNo">1241</span> /**<a name="line.1241"></a> +<span class="sourceLineNo">1242</span> * Return true if the procedure is started.<a name="line.1242"></a> +<span class="sourceLineNo">1243</span> * @param procId the ID of the procedure to check<a name="line.1243"></a> +<span class="sourceLineNo">1244</span> * @return true if the procedure execution is started, otherwise false.<a name="line.1244"></a> +<span class="sourceLineNo">1245</span> */<a name="line.1245"></a> +<span class="sourceLineNo">1246</span> public boolean isStarted(long procId) {<a name="line.1246"></a> +<span class="sourceLineNo">1247</span> Procedure<?> proc = procedures.get(procId);<a name="line.1247"></a> +<span class="sourceLineNo">1248</span> if (proc == null) {<a name="line.1248"></a> +<span class="sourceLineNo">1249</span> return completed.get(procId) != null;<a name="line.1249"></a> +<span class="sourceLineNo">1250</span> }<a name="line.1250"></a> +<span class="sourceLineNo">1251</span> return proc.wasExecuted();<a name="line.1251"></a> +<span class="sourceLineNo">1252</span> }<a name="line.1252"></a> +<span class="sourceLineNo">1253</span><a name="line.1253"></a> +<span class="sourceLineNo">1254</span> /**<a name="line.1254"></a> +<span class="sourceLineNo">1255</span> * Mark the specified completed procedure, as ready to remove.<a name="line.1255"></a> +<span class="sourceLineNo">1256</span> * @param procId the ID of the procedure to remove<a name="line.1256"></a> +<span class="sourceLineNo">1257</span> */<a name="line.1257"></a> +<span class="sourceLineNo">1258</span> public void removeResult(long procId) {<a name="line.1258"></a> +<span class="sourceLineNo">1259</span> CompletedProcedureRetainer<TEnvironment> retainer = completed.get(procId);<a name="line.1259"></a> +<span class="sourceLineNo">1260</span> if (retainer == null) {<a name="line.1260"></a> +<span class="sourceLineNo">1261</span> assert !procedures.containsKey(procId) : "pid=" + procId + " is still running";<a name="line.1261"></a> +<span class="sourceLineNo">1262</span> LOG.debug("pid={} already removed by the cleaner.", procId);<a name="line.1262"></a> +<span class="sourceLineNo">1263</span> return;<a name="line.1263"></a> <span class="sourceLineNo">1264</span> }<a name="line.1264"></a> -<span class="sourceLineNo">1265</span> }<a name="line.1265"></a> -<span class="sourceLineNo">1266</span><a name="line.1266"></a> -<span class="sourceLineNo">1267</span> // ==========================================================================<a name="line.1267"></a> -<span class="sourceLineNo">1268</span> // Procedure IDs helpers<a name="line.1268"></a> -<span class="sourceLineNo">1269</span> // ==========================================================================<a name="line.1269"></a> -<span class="sourceLineNo">1270</span> private long nextProcId() {<a name="line.1270"></a> -<span class="sourceLineNo">1271</span> long procId = lastProcId.incrementAndGet();<a name="line.1271"></a> -<span class="sourceLineNo">1272</span> if (procId < 0) {<a name="line.1272"></a> -<span class="sourceLineNo">1273</span> while (!lastProcId.compareAndSet(procId, 0)) {<a name="line.1273"></a> -<span class="sourceLineNo">1274</span> procId = lastProcId.get();<a name="line.1274"></a> -<span class="sourceLineNo">1275</span> if (procId >= 0)<a name="line.1275"></a> -<span class="sourceLineNo">1276</span> break;<a name="line.1276"></a> -<span class="sourceLineNo">1277</span> }<a name="line.1277"></a> -<span class="sourceLineNo">1278</span> while (procedures.containsKey(procId)) {<a name="line.1278"></a> -<span class="sourceLineNo">1279</span> procId = lastProcId.incrementAndGet();<a name="line.1279"></a> -<span class="sourceLineNo">1280</span> }<a name="line.1280"></a> -<span class="sourceLineNo">1281</span> }<a name="line.1281"></a> -<span class="sourceLineNo">1282</span> assert procId >= 0 : "Invalid procId " + procId;<a name="line.1282"></a> -<span class="sourceLineNo">1283</span> return procId;<a name="line.1283"></a> -<span class="sourceLineNo">1284</span> }<a name="line.1284"></a> -<span class="sourceLineNo">1285</span><a name="line.1285"></a> -<span class="sourceLineNo">1286</span> @VisibleForTesting<a name="line.1286"></a> -<span class="sourceLineNo">1287</span> protected long getLastProcId() {<a name="line.1287"></a> -<span class="sourceLineNo">1288</span> return lastProcId.get();<a name="line.1288"></a> -<span class="sourceLineNo">1289</span> }<a name="line.1289"></a> -<span class="sourceLineNo">1290</span><a name="line.1290"></a> -<span class="sourceLineNo">1291</span> @VisibleForTesting<a name="line.1291"></a> -<span class="sourceLineNo">1292</span> public Set<Long> getActiveProcIds() {<a name="line.1292"></a> -<span class="sourceLineNo">1293</span> return procedures.keySet();<a name="line.1293"></a> -<span class="sourceLineNo">1294</span> }<a name="line.1294"></a> -<span class="sourceLineNo">1295</span><a name="line.1295"></a> -<span class="sourceLineNo">1296</span> Long getRootProcedureId(Procedure<TEnvironment> proc) {<a name="line.1296"></a> -<span class="sourceLineNo">1297</span> return Procedure.getRootProcedureId(procedures, proc);<a name="line.1297"></a> -<span class="sourceLineNo">1298</span> }<a name="line.1298"></a> +<span class="sourceLineNo">1265</span><a name="line.1265"></a> +<span class="sourceLineNo">1266</span> // The CompletedProcedureCleaner will take care of deletion, once the TTL is expired.<a name="line.1266"></a> +<span class="sourceLineNo">1267</span> retainer.setClientAckTime(EnvironmentEdgeManager.currentTime());<a name="line.1267"></a> +<span class="sourceLineNo">1268</span> }<a name="line.1268"></a> +<span class="sourceLineNo">1269</span><a name="line.1269"></a> +<span class="sourceLineNo">1270</span> public Procedure<TEnvironment> getResultOrProcedure(long procId) {<a name="line.1270"></a> +<span class="sourceLineNo">1271</span> CompletedProcedureRetainer<TEnvironment> retainer = completed.get(procId);<a name="line.1271"></a> +<span class="sourceLineNo">1272</span> if (retainer == null) {<a name="line.1272"></a> +<span class="sourceLineNo">1273</span> return procedures.get(procId);<a name="line.1273"></a> +<span class="sourceLineNo">1274</span> } else {<a name="line.1274"></a> +<span class="sourceLineNo">1275</span> return retainer.getProcedure();<a name="line.1275"></a> +<span class="sourceLineNo">1276</span> }<a name="line.1276"></a> +<span class="sourceLineNo">1277</span> }<a name="line.1277"></a> +<span class="sourceLineNo">1278</span><a name="line.1278"></a> +<span class="sourceLineNo">1279</span> /**<a name="line.1279"></a> +<span class="sourceLineNo">1280</span> * Check if the user is this procedure's owner<a name="line.1280"></a> +<span class="sourceLineNo">1281</span> * @param procId the target procedure<a name="line.1281"></a> +<span class="sourceLineNo">1282</span> * @param user the user<a name="line.1282"></a> +<span class="sourceLineNo">1283</span> * @return true if the user is the owner of the procedure,<a name="line.1283"></a> +<span class="sourceLineNo">1284</span> * false otherwise or the owner is unknown.<a name="line.1284"></a> +<span class="sourceLineNo">1285</span> */<a name="line.1285"></a> +<span class="sourceLineNo">1286</span> public boolean isProcedureOwner(long procId, User user) {<a name="line.1286"></a> +<span class="sourceLineNo">1287</span> if (user == null) {<a name="line.1287"></a> +<span class="sourceLineNo">1288</span> return false;<a name="line.1288"></a> +<span class="sourceLineNo">1289</span> }<a name="line.1289"></a> +<span class="sourceLineNo">1290</span> final Procedure<TEnvironment> runningProc = procedures.get(procId);<a name="line.1290"></a> +<span class="sourceLineNo">1291</span> if (runningProc != null) {<a name="line.1291"></a> +<span class="sourceLineNo">1292</span> return runningProc.getOwner().equals(user.getShortName());<a name="line.1292"></a> +<span class="sourceLineNo">1293</span> }<a name="line.1293"></a> +<span class="sourceLineNo">1294</span><a name="line.1294"></a> +<span class="sourceLineNo">1295</span> final CompletedProcedureRetainer<TEnvironment> retainer = completed.get(procId);<a name="line.1295"></a> +<span class="sourceLineNo">1296</span> if (retainer != null) {<a name="line.1296"></a> +<span class="sourceLineNo">1297</span> return retainer.getProcedure().getOwner().equals(user.getShortName());<a name="line.1297"></a> +<span class="sourceLineNo">1298</span> }<a name="line.1298"></a> <span class="sourceLineNo">1299</span><a name="line.1299"></a> -<span class="sourceLineNo">1300</span> // ==========================================================================<a name="line.1300"></a> -<span class="sourceLineNo">1301</span> // Executions<a name="line.1301"></a> -<span class="sourceLineNo">1302</span> // ==========================================================================<a name="line.1302"></a> -<span class="sourceLineNo">1303</span> private void executeProcedure(Procedure<TEnvironment> proc) {<a name="line.1303"></a> -<span class="sourceLineNo">1304</span> final Long rootProcId = getRootProcedureId(proc);<a name="line.1304"></a> -<span class="sourceLineNo">1305</span> if (rootProcId == null) {<a name="line.1305"></a> -<span class="sourceLineNo">1306</span> // The 'proc' was ready to run but the root procedure was rolledback<a name="line.1306"></a> -<span class="sourceLineNo">1307</span> LOG.warn("Rollback because parent is done/rolledback proc=" + proc);<a name="line.1307"></a> -<span class="sourceLineNo">1308</span> executeRollback(proc);<a name="line.1308"></a> -<span class="sourceLineNo">1309</span> return;<a name="line.1309"></a> -<span class="sourceLineNo">1310</span> }<a name="line.1310"></a> -<span class="sourceLineNo">1311</span><a name="line.1311"></a> -<span class="sourceLineNo">1312</span> RootProcedureState<TEnvironment> procStack = rollbackStack.get(rootProcId);<a name="line.1312"></a> -<span class="sourceLineNo">1313</span> if (procStack == null) {<a name="line.1313"></a> -<span class="sourceLineNo">1314</span> LOG.warn("RootProcedureState is null for " + proc.getProcId());<a name="line.1314"></a> -<span class="sourceLineNo">1315</span> return;<a name="line.1315"></a> -<span class="sourceLineNo">1316</span> }<a name="line.1316"></a> -<span class="sourceLineNo">1317</span> do {<a name="line.1317"></a> -<span class="sourceLineNo">1318</span> // Try to acquire the execution<a name="line.1318"></a> -<span class="sourceLineNo">1319</span> if (!procStack.acquire(proc)) {<a name="line.1319"></a> -<span class="sourceLineNo">1320</span> if (procStack.setRollback()) {<a name="line.1320"></a> -<span class="sourceLineNo">1321</span> // we have the 'rollback-lock' we can start rollingback<a name="line.1321"></a> -<span class="sourceLineNo">1322</span> switch (executeRollback(rootProcId, procStack)) {<a name="line.1322"></a> -<span class="sourceLineNo">1323</span> case LOCK_ACQUIRED:<a name="line.1323"></a> -<span class="sourceLineNo">1324</span> break;<a name="line.1324"></a> -<span class="sourceLineNo">1325</span> case LOCK_YIELD_WAIT:<a name="line.1325"></a> -<span class="sourceLineNo">1326</span> procStack.unsetRollback();<a name="line.1326"></a> -<span class="sourceLineNo">1327</span> scheduler.yield(proc);<a name="line.1327"></a> -<span class="sourceLineNo">1328</span> break;<a name="line.1328"></a> -<span class="sourceLineNo">1329</span> case LOCK_EVENT_WAIT:<a name="line.1329"></a> -<span class="sourceLineNo">1330</span> LOG.info("LOCK_EVENT_WAIT rollback..." + proc);<a name="line.1330"></a> -<span class="sourceLineNo">1331</span> procStack.unsetRollback();<a name="line.1331"></a> -<span class="sourceLineNo">1332</span> break;<a name="line.1332"></a> -<span class="sourceLineNo">1333</span> default:<a name="line.1333"></a> -<span class="sourceLineNo">1334</span> throw new UnsupportedOperationException();<a name="line.1334"></a> -<span class="sourceLineNo">1335</span> }<a name="line.1335"></a> -<span class="sourceLineNo">1336</span> } else {<a name="line.1336"></a> -<span class="sourceLineNo">1337</span> // if we can't rollback means that some child is still running.<a name="line.1337"></a> -<span class="sourceLineNo">1338</span> // the rollback will be executed after all the children are done.<a name="line.1338"></a> -<span class="sourceLineNo">1339</span> // If the procedure was never executed, remove and mark it as rolledback.<a name="line.1339"></a> -<span class="sourceLineNo">1340</span> if (!proc.wasExecuted()) {<a name="line.1340"></a> -<span class="sourceLineNo">1341</span> switch (executeRollback(proc)) {<a name="line.1341"></a> -<span class="sourceLineNo">1342</span> case LOCK_ACQUIRED:<a name="line.1342"></a> -<span class="sourceLineNo">1343</span> break;<a name="line.1343"></a> -<span class="sourceLineNo">1344</span> case LOCK_YIELD_WAIT:<a name="line.1344"></a> -<span class="sourceLineNo">1345</span> scheduler.yield(proc);<a name="line.1345"></a> -<span class="sourceLineNo">1346</span> break;<a name="line.1346"></a> -<span class="sourceLineNo">1347</span> case LOCK_EVENT_WAIT:<a name="line.1347"></a> -<span class="sourceLineNo">1348</span> LOG.info("LOCK_EVENT_WAIT can't rollback child running?..." + proc);<a name="line.1348"></a> -<span class="sourceLineNo">1349</span> break;<a name="line.1349"></a> -<span class="sourceLineNo">1350</span> default:<a name="line.1350"></a> -<span class="sourceLineNo">1351</span> throw new UnsupportedOperationException();<a name="line.1351"></a> -<span class="sourceLineNo">1352</span> }<a name="line.1352"></a> -<span class="sourceLineNo">1353</span> }<a name="line.1353"></a> -<span class="sourceLineNo">1354</span> }<a name="line.1354"></a> -<span class="sourceLineNo">1355</span> break;<a name="line.1355"></a> -<span class="sourceLineNo">1356</span> }<a name="line.1356"></a> -<span class="sourceLineNo">1357</span><a name="line.1357"></a> -<span class="sourceLineNo">1358</span> // Execute the procedure<a name="line.1358"></a> -<span class="sourceLineNo">1359</span> assert proc.getState() == ProcedureState.RUNNABLE : proc;<a name="line.1359"></a> -<span class="sourceLineNo">1360</span> // Note that lock is NOT about concurrency but rather about ensuring<a name="line.1360"></a> -<span class="sourceLineNo">1361</span> // ownership of a procedure of an entity such as a region or table<a name="line.1361"></a> -<span class="sourceLineNo">1362</span> LockState lockState = acquireLock(proc);<a name="line.1362"></a> -<span class="sourceLineNo">1363</span> switch (lockState) {<a name="line.1363"></a> -<span class="sourceLineNo">1364</span> case LOCK_ACQUIRED:<a name="line.1364"></a> -<span class="sourceLineNo">1365</span> execProcedure(procStack, proc);<a name="line.1365"></a> -<span class="sourceLineNo">1366</span> break;<a name="line.1366"></a> -<span class="sourceLineNo">1367</span> case LOCK_YIELD_WAIT:<a name="line.1367"></a> -<span class="sourceLineNo">1368</span> LOG.info(lockState + " " + proc);<a name="line.1368"></a> -<span class="sourceLineNo">1369</span> scheduler.yield(proc);<a name="line.1369"></a> -<span class="sourceLineNo">1370</span> break;<a name="line.1370"></a> -<span class="sourceLineNo">1371</span> case LOCK_EVENT_WAIT:<a name="line.1371"></a> -<span class="sourceLineNo">1372</span> // Someone will wake us up when the lock is available<a name="line.1372"></a> -<span class="sourceLineNo">1373</span> LOG.debug(lockState + " " + proc);<a name="line.1373"></a> -<span class="sourceLineNo">1374</span> break;<a name="line.1374"></a> -<span class="sourceLineNo">1375</span> default:<a name="line.1375"></a> -<span class="sourceLineNo">1376</span> throw new UnsupportedOperationException();<a name="line.1376"></a> -<span class="sourceLineNo">1377</span> }<a name="line.1377"></a> -<span class="sourceLineNo">1378</span> procStack.release(proc);<a name="line.1378"></a> +<span class="sourceLineNo">1300</span> // Procedure either does not exist or has already completed and got cleaned up.<a name="line.1300"></a> +<span class="sourceLineNo">1301</span> // At this time, we cannot check the owner of the procedure<a name="line.1301"></a> +<span class="sourceLineNo">1302</span> return false;<a name="line.1302"></a> +<span class="sourceLineNo">1303</span> }<a name="line.1303"></a> +<span class="sourceLineNo">1304</span><a name="line.1304"></a> +<span class="sourceLineNo">1305</span> /**<a name="line.1305"></a> +<span class="sourceLineNo">1306</span> * Should only be used when starting up, where the procedure workers have not been started.<a name="line.1306"></a> +<span class="sourceLineNo">1307</span> * <p/><a name="line.1307"></a> +<span class="sourceLineNo">1308</span> * If the procedure works has been started, the return values maybe changed when you are<a name="line.1308"></a> +<span class="sourceLineNo">1309</span> * processing it so usually this is not safe. Use {@link #getProcedures()} below for most cases as<a name="line.1309"></a> +<span class="sourceLineNo">1310</span> * it will do a copy, and also include the finished procedures.<a name="line.1310"></a> +<span class="sourceLineNo">1311</span> */<a name="line.1311"></a> +<span class="sourceLineNo">1312</span> public Collection<Procedure<TEnvironment>> getActiveProceduresNoCopy() {<a name="line.1312"></a> +<span class="sourceLineNo">1313</span> return procedures.values();<a name="line.1313"></a> +<span class="sourceLineNo">1314</span> }<a name="line.1314"></a> +<span class="sourceLineNo">1315</span><a name="line.1315"></a> +<span class="sourceLineNo">1316</span> /**<a name="line.1316"></a> +<span class="sourceLineNo">1317</span> * Get procedures.<a name="line.1317"></a> +<span class="sourceLineNo">1318</span> * @return the procedures in a list<a name="line.1318"></a> +<span class="sourceLineNo">1319</span> */<a name="line.1319"></a> +<span class="sourceLineNo">1320</span> public List<Procedure<TEnvironment>> getProcedures() {<a name="line.1320"></a> +<span class="sourceLineNo">1321</span> List<Procedure<TEnvironment>> procedureList =<a name="line.1321"></a> +<span class="sourceLineNo">1322</span> new ArrayList<>(procedures.size() + completed.size());<a name="line.1322"></a> +<span class="sourceLineNo">1323</span> procedureList.addAll(procedures.values());<a name="line.1323"></a> +<span class="sourceLineNo">1324</span> // Note: The procedure could show up twice in the list with different state, as<a name="line.1324"></a> +<span class="sourceLineNo">1325</span> // it could complete after we walk through procedures list and insert into<a name="line.1325"></a> +<span class="sourceLineNo">1326</span> // procedureList - it is ok, as we will use the information in the Procedure<a name="line.1326"></a> +<span class="sourceLineNo">1327</span> // to figure it out; to prevent this would increase the complexity of the logic.<a name="line.1327"></a> +<span class="sourceLineNo">1328</span> completed.values().stream().map(CompletedProcedureRetainer::getProcedure)<a name="line.1328"></a> +<span class="sourceLineNo">1329</span> .forEach(procedureList::add);<a name="line.1329"></a> +<span class="sourceLineNo">1330</span> return procedureList;<a name="line.1330"></a> +<span class="sourceLineNo">1331</span> }<a name="line.1331"></a> +<span class="sourceLineNo">1332</span><a name="line.1332"></a> +<span class="sourceLineNo">1333</span> // ==========================================================================<a name="line.1333"></a> +<span class="sourceLineNo">1334</span> // Listeners helpers<a name="line.1334"></a> +<span class="sourceLineNo">1335</span> // ==========================================================================<a name="line.1335"></a> +<span class="sourceLineNo">1336</span> public void registerListener(ProcedureExecutorListener listener) {<a name="line.1336"></a> +<span class="sourceLineNo">1337</span> this.listeners.add(listener);<a name="line.1337"></a> +<span class="sourceLineNo">1338</span> }<a name="line.1338"></a> +<span class="sourceLineNo">1339</span><a name="line.1339"></a> +<span class="sourceLineNo">1340</span> public boolean unregisterListener(ProcedureExecutorListener listener) {<a name="line.1340"></a> +<span class="sourceLineNo">1341</span> return this.listeners.remove(listener);<a name="line.1341"></a> +<span class="sourceLineNo">1342</span> }<a name="line.1342"></a> +<span class="sourceLineNo">1343</span><a name="line.1343"></a> +<span class="sourceLineNo">1344</span> private void sendProcedureLoadedNotification(final long procId) {<a name="line.1344"></a> +<span class="sourceLineNo">1345</span> if (!this.listeners.isEmpty()) {<a name="line.1345"></a> +<span class="sourceLineNo">1346</span> for (ProcedureExecutorListener listener: this.listeners) {<a name="line.1346"></a> +<span class="sourceLineNo">1347</span> try {<a name="line.1347"></a> +<span class="sourceLineNo">1348</span> listener.procedureLoaded(procId);<a name="line.1348"></a> +<span class="sourceLineNo">1349</span> } catch (Throwable e) {<a name="line.1349"></a> +<span class="sourceLineNo">1350</span> LOG.error("Listener " + listener + " had an error: " + e.getMessage(), e);<a name="line.1350"></a> +<span class="sourceLineNo">1351</span> }<a name="line.1351"></a> +<span class="sourceLineNo">1352</span> }<a name="line.1352"></a> +<span class="sourceLineNo">1353</span> }<a name="line.1353"></a> +<span class="sourceLineNo">1354</span> }<a name="line.1354"></a> +<span class="sourceLineNo">1355</span><a name="line.1355"></a> +<span class="sourceLineNo">1356</span> private void sendProcedureAddedNotification(final long procId) {<a name="line.1356"></a> +<span class="sourceLineNo">1357</span> if (!this.listeners.isEmpty()) {<a name="line.1357"></a> +<span class="sourceLineNo">1358</span> for (ProcedureExecutorListener listener: this.listeners) {<a name="line.1358"></a> +<span class="sourceLineNo">1359</span> try {<a name="line.1359"></a> +<span class="sourceLineNo">1360</span> listener.procedureAdded(procId);<a name="line.1360"></a> +<span class="sourceLineNo">1361</span> } catch (Throwable e) {<a name="line.1361"></a> +<span class="sourceLineNo">1362</span> LOG.error("Listener " + listener + " had an error: " + e.getMessage(), e);<a name="line.1362"></a> +<span class="sourceLineNo">1363</span> }<a name="line.1363"></a> +<span class="sourceLineNo">1364</span> }<a name="line.1364"></a> +<span class="sourceLineNo">1365</span> }<a name="line.1365"></a> +<span class="sourceLineNo">1366</span> }<a name="line.1366"></a> +<span class="sourceLineNo">1367</span><a name="line.1367"></a> +<span class="sourceLineNo">1368</span> private void sendProcedureFinishedNotification(final long procId) {<a name="line.1368"></a> +<span class="sourceLineNo">1369</span> if (!this.listeners.isEmpty()) {<a name="line.1369"></a> +<span class="sourceLineNo">1370</span> for (ProcedureExecutorListener listener: this.listeners) {<a name="line.1370"></a> +<span class="sourceLineNo">1371</span> try {<a name="line.1371"></a> +<span class="sourceLineNo">1372</span> listener.procedureFinished(procId);<a name="line.1372"></a> +<span class="sourceLineNo">1373</span> } catch (Throwable e) {<a name="line.1373"></a> +<span class="sourceLineNo">1374</span> LOG.error("Listener " + listener + " had an error: " + e.getMessage(), e);<a name="line.1374"></a> +<span class="sourceLineNo">1375</span> }<a name="line.1375"></a> +<span class="sourceLineNo">1376</span> }<a name="line.1376"></a> +<span class="sourceLineNo">1377</span> }<a name="line.1377"></a> +<span class="sourceLineNo">1378</span> }<a name="line.1378"></a> <span class="sourceLineNo">1379</span><a name="line.1379"></a> -<span class="sourceLineNo">1380</span> if (proc.isSuccess()) {<a name="line.1380"></a> -<span class="sourceLineNo">1381</span> // update metrics on finishing the procedure<a name="line.1381"></a> -<span class="sourceLineNo">1382</span> proc.updateMetricsOnFinish(getEnvironment(), proc.elapsedTime(), true);<a name="line.1382"></a> -<span class="sourceLineNo">1383</span> LOG.info("Finished " + proc + " in " + StringUtils.humanTimeDiff(proc.elapsedTime()));<a name="line.1383"></a> -<span class="sourceLineNo">1384</span> // Finalize the procedure state<a name="line.1384"></a> -<span class="sourceLineNo">1385</span> if (proc.getProcId() == rootProcId) {<a name="line.1385"></a> -<span class="sourceLineNo">1386</span> procedureFinished(proc);<a name="line.1386"></a> -<span class="sourceLineNo">1387</span> } else {<a name="line.1387"></a> -<span class="sourceLineNo">1388</span> execCompletionCleanup(proc);<a name="line.1388"></a> -<span class="sourceLineNo">1389</span> }<a name="line.1389"></a> -<span class="sourceLineNo">1390</span> break;<a name="line.1390"></a> -<span class="sourceLineNo">1391</span> }<a name="line.1391"></a> -<span class="sourceLineNo">1392</span> } while (procStack.isFailed());<a name="line.1392"></a> -<span class="sourceLineNo">1393</span> }<a name="line.1393"></a> -<span class="sourceLineNo">1394</span><a name="line.1394"></a> -<span class="sourceLineNo">1395</span> private LockState acquireLock(Procedure<TEnvironment> proc) {<a name="line.1395"></a> -<span class="sourceLineNo">1396</span> TEnvironment env = getEnvironment();<a name="line.1396"></a> -<span class="sourceLineNo">1397</span> // if holdLock is true, then maybe we already have the lock, so just return LOCK_ACQUIRED if<a name="line.1397"></a> -<span class="sourceLineNo">1398</span> // hasLock is true.<a name="line.1398"></a> -<span class="sourceLineNo">1399</span> if (proc.hasLock()) {<a name="line.1399"></a> -<span class="sourceLineNo">1400</span> return LockState.LOCK_ACQUIRED;<a name="line.1400"></a> -<span class="sourceLineNo">1401</span> }<a name="line.1401"></a> -<span class="sourceLineNo">1402</span> return proc.doAcquireLock(env, store);<a name="line.1402"></a> -<span class="sourceLineNo">1403</span> }<a name="line.1403"></a> -<span class="sourceLineNo">1404</span><a name="line.1404"></a> -<span class="sourceLineNo">1405</span> private void releaseLock(Procedure<TEnvironment> proc, boolean force) {<a name="line.1405"></a> -<span class="sourceLineNo">1406</span> TEnvironment env = getEnvironment();<a name="line.1406"></a> -<span class="sourceLineNo">1407</span> // For how the framework works, we know that we will always have the lock<a name="line.1407"></a> -<span class="sourceLineNo">1408</span> // when we call releaseLock(), so we can avoid calling proc.hasLock()<a name="line.1408"></a> -<span class="sourceLineNo">1409</span> if (force || !proc.holdLock(env) || proc.isFinished()) {<a name="line.1409"></a> -<span class="sourceLineNo">1410</span> proc.doReleaseLock(env, store);<a name="line.1410"></a> -<span class="sourceLineNo">1411</span> }<a name="line.1411"></a> -<span class="sourceLineNo">1412</span> }<a name="line.1412"></a> -<span class="sourceLineNo">1413</span><a name="line.1413"></a> -<span class="sourceLineNo">1414</span> /**<a name="line.1414"></a> -<span class="sourceLineNo">1415</span> * Execute the rollback of the full procedure stack. Once the procedure is rolledback, the<a name="line.1415"></a> -<span class="sourceLineNo">1416</span> * root-procedure will be visible as finished to user, and the result will be the fatal exception.<a name="line.1416"></a> -<span class="sourceLineNo">1417</span> */<a name="line.1417"></a> -<span class="sourceLineNo">1418</span> private LockState executeRollback(long rootProcId, RootProcedureState<TEnvironment> procStack) {<a name="line.1418"></a> -<span class="sourceLineNo">1419</span> Procedure<TEnvironment> rootProc = procedures.get(rootProcId);<a name="line.1419"></a> -<span class="sourceLineNo">1420</span> RemoteProcedureException exception = rootProc.getException();<a name="line.1420"></a> -<span class="sourceLineNo">1421</span> // TODO: This needs doc. The root proc doesn't have an exception. Maybe we are<a name="line.1421"></a> -<span class="sourceLineNo">1422</span> // rolling back because the subprocedure does. Clarify.<a name="line.1422"></a> -<span class="sourceLineNo">1423</span> if (exception == null) {<a name="line.1423"></a> -<span class="sourceLineNo">1424</span> exception = procStack.getException();<a name="line.1424"></a> -<span class="sourceLineNo">1425</span> rootProc.setFailure(exception);<a name="line.1425"></a> -<span class="sourceLineNo">1426</span> store.update(rootProc);<a name="line.1426"></a> +<span class="sourceLineNo">1380</span> // ==========================================================================<a name="line.1380"></a> +<span class="sourceLineNo">1381</span> // Procedure IDs helpers<a name="line.1381"></a> +<span class="sourceLineNo">1382</span> // ==========================================================================<a name="line.1382"></a> +<span class="sourceLineNo">1383</span> private long nextProcId() {<a name="line.1383"></a> +<span class="sourceLineNo">1384</span> long procId = lastProcId.incrementAndGet();<a name="line.1384"></a> +<span class="sourceLineNo">1385</span> if (procId < 0) {<a name="line.1385"></a> +<span class="sourceLineNo">1386</span> while (!lastProcId.compareAndSet(procId, 0)) {<a name="line.1386"></a> +<span class="sourceLineNo">1387</span> procId = lastProcId.get();<a name="line.1387"></a> +<span class="sourceLineNo">1388</span> if (procId >= 0)<a name="line.1388"></a> +<span class="sourceLineNo">1389</span> break;<a name="line.1389"></a> +<span class="sourceLineNo">1390</span> }<a name="line.1390"></a> +<span class="sourceLineNo">1391</span> while (procedures.containsKey(procId)) {<a name="line.1391"></a> +<span class="sourceLineNo">1392</span> procId = lastProcId.incrementAndGet();<a name="line.1392"></a> +<span class="sourceLineNo">1393</span> }<a name="line.1393"></a> +<span class="sourceLineNo">1394</span> }<a name="line.1394"></a> +<span class="sourceLineNo">1395</span> assert procId >= 0 : "Invalid procId " + procId;<a name="line.1395"></a> +<span class="sourceLineNo">1396</span> return procId;<a name="line.1396"></a> +<span class="sourceLineNo">1397</span> }<a name="line.1397"></a> +<span class="sourceLineNo">1398</span><a name="line.1398"></a> +<span class="sourceLineNo">1399</span> @VisibleForTesting<a name="line.1399"></a> +<span class="sourceLineNo">1400</span> protected long getLastProcId() {<a name="line.1400"></a> +<span class="sourceLineNo">1401</span> return lastProcId.get();<a name="line.1401"></a> +<span class="sourceLineNo">1402</span> }<a name="line.1402"></a> +<span class="sourceLineNo">1403</span><a name="line.1403"></a> +<span class="sourceLineNo">1404</span> @VisibleForTesting<a name="line.1404"></a> +<span class="sourceLineNo">1405</span> public Set<Long> getActiveProcIds() {<a name="line.1405"></a> +<span class="sourceLineNo">1406</span> return procedures.keySet();<a name="line.1406"></a> +<span class="sourceLineNo">1407</span> }<a name="line.1407"></a> +<span class="sourceLineNo">1408</span><a name="line.1408"></a> +<span class="sourceLineNo">1409</span> Long getRootProcedureId(Procedure<TEnvironment> proc) {<a name="line.1409"></a> +<span class="sourceLineNo">1410</span> return Procedure.getRootProcedureId(procedures, proc);<a name="line.1410"></a> +<span class="sourceLineNo">1411</span> }<a name="line.1411"></a> +<span class="sourceLineNo">1412</span><a name="line.1412"></a> +<span class="sourceLineNo">1413</span> // ==========================================================================<a name="line.1413"></a> +<span class="sourceLineNo">1414</span> // Executions<a name="line.1414"></a> +<span class="sourceLineNo">1415</span> // ==========================================================================<a name="line.1415"></a> +<span class="sourceLineNo">1416</span> private void executeProcedure(Procedure<TEnvironment> proc) {<a name="line.1416"></a> +<span class="sourceLineNo">1417</span> if (proc.isFinished()) {<a name="line.1417"></a> +<span class="sourceLineNo">1418</span> LOG.debug("{} is already finished, skipping execution"
<TRUNCATED>