Skip to content
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

Fix Field Migration #168

Merged
merged 2 commits into from
Nov 13, 2023
Merged

Fix Field Migration #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa8a445
Fix #162
shedaniel Nov 12, 2023
3448898
Refactor some field migrator code
shedaniel Nov 12, 2023
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
98 changes: 42 additions & 56 deletions ...va/net/fabricmc/loom/configuration/providers/forge/FieldMigratedMappingConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@

import java.io.BufferedReader;
import java.io.IOException;
import java.io.StringWriter;
import java.io.UncheckedIOException;
import java.io.Writer;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardOpenOption;
Expand All @@ -44,7 +44,6 @@
import com.google.common.collect.Table;
import com.google.common.reflect.TypeToken;
import com.google.gson.Gson;
import dev.architectury.refmapremapper.utils.DescriptorRemapper;
import org.gradle.api.Project;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassVisitor;
Expand All @@ -58,7 +57,6 @@
import net.fabricmc.loom.util.FileSystemUtil;
import net.fabricmc.loom.util.ThreadingUtils;
import net.fabricmc.loom.util.service.SharedServiceManager;
import net.fabricmc.loom.util.srg.SrgMerger;
import net.fabricmc.mappingio.MappingReader;
import net.fabricmc.mappingio.format.Tiny2Writer;
import net.fabricmc.mappingio.tree.MappingTree;
Expand Down Expand Up @@ -110,14 +108,6 @@ protected void manipulateMappings(Project project, Path mappingsJar) throws IOEx
this.rawTinyMappings = tinyMappings;
this.rawTinyMappingsWithSrg = tinyMappingsWithSrg;

if (extension.shouldGenerateSrgTiny()) {
if (Files.notExists(rawTinyMappingsWithSrg) || extension.refreshDeps()) {
// Merge tiny mappings with srg
SrgMerger.ExtraMappings extraMappings = SrgMerger.ExtraMappings.ofMojmapTsrg(getMojmapSrgFileIfPossible(project));
SrgMerger.mergeSrg(getRawSrgFile(project), rawTinyMappings, rawTinyMappingsWithSrg, extraMappings, true);
}
}

tinyMappings = mappingsWorkingDir().resolve("mappings-field-migrated.tiny");
tinyMappingsWithSrg = mappingsWorkingDir().resolve("mappings-srg-field-migrated.tiny");

Expand All @@ -132,50 +122,58 @@ protected void manipulateMappings(Project project, Path mappingsJar) throws IOEx

