opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/PayloadVersion.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.datastore.persisted;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.annotations.VisibleForTesting;
  14 import java.io.DataInput;
  15 import java.io.DataOutput;
  16 import java.io.IOException;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.opendaylight.yangtools.concepts.WritableObject;
  19 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeStreamVersion;
  20
  21 /**
  22  * Enumeration of all ABI versions supported by this implementation of persistence. An ABI version has to be bumped
  23  * whenever:
  24  * <ul>
  25  * <li>a new event is defined</li>
  26  * <li>serialization format is changed</li>
  27  * </ul>
  28  *
  29  * <p>
  30  * This version effectively defines the protocol version between actors participating on a particular shard. A shard
  31  * participant instance should oppose RAFT candidates which produce persistence of an unsupported version. If a follower
  32  * encounters an unsupported version it must not become fully-operational, as it does not have an accurate view
  33  * of shard state.
  34  */
  35 @Beta
  36 public enum PayloadVersion implements WritableObject {
  37     // NOTE: enumeration values need to be sorted in ascending order of their version to keep Comparable working
  38
  39     /**
  40      * Version which is older than any other version. This version exists purely for testing purposes.
  41      */
  42     @VisibleForTesting
  43     TEST_PAST_VERSION(0) {
  44         @Override
  45         public NormalizedNodeStreamVersion getStreamVersion() {
  46             throw new UnsupportedOperationException();
  47         }
  48     },
  49
  50     /**
  51      * ABI version shipped enabled {@code 2022.09 Chlorine SR2}. This version revises the serialization format of
  52      * payloads proxies to reduce their size. Otherwise this format is equivalent to {@code #MAGNESIUM}.
  53      *
  54      * @deprecated Use {@link #POTASSIUM} instead.
  55      */
  56     @Deprecated(since = "8.0.0", forRemoval = true)
  57     CHLORINE_SR2(9) {
  58         @Override
  59         public NormalizedNodeStreamVersion getStreamVersion() {
  60             return NormalizedNodeStreamVersion.MAGNESIUM;
  61         }
  62     },
  63
  64     /**
  65      * ABI version shipped enabled {@code 2023.09 Potassium}. This version removes Augmentation identifier and nodes.
  66      * Otherwise this format is equivalent to {@link #CHLORINE_SR2}.
  67      */
  68     POTASSIUM(10) {
  69         @Override
  70         public NormalizedNodeStreamVersion getStreamVersion() {
  71             return NormalizedNodeStreamVersion.POTASSIUM;
  72         }
  73     },
  74
  75     /**
  76      * Version which is newer than any other version. This version exists purely for testing purposes.
  77      */
  78     @VisibleForTesting
  79     TEST_FUTURE_VERSION(65535) {
  80         @Override
  81         public NormalizedNodeStreamVersion getStreamVersion() {
  82             throw new UnsupportedOperationException();
  83         }
  84     };
  85
  86     private final short value;
  87
  88     PayloadVersion(final int intVersion) {
  89         checkArgument(intVersion >= 0 && intVersion <= 65535);
  90         value = (short) intVersion;
  91     }
  92
  93     /**
  94      * Return the unsigned short integer identifying this version.
  95      *
  96      * @return Unsigned short integer identifying this version
  97      */
  98     public short shortValue() {
  99         return value;
 100     }
 101
 102     /**
 103      * Return the NormalizedNode stream version corresponding to this particular ABI.
 104      *
 105      * @return Stream Version to use for this ABI version
 106      */
 107     public abstract @NonNull NormalizedNodeStreamVersion getStreamVersion();
 108
 109     /**
 110      * Return the codebase-native persistence version. This version is the default version allocated to messages
 111      * at runtime. Conversion to previous versions may incur additional overhead (such as object allocation).
 112      *
 113      * @return Current {@link PayloadVersion}
 114      */
 115     public static @NonNull PayloadVersion current() {
 116         return POTASSIUM;
 117     }
 118
 119     /**
 120      * Return the {@link PayloadVersion} corresponding to an unsigned short integer. This method is provided for callers
 121      * which provide their own recovery strategy in case of version incompatibility.
 122      *
 123      * @param version Short integer as returned from {@link #shortValue()}
 124      * @return {@link PayloadVersion}
 125      * @throws FutureVersionException if the specified integer identifies a future version
 126      * @throws PastVersionException if the specified integer identifies a past version which is no longer supported
 127      */
 128     public static @NonNull PayloadVersion valueOf(final short version)
 129             throws FutureVersionException, PastVersionException {
 130         return switch (Short.toUnsignedInt(version)) {
 131             case 0, 1, 2, 3, 4, 5, 6, 7, 8 -> throw new PastVersionException(version, CHLORINE_SR2);
 132             case 9 -> CHLORINE_SR2;
 133             case 10 -> POTASSIUM;
 134             default -> throw new FutureVersionException(version, CHLORINE_SR2);
 135         };
 136     }
 137
 138     @Override
 139     public void writeTo(final DataOutput out) throws IOException {
 140         out.writeShort(value);
 141     }
 142
 143     /**
 144      * Read an {@link PayloadVersion} from a {@link DataInput}. This method is provided for callers which do not have
 145      * a recovery strategy for dealing with unsupported versions.
 146      *
 147      * @param in Input from which to read
 148      * @return An {@link PayloadVersion}
 149      * @throws IOException If read fails or an unsupported version is encountered
 150      */
 151     public static @NonNull PayloadVersion readFrom(final @NonNull DataInput in) throws IOException {
 152         final short s = in.readShort();
 153         try {
 154             return valueOf(s);
 155         } catch (FutureVersionException | PastVersionException e) {
 156             throw new IOException(e);
 157         }
 158     }
 159 }