io.sirix.access.trx.page.TreeModifierImpl Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2022, SirixDB
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the  nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package io.sirix.access.trx.page;

import io.sirix.api.PageReadOnlyTrx;
import io.sirix.cache.TransactionIntentLog;
import io.sirix.index.IndexType;
import io.sirix.page.IndirectPage;
import io.sirix.page.PageReference;
import io.sirix.page.RevisionRootPage;
import io.sirix.page.UberPage;
import io.sirix.settings.Constants;
import org.checkerframework.checker.index.qual.NonNegative;
import io.sirix.cache.PageContainer;

/**
 * @author Johannes Lichtenberger
 */
public final class TreeModifierImpl implements TreeModifier {

  /**
   * Package private constructor.
   */
  TreeModifierImpl() {
  }

  @Override
  public RevisionRootPage preparePreviousRevisionRootPage(final UberPage uberPage, final NodePageReadOnlyTrx pageRtx,
      final TransactionIntentLog log, final @NonNegative int baseRevision, final @NonNegative int representRevision) {
    final RevisionRootPage revisionRootPage;

    if (uberPage.isBootstrap()) {
      revisionRootPage = pageRtx.loadRevRoot(baseRevision);
    } else {
      // Prepare revision root nodePageReference.
      revisionRootPage = new RevisionRootPage(pageRtx.loadRevRoot(baseRevision), representRevision + 1);

      // Link the prepared revision root nodePageReference with the prepared indirect tree.
      log.put(new PageReference(), PageContainer.getInstance(revisionRootPage, revisionRootPage));
    }

    // Return prepared revision root nodePageReference.
    return revisionRootPage;
  }

  @Override
  public PageReference prepareLeafOfTree(final PageReadOnlyTrx pageRtx, final TransactionIntentLog log,
      final int[] inpLevelPageCountExp, final PageReference startReference, @NonNegative final long pageKey,
      final int index, final IndexType indexType, final RevisionRootPage revisionRootPage) {
    // Initial state pointing to the indirect nodePageReference of level 0.
    PageReference reference = startReference;

    int offset;
    long levelKey = pageKey;

    int maxHeight = pageRtx.getCurrentMaxIndirectPageTreeLevel(indexType, index, revisionRootPage);

    // Check if we need an additional level of indirect pages.
    if (pageKey == (1L << inpLevelPageCountExp[inpLevelPageCountExp.length - maxHeight - 1])) {
      maxHeight = incrementCurrentMaxIndirectPageTreeLevel(pageRtx, revisionRootPage, indexType, index);

      // First, get the old referenced page.
      final IndirectPage oldPage = dereferenceOldIndirectPage(pageRtx, log, reference);

      // Add a new indirect page to the top of the tree and to the transaction-log.
      final IndirectPage page = new IndirectPage();

      // Get the first reference.
      final PageReference newReference = page.getOrCreateReference(0);

      // Set new reference in log with the old referenced page.
      log.put(newReference, PageContainer.getInstance(oldPage, oldPage));

      // Create new page reference, add it to the transaction-log and reassign it in the root pages
      // of the tree.
      final PageReference newPageReference = new PageReference();
      log.put(newPageReference, PageContainer.getInstance(page, page));
      setNewIndirectPage(pageRtx, revisionRootPage, indexType, index, newPageReference);

      reference = newPageReference;
    }

    // Iterate through all levels.
    for (int level = inpLevelPageCountExp.length - maxHeight, height = inpLevelPageCountExp.length; level < height;
        level++) {
      offset = (int) (levelKey >> inpLevelPageCountExp[level]);
      levelKey -= (long) offset << inpLevelPageCountExp[level];
      final IndirectPage page = prepareIndirectPage(pageRtx, log, reference);
      reference = page.getOrCreateReference(offset);
    }

    // Return reference to leaf of indirect tree.
    return reference;
  }

