| /* |
| * 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.iotdb.confignode.procedure.impl.schema; |
| |
| import org.apache.iotdb.common.rpc.thrift.TConsensusGroupId; |
| import org.apache.iotdb.common.rpc.thrift.TDataNodeLocation; |
| import org.apache.iotdb.common.rpc.thrift.TRegionReplicaSet; |
| import org.apache.iotdb.common.rpc.thrift.TSStatus; |
| import org.apache.iotdb.commons.exception.IoTDBException; |
| import org.apache.iotdb.commons.exception.MetadataException; |
| import org.apache.iotdb.commons.path.PartialPath; |
| import org.apache.iotdb.commons.path.PathDeserializeUtil; |
| import org.apache.iotdb.commons.path.PathPatternTree; |
| import org.apache.iotdb.confignode.client.DataNodeRequestType; |
| import org.apache.iotdb.confignode.client.async.AsyncDataNodeClientPool; |
| import org.apache.iotdb.confignode.client.async.handlers.AsyncClientHandler; |
| import org.apache.iotdb.confignode.consensus.request.write.pipe.payload.PipeDeactivateTemplatePlan; |
| import org.apache.iotdb.confignode.consensus.request.write.pipe.payload.PipeEnrichedPlan; |
| import org.apache.iotdb.confignode.procedure.env.ConfigNodeProcedureEnv; |
| import org.apache.iotdb.confignode.procedure.exception.ProcedureException; |
| import org.apache.iotdb.confignode.procedure.exception.ProcedureSuspendedException; |
| import org.apache.iotdb.confignode.procedure.exception.ProcedureYieldException; |
| import org.apache.iotdb.confignode.procedure.impl.StateMachineProcedure; |
| import org.apache.iotdb.confignode.procedure.state.schema.DeactivateTemplateState; |
| import org.apache.iotdb.confignode.procedure.store.ProcedureType; |
| import org.apache.iotdb.consensus.exception.ConsensusException; |
| import org.apache.iotdb.db.schemaengine.template.Template; |
| import org.apache.iotdb.mpp.rpc.thrift.TConstructSchemaBlackListWithTemplateReq; |
| import org.apache.iotdb.mpp.rpc.thrift.TDeactivateTemplateReq; |
| import org.apache.iotdb.mpp.rpc.thrift.TDeleteDataForDeleteSchemaReq; |
| import org.apache.iotdb.mpp.rpc.thrift.TInvalidateMatchedSchemaCacheReq; |
| import org.apache.iotdb.mpp.rpc.thrift.TRollbackSchemaBlackListWithTemplateReq; |
| import org.apache.iotdb.pipe.api.exception.PipeException; |
| import org.apache.iotdb.rpc.TSStatusCode; |
| |
| import org.apache.tsfile.utils.ReadWriteIOUtils; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import java.io.ByteArrayOutputStream; |
| import java.io.DataOutputStream; |
| import java.io.IOException; |
| import java.nio.ByteBuffer; |
| import java.util.ArrayList; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Objects; |
| import java.util.Set; |
| import java.util.function.BiFunction; |
| import java.util.stream.Collectors; |
| |
| public class DeactivateTemplateProcedure |
| extends StateMachineProcedure<ConfigNodeProcedureEnv, DeactivateTemplateState> { |
| |
| private static final Logger LOGGER = LoggerFactory.getLogger(DeactivateTemplateProcedure.class); |
| |
| private String queryId; |
| private Map<PartialPath, List<Template>> templateSetInfo; |
| |
| private String requestMessage; // transient |
| // generate from templateSetInfo by concat pattern and measurement in template |
| private PathPatternTree timeSeriesPatternTree; // transient |
| private ByteBuffer timeSeriesPatternTreeBytes; // transient |
| private Map<String, List<Integer>> dataNodeRequest; // transient |
| |
| private static final String CONSENSUS_WRITE_ERROR = |
| "Failed in the write API executing the consensus layer due to: "; |
| |
| public DeactivateTemplateProcedure(boolean isGeneratedByPipe) { |
| super(isGeneratedByPipe); |
| } |
| |
| public DeactivateTemplateProcedure( |
| String queryId, Map<PartialPath, List<Template>> templateSetInfo, boolean isGeneratedByPipe) { |
| super(isGeneratedByPipe); |
| this.queryId = queryId; |
| setTemplateSetInfo(templateSetInfo); |
| } |
| |
| @Override |
| protected Flow executeFromState(ConfigNodeProcedureEnv env, DeactivateTemplateState state) |
| throws ProcedureSuspendedException, ProcedureYieldException, InterruptedException { |
| long startTime = System.currentTimeMillis(); |
| try { |
| switch (state) { |
| case CONSTRUCT_BLACK_LIST: |
| LOGGER.info("Construct schema black list with template {}", requestMessage); |
| if (constructBlackList(env) > 0) { |
| setNextState(DeactivateTemplateState.CLEAN_DATANODE_SCHEMA_CACHE); |
| break; |
| } else { |
| setFailure( |
| new ProcedureException( |
| new IoTDBException( |
| "Target Device Template is not activated on any path matched by given path pattern", |
| TSStatusCode.TEMPLATE_NOT_ACTIVATED.getStatusCode()))); |
| return Flow.NO_MORE_STATE; |
| } |
| case CLEAN_DATANODE_SCHEMA_CACHE: |
| LOGGER.info("Invalidate cache of template timeSeries {}", requestMessage); |
| invalidateCache(env); |
| break; |
| case DELETE_DATA: |
| LOGGER.info("Delete data of template timeSeries {}", requestMessage); |
| deleteData(env); |
| break; |
| case DEACTIVATE_TEMPLATE: |
| LOGGER.info("Deactivate template of {}", requestMessage); |
| deactivateTemplate(env); |
| collectPayload4Pipe(env); |
| return Flow.NO_MORE_STATE; |
| default: |
| setFailure(new ProcedureException("Unrecognized state " + state)); |
| return Flow.NO_MORE_STATE; |
| } |
| return Flow.HAS_MORE_STATE; |
| } finally { |
| LOGGER.info( |
| "DeactivateTemplate-[{}] costs {}ms", state, (System.currentTimeMillis() - startTime)); |
| } |
| } |
| |
| // return the total num of timeSeries in schema black list |
| private long constructBlackList(ConfigNodeProcedureEnv env) { |
| Map<TConsensusGroupId, TRegionReplicaSet> targetSchemaRegionGroup = |
| env.getConfigManager().getRelatedSchemaRegionGroup(timeSeriesPatternTree); |
| if (targetSchemaRegionGroup.isEmpty()) { |
| return 0; |
| } |
| List<TSStatus> successResult = new ArrayList<>(); |
| DeactivateTemplateRegionTaskExecutor<TConstructSchemaBlackListWithTemplateReq> |
| constructBlackListTask = |
| new DeactivateTemplateRegionTaskExecutor<TConstructSchemaBlackListWithTemplateReq>( |
| "construct schema black list", |
| env, |
| targetSchemaRegionGroup, |
| DataNodeRequestType.CONSTRUCT_SCHEMA_BLACK_LIST_WITH_TEMPLATE, |
| ((dataNodeLocation, consensusGroupIdList) -> |
| new TConstructSchemaBlackListWithTemplateReq( |
| consensusGroupIdList, dataNodeRequest))) { |
| @Override |
| protected List<TConsensusGroupId> processResponseOfOneDataNode( |
| TDataNodeLocation dataNodeLocation, |
| List<TConsensusGroupId> consensusGroupIdList, |
| TSStatus response) { |
| List<TConsensusGroupId> failedRegionList = new ArrayList<>(); |
| if (response.getCode() == TSStatusCode.SUCCESS_STATUS.getStatusCode()) { |
| successResult.add(response); |
| } else if (response.getCode() == TSStatusCode.MULTIPLE_ERROR.getStatusCode()) { |
| List<TSStatus> subStatusList = response.getSubStatus(); |
| for (int i = 0; i < subStatusList.size(); i++) { |
| if (subStatusList.get(i).getCode() |
| == TSStatusCode.SUCCESS_STATUS.getStatusCode()) { |
| successResult.add(subStatusList.get(i)); |
| } else { |
| failedRegionList.add(consensusGroupIdList.get(i)); |
| } |
| } |
| } else { |
| failedRegionList.addAll(consensusGroupIdList); |
| } |
| return failedRegionList; |
| } |
| }; |
| constructBlackListTask.execute(); |
| |
| if (isFailed()) { |
| return 0; |
| } |
| |
| long preDeletedNum = 0; |
| for (TSStatus resp : successResult) { |
| preDeletedNum += Long.parseLong(resp.getMessage()); |
| } |
| return preDeletedNum; |
| } |
| |
| private void invalidateCache(ConfigNodeProcedureEnv env) { |
| // if no target timeseres, return directly |
| if (!timeSeriesPatternTree.isEmpty()) { |
| Map<Integer, TDataNodeLocation> dataNodeLocationMap = |
| env.getConfigManager().getNodeManager().getRegisteredDataNodeLocations(); |
| AsyncClientHandler<TInvalidateMatchedSchemaCacheReq, TSStatus> clientHandler = |
| new AsyncClientHandler<>( |
| DataNodeRequestType.INVALIDATE_MATCHED_SCHEMA_CACHE, |
| new TInvalidateMatchedSchemaCacheReq(timeSeriesPatternTreeBytes), |
| dataNodeLocationMap); |
| AsyncDataNodeClientPool.getInstance().sendAsyncRequestToDataNodeWithRetry(clientHandler); |
| Map<Integer, TSStatus> statusMap = clientHandler.getResponseMap(); |
| for (TSStatus status : statusMap.values()) { |
| // all dataNodes must clear the related schema cache |
| if (status.getCode() != TSStatusCode.SUCCESS_STATUS.getStatusCode()) { |
| LOGGER.error( |
| "Failed to invalidate schema cache of template timeSeries {}", requestMessage); |
| setFailure( |
| new ProcedureException(new MetadataException("Invalidate schema cache failed"))); |
| return; |
| } |
| } |
| } |
| |
| setNextState(DeactivateTemplateState.DELETE_DATA); |
| } |
| |
| private void deleteData(ConfigNodeProcedureEnv env) { |
| Map<TConsensusGroupId, TRegionReplicaSet> relatedDataRegionGroup = |
| env.getConfigManager().getRelatedDataRegionGroup(timeSeriesPatternTree); |
| |
| // target timeSeries has no data or no target timeSeries, return directly |
| if (!relatedDataRegionGroup.isEmpty() && !timeSeriesPatternTree.isEmpty()) { |
| DeactivateTemplateRegionTaskExecutor<TDeleteDataForDeleteSchemaReq> deleteDataTask = |
| new DeactivateTemplateRegionTaskExecutor<>( |
| "delete data", |
| env, |
| relatedDataRegionGroup, |
| true, |
| DataNodeRequestType.DELETE_DATA_FOR_DELETE_SCHEMA, |
| ((dataNodeLocation, consensusGroupIdList) -> |
| new TDeleteDataForDeleteSchemaReq( |
| new ArrayList<>(consensusGroupIdList), timeSeriesPatternTreeBytes))); |
| deleteDataTask.execute(); |
| } |
| setNextState(DeactivateTemplateState.DEACTIVATE_TEMPLATE); |
| } |
| |
| private void deactivateTemplate(ConfigNodeProcedureEnv env) { |
| DeactivateTemplateRegionTaskExecutor<TDeactivateTemplateReq> deleteTimeSeriesTask = |
| new DeactivateTemplateRegionTaskExecutor<>( |
| "deactivate template schema", |
| env, |
| env.getConfigManager().getRelatedSchemaRegionGroup(timeSeriesPatternTree), |
| DataNodeRequestType.DEACTIVATE_TEMPLATE, |
| ((dataNodeLocation, consensusGroupIdList) -> |
| new TDeactivateTemplateReq(consensusGroupIdList, dataNodeRequest) |
| .setIsGeneratedByPipe(isGeneratedByPipe))); |
| deleteTimeSeriesTask.execute(); |
| } |
| |
| private void collectPayload4Pipe(ConfigNodeProcedureEnv env) { |
| TSStatus result; |
| try { |
| result = |
| env.getConfigManager() |
| .getConsensusManager() |
| .write( |
| isGeneratedByPipe |
| ? new PipeEnrichedPlan(new PipeDeactivateTemplatePlan(templateSetInfo)) |
| : new PipeDeactivateTemplatePlan(templateSetInfo)); |
| } catch (ConsensusException e) { |
| LOGGER.warn(CONSENSUS_WRITE_ERROR, e); |
| result = new TSStatus(TSStatusCode.EXECUTE_STATEMENT_ERROR.getStatusCode()); |
| result.setMessage(e.getMessage()); |
| } |
| if (result.getCode() != TSStatusCode.SUCCESS_STATUS.getStatusCode()) { |
| throw new PipeException(result.getMessage()); |
| } |
| } |
| |
| @Override |
| protected void rollbackState( |
| ConfigNodeProcedureEnv env, DeactivateTemplateState deactivateTemplateState) |
| throws IOException, InterruptedException, ProcedureException { |
| if (deactivateTemplateState == DeactivateTemplateState.CONSTRUCT_BLACK_LIST) { |
| DeactivateTemplateRegionTaskExecutor<TRollbackSchemaBlackListWithTemplateReq> |
| rollbackStateTask = |
| new DeactivateTemplateRegionTaskExecutor<>( |
| "roll back schema black list", |
| env, |
| env.getConfigManager().getRelatedSchemaRegionGroup(timeSeriesPatternTree), |
| DataNodeRequestType.ROLLBACK_SCHEMA_BLACK_LIST_WITH_TEMPLATE, |
| ((dataNodeLocation, consensusGroupIdList) -> |
| new TRollbackSchemaBlackListWithTemplateReq( |
| consensusGroupIdList, dataNodeRequest))); |
| rollbackStateTask.execute(); |
| } |
| } |
| |
| @Override |
| protected boolean isRollbackSupported(DeactivateTemplateState deactivateTemplateState) { |
| return true; |
| } |
| |
| @Override |
| protected DeactivateTemplateState getState(int stateId) { |
| return DeactivateTemplateState.values()[stateId]; |
| } |
| |
| @Override |
| protected int getStateId(DeactivateTemplateState deactivateTemplateState) { |
| return deactivateTemplateState.ordinal(); |
| } |
| |
| @Override |
| protected DeactivateTemplateState getInitialState() { |
| return DeactivateTemplateState.CONSTRUCT_BLACK_LIST; |
| } |
| |
| public String getQueryId() { |
| return queryId; |
| } |
| |
| public Map<PartialPath, List<Template>> getTemplateSetInfo() { |
| return templateSetInfo; |
| } |
| |
| private void setTemplateSetInfo(Map<PartialPath, List<Template>> templateSetInfo) { |
| this.templateSetInfo = templateSetInfo; |
| prepareRequestMessage(templateSetInfo); |
| prepareTimeSeriesPatternTree(templateSetInfo); |
| prepareDataNodeRequest(templateSetInfo); |
| } |
| |
| private void prepareRequestMessage(Map<PartialPath, List<Template>> templateSetInfo) { |
| StringBuilder stringBuilder = new StringBuilder(); |
| stringBuilder.append("{"); |
| for (Map.Entry<PartialPath, List<Template>> entry : templateSetInfo.entrySet()) { |
| stringBuilder |
| .append(entry.getKey()) |
| .append(":") |
| .append(entry.getValue().stream().map(Template::getName).collect(Collectors.toList())) |
| .append(";"); |
| } |
| stringBuilder.append("}"); |
| this.requestMessage = stringBuilder.toString(); |
| } |
| |
| private void prepareTimeSeriesPatternTree(Map<PartialPath, List<Template>> templateSetInfo) { |
| PathPatternTree patternTree = new PathPatternTree(); |
| for (Map.Entry<PartialPath, List<Template>> entry : templateSetInfo.entrySet()) { |
| for (Template template : entry.getValue()) { |
| for (String measurement : template.getSchemaMap().keySet()) { |
| patternTree.appendPathPattern(entry.getKey().concatNode(measurement)); |
| } |
| } |
| } |
| patternTree.constructTree(); |
| this.timeSeriesPatternTree = patternTree; |
| ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream(); |
| DataOutputStream dataOutputStream = new DataOutputStream(byteArrayOutputStream); |
| try { |
| patternTree.serialize(dataOutputStream); |
| } catch (IOException ignored) { |
| |
| } |
| this.timeSeriesPatternTreeBytes = ByteBuffer.wrap(byteArrayOutputStream.toByteArray()); |
| } |
| |
| private void prepareDataNodeRequest(Map<PartialPath, List<Template>> templateSetInfo) { |
| Map<String, List<Integer>> dataNodeRequest = new HashMap<>(); |
| templateSetInfo.forEach( |
| (k, v) -> |
| dataNodeRequest.put( |
| k.getFullPath(), v.stream().map(Template::getId).collect(Collectors.toList()))); |
| this.dataNodeRequest = dataNodeRequest; |
| } |
| |
| @Override |
| public void serialize(DataOutputStream stream) throws IOException { |
| stream.writeShort( |
| isGeneratedByPipe |
| ? ProcedureType.PIPE_ENRICHED_DEACTIVATE_TEMPLATE_PROCEDURE.getTypeCode() |
| : ProcedureType.DEACTIVATE_TEMPLATE_PROCEDURE.getTypeCode()); |
| super.serialize(stream); |
| ReadWriteIOUtils.write(queryId, stream); |
| ReadWriteIOUtils.write(templateSetInfo.size(), stream); |
| for (Map.Entry<PartialPath, List<Template>> entry : templateSetInfo.entrySet()) { |
| entry.getKey().serialize(stream); |
| ReadWriteIOUtils.write(entry.getValue().size(), stream); |
| for (Template template : entry.getValue()) { |
| template.serialize(stream); |
| } |
| } |
| } |
| |
| @Override |
| public void deserialize(ByteBuffer byteBuffer) { |
| super.deserialize(byteBuffer); |
| queryId = ReadWriteIOUtils.readString(byteBuffer); |
| int size = ReadWriteIOUtils.readInt(byteBuffer); |
| Map<PartialPath, List<Template>> templateSetInfo = new HashMap<>(); |
| for (int i = 0; i < size; i++) { |
| PartialPath pattern = (PartialPath) PathDeserializeUtil.deserialize(byteBuffer); |
| int templateNum = ReadWriteIOUtils.readInt(byteBuffer); |
| List<Template> templateList = new ArrayList<>(templateNum); |
| for (int j = 0; j < templateNum; j++) { |
| Template template = new Template(); |
| template.deserialize(byteBuffer); |
| templateList.add(template); |
| } |
| templateSetInfo.put(pattern, templateList); |
| } |
| setTemplateSetInfo(templateSetInfo); |
| } |
| |
| @Override |
| public boolean equals(Object o) { |
| if (this == o) return true; |
| if (o == null || getClass() != o.getClass()) return false; |
| DeactivateTemplateProcedure that = (DeactivateTemplateProcedure) o; |
| return Objects.equals(getProcId(), that.getProcId()) |
| && Objects.equals(getCurrentState(), that.getCurrentState()) |
| && Objects.equals(getCycles(), that.getCycles()) |
| && Objects.equals(isGeneratedByPipe, that.isGeneratedByPipe) |
| && Objects.equals(queryId, that.queryId) |
| && Objects.equals(templateSetInfo, that.templateSetInfo); |
| } |
| |
| @Override |
| public int hashCode() { |
| return Objects.hash( |
| getProcId(), getCurrentState(), getCycles(), isGeneratedByPipe, queryId, templateSetInfo); |
| } |
| |
| private class DeactivateTemplateRegionTaskExecutor<Q> |
| extends DataNodeRegionTaskExecutor<Q, TSStatus> { |
| |
| private final String taskName; |
| |
| DeactivateTemplateRegionTaskExecutor( |
| String taskName, |
| ConfigNodeProcedureEnv env, |
| Map<TConsensusGroupId, TRegionReplicaSet> targetSchemaRegionGroup, |
| DataNodeRequestType dataNodeRequestType, |
| BiFunction<TDataNodeLocation, List<TConsensusGroupId>, Q> dataNodeRequestGenerator) { |
| super(env, targetSchemaRegionGroup, false, dataNodeRequestType, dataNodeRequestGenerator); |
| this.taskName = taskName; |
| } |
| |
| DeactivateTemplateRegionTaskExecutor( |
| String taskName, |
| ConfigNodeProcedureEnv env, |
| Map<TConsensusGroupId, TRegionReplicaSet> targetSchemaRegionGroup, |
| boolean executeOnAllReplicaset, |
| DataNodeRequestType dataNodeRequestType, |
| BiFunction<TDataNodeLocation, List<TConsensusGroupId>, Q> dataNodeRequestGenerator) { |
| super( |
| env, |
| targetSchemaRegionGroup, |
| executeOnAllReplicaset, |
| dataNodeRequestType, |
| dataNodeRequestGenerator); |
| this.taskName = taskName; |
| } |
| |
| @Override |
| protected List<TConsensusGroupId> processResponseOfOneDataNode( |
| TDataNodeLocation dataNodeLocation, |
| List<TConsensusGroupId> consensusGroupIdList, |
| TSStatus response) { |
| List<TConsensusGroupId> failedRegionList = new ArrayList<>(); |
| if (response.getCode() == TSStatusCode.SUCCESS_STATUS.getStatusCode()) { |
| return failedRegionList; |
| } |
| |
| if (response.getCode() == TSStatusCode.MULTIPLE_ERROR.getStatusCode()) { |
| List<TSStatus> subStatus = response.getSubStatus(); |
| for (int i = 0; i < subStatus.size(); i++) { |
| if (subStatus.get(i).getCode() != TSStatusCode.SUCCESS_STATUS.getStatusCode()) { |
| failedRegionList.add(consensusGroupIdList.get(i)); |
| } |
| } |
| } else { |
| failedRegionList.addAll(consensusGroupIdList); |
| } |
| return failedRegionList; |
| } |
| |
| @Override |
| protected void onAllReplicasetFailure( |
| TConsensusGroupId consensusGroupId, Set<TDataNodeLocation> dataNodeLocationSet) { |
| setFailure( |
| new ProcedureException( |
| new MetadataException( |
| String.format( |
| "Deactivate template of %s failed when [%s] because all replicaset of schemaRegion %s failed. %s", |
| requestMessage, taskName, consensusGroupId.id, dataNodeLocationSet)))); |
| interruptTask(); |
| } |
| } |
| } |
