content: /*
   * 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.db.streaming;
  
  import java.io.IOException;
  import java.nio.ByteBuffer;
  import java.nio.channels.WritableByteChannel;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.concurrent.Callable;
  import java.util.concurrent.CountDownLatch;
  import java.util.concurrent.ExecutorService;
  import java.util.concurrent.Executors;
  import java.util.concurrent.Future;
  import java.util.concurrent.TimeUnit;
  
  import com.google.common.collect.ImmutableMap;
  import com.google.common.collect.Iterables;
  import org.junit.After;
  import org.junit.AfterClass;
  import org.junit.Before;
  import org.junit.BeforeClass;
  import org.junit.Test;
  import org.junit.runner.RunWith;
  
  import io.netty.buffer.ByteBuf;
  import io.netty.buffer.Unpooled;
  import io.netty.channel.ChannelHandlerContext;
  import io.netty.channel.ChannelOutboundHandlerAdapter;
  import io.netty.channel.ChannelPromise;
  import io.netty.channel.embedded.EmbeddedChannel;
  import org.apache.cassandra.SchemaLoader;
  import org.apache.cassandra.Util;
  import org.apache.cassandra.db.ColumnFamilyStore;
  import org.apache.cassandra.db.Keyspace;
  import org.apache.cassandra.db.RowUpdateBuilder;
  import org.apache.cassandra.db.compaction.CompactionManager;
  import org.apache.cassandra.db.compaction.OperationType;
  import org.apache.cassandra.db.lifecycle.LifecycleTransaction;
  import org.apache.cassandra.db.lifecycle.StreamingLifecycleTransaction;
  import org.apache.cassandra.dht.ByteOrderedPartitioner;
  import org.apache.cassandra.dht.Range;
  import org.apache.cassandra.dht.Token;
  import org.apache.cassandra.io.sstable.Descriptor;
  import org.apache.cassandra.io.sstable.SSTableTxnSingleStreamWriter;
  import org.apache.cassandra.io.sstable.SSTableUtils;
  import org.apache.cassandra.io.sstable.format.SSTableReader;
  import org.apache.cassandra.io.sstable.indexsummary.IndexSummaryManager;
  import org.apache.cassandra.io.sstable.indexsummary.IndexSummaryRedistribution;
  import org.apache.cassandra.io.util.DataInputBuffer;
  import org.apache.cassandra.locator.InetAddressAndPort;
  import org.apache.cassandra.locator.RangesAtEndpoint;
  import org.apache.cassandra.net.AsyncStreamingOutputPlus;
  import org.apache.cassandra.net.BufferPoolAllocator;
  import org.apache.cassandra.net.MessagingService;
  import org.apache.cassandra.net.SharedDefaultFileRegion;
  import org.apache.cassandra.schema.KeyspaceParams;
  import org.apache.cassandra.schema.SchemaTestUtil;
  import org.apache.cassandra.schema.TableMetadata;
  import org.apache.cassandra.service.ActiveRepairService;
  import org.apache.cassandra.streaming.OutgoingStream;
  import org.apache.cassandra.streaming.PreviewKind;
  import org.apache.cassandra.streaming.SessionInfo;
  import org.apache.cassandra.streaming.StreamCoordinator;
  import org.apache.cassandra.streaming.StreamOperation;
  import org.apache.cassandra.streaming.StreamResultFuture;
  import org.apache.cassandra.streaming.StreamSession;
  import org.apache.cassandra.streaming.StreamSummary;
  import org.apache.cassandra.streaming.async.NettyStreamingConnectionFactory;
  import org.apache.cassandra.streaming.messages.StreamMessageHeader;
  import org.apache.cassandra.utils.ByteBufferUtil;
  import org.apache.cassandra.utils.FBUtilities;
  import org.apache.cassandra.utils.Throwables;
  import org.jboss.byteman.contrib.bmunit.BMRule;
  import org.jboss.byteman.contrib.bmunit.BMUnitRunner;
  
  import static java.util.Collections.emptyList;
  import static org.apache.cassandra.service.ActiveRepairService.NO_PENDING_REPAIR;
  import static org.apache.cassandra.utils.TimeUUID.Generator.nextTimeUUID;
  import static org.junit.Assert.assertTrue;
  
  @RunWith(BMUnitRunner.class)
  public class EntireSSTableStreamConcurrentComponentMutationTest
  {
      public static final String KEYSPACE = "CassandraEntireSSTableStreamLockTest";
      public static final String CF_STANDARD = "Standard1";
  
      private static final Callable<?> NO_OP = () -> null;
  
      private static SSTableReader sstable;
      private static Descriptor descriptor;
      private static ColumnFamilyStore store;
      private static RangesAtEndpoint rangesAtEndpoint;
  
      private static ExecutorService service;
  
      private static CountDownLatch latch = new CountDownLatch(1);
  
      @BeforeClass
      public static void defineSchemaAndPrepareSSTable()
      {
          SchemaLoader.prepareServer();
          SchemaLoader.createKeyspace(KEYSPACE,
                                      KeyspaceParams.simple(1),
                                      SchemaLoader.standardCFMD(KEYSPACE, CF_STANDARD));
  
          Keyspace keyspace = Keyspace.open(KEYSPACE);
          store = keyspace.getColumnFamilyStore("Standard1");
  
          // insert data and compact to a single sstable
          CompactionManager.instance.disableAutoCompaction();
          for (int j = 0; j < 10; j++)
          {
              new RowUpdateBuilder(store.metadata(), j, String.valueOf(j))
              .clustering("0")
              .add("val", ByteBufferUtil.EMPTY_BYTE_BUFFER)
              .build()
              .applyUnsafe();
          }
          Util.flush(store);
          CompactionManager.instance.performMaximal(store);
  
          Token start = ByteOrderedPartitioner.instance.getTokenFactory().fromString(Long.toHexString(0));
          Token end = ByteOrderedPartitioner.instance.getTokenFactory().fromString(Long.toHexString(100));
          rangesAtEndpoint = RangesAtEndpoint.toDummyList(Collections.singleton(new Range<>(start, end)));
  
          service = Executors.newFixedThreadPool(2);
      }
  
      @AfterClass
      public static void cleanup()
      {
          service.shutdown();
      }
  
      @Before
      public void init()
      {
          sstable = store.getLiveSSTables().iterator().next();
          descriptor = sstable.descriptor;
      }
  
      @After
      public void reset() throws IOException
      {
          latch = new CountDownLatch(1);
          // reset repair info to avoid test interfering each other
          descriptor.getMetadataSerializer().mutateRepairMetadata(descriptor, 0, ActiveRepairService.NO_PENDING_REPAIR, false);
      }
  
      @Test
      public void testStream() throws Throwable
      {
          testStreamWithConcurrentComponentMutation(NO_OP, NO_OP);
      }
  
      /**
       * Entire-sstable-streaming receiver will throw checksum validation failure because concurrent stats metadata
       * update causes the actual transfered file size to be different from the one in {@link ComponentManifest}
       */
      @Test
      public void testStreamWithStatsMutation() throws Throwable
      {
          testStreamWithConcurrentComponentMutation(() -> {
  
              Descriptor desc = sstable.descriptor;
              desc.getMetadataSerializer().mutate(desc, "testing", stats -> stats.mutateRepairedMetadata(0, nextTimeUUID(), false));
  
              return null;
          }, NO_OP);
      }
  
      @Test
      @BMRule(name = "Delay saving index summary, manifest may link partially written file if there is no lock",
              targetClass = "SSTableReader",
              targetMethod = "saveSummary(Descriptor, DecoratedKey, DecoratedKey, IndexSummary)",
              targetLocation = "AFTER INVOKE serialize",
              condition = "$descriptor.cfname.contains(\"Standard1\")",
              action = "org.apache.cassandra.db.streaming.EntireSSTableStreamConcurrentComponentMutationTest.countDown();Thread.sleep(5000);")
      public void testStreamWithIndexSummaryRedistributionDelaySavingSummary() throws Throwable
      {
          testStreamWithConcurrentComponentMutation(() -> {
              // wait until new index summary is partially written
              latch.await(1, TimeUnit.MINUTES);
              return null;
          }, this::indexSummaryRedistribution);
      }
  
      // used by byteman
      private static void countDown()
      {
          latch.countDown();
      }
  
      private void testStreamWithConcurrentComponentMutation(Callable<?> runBeforeStreaming, Callable<?> runConcurrentWithStreaming) throws Throwable
      {
          ByteBuf serializedFile = Unpooled.buffer(8192);
          InetAddressAndPort peer = FBUtilities.getBroadcastAddressAndPort();
          StreamSession session = setupStreamingSessionForTest();
          Collection<OutgoingStream> outgoingStreams = store.getStreamManager().createOutgoingStreams(session, rangesAtEndpoint, NO_PENDING_REPAIR, PreviewKind.NONE);
          CassandraOutgoingFile outgoingFile = (CassandraOutgoingFile) Iterables.getOnlyElement(outgoingStreams);
  
          Future<?> streaming = executeAsync(() -> {
              runBeforeStreaming.call();
  
              try (AsyncStreamingOutputPlus out = new AsyncStreamingOutputPlus(createMockNettyChannel(serializedFile)))
              {
                  outgoingFile.write(session, out, MessagingService.current_version);
                  assertTrue(sstable.descriptor.getTemporaryFiles().isEmpty());
              }
              return null;
          });
  
          Future<?> concurrentMutations = executeAsync(runConcurrentWithStreaming);
  
          streaming.get(3, TimeUnit.MINUTES);
          concurrentMutations.get(3, TimeUnit.MINUTES);
  
          session.prepareReceiving(new StreamSummary(sstable.metadata().id, emptyList(), 1, 5104));
          StreamMessageHeader messageHeader = new StreamMessageHeader(sstable.metadata().id, peer, session.planId(), false, 0, 0, 0, null);
  
          try (DataInputBuffer in = new DataInputBuffer(serializedFile.nioBuffer(), false))
          {
              CassandraStreamHeader header = CassandraStreamHeader.serializer.deserialize(in, MessagingService.current_version);
              CassandraEntireSSTableStreamReader reader = new CassandraEntireSSTableStreamReader(messageHeader, header, session);
              StreamingLifecycleTransaction stt = new StreamingLifecycleTransaction();
              SSTableTxnSingleStreamWriter writer = (SSTableTxnSingleStreamWriter) reader.read(in);
              SSTableReader streamedSSTable = Iterables.getOnlyElement(writer.transferOwnershipTo(stt));
              SSTableUtils.assertContentEquals(sstable, streamedSSTable);
              stt.abort();
          }
      }
  
      private boolean indexSummaryRedistribution() throws IOException
      {
          long nonRedistributingOffHeapSize = 0;
          long memoryPoolBytes = 1024 * 1024;
  
          // rewrite index summary file with new min/max index interval
          TableMetadata origin = store.metadata();
          SchemaTestUtil.announceTableUpdate(origin.unbuild().minIndexInterval(1).maxIndexInterval(2).build());
  
          try (LifecycleTransaction txn = store.getTracker().tryModify(sstable, OperationType.INDEX_SUMMARY))
          {
              IndexSummaryManager.redistributeSummaries(new IndexSummaryRedistribution(ImmutableMap.of(store.metadata().id, txn),
                                                                                       nonRedistributingOffHeapSize,
                                                                                       memoryPoolBytes));
          }
  
          // reset min/max index interval
          SchemaTestUtil.announceTableUpdate(origin);
          return true;
      }
  
      private Future<?> executeAsync(Callable<?> task)
      {
          return service.submit(() -> {
              try
              {
                  task.call();
              }
              catch (Exception e)
              {
                  throw Throwables.unchecked(e);
              }
          });
      }
  
      private EmbeddedChannel createMockNettyChannel(ByteBuf serializedFile)
      {
          WritableByteChannel wbc = new WritableByteChannel()
          {
              private boolean isOpen = true;
              public int write(ByteBuffer src)
              {
                  int size = src.limit();
                  serializedFile.writeBytes(src);
                  return size;
              }
  
              public boolean isOpen()
              {
                  return isOpen;
              }
  
              public void close()
              {
                  isOpen = false;
              }
          };
  
          return new EmbeddedChannel(new ChannelOutboundHandlerAdapter() {
                  @Override
                  public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception
                  {
                      if (msg instanceof BufferPoolAllocator.Wrapped)
                      {
  
                          ByteBuffer buf = ((BufferPoolAllocator.Wrapped) msg).adopt();
                          wbc.write(buf);
                      }
                      else
                      {
                          ((SharedDefaultFileRegion) msg).transferTo(wbc, 0);
                      }
                      super.write(ctx, msg, promise);
                  }
              });
      }
  
      private StreamSession setupStreamingSessionForTest()
      {
          StreamCoordinator streamCoordinator = new StreamCoordinator(StreamOperation.BOOTSTRAP, 1, new NettyStreamingConnectionFactory(), false, false, null, PreviewKind.NONE);
          StreamResultFuture future = StreamResultFuture.createInitiator(nextTimeUUID(), StreamOperation.BOOTSTRAP, emptyList(), streamCoordinator);
  
          InetAddressAndPort peer = FBUtilities.getBroadcastAddressAndPort();
          streamCoordinator.addSessionInfo(new SessionInfo(peer, 0, peer, emptyList(), emptyList(), StreamSession.State.INITIALIZED, null));
  
          StreamSession session = streamCoordinator.getOrCreateOutboundSession(peer);
          session.init(future);
          return session;
      }
  }
  