/*
COPYRIGHT STATUS:
Dec 1st 2001, Fermi National Accelerator Laboratory (FNAL) documents and
software are sponsored by the U.S. Department of Energy under Contract No.
DE-AC02-76CH03000. Therefore, the U.S. Government retains a world-wide
non-exclusive, royalty-free license to publish or reproduce these documents
and software for U.S. Government purposes. All documents and software
available from this server are protected under the U.S. and Foreign
Copyright Laws, and FNAL reserves all rights.
Distribution of the software available from this server is free of
charge subject to the user following the terms of the Fermitools
Software Legal Information.
Redistribution and/or modification of the software shall be accompanied
by the Fermitools Software Legal Information (including the copyright
notice).
The user is asked to feed back problems, benefits, and/or suggestions
about the software to the Fermilab Software Providers.
Neither the name of Fermilab, the URA, nor the names of the contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
DISCLAIMER OF LIABILITY (BSD):
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 FERMILAB,
OR THE URA, OR THE U.S. DEPARTMENT of ENERGY, OR CONTRIBUTORS 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.
Liabilities of the Government:
This software is provided by URA, independent from its Prime Contract
with the U.S. Department of Energy. URA is acting independently from
the Government and in its own private capacity and is not acting on
behalf of the U.S. Government, nor as its contractor nor its agent.
Correspondingly, it is understood and agreed that the U.S. Government
has no connection to this software and in no manner whatsoever shall
be liable for nor assume any responsibility or obligation for any claim,
cost, or damages arising out of or resulting from the use of the software
available from this server.
Export Control:
All documents and software available from this server are subject to U.S.
export control laws. Anyone downloading information from this server is
obligated to secure any necessary Government licenses before exporting
documents or software obtained from this server.
*/
package org.dcache.resilience.data;
import com.google.common.annotations.VisibleForTesting;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.sql.Connection;
import java.util.ArrayList;
import java.util.Collection;
import diskCacheV111.util.AccessLatency;
import diskCacheV111.util.CacheException;
import diskCacheV111.util.FileNotFoundCacheException;
import diskCacheV111.util.PnfsId;
import org.dcache.resilience.db.LocalNamespaceAccess;
import org.dcache.resilience.db.NamespaceAccess;
import org.dcache.resilience.db.ScanSummary;
import org.dcache.resilience.handlers.FileOperationHandler;
import org.dcache.resilience.handlers.ResilienceMessageHandler;
import org.dcache.resilience.util.LocationSelector;
import org.dcache.resilience.data.PoolOperation.SelectionAction;
import org.dcache.vehicles.FileAttributes;
/**
* <p>A transient encapsulation of pertinent configuration data regarding
* a file location.</p>
*
* <p>Implements verification/validation methods to determine if the update
* should be registered in the operation map or not.</p>
*
* @see FileOperationMap#register(FileUpdate)
* @see FileOperationHandler#handleLocationUpdate(FileUpdate)
* @see ResilienceMessageHandler#updatePnfsLocation(FileUpdate)
* @see LocalNamespaceAccess#handleQuery(Connection, ScanSummary)
*/
public final class FileUpdate {
private static final Logger LOGGER = LoggerFactory.getLogger(
FileUpdate.class);
/**
* @return <code>null</code> if AccessLatency is not ONLINE, or if the file
* is not found or there are no locations for it and the
* message being processed is for a clear cache location; otherwise
* the file attribute set required to process resilience.
*/
public static FileAttributes getAttributes(PnfsId pnfsId, String pool,
MessageType messageType,
NamespaceAccess namespace)
throws CacheException {
try {
FileAttributes attributes = namespace.getRequiredAttributes(pnfsId);
if (attributes == null) {
throw new FileNotFoundCacheException(String.format("No attributes "
+ "returned for %s", pnfsId));
}
LOGGER.trace("Got required attributes for {}.", pnfsId);
if (!attributes.getAccessLatency().equals(AccessLatency.ONLINE)) {
LOGGER.trace("AccessLatency of {} is not ONLINE; ignoring ...",
pnfsId);
return null;
}
if (attributes.getLocations().isEmpty()) {
if (messageType == MessageType.CLEAR_CACHE_LOCATION) {
LOGGER.trace("ClearCacheLocationMessage for {}; "
+ "no current locations; "
+ "file probably deleted "
+ "from namespace.",
pnfsId);
return null;
}
/*
* Due to a possible race between PnfsManager and resilience
* to process the message into/from the namespace.
*
* We can assume here that this is a new file, so
* we just add the originating location to the attribute
* location list.
*/
LOGGER.trace("{} has no locations yet.", pnfsId);
Collection<String> singleLoc = new ArrayList<>();
singleLoc.add(pool);
attributes.setLocations(singleLoc);
}
LOGGER.debug("After call to namespace, {} has locations {}.",
pnfsId,
attributes.getLocations());
return attributes;
} catch (FileNotFoundCacheException e) {
/*
* Most likely we received a PnfsClearCacheLocationMessage
* as the result of a file deletion.
*/
LOGGER.debug("{}; {} has likely been deleted from the namespace.",
e.getMessage(),
pnfsId);
return null;
}
}
public final PnfsId pnfsId;
public final String pool;
public final MessageType type;
public final SelectionAction action;
final boolean isParent;
private final boolean isFullScan;
private Integer group;
private FileAttributes attributes;
private int poolIndex;
private Integer unitIndex;
private Integer count;
private boolean fromReload;
@VisibleForTesting
public FileUpdate(PnfsId pnfsId,
String pool,
MessageType type,
Integer poolIndex,
Integer groupIndex,
Integer unitIndex,
FileAttributes attributes) {
this(pnfsId, pool, type, SelectionAction.NONE, groupIndex, true);
this.poolIndex = poolIndex;
this.unitIndex = unitIndex;
this.attributes = attributes;
}
public FileUpdate(PnfsId pnfsId, String pool, MessageType type, boolean full) {
this(pnfsId, pool, type, SelectionAction.NONE, null, full);
}
/**
* @param pnfsId of the file.
* @param pool either the source of the message, or the pool being scanned.
* @param type CORRUPT_FILE, CLEAR_CACHE_LOCATION, ADD_CACHE_LOCATION,
* POOL_STATUS_DOWN, or POOL_STATUS_UP.
* @param action from PoolSelectionUnit (ADD, REMOVE, MODIFY, NONE).
* @param group of the pool, if action is not NONE or MODIFY
* (can be <code>null</code>).
* @param full if true, set the op count to the computed difference
* between required and readable; otherwise,
* set the op count to 1.
*/
public FileUpdate(PnfsId pnfsId, String pool, MessageType type,
SelectionAction action, Integer group, boolean full) {
this.pnfsId = pnfsId;
this.pool = pool;
this.type = type;
if (type == null) {
isParent = false;
} else {
switch (type) {
case POOL_STATUS_DOWN:
case POOL_STATUS_UP:
isParent = true;
break;
default:
isParent = false;
}
}
this.action = action;
this.group = group;
fromReload = false;
isFullScan = full;
}
public FileAttributes getAttributes() {
return attributes;
}
public Integer getCount() {
return count;
}
public Integer getGroup() {
return group;
}
public int getPoolIndex() {
return poolIndex;
}
public int getSelectionAction() {
return action.ordinal();
}
public long getSize() { return attributes.getSize(); }
public Integer getUnitIndex() {
return unitIndex;
}
public boolean isFromReload() {
return fromReload;
}
public void setCount(Integer count) {
this.count = count;
}
public void setFromReload(boolean fromReload) {
this.fromReload = fromReload;
}
public boolean shouldVerifySticky() {
return !isFromReload() && type != MessageType.CLEAR_CACHE_LOCATION &&
(!isParent || action == SelectionAction.ADD);
}
public String toString() {
return String.format(
"(%s)(%s)(%s)(parent %s)(psu action %s)(group %s)(count %s)",
pnfsId, pool, type, isParent, action, group, count);
}
public boolean validateAttributes(NamespaceAccess access)
throws CacheException {
LOGGER.trace("validateAttributes for {}", this);
attributes = getAttributes(pnfsId, pool, type, access);
LOGGER.trace("validateAttributes, {}", attributes);
return attributes != null;
}
public boolean validateForAction(Integer storageUnit,
PoolInfoMap poolInfoMap,
LocationSelector locationSelector) {
/*
* Storage unit is not recorded in checkpoint, so it should
* be set here.
*/
unitIndex = poolInfoMap.getStorageUnitIndex(attributes);
LOGGER.trace("validateForAction {} got unit from attributes {}.",
pnfsId, unitIndex);
/*
* Check to see if this is from a reload of the checkpoint record.
* If so, the operation count should be non-null.
*/
if (fromReload) {
LOGGER.debug("validateForAction, data was reloaded, restoredCount {}",
count);
return count > 0;
}
StorageUnitConstraints constraints
= poolInfoMap.getStorageUnitConstraints(unitIndex);
/*
* Files may be in need of migration even if the correct number
* exist. Force the file operation into the table if the
* storage unit matches the modified one.
*/
if (unitIndex.equals(storageUnit)) {
/*
* The maximum number of steps required to redistribute all files
* would be (required - 1) removes + (required - 1) copies.
*/
count = 2 * (constraints.getRequired() - 1);
return true;
}
Collection<String> locations
= poolInfoMap.getMemberLocations(group,
attributes.getLocations());
/*
* This indicates that all the locations for the file do not belong
* to the given pool group. This could happen if all locations
* that were once part of the group are removed. In this case,
* the operation is a NOP.
*/
if (locations.isEmpty()) {
return false;
}
/*
* Check the constraints.
* Countable means readable OR intentionally excluded locations.
* If there are copies missing only from excluded locations,
* do nothing.
*/
int countable = poolInfoMap.getCountableLocations(locations);
count = constraints.getRequired() - countable;
LOGGER.debug("validateForAction ({} needs {} replicas, locations {}, "
+ "{} countable; difference = {}.",
pnfsId, constraints.getRequired(),
locations, countable, count);
if (count == 0) {
LOGGER.debug("{}, requirements are already met.", pnfsId);
return false;
}
/**
* Multiple copies per update are set only when the file is a new
* entry in the namespace, or when the scan of the pool is periodic or
* forced by an admin command. A pool status change or clear cache
* location message will trigger only a single migration or single
* remove.
*/
count = isFullScan ? Math.abs(count) : 1;
LOGGER.trace("validateForAction, computed count as {}", count);
return true;
}
public boolean verifyPoolGroup(PoolInfoMap poolInfoMap) {
poolIndex = poolInfoMap.getPoolIndex(pool);
if (group != null) {
return poolInfoMap.isResilientGroup(group);
}
group = poolInfoMap.getResilientPoolGroup(poolIndex);
return group != null;
}
}