org.neo4j.consistency.checking.NodeDynamicLabelOrphanChainStartCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-consistency-check Show documentation
Tool for checking consistency of a Neo4j data store.
There is a newer version: 5.26.0
Show newest version
/*
 * Copyright (c) 2002-2020 "Neo4j,"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.consistency.checking;

import org.neo4j.consistency.checking.full.FullCheck;
import org.neo4j.consistency.report.ConsistencyReport.DynamicLabelConsistencyReport;
import org.neo4j.consistency.store.RecordAccess;
import org.neo4j.kernel.impl.store.record.DynamicRecord;
import org.neo4j.kernel.impl.store.record.NodeRecord;

import static org.neo4j.kernel.impl.store.NodeLabelsField.fieldPointsToDynamicRecordOfLabels;
import static org.neo4j.kernel.impl.store.NodeLabelsField.firstDynamicLabelRecordId;
import static org.neo4j.kernel.impl.store.NodeStore.readOwnerFromDynamicLabelsRecord;

/**
 * Used by {@link FullCheck} to verify orphanage for node dynamic label records.
 *
 * Actual list of labels is verified from {@link NodeRecordCheck}
 */
public class NodeDynamicLabelOrphanChainStartCheck
        implements RecordCheck,
        ComparativeRecordChecker
{

    private static final
    ComparativeRecordChecker VALID_NODE_RECORD =
            ( record, nodeRecord, engine, records ) ->
            {
                if ( ! nodeRecord.inUse() )
                {
                    // if this node record is not in use it is not a valid owner
                    engine.report().orphanDynamicLabelRecordDueToInvalidOwner( nodeRecord );
                }
                else
                {
                    // if this node record is in use but doesn't point to the dynamic label record
                    // that label record has an invalid owner
                    long recordId = record.getId();
                    if ( fieldPointsToDynamicRecordOfLabels( nodeRecord.getLabelField() ) )
                    {
                        long dynamicLabelRecordId = firstDynamicLabelRecordId( nodeRecord.getLabelField() );
                        if ( dynamicLabelRecordId != recordId )
                        {
                            engine.report().orphanDynamicLabelRecordDueToInvalidOwner( nodeRecord );
                        }
                    }
                }
            };

    @Override
    public void check( DynamicRecord record,
                       CheckerEngine engine,
                       RecordAccess records )
    {
        if ( record.inUse() && record.isStartRecord() )
        {
            Long ownerId = readOwnerFromDynamicLabelsRecord( record );
            if ( null == ownerId )
            {
                // no owner but in use indicates a broken record
                engine.report().orphanDynamicLabelRecord();
            }
            else
            {
                // look at owning node record to verify consistency
                engine.comparativeCheck( records.node( ownerId ), VALID_NODE_RECORD );
            }
        }
    }

    @Override
    public void checkReference( DynamicRecord record, DynamicRecord record2,
                                CheckerEngine engine,
                                RecordAccess records )
    {
    }
}