1 /*
  2  * Copyright (c) 1997, 2021, 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  */
 49 extern jclass ia_class;
 50 extern jfieldID iac_addressID;
 51 extern jfieldID iac_familyID;
 52 extern jfieldID iac_hostNameID;
 53 extern jfieldID iac_origHostNameID;
 54 
 55 JNIEXPORT void JNICALL initInetAddressIDs(JNIEnv *env);
 56 
 57 /** (Inet6Address accessors)
 58  * set_ methods return JNI_TRUE on success JNI_FALSE on error
 59  * get_ methods that return int/boolean, return -1 on error
 60  * get_ methods that return objects return NULL on error.
 61  */
 62 extern jboolean setInet6Address_scopeifname(JNIEnv *env, jobject ia6Obj, jobject scopeifname);
 63 extern unsigned int getInet6Address_scopeid(JNIEnv *env, jobject ia6Obj);
 64 extern jboolean setInet6Address_scopeid(JNIEnv *env, jobject ia6Obj, int scopeid);
 65 extern jboolean getInet6Address_ipaddress(JNIEnv *env, jobject ia6Obj, char *dest);
 66 extern jboolean setInet6Address_ipaddress(JNIEnv *env, jobject ia6Obj, char *address);
 67 
 68 extern void setInetAddress_addr(JNIEnv *env, jobject iaObj, int address);
 69 extern void setInetAddress_family(JNIEnv *env, jobject iaObj, int family);
 70 extern void setInetAddress_hostName(JNIEnv *env, jobject iaObj, jobject h);
 71 extern int getInetAddress_addr(JNIEnv *env, jobject iaObj);
 72 extern int getInetAddress_family(JNIEnv *env, jobject iaObj);
 73 
 74 extern jclass ia4_class;
 75 extern jmethodID ia4_ctrID;
 76 
 77 /* NetworkInterface fields */
 78 extern jclass ni_class;
 79 extern jfieldID ni_nameID;
 80 extern jfieldID ni_indexID;
 81 extern jfieldID ni_addrsID;
 82 extern jfieldID ni_descID;
 83 extern jmethodID ni_ctrID;
 84 
 85 /* DatagramPacket fields */
 86 extern jfieldID dp_addressID;
 87 extern jfieldID dp_portID;
 88 extern jfieldID dp_bufID;
 89 extern jfieldID dp_offsetID;
 90 extern jfieldID dp_lengthID;
 91 extern jfieldID dp_bufLengthID;
 92 
 93 /* Inet6Address fields */
 94 extern jclass ia6_class;
 95 extern jfieldID ia6_holder6ID;
 96 extern jfieldID ia6_ipaddressID;
 97 extern jfieldID ia6_scopeidID;
 98 extern jfieldID ia6_scopeidsetID;
 99 extern jfieldID ia6_scopeifnameID;
100 extern jmethodID ia6_ctrID;
101 
102 /************************************************************************
103  *  Utilities
104  */
105 JNIEXPORT void JNICALL Java_java_net_InetAddress_init(JNIEnv *env, jclass cls);
106 JNIEXPORT void JNICALL Java_java_net_Inet4Address_init(JNIEnv *env, jclass cls);
107 JNIEXPORT void JNICALL Java_java_net_Inet6Address_init(JNIEnv *env, jclass cls);
108 JNIEXPORT void JNICALL Java_java_net_NetworkInterface_init(JNIEnv *env, jclass cls);
109 
110 JNIEXPORT void JNICALL NET_ThrowNew(JNIEnv *env, int errorNum, char *msg);
111 
112 void NET_ThrowCurrent(JNIEnv *env, char *msg);
113 
114 jfieldID NET_GetFileDescriptorID(JNIEnv *env);
115 
116 JNIEXPORT jint JNICALL ipv4_available();
117 JNIEXPORT jint JNICALL ipv6_available();
118 
119 JNIEXPORT jint JNICALL reuseport_available();
120 
121 /**
122  * This function will fill a SOCKETADDRESS structure from an InetAddress
123  * object.
124  *
125  * The parameter 'sa' must point to valid storage of size
126  * 'sizeof(SOCKETADDRESS)'.
127  *
128  * The parameter 'len' is a pointer to an int and is used for returning
129  * the actual sockaddr length, e.g. 'sizeof(struct sockaddr_in)' or
130  * 'sizeof(struct sockaddr_in6)'.
131  *
132  * If the type of the InetAddress object is IPv6, the function will fill a
133  * sockaddr_in6 structure. IPv6 must be available in that case, otherwise an
134  * exception is thrown.
135  * In the case of an IPv4 InetAddress, when IPv6 is available and
136  * v4MappedAddress is TRUE, this method will fill a sockaddr_in6 structure
137  * containing an IPv4 mapped IPv6 address. Otherwise a sockaddr_in
138  * structure will be filled.
139  */
140 JNIEXPORT int JNICALL
141 NET_InetAddressToSockaddr(JNIEnv *env, jobject iaObj, int port,
142                           SOCKETADDRESS *sa, int *len,
143                           jboolean v4MappedAddress);
144 
145 JNIEXPORT jobject JNICALL
146 NET_SockaddrToInetAddress(JNIEnv *env, SOCKETADDRESS *sa, int *port);
147 
148 void platformInit();
149 
150 JNIEXPORT jint JNICALL NET_GetPortFromSockaddr(SOCKETADDRESS *sa);
151 
152 JNIEXPORT jboolean JNICALL
153 NET_SockaddrEqualsInetAddress(JNIEnv *env, SOCKETADDRESS *sa, jobject iaObj);
154 
155 int NET_IsIPv4Mapped(jbyte* caddr);
156 
157 int NET_IPv4MappedToIPv4(jbyte* caddr);
158 
159 int NET_IsEqual(jbyte* caddr1, jbyte* caddr2);
160 
161 int NET_IsZeroAddr(jbyte* caddr);
162 
163 /* Socket operations
164  *
165  * These work just like the system calls, except that they may do some
166  * platform-specific pre/post processing of the arguments and/or results.
167  */
168 
169 JNIEXPORT int JNICALL
170 NET_SocketAvailable(int fd, int *pbytes);
171 
172 JNIEXPORT int JNICALL
173 NET_GetSockOpt(int fd, int level, int opt, void *result, int *len);
174 
175 JNIEXPORT int JNICALL
176 NET_SetSockOpt(int fd, int level, int opt, const void *arg, int len);
177 
178 JNIEXPORT int JNICALL
179 NET_Bind(int fd, SOCKETADDRESS *sa, int len);
180 
181 JNIEXPORT int JNICALL
182 NET_MapSocketOption(jint cmd, int *level, int *optname);
183 
184 JNIEXPORT int JNICALL
185 NET_MapSocketOptionV6(jint cmd, int *level, int *optname);
186 
187 JNIEXPORT jint JNICALL
188 NET_EnableFastTcpLoopback(int fd);
189 
190 unsigned short in_cksum(unsigned short *addr, int len);
191 
192 jint NET_Wait(JNIEnv *env, jint fd, jint flags, jint timeout);
193 
194 int lookupCharacteristicsToAddressFamily(int characteristics);
195 
196 int addressesInSystemOrder(int characteristics);
197 
198 #endif /* NET_UTILS_H */