| /* |
| * 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.jackrabbit.oak.segment.tool.iotrace; |
| |
| import static com.google.common.base.Preconditions.checkArgument; |
| import static java.lang.String.valueOf; |
| import static org.apache.jackrabbit.oak.commons.PathUtils.concat; |
| import static org.apache.jackrabbit.oak.commons.PathUtils.elements; |
| |
| import java.io.Writer; |
| import java.util.List; |
| import java.util.concurrent.atomic.AtomicInteger; |
| import java.util.function.Consumer; |
| import java.util.function.Function; |
| |
| import com.google.common.collect.ImmutableList; |
| import org.apache.jackrabbit.oak.spi.state.NodeState; |
| import org.jetbrains.annotations.NotNull; |
| |
| /** |
| * A depth first traversal trace. |
| * <p> |
| * When {@link Trace#run(NodeState) run} this trace performs a depth first traversal starting |
| * from the passed node down to a certain depth. It logs the current depth, the number of traversed |
| * nodes and the current path as additional {@link IOTracer#setContext(List) context}. |
| */ |
| public class DepthFirstTrace implements Trace { |
| |
| /** |
| * The context specification of this trace. |
| * @see IOTracer#newIOTracer(Function, Writer, String) |
| */ |
| @NotNull |
| public static final String CONTEXT_SPEC = "depth,count,path"; |
| |
| private final int depth; |
| |
| @NotNull |
| private final String path; |
| |
| @NotNull |
| private final Consumer<List<String>> context; |
| |
| @NotNull |
| private final AtomicInteger nodeCount = new AtomicInteger(); |
| |
| /** |
| * Create a new instance of a depth first traversal trace. |
| * @param depth maximal depth of the nodes to traverse |
| * @param path path of the root node where to start traversing |
| * @param context consumer to pass the additional context to |
| */ |
| public DepthFirstTrace(int depth, @NotNull String path, @NotNull Consumer<List<String>> context) { |
| checkArgument(depth >= 0); |
| |
| this.depth = depth; |
| this.path = path; |
| this.context = context; |
| } |
| |
| @Override |
| public void run(@NotNull NodeState node) { |
| traverse(getNode(node, path), 0, path); |
| } |
| |
| @NotNull |
| private static NodeState getNode(@NotNull NodeState root, @NotNull String path) { |
| NodeState node = root; |
| for (String name : elements(path)) { |
| node = node.getChildNode(name); |
| } |
| return node; |
| } |
| |
| private void traverse(NodeState node, int depth, @NotNull String path) { |
| updateContext(context, depth, nodeCount.incrementAndGet(), path); |
| if (depth < this.depth) { |
| node.getChildNodeEntries().forEach(cse -> { |
| String childPath = concat(path, cse.getName()); |
| traverse(cse.getNodeState(), depth + 1, childPath); |
| }); |
| } |
| } |
| |
| private static void updateContext( |
| @NotNull Consumer<List<String>> context, int depth, int count, @NotNull String path) { |
| context.accept(ImmutableList.of(valueOf(depth), valueOf(count), path)); |
| } |
| |
| } |