  private IndirectPage dereferenceOldIndirectPage(final PageReadOnlyTrx pageRtx, final TransactionIntentLog log,
      PageReference reference) throws AssertionError {
    final PageContainer cont = log.get(reference);
    IndirectPage oldPage = cont == null ? null : (IndirectPage) cont.getComplete();
    if (oldPage == null) {
      if (reference.getKey() == Constants.NULL_ID_LONG) {
        throw new AssertionError("The referenced page on top must of our tree must exist (first IndirectPage).");
      } else {
        final IndirectPage indirectPage = pageRtx.dereferenceIndirectPageReference(reference);
        oldPage = new IndirectPage(indirectPage);
      }
    }
    return oldPage;
  }

  private void setNewIndirectPage(final PageReadOnlyTrx pageRtx, final RevisionRootPage revisionRoot,
      final IndexType indexType, final int index, final PageReference pageReference) {
    // $CASES-OMITTED$
    switch (indexType) {
      case DOCUMENT -> revisionRoot.setOrCreateReference(0, pageReference);
      case CHANGED_NODES -> revisionRoot.setOrCreateReference(1, pageReference);
      case RECORD_TO_REVISIONS -> revisionRoot.setOrCreateReference(2, pageReference);
      case CAS -> pageRtx.getCASPage(revisionRoot).setOrCreateReference(index, pageReference);
      case PATH -> pageRtx.getPathPage(revisionRoot).setOrCreateReference(index, pageReference);
      case NAME -> pageRtx.getNamePage(revisionRoot).setOrCreateReference(index, pageReference);
      case PATH_SUMMARY -> pageRtx.getPathSummaryPage(revisionRoot).setOrCreateReference(index, pageReference);
      default -> throw new IllegalStateException(
          "Only defined for node, path summary, text value and attribute value pages!");
    }
  }

  private int incrementCurrentMaxIndirectPageTreeLevel(final PageReadOnlyTrx pageRtx,
      final RevisionRootPage revisionRoot, final IndexType indexType, final int index) {
    // $CASES-OMITTED$
    return switch (indexType) {
      case DOCUMENT -> revisionRoot.incrementAndGetCurrentMaxLevelOfDocumentIndexIndirectPages();
      case CHANGED_NODES -> revisionRoot.incrementAndGetCurrentMaxLevelOfChangedNodesIndexIndirectPages();
      case RECORD_TO_REVISIONS -> revisionRoot.incrementAndGetCurrentMaxLevelOfRecordToRevisionsIndexIndirectPages();
      case CAS -> pageRtx.getCASPage(revisionRoot).incrementAndGetCurrentMaxLevelOfIndirectPages(index);
      case PATH -> pageRtx.getPathPage(revisionRoot).incrementAndGetCurrentMaxLevelOfIndirectPages(index);
      case NAME -> pageRtx.getNamePage(revisionRoot).incrementAndGetCurrentMaxLevelOfIndirectPages(index);
      case PATH_SUMMARY -> pageRtx.getPathSummaryPage(revisionRoot)
                                  .incrementAndGetCurrentMaxLevelOfIndirectPages(index);
      default -> throw new IllegalStateException(
          "Only defined for node, path summary, text value and attribute value pages!");
    };
  }

  @Override
  public IndirectPage prepareIndirectPage(final PageReadOnlyTrx pageRtx, final TransactionIntentLog log,
      final PageReference reference) {
    final PageContainer cont = log.get(reference);
    IndirectPage page = cont == null ? null : (IndirectPage) cont.getComplete();
    if (page == null) {
      if (reference.getKey() == Constants.NULL_ID_LONG) {
        page = new IndirectPage();
      } else {
        final IndirectPage indirectPage = pageRtx.dereferenceIndirectPageReference(reference);
        page = new IndirectPage(indirectPage);
      }
      log.put(reference, PageContainer.getInstance(page, page));
    }
    return page;
  }
}