View Javadoc
1   /*
2    * Copyright 2017 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.resolver.dns;
17  
18  import io.netty.util.internal.PlatformDependent;
19  import io.netty.util.internal.logging.InternalLogger;
20  import io.netty.util.internal.logging.InternalLoggerFactory;
21  
22  import java.lang.reflect.Constructor;
23  import java.lang.reflect.InvocationTargetException;
24  import java.security.AccessController;
25  import java.security.PrivilegedAction;
26  import java.util.concurrent.TimeUnit;
27  import java.util.concurrent.atomic.AtomicLong;
28  
29  /**
30   * Utility methods related to {@link DnsServerAddressStreamProvider}.
31   */
32  public final class DnsServerAddressStreamProviders {
33  
34      private static final InternalLogger LOGGER =
35              InternalLoggerFactory.getInstance(DnsServerAddressStreamProviders.class);
36      private static final Constructor<? extends DnsServerAddressStreamProvider> STREAM_PROVIDER_CONSTRUCTOR;
37      private static final String MACOS_PROVIDER_CLASS_NAME =
38              "io.netty.resolver.dns.macos.MacOSDnsServerAddressStreamProvider";
39  
40      static {
41          Constructor<? extends DnsServerAddressStreamProvider> constructor = null;
42          if (PlatformDependent.isOsx()) {
43              try {
44                  // As MacOSDnsServerAddressStreamProvider is contained in another jar which depends on this jar
45                  // we use reflection to use it if its on the classpath.
46                  Object maybeProvider = AccessController.doPrivileged(new PrivilegedAction<Object>() {
47                      @Override
48                      public Object run() {
49                          try {
50                              return Class.forName(
51                                      MACOS_PROVIDER_CLASS_NAME,
52                                      true,
53                                      DnsServerAddressStreamProviders.class.getClassLoader());
54                          } catch (Throwable cause) {
55                              return cause;
56                          }
57                      }
58                  });
59                  if (maybeProvider instanceof Class) {
60                      @SuppressWarnings("unchecked")
61                      Class<? extends DnsServerAddressStreamProvider> providerClass =
62                              (Class<? extends DnsServerAddressStreamProvider>) maybeProvider;
63                      constructor = providerClass.getConstructor();
64                      constructor.newInstance();  // ctor ensures availability
65                      LOGGER.debug("{}: available", MACOS_PROVIDER_CLASS_NAME);
66                  } else {
67                      throw (Throwable) maybeProvider;
68                  }
69              } catch (ClassNotFoundException cause) {
70                  LOGGER.warn("Can not find {} in the classpath, fallback to system defaults. This may result in "
71                          + "incorrect DNS resolutions on MacOS. Check whether you have a dependency on "
72                          + "'io.netty:netty-resolver-dns-native-macos'", MACOS_PROVIDER_CLASS_NAME);
73              } catch (Throwable cause) {
74                  if (LOGGER.isDebugEnabled()) {
75                      LOGGER.error("Unable to load {}, fallback to system defaults. This may result in "
76                              + "incorrect DNS resolutions on MacOS. Check whether you have a dependency on "
77                              + "'io.netty:netty-resolver-dns-native-macos'", MACOS_PROVIDER_CLASS_NAME, cause);
78                  } else {
79                      LOGGER.error("Unable to load {}, fallback to system defaults. This may result in "
80                              + "incorrect DNS resolutions on MacOS. Check whether you have a dependency on "
81                              + "'io.netty:netty-resolver-dns-native-macos'. Use DEBUG level to see the full stack: {}",
82                              MACOS_PROVIDER_CLASS_NAME,
83                              cause.getCause() != null ? cause.getCause().toString() : cause.toString());
84                  }
85                  constructor = null;
86              }
87          }
88          STREAM_PROVIDER_CONSTRUCTOR = constructor;
89      }
90  
91      private DnsServerAddressStreamProviders() {
92      }
93  
94      /**
95       * A {@link DnsServerAddressStreamProvider} which inherits the DNS servers from your local host's configuration.
96       * <p>
97       * Note that only macOS and Linux are currently supported.
98       * @return A {@link DnsServerAddressStreamProvider} which inherits the DNS servers from your local host's
99       * configuration.
100      */
101     public static DnsServerAddressStreamProvider platformDefault() {
102         if (STREAM_PROVIDER_CONSTRUCTOR != null) {
103             try {
104                 return STREAM_PROVIDER_CONSTRUCTOR.newInstance();
105             } catch (IllegalAccessException | InstantiationException | InvocationTargetException e) {
106                 // ignore
107             }
108         }
109         return unixDefault();
110     }
111 
112     public static DnsServerAddressStreamProvider unixDefault() {
113         return DefaultProviderHolder.DEFAULT_DNS_SERVER_ADDRESS_STREAM_PROVIDER;
114     }
115 
116     // We use a Holder class to only initialize DEFAULT_DNS_SERVER_ADDRESS_STREAM_PROVIDER if we really
117     // need it.
118     private static final class DefaultProviderHolder {
119         // We use 5 minutes which is the same as what OpenJDK is using in sun.net.dns.ResolverConfigurationImpl.
120         private static final long REFRESH_INTERVAL = TimeUnit.MINUTES.toNanos(5);
121 
122         // TODO(scott): how is this done on Windows? This may require a JNI call to GetNetworkParams
123         // https://msdn.microsoft.com/en-us/library/aa365968(VS.85).aspx.
124         static final DnsServerAddressStreamProvider DEFAULT_DNS_SERVER_ADDRESS_STREAM_PROVIDER =
125                 new DnsServerAddressStreamProvider() {
126                     private volatile DnsServerAddressStreamProvider currentProvider = provider();
127                     private final AtomicLong lastRefresh = new AtomicLong(System.nanoTime());
128 
129                     @Override
130                     public DnsServerAddressStream nameServerAddressStream(String hostname) {
131                         long last = lastRefresh.get();
132                         DnsServerAddressStreamProvider current = currentProvider;
133                         if (System.nanoTime() - last > REFRESH_INTERVAL) {
134                             // This is slightly racy which means it will be possible still use the old configuration
135                             // for a small amount of time, but that's ok.
136                             if (lastRefresh.compareAndSet(last, System.nanoTime())) {
137                                 current = currentProvider = provider();
138                             }
139                         }
140                         return current.nameServerAddressStream(hostname);
141                     }
142 
143                     private DnsServerAddressStreamProvider provider() {
144                         // If on windows just use the DefaultDnsServerAddressStreamProvider.INSTANCE as otherwise
145                         // we will log some error which may be confusing.
146                         return PlatformDependent.isWindows() ? DefaultDnsServerAddressStreamProvider.INSTANCE :
147                                 UnixResolverDnsServerAddressStreamProvider.parseSilently();
148                     }
149                 };
150     }
151 }