Skip to content

Commit

Permalink
[Truffle] Use simpler primitives to build the encoding map and move m…
Browse files Browse the repository at this point in the history 
…ost of it to Ruby.
@eregon
eregon committed Jul 5, 2016
1 parent 45885c9 commit 2e5aa26
Showing 2 changed files with 63 additions and 87 deletions.
119 changes: 37 additions & 82 deletions truffle/src/main/java/org/jruby/truffle/core/encoding/EncodingNodes.java
View file
Original file line number Diff line number Diff line change
@@ -11,6 +11,7 @@
*/
package org.jruby.truffle.core.encoding;

import com.oracle.truffle.api.CompilerAsserts;
import com.oracle.truffle.api.CompilerDirectives;
import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
import com.oracle.truffle.api.dsl.Cached;
@@ -23,11 +24,11 @@
import com.oracle.truffle.api.source.SourceSection;
import org.jcodings.Encoding;
import org.jcodings.EncodingDB;
import org.jcodings.specific.ASCIIEncoding;
import org.jcodings.EncodingDB.Entry;
import org.jcodings.specific.USASCIIEncoding;
import org.jcodings.specific.UTF8Encoding;
import org.jcodings.util.CaseInsensitiveBytesHash;
import org.jcodings.util.Hash;
import org.jcodings.util.CaseInsensitiveBytesHash.CaseInsensitiveBytesHashEntry;
import org.jcodings.util.Hash.HashEntry;
import org.jruby.runtime.Visibility;
import org.jruby.truffle.Layouts;
import org.jruby.truffle.RubyContext;
import org.jruby.truffle.builtins.CoreClass;
@@ -37,18 +38,16 @@
import org.jruby.truffle.builtins.Primitive;
import org.jruby.truffle.builtins.PrimitiveArrayArgumentsNode;
import org.jruby.truffle.builtins.UnaryCoreMethodNode;
import org.jruby.truffle.builtins.YieldingCoreMethodNode;
import org.jruby.truffle.core.cast.ToEncodingNode;
import org.jruby.truffle.core.cast.ToStrNode;
import org.jruby.truffle.core.cast.ToStrNodeGen;
import org.jruby.truffle.core.rope.CodeRange;
import org.jruby.truffle.core.rope.Rope;
import org.jruby.truffle.core.rope.RopeOperations;
import org.jruby.truffle.core.string.StringOperations;
import org.jruby.truffle.language.RubyGuards;
import org.jruby.truffle.language.RubyNode;
import org.jruby.truffle.language.control.RaiseException;
import org.jruby.truffle.language.dispatch.CallDispatchHeadNode;
import org.jruby.truffle.language.dispatch.DispatchHeadNodeFactory;
import org.jruby.util.ByteList;

@CoreClass("Encoding")
@@ -458,92 +457,48 @@ protected static boolean isDummy(DynamicObject encoding) {
}

