Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
8260976: investigate ways to filter jextract output
Reviewed-by: jvernee
- Loading branch information
1 parent
94b76fd
commit 04160de
Showing
8 changed files
with
396 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 0 additions & 54 deletions
54
src/jdk.incubator.jextract/share/classes/jdk/internal/jextract/impl/Filter.java
This file was deleted.
Oops, something went wrong.
164 changes: 164 additions & 0 deletions
164
src/jdk.incubator.jextract/share/classes/jdk/internal/jextract/impl/IncludeHelper.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| /* | ||
| * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved. | ||
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | ||
| * | ||
| * This code is free software; you can redistribute it and/or modify it | ||
| * under the terms of the GNU General Public License version 2 only, as | ||
| * published by the Free Software Foundation. Oracle designates this | ||
| * particular file as subject to the "Classpath" exception as provided | ||
| * by Oracle in the LICENSE file that accompanied this code. | ||
| * | ||
| * This code is distributed in the hope that it will be useful, but WITHOUT | ||
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | ||
| * version 2 for more details (a copy is included in the LICENSE file that | ||
| * accompanied this code). | ||
| * | ||
| * You should have received a copy of the GNU General Public License version | ||
| * 2 along with this work; if not, write to the Free Software Foundation, | ||
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | ||
| * | ||
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | ||
| * or visit www.oracle.com if you need additional information or have any | ||
| * questions. | ||
| */ | ||
|
|
||
| package jdk.internal.jextract.impl; | ||
|
|
||
| import jdk.incubator.jextract.Declaration; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.UncheckedIOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.StandardOpenOption; | ||
| import java.util.Comparator; | ||
| import java.util.EnumMap; | ||
| import java.util.HashMap; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.TreeMap; | ||
| import java.util.TreeSet; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| public class IncludeHelper { | ||
|
|
||
| public enum IncludeKind { | ||
| MACRO, | ||
| VAR, | ||
| FUNCTION, | ||
| TYPEDEF, | ||
| STRUCT, | ||
| UNION; | ||
|
|
||
| public String optionName() { | ||
| return "include-" + name().toLowerCase(); | ||
| } | ||
|
|
||
| static IncludeKind fromDeclaration(Declaration d) { | ||
| if (d instanceof Declaration.Constant) { | ||
| return MACRO; | ||
| } else if (d instanceof Declaration.Variable) { | ||
| return VAR; | ||
| } else if (d instanceof Declaration.Function) { | ||
| return FUNCTION; | ||
| } else if (d instanceof Declaration.Typedef) { | ||
| return TYPEDEF; | ||
| } else if (d instanceof Declaration.Scoped scoped) { | ||
| return fromScoped(scoped); | ||
| } else { | ||
| throw new IllegalStateException("Cannot get here!"); | ||
| } | ||
| } | ||
|
|
||
| static IncludeKind fromScoped(Declaration.Scoped scoped) { | ||
| return switch (scoped.kind()) { | ||
| case STRUCT -> IncludeKind.STRUCT; | ||
| case UNION -> IncludeKind.UNION; | ||
| default -> throw new IllegalStateException("Cannot get here!"); | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| private final EnumMap<IncludeKind, Set<String>> includesSymbolNamesByKind = new EnumMap<>(IncludeKind.class); | ||
| private final Set<Declaration> usedDeclarations = new HashSet<>(); | ||
| public String dumpIncludesFile; | ||
|
|
||
| public void addSymbol(IncludeKind kind, String symbolName) { | ||
| Set<String> names = includesSymbolNamesByKind.computeIfAbsent(kind, (_unused) -> new HashSet<>()); | ||
| names.add(symbolName); | ||
| } | ||
|
|
||
| public boolean isIncluded(Declaration.Variable variable) { | ||
| return checkIncludedAndAddIfNeeded(IncludeKind.VAR, variable); | ||
| } | ||
|
|
||
| public boolean isIncluded(Declaration.Function function) { | ||
| return checkIncludedAndAddIfNeeded(IncludeKind.FUNCTION, function); | ||
| } | ||
|
|
||
| public boolean isIncluded(Declaration.Constant constant) { | ||
| return checkIncludedAndAddIfNeeded(IncludeKind.MACRO, constant); | ||
| } | ||
|
|
||
| public boolean isIncluded(Declaration.Typedef typedef) { | ||
| return checkIncludedAndAddIfNeeded(IncludeKind.TYPEDEF, typedef); | ||
| } | ||
|
|
||
| public boolean isIncluded(Declaration.Scoped scoped) { | ||
| return checkIncludedAndAddIfNeeded(IncludeKind.fromScoped(scoped), scoped); | ||
| } | ||
|
|
||
| private boolean checkIncludedAndAddIfNeeded(IncludeKind kind, Declaration declaration) { | ||
| boolean included = isIncludedInternal(kind, declaration); | ||
| if (included && dumpIncludesFile != null) { | ||
| usedDeclarations.add(declaration); | ||
| } | ||
| return included; | ||
| } | ||
|
|
||
| private boolean isIncludedInternal(IncludeKind kind, Declaration declaration) { | ||
| if (!isEnabled()) { | ||
| return true; | ||
| } else { | ||
| Set<String> names = includesSymbolNamesByKind.computeIfAbsent(kind, (_unused) -> new HashSet<>()); | ||
| return names.contains(declaration.name()); | ||
| } | ||
| } | ||
|
|
||
| public boolean isEnabled() { | ||
| return includesSymbolNamesByKind.size() > 0; | ||
| } | ||
|
|
||
| public void dumpIncludes() { | ||
| try (var writer = Files.newBufferedWriter(Path.of(dumpIncludesFile), StandardOpenOption.CREATE)) { | ||
| Map<Path, Set<Declaration>> declsByPath = usedDeclarations.stream() | ||
| .collect(Collectors.groupingBy(d -> d.pos().path(), | ||
| () -> new TreeMap<>(Path::compareTo), | ||
| Collectors.toCollection(() -> new TreeSet<>(Comparator.comparing(Declaration::name))))); | ||
| String lineSep = ""; | ||
| for (Map.Entry<Path, Set<Declaration>> pathEntries : declsByPath.entrySet()) { | ||
| writer.append(lineSep); | ||
| writer.append("#### Extracted from: " + pathEntries.getKey().toString() + "\n\n"); | ||
| Map<IncludeKind, List<Declaration>> declsByKind = pathEntries.getValue().stream() | ||
| .collect(Collectors.groupingBy(IncludeKind::fromDeclaration)); | ||
| int maxLengthOptionCol = pathEntries.getValue().stream().mapToInt(d -> d.name().length()).max().getAsInt(); | ||
| maxLengthOptionCol += 2; // -- | ||
| maxLengthOptionCol += IncludeKind.FUNCTION.optionName().length(); // max option name | ||
| maxLengthOptionCol += 1; // space | ||
| for (Map.Entry<IncludeKind, List<Declaration>> kindEntries : declsByKind.entrySet()) { | ||
| for (Declaration d : kindEntries.getValue()) { | ||
| writer.append(String.format("%-" + maxLengthOptionCol + "s %s", | ||
| "--" + kindEntries.getKey().optionName() + " " + d.name(), | ||
| "# header: " + pathEntries.getKey() + "\n")); | ||
| } | ||
| } | ||
| lineSep = "\n"; | ||
| } | ||
| } catch (IOException exception) { | ||
| throw new UncheckedIOException(exception); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.