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  * @author Robert Varga
  36  */
  37 @Beta
  38 public enum PayloadVersion implements WritableObject {
  39     // NOTE: enumeration values need to be sorted in ascending order of their version to keep Comparable working
  40
  41     /**
  42      * Version which is older than any other version. This version exists purely for testing purposes.
  43      */
  44     @VisibleForTesting
  45     TEST_PAST_VERSION(0) {
  46         @Override
  47         public NormalizedNodeStreamVersion getStreamVersion() {
  48             throw new UnsupportedOperationException();
  49         }
  50     },
  51
  52     /**
  53      * ABI version as shipped in Sodium SR1 Simultaneous Release. QName-bearing messages are using
  54      * {@link NormalizedNodeStreamVersion#SODIUM_SR1}, which improves encoding.
  55      */
  56     SODIUM_SR1(7) {
  57         @Override
  58         public NormalizedNodeStreamVersion getStreamVersion() {
  59             return NormalizedNodeStreamVersion.SODIUM_SR1;
  60         }
  61     },
  62
  63     /**
  64      * Revised payload version. Payloads remain the same as {@link #SODIUM_SR1}, but messages bearing QNames in any
  65      * shape are using {@link NormalizedNodeStreamVersion#MAGNESIUM}, which improves encoding.
  66      */
  67     MAGNESIUM(8) {
  68         @Override
  69         public NormalizedNodeStreamVersion getStreamVersion() {
  70             return NormalizedNodeStreamVersion.MAGNESIUM;
  71         }
  72     },
  73
  74     /**
  75      * ABI version shipped enabled {@code 2022.09 Chlorine SR2}. This version revises the serialization format of
  76      * payloads proxies to reduce their size. Otherwise this format is equivalent to {@link #MAGNESIUM}.
  77      */
  78     CHLORINE_SR2(9) {
  79         @Override
  80         public NormalizedNodeStreamVersion getStreamVersion() {
  81             return NormalizedNodeStreamVersion.MAGNESIUM;
  82         }
  83     },
  84
  85     /**
  86      * Version which is newer than any other version. This version exists purely for testing purposes.
  87      */
  88     @VisibleForTesting
  89     TEST_FUTURE_VERSION(65535) {
  90         @Override
  91         public NormalizedNodeStreamVersion getStreamVersion() {
  92             throw new UnsupportedOperationException();
  93         }
  94     };
  95
  96     private final short value;
  97
  98     PayloadVersion(final int intVersion) {
  99         checkArgument(intVersion >= 0 && intVersion <= 65535);
 100         value = (short) intVersion;
 101     }
 102
 103     /**
 104      * Return the unsigned short integer identifying this version.
 105      *
 106      * @return Unsigned short integer identifying this version
 107      */
 108     public short shortValue() {
 109         return value;
 110     }
 111
 112     /**
 113      * Return the NormalizedNode stream version corresponding to this particular ABI.
 114      *
 115      * @return Stream Version to use for this ABI version
 116      */
 117     public abstract @NonNull NormalizedNodeStreamVersion getStreamVersion();
 118
 119     /**
 120      * Return the codebase-native persistence version. This version is the default version allocated to messages
 121      * at runtime. Conversion to previous versions may incur additional overhead (such as object allocation).
 122      *
 123      * @return Current {@link PayloadVersion}
 124      */
 125     public static @NonNull PayloadVersion current() {
 126         return MAGNESIUM;
 127     }
 128
 129     /**
 130      * Return the {@link PayloadVersion} corresponding to an unsigned short integer. This method is provided for callers
 131      * which provide their own recovery strategy in case of version incompatibility.
 132      *
 133      * @param version Short integer as returned from {@link #shortValue()}
 134      * @return {@link PayloadVersion}
 135      * @throws FutureVersionException if the specified integer identifies a future version
 136      * @throws PastVersionException if the specified integer identifies a past version which is no longer supported
 137      */
 138     public static @NonNull PayloadVersion valueOf(final short version)
 139             throws FutureVersionException, PastVersionException {
 140         return switch (Short.toUnsignedInt(version)) {
 141             case 0, 1, 2, 3, 4, 5, 6 -> throw new PastVersionException(version, SODIUM_SR1);
 142             case 7 -> SODIUM_SR1;
 143             case 8 -> MAGNESIUM;
 144             case 9 -> CHLORINE_SR2;
 145             default -> throw new FutureVersionException(version, CHLORINE_SR2);
 146         };
 147     }
 148
 149     @Override
 150     public void writeTo(final DataOutput out) throws IOException {
 151         out.writeShort(value);
 152     }
 153
 154     /**
 155      * Read an {@link PayloadVersion} from a {@link DataInput}. This method is provided for callers which do not have
 156      * a recovery strategy for dealing with unsupported versions.
 157      *
 158      * @param in Input from which to read
 159      * @return An {@link PayloadVersion}
 160      * @throws IOException If read fails or an unsupported version is encountered
 161      */
 162     public static @NonNull PayloadVersion readFrom(final @NonNull DataInput in) throws IOException {
 163         final short s = in.readShort();
 164         try {
 165             return valueOf(s);
 166         } catch (FutureVersionException | PastVersionException e) {
 167             throw new IOException(e);
 168         }
 169     }
 170 }