@NonStandard
@CoreMethod(names = "encoding_map", onSingleton = true)
public abstract static class EncodingMapNode extends CoreMethodArrayArgumentsNode {

@Child private CallDispatchHeadNode upcaseNode;
@Child private CallDispatchHeadNode toSymNode;
@Child private CallDispatchHeadNode newLookupTableNode;
@Child private CallDispatchHeadNode lookupTableWriteNode;
@Child private CallDispatchHeadNode newTupleNode;

public EncodingMapNode(RubyContext context, SourceSection sourceSection) {
super(context, sourceSection);
upcaseNode = DispatchHeadNodeFactory.createMethodCall(context);
toSymNode = DispatchHeadNodeFactory.createMethodCall(context);
newLookupTableNode = DispatchHeadNodeFactory.createMethodCall(context);
lookupTableWriteNode = DispatchHeadNodeFactory.createMethodCall(context);
newTupleNode = DispatchHeadNodeFactory.createMethodCall(context);
}
@CoreMethod(names = "each_alias", onSingleton = true, visibility = Visibility.PRIVATE, needsBlock = true)
public abstract static class EachAliasNode extends YieldingCoreMethodNode {

@Specialization
public Object encodingMap(VirtualFrame frame) {
Object ret = newLookupTableNode.call(frame, coreLibrary().getLookupTableClass(), "new");

final DynamicObject[] encodings = getContext().getEncodingManager().getUnsafeEncodingList();
for (int i = 0; i < encodings.length; i++) {
final Object upcased = upcaseNode.call(frame, Layouts.ENCODING.getName(encodings[i]), "upcase");
final Object key = toSymNode.call(frame, upcased, "to_sym");
final Object value = newTupleNode.call(frame, coreLibrary().getTupleClass(), "create", nil(), i);

lookupTableWriteNode.call(frame, ret, "[]=", key, value);
public DynamicObject eachAlias(VirtualFrame frame, DynamicObject block) {
CompilerAsserts.neverPartOfCompilation();
for (HashEntry<Entry> entry : EncodingDB.getAliases().entryIterator()) {
final CaseInsensitiveBytesHashEntry<Entry> e = (CaseInsensitiveBytesHashEntry<Entry>) entry;
final ByteList aliasName = new ByteList(e.bytes, e.p, e.end - e.p);
yield(frame, block, createString(aliasName), entry.value.getIndex());
}

final Hash<EncodingDB.Entry>.HashEntryIterator i = EncodingDB.getAliases().entryIterator();
while (i.hasNext()) {
final CaseInsensitiveBytesHash.CaseInsensitiveBytesHashEntry<EncodingDB.Entry> e =
((CaseInsensitiveBytesHash.CaseInsensitiveBytesHashEntry<EncodingDB.Entry>) i.next());

final Object upcased = upcaseNode.call(frame, createString(new ByteList(e.bytes, e.p, e.end - e.p)), "upcase");
final Object key = toSymNode.call(frame, upcased, "to_sym");
final DynamicObject alias = createString(new ByteList(e.bytes, e.p, e.end - e.p));
final int index = e.value.getIndex();


final Object value = newTupleNode.call(frame, coreLibrary().getTupleClass(), "create", alias, index);
lookupTableWriteNode.call(frame, ret, "[]=", key, value);
}

final Encoding defaultInternalEncoding = getContext().getJRubyRuntime().getDefaultInternalEncoding();
final Object internalTuple = makeTuple(frame, newTupleNode, create7BitString("internal", UTF8Encoding.INSTANCE), indexLookup(encodings, defaultInternalEncoding));
lookupTableWriteNode.call(frame, ret, "[]=", getSymbol("INTERNAL"), internalTuple);

final Encoding defaultExternalEncoding = getContext().getJRubyRuntime().getDefaultExternalEncoding();
final Object externalTuple = makeTuple(frame, newTupleNode, create7BitString("external", UTF8Encoding.INSTANCE), indexLookup(encodings, defaultExternalEncoding));
lookupTableWriteNode.call(frame, ret, "[]=", getSymbol("EXTERNAL"), externalTuple);

final Encoding localeEncoding = getContext().getEncodingManager().getLocaleEncoding();
final Object localeTuple = makeTuple(frame, newTupleNode, create7BitString("locale", UTF8Encoding.INSTANCE), indexLookup(encodings, localeEncoding));
lookupTableWriteNode.call(frame, ret, "[]=", getSymbol("LOCALE"), localeTuple);

final Encoding filesystemEncoding = getContext().getEncodingManager().getLocaleEncoding();
final Object filesystemTuple = makeTuple(frame, newTupleNode, create7BitString("filesystem", UTF8Encoding.INSTANCE), indexLookup(encodings, filesystemEncoding));
lookupTableWriteNode.call(frame, ret, "[]=", getSymbol("FILESYSTEM"), filesystemTuple);

return ret;
return nil();
}
}

private Object makeTuple(VirtualFrame frame, CallDispatchHeadNode newTupleNode, Object... values) {
return newTupleNode.call(frame, coreLibrary().getTupleClass(), "create", values);
}
@NonStandard
@CoreMethod(names = "get_default_encoding", onSingleton = true, visibility = Visibility.PRIVATE, required = 1)
public abstract static class GetDefaultEncodingNode extends CoreMethodArrayArgumentsNode {

@TruffleBoundary
public Object indexLookup(DynamicObject[] encodings, Encoding encoding) {
// TODO (nirvdrum 25-Mar-15): Build up this lookup table in RubyEncoding as we register encodings.
@Specialization(guards = "isRubyString(name)")
public DynamicObject getDefaultEncoding(DynamicObject name) {
final Encoding encoding = getEncoding(StringOperations.getString(name));
if (encoding == null) {
return nil();
} else {
return getContext().getEncodingManager().getRubyEncoding(encoding);
}
}

final Rope encodingNameRope = RopeOperations.create(encoding.getName(), ASCIIEncoding.INSTANCE, CodeRange.CR_UNKNOWN);

for (int i = 0; i < encodings.length; i++) {
final Rope nameRope = StringOperations.rope(Layouts.ENCODING.getName(encodings[i]));
if (nameRope.equals(encodingNameRope)) {
return i;
}
@TruffleBoundary
private Encoding getEncoding(String name) {
switch (name) {
case "internal":
return getContext().getJRubyRuntime().getDefaultInternalEncoding();
case "external":
return getContext().getJRubyRuntime().getDefaultExternalEncoding();
case "locale":
case "filesystem":
return getContext().getEncodingManager().getLocaleEncoding();
default:
throw new UnsupportedOperationException();
}

throw new UnsupportedOperationException(String.format("Could not find encoding %s in the registered encoding list", encoding.toString()));
}
}

31 changes: 26 additions & 5 deletions truffle/src/main/ruby/core/encoding.rb
View file
Original file line number Diff line number Diff line change
@@ -36,9 +36,6 @@ class EncodingError < StandardError
end

class Encoding
# There's a fun bootstrapping issue here. Encoding::Converter.transcoding_map needs access to the Encoding::Transcoding
# class. However, this shim runs before Encoding::Transcoding is defined. Since the class body is short, we reproduce
# it here along with a convenient factory method.
class Transcoding
attr_accessor :source
attr_accessor :target
@@ -57,9 +54,33 @@ def self.create(source, target)
end
end

class << self
def build_encoding_map
map = Rubinius::LookupTable.new
EncodingList.each_with_index { |encoding, index|
key = encoding.name.upcase.to_sym
map[key] = [nil, index]
}

each_alias { |alias_name, index|
key = alias_name.upcase.to_sym
map[key] = [alias_name, index]
}

%w[internal external locale filesystem].each { |name|
key = name.upcase.to_sym
enc = get_default_encoding(name)
index = enc ? map[enc.name].last : nil
map[key] = [name, index]
}
map
end
private :build_encoding_map
end

TranscodingMap = Encoding::Converter.transcoding_map
EncodingMap = Encoding.encoding_map
EncodingList = Encoding.list
EncodingList = Encoding.list.freeze
EncodingMap = build_encoding_map

@default_external = undefined
@default_internal = undefined

4 comments on commit 2e5aa26

@nirvdrum
Copy link
Contributor

@nirvdrum nirvdrum commented on 2e5aa26 Jul 5, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

+1 on getting this shorter. Interestingly, when I read the Ruby I was concerned that we might have referential integrity issues in the indices used. But the Ruby code is equivalent to the Java code and just makes that caveat easier to see. So, we're certainly no worse off than before.

@eregon
Copy link
Member Author

@eregon eregon commented on 2e5aa26 Jul 5, 2016

Choose a reason for hiding this comment

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

Yeah, the pattern to call some method yielding the converted Java values while bootstrapping works quite nicely :)

@nirvdrum
Copy link
Contributor

Choose a reason for hiding this comment

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

My concern was the each_with_index values (generated by list order) not matching the EncodingDB values (order not guaranteed -- index values just come from jcodings). But we essentially sort Encoding.list by the EncodingDB index values..

@eregon
Copy link
Member Author

@eregon eregon commented on 2e5aa26 Jul 5, 2016

Choose a reason for hiding this comment

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

Yeah, I spent a bit of time to figure out if that was right, but since ENCODING_LIST_BY_ENCODING_LIST_INDEX is assigned with the native index I assumed it's all right.

Please sign in to comment.