1 /*
   2  * Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 #ifndef NET_UTILS_H
  27 #define NET_UTILS_H
  28 
  29 #include "jvm.h"
  30 #include "jni_util.h"
  31 #include "net_util_md.h"
  32 
  33 /************************************************************************
  34  * Macros and misc constants
  35  */
  36 
  37 #define MAX_PACKET_LEN 65536
  38 
  39 #define NET_WAIT_READ    0x01
  40 #define NET_WAIT_WRITE   0x02
  41 #define NET_WAIT_CONNECT 0x04
  42 
  43 /************************************************************************
  44  * Cached field IDs
  45  *
  46  * The naming convention for field IDs is
  47  *      <class abbrv>_<fieldName>ID
  48  * i.e. psi_timeoutID is PlainSocketImpl's timeout field's ID.
  49  */
  50 extern jclass ia_class;
  51 extern jfieldID iac_addressID;
  52 extern jfieldID iac_familyID;
  53 extern jfieldID iac_hostNameID;
  54 extern jfieldID iac_origHostNameID;
  55 extern jfieldID ia_preferIPv6AddressID;
  56 
  57 JNIEXPORT void JNICALL initInetAddressIDs(JNIEnv *env);
  58 
  59 /** (Inet6Address accessors)
  60  * set_ methods return JNI_TRUE on success JNI_FALSE on error
  61  * get_ methods that return int/boolean, return -1 on error
  62  * get_ methods that return objects return NULL on error.
  63  */
  64 extern jboolean setInet6Address_scopeifname(JNIEnv *env, jobject ia6Obj, jobject scopeifname);
  65 extern unsigned int getInet6Address_scopeid(JNIEnv *env, jobject ia6Obj);
  66 extern jboolean setInet6Address_scopeid(JNIEnv *env, jobject ia6Obj, int scopeid);
  67 extern jboolean getInet6Address_ipaddress(JNIEnv *env, jobject ia6Obj, char *dest);
  68 extern jboolean setInet6Address_ipaddress(JNIEnv *env, jobject ia6Obj, char *address);
  69 
  70 extern void setInetAddress_addr(JNIEnv *env, jobject iaObj, int address);
  71 extern void setInetAddress_family(JNIEnv *env, jobject iaObj, int family);
  72 extern void setInetAddress_hostName(JNIEnv *env, jobject iaObj, jobject h);
  73 extern int getInetAddress_addr(JNIEnv *env, jobject iaObj);
  74 extern int getInetAddress_family(JNIEnv *env, jobject iaObj);
  75 
  76 extern jclass ia4_class;
  77 extern jmethodID ia4_ctrID;
  78 
  79 /* NetworkInterface fields */
  80 extern jclass ni_class;
  81 extern jfieldID ni_nameID;
  82 extern jfieldID ni_indexID;
  83 extern jfieldID ni_addrsID;
  84 extern jfieldID ni_descID;
  85 extern jmethodID ni_ctrID;
  86 
  87 /* PlainSocketImpl fields */
  88 extern jfieldID psi_timeoutID;
  89 extern jfieldID psi_fdID;
  90 extern jfieldID psi_addressID;
  91 extern jfieldID psi_portID;
  92 extern jfieldID psi_localportID;
  93 
  94 /* DatagramPacket fields */
  95 extern jfieldID dp_addressID;
  96 extern jfieldID dp_portID;
  97 extern jfieldID dp_bufID;
  98 extern jfieldID dp_offsetID;
  99 extern jfieldID dp_lengthID;
 100 extern jfieldID dp_bufLengthID;
 101 
 102 /* Inet6Address fields */
 103 extern jclass ia6_class;
 104 extern jfieldID ia6_holder6ID;
 105 extern jfieldID ia6_ipaddressID;
 106 extern jfieldID ia6_scopeidID;
 107 extern jfieldID ia6_scopeidsetID;
 108 extern jfieldID ia6_scopeifnameID;
 109 extern jmethodID ia6_ctrID;
 110 
 111 /************************************************************************
 112  *  Utilities
 113  */
 114 JNIEXPORT void JNICALL Java_java_net_InetAddress_init(JNIEnv *env, jclass cls);
 115 JNIEXPORT void JNICALL Java_java_net_Inet4Address_init(JNIEnv *env, jclass cls);
 116 JNIEXPORT void JNICALL Java_java_net_Inet6Address_init(JNIEnv *env, jclass cls);
 117 JNIEXPORT void JNICALL Java_java_net_NetworkInterface_init(JNIEnv *env, jclass cls);
 118 
 119 JNIEXPORT void JNICALL NET_ThrowNew(JNIEnv *env, int errorNum, char *msg);
 120 
 121 void NET_ThrowCurrent(JNIEnv *env, char *msg);
 122 
 123 jfieldID NET_GetFileDescriptorID(JNIEnv *env);
 124 
 125 JNIEXPORT jint JNICALL ipv4_available();
 126 JNIEXPORT jint JNICALL ipv6_available();
 127 
 128 JNIEXPORT jint JNICALL reuseport_available();
 129 
 130 /**
 131  * This function will fill a SOCKETADDRESS structure from an InetAddress
 132  * object.
 133  *
 134  * The parameter 'sa' must point to valid storage of size
 135  * 'sizeof(SOCKETADDRESS)'.
 136  *
 137  * The parameter 'len' is a pointer to an int and is used for returning
 138  * the actual sockaddr length, e.g. 'sizeof(struct sockaddr_in)' or
 139  * 'sizeof(struct sockaddr_in6)'.
 140  *
 141  * If the type of the InetAddress object is IPv6, the function will fill a
 142  * sockaddr_in6 structure. IPv6 must be available in that case, otherwise an
 143  * exception is thrown.
 144  * In the case of an IPv4 InetAddress, when IPv6 is available and
 145  * v4MappedAddress is TRUE, this method will fill a sockaddr_in6 structure
 146  * containing an IPv4 mapped IPv6 address. Otherwise a sockaddr_in
 147  * structure will be filled.
 148  */
 149 JNIEXPORT int JNICALL
 150 NET_InetAddressToSockaddr(JNIEnv *env, jobject iaObj, int port,
 151                           SOCKETADDRESS *sa, int *len,
 152                           jboolean v4MappedAddress);
 153 
 154 JNIEXPORT jobject JNICALL
 155 NET_SockaddrToInetAddress(JNIEnv *env, SOCKETADDRESS *sa, int *port);
 156 
 157 void platformInit();
 158 
 159 JNIEXPORT jint JNICALL NET_GetPortFromSockaddr(SOCKETADDRESS *sa);
 160 
 161 JNIEXPORT jboolean JNICALL
 162 NET_SockaddrEqualsInetAddress(JNIEnv *env, SOCKETADDRESS *sa, jobject iaObj);
 163 
 164 int NET_IsIPv4Mapped(jbyte* caddr);
 165 
 166 int NET_IPv4MappedToIPv4(jbyte* caddr);
 167 
 168 int NET_IsEqual(jbyte* caddr1, jbyte* caddr2);
 169 
 170 int NET_IsZeroAddr(jbyte* caddr);
 171 
 172 /* Socket operations
 173  *
 174  * These work just like the system calls, except that they may do some
 175  * platform-specific pre/post processing of the arguments and/or results.
 176  */
 177 
 178 JNIEXPORT int JNICALL
 179 NET_SocketAvailable(int fd, int *pbytes);
 180 
 181 JNIEXPORT int JNICALL
 182 NET_GetSockOpt(int fd, int level, int opt, void *result, int *len);
 183 
 184 JNIEXPORT int JNICALL
 185 NET_SetSockOpt(int fd, int level, int opt, const void *arg, int len);
 186 
 187 JNIEXPORT int JNICALL
 188 NET_Bind(int fd, SOCKETADDRESS *sa, int len);
 189 
 190 JNIEXPORT int JNICALL
 191 NET_MapSocketOption(jint cmd, int *level, int *optname);
 192 
 193 JNIEXPORT int JNICALL
 194 NET_MapSocketOptionV6(jint cmd, int *level, int *optname);
 195 
 196 JNIEXPORT jint JNICALL
 197 NET_EnableFastTcpLoopback(int fd);
 198 
 199 unsigned short in_cksum(unsigned short *addr, int len);
 200 
 201 jint NET_Wait(JNIEnv *env, jint fd, jint flags, jint timeout);
 202 
 203 #endif /* NET_UTILS_H */