org.apache.flink.runtime.state.KeyedBackendStateMetaInfoSnapshotReaderWriters Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.flink.runtime.state;
import org.apache.flink.api.common.state.StateDescriptor;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.api.common.typeutils.TypeSerializerConfigSnapshot;
import org.apache.flink.api.common.typeutils.TypeSerializerSerializationUtil;
import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.core.memory.DataInputView;
import org.apache.flink.core.memory.DataOutputView;
import org.apache.flink.util.Preconditions;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
/**
* Readers and writers for different versions of the {@link RegisteredKeyedBackendStateMetaInfo.Snapshot}.
* Outdated formats are also kept here for documentation of history backlog.
*/
public class KeyedBackendStateMetaInfoSnapshotReaderWriters {
// -------------------------------------------------------------------------------
// Writers
// - v1: Flink 1.2.x
// - v2: Flink 1.3.x
// -------------------------------------------------------------------------------
public static KeyedBackendStateMetaInfoWriter getWriterForVersion(
int version, RegisteredKeyedBackendStateMetaInfo.Snapshot stateMetaInfo) {
switch (version) {
case 1:
case 2:
return new KeyedBackendStateMetaInfoWriterV1V2<>(stateMetaInfo);
case 3:
// current version
case KeyedBackendSerializationProxy.VERSION:
return new KeyedBackendStateMetaInfoWriterV3<>(stateMetaInfo);
default:
// guard for future
throw new IllegalStateException(
"Unrecognized keyed backend state meta info writer version: " + version);
}
}
public interface KeyedBackendStateMetaInfoWriter {
void writeStateMetaInfo(DataOutputView out) throws IOException;
}
static abstract class AbstractKeyedBackendStateMetaInfoWriter implements KeyedBackendStateMetaInfoWriter {
protected final RegisteredKeyedBackendStateMetaInfo.Snapshot stateMetaInfo;
public AbstractKeyedBackendStateMetaInfoWriter(RegisteredKeyedBackendStateMetaInfo.Snapshot stateMetaInfo) {
this.stateMetaInfo = Preconditions.checkNotNull(stateMetaInfo);
}
}
static class KeyedBackendStateMetaInfoWriterV1V2 extends AbstractKeyedBackendStateMetaInfoWriter {
public KeyedBackendStateMetaInfoWriterV1V2(RegisteredKeyedBackendStateMetaInfo.Snapshot stateMetaInfo) {
super(stateMetaInfo);
}
@Override
public void writeStateMetaInfo(DataOutputView out) throws IOException {
out.writeInt(stateMetaInfo.getStateType().ordinal());
out.writeUTF(stateMetaInfo.getName());
TypeSerializerSerializationUtil.writeSerializer(out, stateMetaInfo.getNamespaceSerializer());
TypeSerializerSerializationUtil.writeSerializer(out, stateMetaInfo.getStateSerializer());
}
}
static class KeyedBackendStateMetaInfoWriterV3 extends AbstractKeyedBackendStateMetaInfoWriter {
public KeyedBackendStateMetaInfoWriterV3(RegisteredKeyedBackendStateMetaInfo.Snapshot stateMetaInfo) {
super(stateMetaInfo);
}
@Override
public void writeStateMetaInfo(DataOutputView out) throws IOException {
out.writeInt(stateMetaInfo.getStateType().ordinal());
out.writeUTF(stateMetaInfo.getName());
// write in a way that allows us to be fault-tolerant and skip blocks in the case of java serialization failures
TypeSerializerSerializationUtil.writeSerializersAndConfigsWithResilience(
out,
Arrays.asList(
new Tuple2, TypeSerializerConfigSnapshot>(
stateMetaInfo.getNamespaceSerializer(), stateMetaInfo.getNamespaceSerializerConfigSnapshot()),
new Tuple2, TypeSerializerConfigSnapshot>(
stateMetaInfo.getStateSerializer(), stateMetaInfo.getStateSerializerConfigSnapshot())));
}
}
// -------------------------------------------------------------------------------
// Readers
// - v1: Flink 1.2.x
// - v2: Flink 1.3.x
// -------------------------------------------------------------------------------
public static KeyedBackendStateMetaInfoReader getReaderForVersion(
int version, ClassLoader userCodeClassLoader) {
switch (version) {
case 1:
case 2:
return new KeyedBackendStateMetaInfoReaderV1V2<>(userCodeClassLoader);
// current version
case 3:
case KeyedBackendSerializationProxy.VERSION:
return new KeyedBackendStateMetaInfoReaderV3<>(userCodeClassLoader);
default:
// guard for future
throw new IllegalStateException(
"Unrecognized keyed backend state meta info reader version: " + version);
}
}
public interface KeyedBackendStateMetaInfoReader {
RegisteredKeyedBackendStateMetaInfo.Snapshot readStateMetaInfo(DataInputView in) throws IOException;
}
static abstract class AbstractKeyedBackendStateMetaInfoReader implements KeyedBackendStateMetaInfoReader {
protected final ClassLoader userCodeClassLoader;
public AbstractKeyedBackendStateMetaInfoReader(ClassLoader userCodeClassLoader) {
this.userCodeClassLoader = Preconditions.checkNotNull(userCodeClassLoader);
}
}
static class KeyedBackendStateMetaInfoReaderV1V2 extends AbstractKeyedBackendStateMetaInfoReader {
public KeyedBackendStateMetaInfoReaderV1V2(ClassLoader userCodeClassLoader) {
super(userCodeClassLoader);
}
@Override
public RegisteredKeyedBackendStateMetaInfo.Snapshot readStateMetaInfo(DataInputView in) throws IOException {
RegisteredKeyedBackendStateMetaInfo.Snapshot metaInfo =
new RegisteredKeyedBackendStateMetaInfo.Snapshot<>();
metaInfo.setStateType(StateDescriptor.Type.values()[in.readInt()]);
metaInfo.setName(in.readUTF());
metaInfo.setNamespaceSerializer(TypeSerializerSerializationUtil.tryReadSerializer(in, userCodeClassLoader));
metaInfo.setStateSerializer(TypeSerializerSerializationUtil.tryReadSerializer(in, userCodeClassLoader));
// older versions do not contain the configuration snapshot
metaInfo.setNamespaceSerializerConfigSnapshot(null);
metaInfo.setStateSerializerConfigSnapshot(null);
return metaInfo;
}
}
@SuppressWarnings("unchecked")
static class KeyedBackendStateMetaInfoReaderV3 extends AbstractKeyedBackendStateMetaInfoReader {
public KeyedBackendStateMetaInfoReaderV3(ClassLoader userCodeClassLoader) {
super(userCodeClassLoader);
}
@Override
public RegisteredKeyedBackendStateMetaInfo.Snapshot readStateMetaInfo(DataInputView in) throws IOException {
RegisteredKeyedBackendStateMetaInfo.Snapshot metaInfo =
new RegisteredKeyedBackendStateMetaInfo.Snapshot<>();
metaInfo.setStateType(StateDescriptor.Type.values()[in.readInt()]);
metaInfo.setName(in.readUTF());
List, TypeSerializerConfigSnapshot>> serializersAndConfigs =
TypeSerializerSerializationUtil.readSerializersAndConfigsWithResilience(in, userCodeClassLoader);
metaInfo.setNamespaceSerializer((TypeSerializer) serializersAndConfigs.get(0).f0);
metaInfo.setNamespaceSerializerConfigSnapshot(serializersAndConfigs.get(0).f1);
metaInfo.setStateSerializer((TypeSerializer) serializersAndConfigs.get(1).f0);
metaInfo.setStateSerializerConfigSnapshot(serializersAndConfigs.get(1).f1);
return metaInfo;
}
}
}