joy/android_packages_modules_Connectivity
Watch
1
Fork
You've already forked android_packages_modules_Connectivity
 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge "Introduce LegacyStruct to expose writeToBytes(ByteOrder)" into main

Browse source
This commit is contained in:
Treehugger Robot 2025-07-29 13:14:53 -07:00 • committed by Android (Google) Code Review
commit bd78be51a5
14 changed files with 83 additions and 59 deletions
Download patch file Download diff file Expand all files Collapse all files

34
staticlibs/device/com/android/net/module/util/LegacyStruct.java Normal file
View file

@ -0,0 +1,34 @@
/*
* Copyright (C) 2025 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.net.module.util;
import java.nio.ByteOrder;
/**
* LegacyStruct is solely used for providing access to the deprecated writeToBytes(ByteOrder)
* method.
*
* The goal is to slowly move all Struct classes to defining the ByteOrder directly on the field (by
* virtue of using the BE int types) after which LegacyStruct can be deleted.
*/
public class LegacyStruct extends Struct {
/** A wrapper around {@code Struct#legacyWriteToBytes} */
public final byte[] writeToBytes(final ByteOrder order) {
return legacyWriteToBytes(order);
}
}

9
staticlibs/device/com/android/net/module/util/Struct.java
View file

@ -706,9 +706,12 @@ public class Struct {
/**
* Convert the parsed Struct subclass object to byte array.
*
* WARNING: Structs should use byteorder annotations on the field, rather than using
* legacyWriteToBytes. This method will be deleted in the future.
*
* @param order indicate ByteBuffer is outputted as little-endian or big-endian.
*/
public final byte[] writeToBytes(final ByteOrder order) {
protected final byte[] legacyWriteToBytes(final ByteOrder order) {
final FieldInfo[] fieldInfos = getClassFieldInfo(this.getClass());
final byte[] output = new byte[getSizeInternal(fieldInfos)];
final ByteBuffer buffer = ByteBuffer.wrap(output);
@ -719,7 +722,7 @@ public class Struct {
/** Convert the parsed Struct subclass object to byte array with native order. */
public final byte[] writeToBytes() {
return writeToBytes(ByteOrder.nativeOrder());
return legacyWriteToBytes(ByteOrder.nativeOrder());
}
@Override
@ -788,7 +791,7 @@ public class Struct {
}
/** A simple Struct which only contains a bool field. */
public static class Bool extends Struct {
public static class Bool extends LegacyStruct {
@Struct.Field(order = 0, type = Struct.Type.Bool)
public final boolean val;

4
staticlibs/device/com/android/net/module/util/structs/FragmentHeader.java
View file

@ -16,7 +16,7 @@
package com.android.net.module.util.structs;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -31,7 +31,7 @@ import com.android.net.module.util.Struct.Type;
* | Identification |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
public class FragmentHeader extends Struct {
public class FragmentHeader extends LegacyStruct {
@Field(order = 0, type = Type.U8)
public final short nextHeader;
@Field(order = 1, type = Type.S8)

4
staticlibs/device/com/android/net/module/util/structs/IaAddressOption.java
View file

@ -18,7 +18,7 @@ package com.android.net.module.util.structs;
import static com.android.net.module.util.NetworkStackConstants.DHCP6_OPTION_IA_ADDR;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -49,7 +49,7 @@ import java.nio.ByteOrder;
* . .
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
public class IaAddressOption extends Struct {
public class IaAddressOption extends LegacyStruct {
public static final int LENGTH = 24; // option length excluding IAaddr-options
@Field(order = 0, type = Type.S16)

4
staticlibs/device/com/android/net/module/util/structs/IaPdOption.java
View file

@ -18,7 +18,7 @@ package com.android.net.module.util.structs;
import static com.android.net.module.util.NetworkStackConstants.DHCP6_OPTION_IA_PD;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -46,7 +46,7 @@ import java.nio.ByteOrder;
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*
*/
public class IaPdOption extends Struct {
public class IaPdOption extends LegacyStruct {
public static final int LENGTH = 12; // option length excluding IA_PD options
@Field(order = 0, type = Type.S16)

4
staticlibs/device/com/android/net/module/util/structs/IaPrefixOption.java
View file

@ -21,7 +21,7 @@ import static com.android.net.module.util.NetworkStackConstants.DHCP6_OPTION_IAP
import android.net.IpPrefix;
import android.util.Log;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Computed;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -58,7 +58,7 @@ import java.nio.ByteOrder;
* . .
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
public class IaPrefixOption extends Struct {
public class IaPrefixOption extends LegacyStruct {
private static final String TAG = IaPrefixOption.class.getSimpleName();
public static final int LENGTH = 25; // option length excluding IAprefix-options

4
staticlibs/device/com/android/net/module/util/structs/LlaOption.java
View file

@ -18,7 +18,7 @@ package com.android.net.module.util.structs;
import android.net.MacAddress;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -34,7 +34,7 @@ import java.nio.ByteOrder;
* | Type | Length | Link-Layer Address ...
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
public class LlaOption extends Struct {
public class LlaOption extends LegacyStruct {
@Field(order = 0, type = Type.S8)
public final byte type;
@Field(order = 1, type = Type.S8)

4
staticlibs/device/com/android/net/module/util/structs/MtuOption.java
View file

@ -18,7 +18,7 @@ package com.android.net.module.util.structs;
import static com.android.net.module.util.NetworkStackConstants.ICMPV6_ND_OPTION_MTU;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -36,7 +36,7 @@ import java.nio.ByteOrder;
* | MTU |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
public class MtuOption extends Struct {
public class MtuOption extends LegacyStruct {
@Field(order = 0, type = Type.S8)
public final byte type;
@Field(order = 1, type = Type.S8)

4
staticlibs/device/com/android/net/module/util/structs/NaHeader.java
View file

@ -16,7 +16,7 @@
package com.android.net.module.util.structs;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -44,7 +44,7 @@ import java.net.Inet6Address;
* | Options ...
* +-+-+-+-+-+-+-+-+-+-+-+-
*/
public class NaHeader extends Struct {
public class NaHeader extends LegacyStruct {
@Field(order = 0, type = Type.S32)
public int flags; // Router flag, Solicited flag, Override flag and 29 Reserved bits.
@Field(order = 1, type = Type.Ipv6Address)

4
staticlibs/device/com/android/net/module/util/structs/NsHeader.java
View file

@ -16,7 +16,7 @@
package com.android.net.module.util.structs;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -44,7 +44,7 @@ import java.net.Inet6Address;
* | Options ...
* +-+-+-+-+-+-+-+-+-+-+-+-
*/
public class NsHeader extends Struct {
public class NsHeader extends LegacyStruct {
@Field(order = 0, type = Type.S32)
public int reserved; // 32 Reserved bits.
@Field(order = 1, type = Type.Ipv6Address)

4
staticlibs/device/com/android/net/module/util/structs/PrefixInformationOption.java
View file

@ -23,7 +23,7 @@ import android.net.IpPrefix;
import androidx.annotation.NonNull;
import androidx.annotation.VisibleForTesting;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Computed;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -57,7 +57,7 @@ import java.nio.ByteOrder;
* | |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
public class PrefixInformationOption extends Struct {
public class PrefixInformationOption extends LegacyStruct {
@Field(order = 0, type = Type.S8)
public final byte type;
@Field(order = 1, type = Type.S8)

4
staticlibs/device/com/android/net/module/util/structs/RaHeader.java
View file

@ -16,7 +16,7 @@
package com.android.net.module.util.structs;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -38,7 +38,7 @@ import com.android.net.module.util.Struct.Type;
* | Options ...
* +-+-+-+-+-+-+-+-+-+-+-+-
*/
public class RaHeader extends Struct {
public class RaHeader extends LegacyStruct {
@Field(order = 0, type = Type.S8)
public final byte hopLimit;
// "Managed address configuration", "Other configuration" bits, and 6 reserved bits

4
staticlibs/device/com/android/net/module/util/structs/RouteInformationOption.java
View file

@ -22,7 +22,7 @@ import android.net.IpPrefix;
import androidx.annotation.NonNull;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -44,7 +44,7 @@ import java.nio.ByteOrder;
* . .
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
*/
public class RouteInformationOption extends Struct {
public class RouteInformationOption extends LegacyStruct {
public enum Preference {
HIGH((byte) 0x1),
MEDIUM((byte) 0x0),

4
staticlibs/device/com/android/net/module/util/structs/RsHeader.java
View file

@ -16,7 +16,7 @@
package com.android.net.module.util.structs;
import com.android.net.module.util.Struct;
import com.android.net.module.util.LegacyStruct;
import com.android.net.module.util.Struct.Field;
import com.android.net.module.util.Struct.Type;
@ -34,7 +34,7 @@ import com.android.net.module.util.Struct.Type;
* | Options ...
* +-+-+-+-+-+-+-+-+-+-+-+-
*/
public class RsHeader extends Struct {
public class RsHeader extends LegacyStruct {
@Field(order = 0, type = Type.S32)
public final int reserved;