Skip to content

Commit

Permalink
Extract SocketAdress logic from NameResolver
Browse files Browse the repository at this point in the history 
Motivation:

As discussed in netty#4529, NameResolver design shouldn't be resolving SocketAddresses (or String name + port) and return InetSocketAddresses. It should resolve String names and return InetAddresses.
This SocketAddress to InetSocketAddresses resolution is actually a different concern, used by Bootstrap.

Modifications:

Extract SocketAddress to InetSocketAddresses resolution concern to a new class hierarchy named AddressResolver.
These AddressResolvers delegate to NameResolvers.

Result:

Better separation of concerns.

Note that new AddressResolvers generate a bit more allocations because of the intermediate Promise and List<InetAddress>.
  • Loading branch information
@slandelle @normanmaurer
slandelle authored and normanmaurer committed Dec 14, 2015
1 parent 89ff831 commit 6393506
Show file tree
Hide file tree
Showing 18 changed files with 602 additions and 400 deletions.
8 changes: 4 additions & 4 deletions handler-proxy/src/test/java/io/netty/handler/proxy/ProxyHandlerTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
import io.netty.handler.ssl.SslContext;
import io.netty.handler.ssl.util.InsecureTrustManagerFactory;
import io.netty.handler.ssl.util.SelfSignedCertificate;
import io.netty.resolver.NoopNameResolverGroup;
import io.netty.resolver.NoopAddressResolverGroup;
import io.netty.util.CharsetUtil;
import io.netty.util.concurrent.DefaultThreadFactory;
import io.netty.util.concurrent.Future;
Expand Down Expand Up @@ -523,7 +523,7 @@ protected void test() throws Exception {
Bootstrap b = new Bootstrap();
b.group(group);
b.channel(NioSocketChannel.class);
b.resolver(NoopNameResolverGroup.INSTANCE);
b.resolver(NoopAddressResolverGroup.INSTANCE);
b.handler(new ChannelInitializer<SocketChannel>() {
@Override
protected void initChannel(SocketChannel ch) throws Exception {
Expand Down Expand Up @@ -571,7 +571,7 @@ protected void test() throws Exception {
Bootstrap b = new Bootstrap();
b.group(group);
b.channel(NioSocketChannel.class);
b.resolver(NoopNameResolverGroup.INSTANCE);
b.resolver(NoopAddressResolverGroup.INSTANCE);
b.handler(new ChannelInitializer<SocketChannel>() {
@Override
protected void initChannel(SocketChannel ch) throws Exception {
Expand Down Expand Up @@ -616,7 +616,7 @@ protected void test() throws Exception {
Bootstrap b = new Bootstrap();
b.group(group);
b.channel(NioSocketChannel.class);
b.resolver(NoopNameResolverGroup.INSTANCE);
b.resolver(NoopAddressResolverGroup.INSTANCE);
b.handler(new ChannelInitializer<SocketChannel>() {
@Override
protected void initChannel(SocketChannel ch) throws Exception {
Expand Down
24 changes: 12 additions & 12 deletions ...ty/resolver/dns/DnsNameResolverGroup.java → ...resolver/dns/DnsAddressResolverGroup.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
import io.netty.channel.EventLoop;
import io.netty.channel.ReflectiveChannelFactory;
import io.netty.channel.socket.DatagramChannel;
import io.netty.resolver.NameResolver;
import io.netty.resolver.NameResolverGroup;
import io.netty.resolver.AddressResolver;
import io.netty.resolver.AddressResolverGroup;
import io.netty.util.concurrent.EventExecutor;
import io.netty.util.internal.StringUtil;

Expand All @@ -30,31 +30,31 @@
import static io.netty.resolver.dns.DnsNameResolver.ANY_LOCAL_ADDR;

/**
* A {@link NameResolverGroup} of {@link DnsNameResolver}s.
* A {@link AddressResolverGroup} of {@link DnsNameResolver}s.
*/
public class DnsNameResolverGroup extends NameResolverGroup<InetSocketAddress> {
public class DnsAddressResolverGroup extends AddressResolverGroup<InetSocketAddress> {

private final ChannelFactory<? extends DatagramChannel> channelFactory;
private final InetSocketAddress localAddress;
private final DnsServerAddresses nameServerAddresses;

public DnsNameResolverGroup(
public DnsAddressResolverGroup(
Class<? extends DatagramChannel> channelType, DnsServerAddresses nameServerAddresses) {
this(channelType, ANY_LOCAL_ADDR, nameServerAddresses);
}

public DnsNameResolverGroup(
public DnsAddressResolverGroup(
Class<? extends DatagramChannel> channelType,
InetSocketAddress localAddress, DnsServerAddresses nameServerAddresses) {
this(new ReflectiveChannelFactory<DatagramChannel>(channelType), localAddress, nameServerAddresses);
}

public DnsNameResolverGroup(
public DnsAddressResolverGroup(
ChannelFactory<? extends DatagramChannel> channelFactory, DnsServerAddresses nameServerAddresses) {
this(channelFactory, ANY_LOCAL_ADDR, nameServerAddresses);
}

public DnsNameResolverGroup(
public DnsAddressResolverGroup(
ChannelFactory<? extends DatagramChannel> channelFactory,
InetSocketAddress localAddress, DnsServerAddresses nameServerAddresses) {
this.channelFactory = channelFactory;
Expand All @@ -63,7 +63,7 @@ public DnsNameResolverGroup(
}

@Override
protected final NameResolver<InetSocketAddress> newResolver(EventExecutor executor) throws Exception {
protected final AddressResolver<InetSocketAddress> newResolver(EventExecutor executor) throws Exception {
if (!(executor instanceof EventLoop)) {
throw new IllegalStateException(
"unsupported executor type: " + StringUtil.simpleClassName(executor) +
Expand All @@ -77,11 +77,11 @@ protected final NameResolver<InetSocketAddress> newResolver(EventExecutor execut
* Creates a new {@link DnsNameResolver}. Override this method to create an alternative {@link DnsNameResolver}
* implementation or override the default configuration.
*/
protected DnsNameResolver newResolver(
protected AddressResolver<InetSocketAddress> newResolver(
EventLoop eventLoop, ChannelFactory<? extends DatagramChannel> channelFactory,
InetSocketAddress localAddress, DnsServerAddresses nameServerAddresses) throws Exception {

return new DnsNameResolver(
eventLoop, channelFactory, localAddress, nameServerAddresses);
return new DnsNameResolver(eventLoop, channelFactory, localAddress, nameServerAddresses)
.asAddressResolver();
}
}
101 changes: 40 additions & 61 deletions resolver-dns/src/main/java/io/netty/resolver/dns/DnsNameResolver.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,23 +33,20 @@
import io.netty.handler.codec.dns.DatagramDnsResponseDecoder;
import io.netty.handler.codec.dns.DnsQuestion;
import io.netty.handler.codec.dns.DnsResponse;
import io.netty.resolver.NameResolver;
import io.netty.resolver.SimpleNameResolver;
import io.netty.resolver.InetNameResolver;
import io.netty.util.NetUtil;
import io.netty.util.ReferenceCountUtil;
import io.netty.util.concurrent.FastThreadLocal;
import io.netty.util.concurrent.Future;
import io.netty.util.concurrent.Promise;
import io.netty.util.internal.OneTimeTask;
import io.netty.util.internal.PlatformDependent;
import io.netty.util.internal.SystemPropertyUtil;
import io.netty.util.internal.logging.InternalLogger;
import io.netty.util.internal.logging.InternalLoggerFactory;

import java.net.IDN;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
Expand All @@ -62,9 +59,9 @@
import static io.netty.util.internal.ObjectUtil.checkNotNull;

/**
* A DNS-based {@link NameResolver}.
* A DNS-based {@link InetNameResolver}.
*/
public class DnsNameResolver extends SimpleNameResolver<InetSocketAddress> {
public class DnsNameResolver extends InetNameResolver {

private static final InternalLogger logger = InternalLoggerFactory.getInstance(DnsNameResolver.class);

Expand All @@ -74,7 +71,7 @@ public class DnsNameResolver extends SimpleNameResolver<InetSocketAddress> {

static {
// Note that we did not use SystemPropertyUtil.getBoolean() here to emulate the behavior of JDK.
if ("true".equalsIgnoreCase(SystemPropertyUtil.get("java.net.preferIPv6Addresses"))) {
if (Boolean.getBoolean("java.net.preferIPv6Addresses")) {
DEFAULT_RESOLVE_ADDRESS_TYPES[0] = InternetProtocolFamily.IPv6;
DEFAULT_RESOLVE_ADDRESS_TYPES[1] = InternetProtocolFamily.IPv4;
logger.debug("-Djava.net.preferIPv6Addresses: true");
Expand All @@ -98,7 +95,7 @@ public class DnsNameResolver extends SimpleNameResolver<InetSocketAddress> {
final DnsQueryContextManager queryContextManager = new DnsQueryContextManager();

/**
* Cache for {@link #doResolve(InetSocketAddress, Promise)} and {@link #doResolveAll(InetSocketAddress, Promise)}.
* Cache for {@link #doResolve(String, Promise)} and {@link #doResolveAll(String, Promise)}.
*/
final ConcurrentMap<String, List<DnsCacheEntry>> resolveCache = PlatformDependent.newConcurrentHashMap();

Expand Down Expand Up @@ -329,7 +326,7 @@ public DnsNameResolver setQueryTimeoutMillis(long queryTimeoutMillis) {
}

/**
* Returns the list of the protocol families of the address resolved by {@link #resolve(SocketAddress)}
* Returns the list of the protocol families of the address resolved by {@link #resolve(String)}
* in the order of preference.
* The default value depends on the value of the system property {@code "java.net.preferIPv6Addresses"}.
*
Expand All @@ -344,7 +341,7 @@ InternetProtocolFamily[] resolveAddressTypesUnsafe() {
}

/**
* Sets the list of the protocol families of the address resolved by {@link #resolve(SocketAddress)}.
* Sets the list of the protocol families of the address resolved by {@link #resolve(String)}.
* Usually, both {@link InternetProtocolFamily#IPv4} and {@link InternetProtocolFamily#IPv6} are specified in the
* order of preference. To enforce the resolve to retrieve the address of a specific protocol family, specify
* only a single {@link InternetProtocolFamily}.
Expand Down Expand Up @@ -382,7 +379,7 @@ public DnsNameResolver setResolveAddressTypes(InternetProtocolFamily... resolveA
}

/**
* Sets the list of the protocol families of the address resolved by {@link #resolve(SocketAddress)}.
* Sets the list of the protocol families of the address resolved by {@link #resolve(String)}.
* Usually, both {@link InternetProtocolFamily#IPv4} and {@link InternetProtocolFamily#IPv6} are specified in the
* order of preference. To enforce the resolve to retrieve the address of a specific protocol family, specify
* only a single {@link InternetProtocolFamily}.
Expand Down Expand Up @@ -594,28 +591,22 @@ protected EventLoop executor() {
}

@Override
protected boolean doIsResolved(InetSocketAddress address) {
return !address.isUnresolved();
}

@Override
protected void doResolve(InetSocketAddress unresolvedAddress, Promise<InetSocketAddress> promise) throws Exception {
final byte[] bytes = NetUtil.createByteArrayFromIpAddressString(unresolvedAddress.getHostName());
protected void doResolve(String inetHost, Promise<InetAddress> promise) throws Exception {
final byte[] bytes = NetUtil.createByteArrayFromIpAddressString(inetHost);
if (bytes != null) {
// The unresolvedAddress was created via a String that contains an ipaddress.
promise.setSuccess(new InetSocketAddress(InetAddress.getByAddress(bytes), unresolvedAddress.getPort()));
// The inetHost is actually an ipaddress.
promise.setSuccess(InetAddress.getByAddress(bytes));
return;
}

final String hostname = hostname(unresolvedAddress);
final int port = unresolvedAddress.getPort();
final String hostname = hostname(inetHost);

if (!doResolveCached(hostname, port, promise)) {
doResolveUncached(hostname, port, promise);
if (!doResolveCached(hostname, promise)) {
doResolveUncached(hostname, promise);
}
}

private boolean doResolveCached(String hostname, int port, Promise<InetSocketAddress> promise) {
private boolean doResolveCached(String hostname, Promise<InetAddress> promise) {
final List<DnsCacheEntry> cachedEntries = resolveCache.get(hostname);
if (cachedEntries == null) {
return false;
Expand Down Expand Up @@ -644,7 +635,7 @@ private boolean doResolveCached(String hostname, int port, Promise<InetSocketAdd
}

if (address != null) {
setSuccess(promise, new InetSocketAddress(address, port));
setSuccess(promise, address);
} else if (cause != null) {
if (!promise.tryFailure(cause)) {
logger.warn("Failed to notify failure to a promise: {}", promise, cause);
Expand All @@ -656,15 +647,15 @@ private boolean doResolveCached(String hostname, int port, Promise<InetSocketAdd
return true;
}

private static void setSuccess(Promise<InetSocketAddress> promise, InetSocketAddress result) {
private static void setSuccess(Promise<InetAddress> promise, InetAddress result) {
if (!promise.trySuccess(result)) {
logger.warn("Failed to notify success ({}) to a promise: {}", result, promise);
}
}

private void doResolveUncached(String hostname, final int port, Promise<InetSocketAddress> promise) {
final DnsNameResolverContext<InetSocketAddress> ctx =
new DnsNameResolverContext<InetSocketAddress>(this, hostname, promise) {
private void doResolveUncached(String hostname, Promise<InetAddress> promise) {
final DnsNameResolverContext<InetAddress> ctx =
new DnsNameResolverContext<InetAddress>(this, hostname, promise) {
@Override
protected boolean finishResolve(
Class<? extends InetAddress> addressType, List<DnsCacheEntry> resolvedEntries) {
Expand All @@ -673,7 +664,7 @@ protected boolean finishResolve(
for (int i = 0; i < numEntries; i++) {
final InetAddress a = resolvedEntries.get(i).address();
if (addressType.isInstance(a)) {
setSuccess(promise(), new InetSocketAddress(a, port));
setSuccess(promise(), a);
return true;
}
}
Expand All @@ -685,32 +676,29 @@ protected boolean finishResolve(
}

@Override
protected void doResolveAll(
InetSocketAddress unresolvedAddress, Promise<List<InetSocketAddress>> promise) throws Exception {
protected void doResolveAll(String inetHost, Promise<List<InetAddress>> promise) throws Exception {

final byte[] bytes = NetUtil.createByteArrayFromIpAddressString(unresolvedAddress.getHostName());
final byte[] bytes = NetUtil.createByteArrayFromIpAddressString(inetHost);
if (bytes != null) {
// The unresolvedAddress was created via a String that contains an ipaddress.
promise.setSuccess(Collections.singletonList(
new InetSocketAddress(InetAddress.getByAddress(bytes), unresolvedAddress.getPort())));
promise.setSuccess(Collections.singletonList(InetAddress.getByAddress(bytes)));
return;
}

final String hostname = hostname(unresolvedAddress);
final int port = unresolvedAddress.getPort();
final String hostname = hostname(inetHost);

if (!doResolveAllCached(hostname, port, promise)) {
doResolveAllUncached(hostname, port, promise);
if (!doResolveAllCached(hostname, promise)) {
doResolveAllUncached(hostname, promise);
}
}

private boolean doResolveAllCached(String hostname, int port, Promise<List<InetSocketAddress>> promise) {
private boolean doResolveAllCached(String hostname, Promise<List<InetAddress>> promise) {
final List<DnsCacheEntry> cachedEntries = resolveCache.get(hostname);
if (cachedEntries == null) {
return false;
}

List<InetSocketAddress> result = null;
List<InetAddress> result = null;
Throwable cause = null;
synchronized (cachedEntries) {
final int numEntries = cachedEntries.size();
Expand All @@ -724,9 +712,9 @@ private boolean doResolveAllCached(String hostname, int port, Promise<List<InetS
final DnsCacheEntry e = cachedEntries.get(i);
if (f.addressType().isInstance(e.address())) {
if (result == null) {
result = new ArrayList<InetSocketAddress>(numEntries);
result = new ArrayList<InetAddress>(numEntries);
}
result.add(new InetSocketAddress(e.address(), port));
result.add(e.address());
}
}
}
Expand All @@ -744,23 +732,22 @@ private boolean doResolveAllCached(String hostname, int port, Promise<List<InetS
return true;
}

private void doResolveAllUncached(final String hostname, final int port,
final Promise<List<InetSocketAddress>> promise) {
final DnsNameResolverContext<List<InetSocketAddress>> ctx =
new DnsNameResolverContext<List<InetSocketAddress>>(this, hostname, promise) {
private void doResolveAllUncached(final String hostname, final Promise<List<InetAddress>> promise) {
final DnsNameResolverContext<List<InetAddress>> ctx =
new DnsNameResolverContext<List<InetAddress>>(this, hostname, promise) {
@Override
protected boolean finishResolve(
Class<? extends InetAddress> addressType, List<DnsCacheEntry> resolvedEntries) {

List<InetSocketAddress> result = null;
List<InetAddress> result = null;
final int numEntries = resolvedEntries.size();
for (int i = 0; i < numEntries; i++) {
final InetAddress a = resolvedEntries.get(i).address();
if (addressType.isInstance(a)) {
if (result == null) {
result = new ArrayList<InetSocketAddress>(numEntries);
result = new ArrayList<InetAddress>(numEntries);
}
result.add(new InetSocketAddress(a, port));
result.add(a);
}
}

Expand All @@ -775,16 +762,8 @@ protected boolean finishResolve(
ctx.resolve();
}

private static String hostname(InetSocketAddress addr) {
// InetSocketAddress.getHostString() is available since Java 7.
final String hostname;
if (PlatformDependent.javaVersion() < 7) {
hostname = addr.getHostName();
} else {
hostname = addr.getHostString();
}

return IDN.toASCII(hostname);
private static String hostname(String inetHost) {
return IDN.toASCII(inetHost);
}

void cache(String hostname, InetAddress address, long originalTtl) {
Expand Down
Loading

0 comments on commit 6393506

Please sign in to comment.