test/simulator/main/org/apache/cassandra/simulator/paxos/PaxosClusterSimulation.java

/*
 * 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.cassandra.simulator.paxos;

import java.io.IOException;

import org.apache.cassandra.config.Config.PaxosVariant;
import org.apache.cassandra.distributed.api.ConsistencyLevel;
import org.apache.cassandra.simulator.RandomSource;
import org.apache.cassandra.simulator.ClusterSimulation;
import org.apache.cassandra.simulator.utils.KindOfSequence;

import static java.util.concurrent.TimeUnit.SECONDS;
import static org.apache.cassandra.distributed.api.ConsistencyLevel.SERIAL;

class PaxosClusterSimulation extends ClusterSimulation<PaxosSimulation> implements AutoCloseable
{
    @SuppressWarnings("UnusedReturnValue")
    static class Builder extends ClusterSimulation.Builder<PaxosSimulation>
    {
        PaxosVariant initialPaxosVariant = PaxosVariant.v2;
        PaxosVariant finalPaxosVariant = null;
        Boolean stateCache;
        ConsistencyLevel serialConsistency = SERIAL;

        public Builder consistency(ConsistencyLevel serialConsistency)
        {
            this.serialConsistency = serialConsistency;
            return this;
        }

        public Builder stateCache(Boolean stateCache)
        {
            this.stateCache = stateCache;
            return this;
        }

        public Builder initialPaxosVariant(PaxosVariant variant)
        {
            initialPaxosVariant = variant;
            return this;
        }

        public Builder finalPaxosVariant(PaxosVariant variant)
        {
            finalPaxosVariant = variant;
            return this;
        }

        public PaxosClusterSimulation create(long seed) throws IOException
        {
            RandomSource random = randomSupplier.get();
            random.reset(seed);
            return new PaxosClusterSimulation(random, seed, uniqueNum, this);
        }
    }

    PaxosClusterSimulation(RandomSource random, long seed, int uniqueNum, Builder builder) throws IOException
    {
        super(random, seed, uniqueNum, builder,
              config -> config.set("paxos_variant", builder.initialPaxosVariant.name())
                              .set("paxos_cache_size", (builder.stateCache != null ? builder.stateCache : random.uniformFloat() < 0.5) ? null : "0MiB")
                              .set("paxos_state_purging", "repaired")
                              .set("paxos_on_linearizability_violations", "log")
        ,
              (simulated, schedulers, cluster, options) -> {
                  int[] primaryKeys = primaryKeys(seed, builder.primaryKeyCount());
                  KindOfSequence.Period jitter = RandomSource.Choices.uniform(KindOfSequence.values()).choose(random)
                                                                     .period(builder.schedulerJitterNanos(), random);
                  return new PairOfSequencesPaxosSimulation(simulated, cluster, options.changePaxosVariantTo(builder.finalPaxosVariant),
                                                            builder.readChance().select(random), builder.concurrency(), builder.primaryKeySeconds(), builder.withinKeyConcurrency(),
                                                            builder.serialConsistency, schedulers, builder.debug(), seed,
                                                            primaryKeys, builder.secondsToSimulate() >= 0 ? SECONDS.toNanos(builder.secondsToSimulate()) : -1,
                                                            () -> jitter.get(random));
              });
    }

    private static int[] primaryKeys(long seed, int count)
    {
        int primaryKey = (int) (seed);
        int[] primaryKeys = new int[count];
        for (int i = 0 ; i < primaryKeys.length ; ++i)
            primaryKeys[i] = primaryKey += 1 << 20;
        return primaryKeys;
    }
}