Skip to content

Move the addition of reflection log classes to Options.postProcess #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jjppp wants to merge 1 commit into from
Closed

Move the addition of reflection log classes to Options.postProcess #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions src/main/java/pascal/taie/Main.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public static void main(String... args) {
logger.info("No analyses are specified");
System.exit(0);
}
buildWorld(options, plan.analyses());
buildWorld(options);
executePlan(plan);
}, "Tai-e");
LoggerConfigs.reconfigure();
Expand Down Expand Up @@ -117,12 +117,11 @@ private static Plan processConfigs(Options options) {
public static void buildWorld(String... args) {
Options options = Options.parse(args);
LoggerConfigs.setOutput(options.getOutputDir());
Plan plan = processConfigs(options);
buildWorld(options, plan.analyses());
buildWorld(options);
LoggerConfigs.reconfigure();
}

private static void buildWorld(Options options, List<AnalysisConfig> analyses) {
private static void buildWorld(Options options) {
Monitor.runAndCount(() -> {
try {
Class<? extends WorldBuilder> builderClass = options.getWorldBuilderClass();
Expand All @@ -131,7 +130,7 @@ private static void buildWorld(Options options, List<AnalysisConfig> analyses) {
if (options.isWorldCacheMode()) {
builder = new CachedWorldBuilder(builder);
}
builder.build(options, analyses);
builder.build(options);
logger.info("{} classes with {} methods in the world",
World.get()
.getClassHierarchy()
Expand All @@ -143,7 +142,7 @@ private static void buildWorld(Options options, List<AnalysisConfig> analyses) {
.mapToInt(c -> c.getDeclaredMethods().size())
.sum());
} catch (InstantiationException | IllegalAccessException |
NoSuchMethodException | InvocationTargetException e) {
NoSuchMethodException | InvocationTargetException e) {
System.err.println("Failed to build world due to " + e);
System.exit(1);
}
Expand Down
9 changes: 2 additions & 7 deletions src/main/java/pascal/taie/WorldBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,8 @@

package pascal.taie;

import pascal.taie.config.AnalysisConfig;
import pascal.taie.config.Options;

import java.util.List;

/**
* Interface for {@link World} builder.
*/
Expand All @@ -35,10 +32,8 @@ public interface WorldBuilder {
/**
* Builds a new instance of {@link World} and make it globally accessible
* through static methods of {@link World}.
* TODO: remove {@code analyses}.
*
* @param options the options
* @param analyses the analyses to be executed
* @param options the options
*/
void build(Options options, List<AnalysisConfig> analyses);
void build(Options options);
}
82 changes: 79 additions & 3 deletions src/main/java/pascal/taie/config/Options.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
Expand All @@ -37,6 +39,9 @@
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import pascal.taie.WorldBuilder;
import pascal.taie.analysis.pta.PointerAnalysis;
import pascal.taie.analysis.pta.plugin.reflection.LogItem;
import pascal.taie.language.classes.StringReps;
import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
Expand All @@ -48,10 +53,12 @@
import java.time.Instant;
import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.StringJoiner;
import java.util.function.Predicate;

/**
Expand Down Expand Up @@ -261,9 +268,9 @@ public File getPlanFile() {
description = "Analyses to be executed",
paramLabel = "<analysisID[=<options>]>",
mapFallbackValue = "")
private Map<String, String> analyses = Map.of();
private Map<String, AnalysisOptions> analyses = Map.of();

public Map<String, String> getAnalyses() {
public Map<String, AnalysisOptions> getAnalyses() {
return analyses;
}

Expand Down Expand Up @@ -293,7 +300,9 @@ public Set<String> getKeepResult() {
* Parses arguments and return the parsed and post-processed Options.
*/
public static Options parse(String... args) {
Options options = CommandLine.populateCommand(new Options(), args);
CommandLine commandLine = new CommandLine(new Options())
.registerConverter(AnalysisOptions.class, new AnalysisOptionsConverter());
Options options = (Options) commandLine.parseArgs(args).commandSpec().userObject();
return postProcess(options);
}

Expand Down Expand Up @@ -328,6 +337,7 @@ private static Options postProcess(Options options) {
"at least one of --main-class, --input-classes " +
"or --app-class-path should be specified");
}
options.addReflectionLogClasses();
// mkdir for output dir
if (!options.outputDir.exists()) {
options.outputDir.mkdirs();
Expand Down Expand Up @@ -499,6 +509,72 @@ private static String toSerializedFilePath(String file) {
.replace('\\', '/');
}

private static class AnalysisOptionsConverter implements CommandLine.ITypeConverter<AnalysisOptions> {
@Override
public AnalysisOptions convert(String value) {
ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
JavaType mapType = mapper.getTypeFactory()
.constructMapType(Map.class, String.class, Object.class);
String optStr = toYAMLString(value);
try {
Map<String, Object> optsMap = optStr.isBlank()
? Map.of()
// Leverage Jackson to parse YAML string to Map
: mapper.readValue(optStr, mapType);
return new AnalysisOptions(optsMap);
} catch (JsonProcessingException e) {
throw new ConfigException("Invalid analysis options: " + value, e);
}
}

/**
* Converts option string to a valid YAML string.
* The option string is of format "key1:value1;key2:value2;...".
*/
private static String toYAMLString(String optValue) {
StringJoiner joiner = new StringJoiner("\n");
for (String keyValue : optValue.split(";")) {
if (!keyValue.isBlank()) {
int i = keyValue.indexOf(':'); // split keyValue
joiner.add(keyValue.substring(0, i) + ": "
+ keyValue.substring(i + 1));
}
}
return joiner.toString();
}
}

/**
* Add classes in reflection log to the input classes.
* <p>
* TODO: this is still a tentative solution.
*/
private void addReflectionLogClasses() {
List<String> inputClasses = new ArrayList<>(this.inputClasses);
AnalysisOptions analysisOptions = analyses.get(PointerAnalysis.ID);
if (analysisOptions == null || !analysisOptions.has("reflection-log")) {
return;
}
String path = analysisOptions.getString("reflection-log");
if (path != null) {
LogItem.load(path).forEach(item -> {
// add target class
String target = item.target;
String targetClass;
if (target.startsWith("<")) {
targetClass = StringReps.getClassNameOf(target);
} else {
targetClass = target;
}
if (StringReps.isArrayType(targetClass)) {
targetClass = StringReps.getBaseTypeNameOf(target);
}
inputClasses.add(targetClass);
});
}
this.inputClasses = List.copyOf(inputClasses);
}

@Override
public String toString() {
return "Options{" +
Expand Down
39 changes: 2 additions & 37 deletions src/main/java/pascal/taie/config/PlanConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
Expand All @@ -35,9 +34,7 @@
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.StringJoiner;

/**
* Configuration for an analysis to be executed.
Expand Down Expand Up @@ -108,48 +105,16 @@ public static List<PlanConfig> readConfigs(File file) {
* Reads a list of PlanConfig from options.
*/
public static List<PlanConfig> readConfigs(Options options) {
ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
JavaType mapType = mapper.getTypeFactory()
.constructMapType(Map.class, String.class, Object.class);
return options.getAnalyses().entrySet()
.stream()
.map(entry -> {
String id = entry.getKey();
String optStr = toYAMLString(entry.getValue());
try {
Map<String, Object> optsMap = optStr.isBlank()
? Map.of()
// Leverage Jackson to parse YAML string to Map
: mapper.readValue(optStr, mapType);
return new PlanConfig(id, new AnalysisOptions(optsMap));
} catch (JsonProcessingException e) {
throw new ConfigException("Invalid analysis options: " +
entry.getKey() + ":" + entry.getValue(), e);
}
AnalysisOptions analysisOptions = entry.getValue();
return new PlanConfig(id, analysisOptions);
})
.toList();
}

/**
* Converts option string to a valid YAML string.
* The option string is of format "key1:value1;key2:value2;...".
*/
private static String toYAMLString(String optValue) {
StringJoiner joiner = new StringJoiner("\n");
for (String keyValue : optValue.split(";")) {
if (!keyValue.isBlank()) {
int i = keyValue.indexOf(':'); // split keyValue
if (i == -1) {
throw new IllegalArgumentException("Invalid argument format '" + keyValue
+ "'. Expected format: 'key:value'");
}
joiner.add(keyValue.substring(0, i) + ": "
+ keyValue.substring(i + 1));
}
}
return joiner.toString();
}

/**
* Writes a list of PlanConfigs to given file.
*/
Expand Down
22 changes: 6 additions & 16 deletions src/main/java/pascal/taie/frontend/cache/CachedWorldBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import org.apache.logging.log4j.Logger;
import pascal.taie.World;
import pascal.taie.WorldBuilder;
import pascal.taie.config.AnalysisConfig;
import pascal.taie.config.Options;
import pascal.taie.util.Monitor;

Expand Down Expand Up @@ -69,12 +68,12 @@ public CachedWorldBuilder(WorldBuilder delegate) {
}

@Override
public void build(Options options, List<AnalysisConfig> analyses) {
public void build(Options options) {
File worldCacheFile = getWorldCacheFile(options);
if (loadCache(options, worldCacheFile)) {
return;
}
runWorldBuilder(options, analyses);
runWorldBuilder(options);
saveCache(worldCacheFile);
}

Expand All @@ -86,10 +85,8 @@ private boolean loadCache(Options options, File worldCacheFile) {
logger.info("Loading the world cache from {}", worldCacheFile);
Monitor monitor = new Monitor("Load the world cache");
monitor.start();
ObjectInputStream ois = null;
try {
ois = new ObjectInputStream(
new BufferedInputStream(new FileInputStream(worldCacheFile)));
try (ObjectInputStream ois = new ObjectInputStream(
new BufferedInputStream(new FileInputStream(worldCacheFile)))) {
World world = (World) ois.readObject();
World.set(world);
world.setOptions(options);
Expand All @@ -98,24 +95,17 @@ private boolean loadCache(Options options, File worldCacheFile) {
logger.error("Failed to load world cache from {} due to {}",
worldCacheFile, e);
} finally {
if (ois != null) {
try {
ois.close();
} catch (Exception e) {
logger.error("Failed to close input stream", e);
}
}
monitor.stop();
logger.info(monitor);
}
return false;
}

private void runWorldBuilder(Options options, List<AnalysisConfig> analyses) {
private void runWorldBuilder(Options options) {
logger.info("Running the WorldBuilder ...");
Monitor monitor = new Monitor("Run the WorldBuilder");
monitor.start();
delegate.build(options, analyses);
delegate.build(options);
monitor.stop();
logger.info(monitor);
}
Expand Down
Loading