public void updateFieldMigration(Project project) throws IOException {
if (!Files.exists(migratedFieldsCache)) {
generateNewFieldMigration(project);
migratedFields.clear();
migratedFields.addAll(generateNewFieldMigration(project, MinecraftPatchedProvider.get(project).getMinecraftPatchedSrgJar(), MappingsNamespace.SRG.toString(), rawTinyMappingsWithSrg).entrySet());
Map<String, String> map = new HashMap<>();
migratedFields.forEach(entry -> {
map.put(entry.getKey().owner + "#" + entry.getKey().field, entry.getValue());
});
Files.writeString(migratedFieldsCache, new Gson().toJson(map));
Files.deleteIfExists(tinyMappings);
Files.deleteIfExists(tinyMappingsWithSrg);
}

if (!Files.exists(tinyMappings)) {
if (Files.notExists(tinyMappings) || Files.notExists(tinyMappingsWithSrg)) {
Table<String, String, String> fieldDescriptorMap = HashBasedTable.create();

for (Map.Entry<FieldMember, String> entry : migratedFields) {
fieldDescriptorMap.put(entry.getKey().owner, entry.getKey().field, entry.getValue());
}

MemoryMappingTree mappings = new MemoryMappingTree();
injectMigration(project, fieldDescriptorMap, rawTinyMappings, tinyMappings);
injectMigration(project, fieldDescriptorMap, rawTinyMappingsWithSrg, tinyMappingsWithSrg);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, it makes applying the same thing to the Mojang-merged mappings much easier too

}
}

try (BufferedReader reader = Files.newBufferedReader(rawTinyMappings)) {
MappingReader.read(reader, mappings);
private static void injectMigration(Project project, Table<String, String, String> fieldDescriptorMap, Path source, Path out) throws IOException {
MemoryMappingTree mappings = new MemoryMappingTree();

for (MappingTree.ClassMapping classDef : new ArrayList<>(mappings.getClasses())) {
Map<String, String> row = fieldDescriptorMap.row(classDef.getName(MappingsNamespace.INTERMEDIARY.toString()));
try (BufferedReader reader = Files.newBufferedReader(source)) {
MappingReader.read(reader, mappings);
}

for (MappingTree.ClassMapping classDef : new ArrayList<>(mappings.getClasses())) {
Map<String, String> row = fieldDescriptorMap.row(classDef.getName(MappingsNamespace.INTERMEDIARY.toString()));

if (!row.isEmpty()) {
for (MappingTree.FieldMapping fieldDef : new ArrayList<>(classDef.getFields())) {
String newDescriptor = row.get(fieldDef.getName(MappingsNamespace.INTERMEDIARY.toString()));
if (!row.isEmpty()) {
for (MappingTree.FieldMapping fieldDef : new ArrayList<>(classDef.getFields())) {
String newDescriptor = row.get(fieldDef.getName(MappingsNamespace.INTERMEDIARY.toString()));

if (newDescriptor != null) {
fieldDef.setSrcDesc(mappings.mapDesc(newDescriptor, mappings.getNamespaceId(MappingsNamespace.INTERMEDIARY.toString()), MappingTreeView.SRC_NAMESPACE_ID));
}
}
if (newDescriptor != null) {
String prev = fieldDef.getDesc(MappingsNamespace.INTERMEDIARY.toString());
fieldDef.setSrcDesc(mappings.mapDesc(newDescriptor, mappings.getNamespaceId(MappingsNamespace.INTERMEDIARY.toString()), MappingTreeView.SRC_NAMESPACE_ID));
project.getLogger().info("Migrated field descriptor of field {}#{} from {} to {}", classDef.getName(MappingsNamespace.INTERMEDIARY.toString()), fieldDef.getName(MappingsNamespace.INTERMEDIARY.toString()), prev, newDescriptor);
}
}
}
}

StringWriter stringWriter = new StringWriter();
Tiny2Writer tiny2Writer = new Tiny2Writer(stringWriter, false);
mappings.accept(tiny2Writer);
Files.writeString(tinyMappings, stringWriter.toString(), StandardOpenOption.CREATE);
try (Writer writer = Files.newBufferedWriter(out, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING)) {
mappings.accept(new Tiny2Writer(writer, false));
}
}

private void generateNewFieldMigration(Project project) throws IOException {
private static Map<FieldMember, String> generateNewFieldMigration(Project project, Path patchedJar, String patchedJarNamespace, Path mappingsPath) throws IOException {
Map<FieldMember, String> fieldDescriptorMap = new ConcurrentHashMap<>();
LoomGradleExtension extension = LoomGradleExtension.get(project);
ThreadingUtils.TaskCompleter completer = ThreadingUtils.taskCompleter();
Expand All @@ -200,8 +198,7 @@ public FieldVisitor visitField(int access, String name, String descriptor, Strin
}

Visitor visitor = new Visitor(Opcodes.ASM9);
Path patchedSrgJar = MinecraftPatchedProvider.get(project).getMinecraftPatchedSrgJar();
FileSystemUtil.Delegate system = FileSystemUtil.getJarFileSystem(patchedSrgJar, false);
FileSystemUtil.Delegate system = FileSystemUtil.getJarFileSystem(patchedJar, false);
completer.onComplete(value -> system.close());

for (Path fsPath : (Iterable<? extends Path>) Files.walk(system.get().getPath("/"))::iterator) {
Expand All @@ -216,40 +213,29 @@ public FieldVisitor visitField(int access, String name, String descriptor, Strin
completer.complete();
Map<FieldMember, String> migratedFields = new HashMap<>();

try (BufferedReader reader = Files.newBufferedReader(rawTinyMappingsWithSrg)) {
try (BufferedReader reader = Files.newBufferedReader(mappingsPath)) {
MemoryMappingTree mappings = new MemoryMappingTree();
MappingReader.read(reader, mappings);
Map<String, String> srgToIntermediary = new HashMap<>();

for (MappingTree.ClassMapping aClass : mappings.getClasses()) {
srgToIntermediary.put(aClass.getName("srg"), aClass.getName("intermediary"));
}

for (MappingTree.ClassMapping classDef : mappings.getClasses()) {
String ownerSrg = classDef.getName("srg");
String ownerIntermediary = classDef.getName("intermediary");

for (MappingTree.FieldMapping fieldDef : classDef.getFields()) {
String fieldSrg = fieldDef.getName("srg");
String descriptorSrg = fieldDef.getDesc("srg");

FieldMember member = new FieldMember(ownerSrg, fieldSrg);
String newDescriptor = fieldDescriptorMap.get(member);

if (newDescriptor != null && !newDescriptor.equals(descriptorSrg)) {
String fieldIntermediary = fieldDef.getName("intermediary");
String descriptorIntermediary = fieldDef.getDesc("intermediary");
String newDescriptorRemapped = DescriptorRemapper.remapDescriptor(newDescriptor,
clazz -> srgToIntermediary.getOrDefault(clazz, clazz));
migratedFields.put(new FieldMember(ownerIntermediary, fieldIntermediary), newDescriptorRemapped);
project.getLogger().info(ownerIntermediary + "#" + fieldIntermediary + ": " + descriptorIntermediary + " -> " + newDescriptorRemapped);
String newDescriptor = fieldDescriptorMap.get(new FieldMember(classDef.getName(patchedJarNamespace), fieldDef.getName(patchedJarNamespace)));
String existingDescriptor = fieldDef.getDesc(patchedJarNamespace);

if (newDescriptor != null && !newDescriptor.equals(existingDescriptor)) {
String ownerIntermediary = classDef.getName(MappingsNamespace.INTERMEDIARY.toString());
String fieldIntermediary = fieldDef.getName(MappingsNamespace.INTERMEDIARY.toString());
String descriptorIntermediary = fieldDef.getDesc(MappingsNamespace.INTERMEDIARY.toString());
String newDescriptorIntermediary = mappings.mapDesc(newDescriptor, mappings.getNamespaceId(patchedJarNamespace),
mappings.getNamespaceId(MappingsNamespace.INTERMEDIARY.toString()));
migratedFields.put(new FieldMember(ownerIntermediary, fieldIntermediary), newDescriptorIntermediary);
project.getLogger().info("Found migration of " + ownerIntermediary + "#" + fieldIntermediary + ": " + descriptorIntermediary + " -> " + newDescriptorIntermediary);
}
}
}
}

this.migratedFields.clear();
this.migratedFields.addAll(migratedFields.entrySet());
return migratedFields;
}

public static class FieldMember {
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/net/fabricmc/loom/configuration/providers/mappings/MappingConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,6 @@ protected void setup(Project project, SharedServiceManager serviceManager, Minec

public void setupPost(Project project) throws IOException {
LoomGradleExtension extension = LoomGradleExtension.get(project);
manipulateMappings(project, tinyMappingsJar);

if (extension.shouldGenerateSrgTiny()) {
if (Files.notExists(tinyMappingsWithSrg) || extension.refreshDeps()) {
Expand All @@ -206,6 +205,8 @@ public void setupPost(Project project) throws IOException {
project.getLogger().info(":merged srg mappings in " + stopwatch.stop());
}
}

manipulateMappings(project, tinyMappingsJar);
}

public void applyToProject(Project project, DependencyInfo dependency) throws IOException {
Expand Down
Loading