Java tutorial
/** * 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 * <p> * http://www.apache.org/licenses/LICENSE-2.0 * <p> * 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.hadoop.yarn.server.resourcemanager; import java.io.IOException; import java.util.ArrayList; import java.util.EnumSet; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; import org.apache.commons.logging.Log; import org.apache.hadoop.conf.Configuration; import org.apache.hadoop.security.AccessControlException; import org.apache.hadoop.security.UserGroupInformation; import org.apache.hadoop.security.authorize.AccessControlList; import org.apache.hadoop.security.authorize.ProxyUsers; import org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest; import org.apache.hadoop.yarn.api.records.ApplicationAttemptId; import org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport; import org.apache.hadoop.yarn.api.records.ContainerId; import org.apache.hadoop.yarn.api.records.NodeState; import org.apache.hadoop.yarn.api.records.QueueInfo; import org.apache.hadoop.yarn.api.records.Resource; import org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest; import org.apache.hadoop.yarn.api.records.ResourceRequest; import org.apache.hadoop.yarn.api.records.UpdateContainerError; import org.apache.hadoop.yarn.api.records.UpdateContainerRequest; import org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState; import org.apache.hadoop.yarn.api.records.YarnApplicationState; import org.apache.hadoop.yarn.conf.YarnConfiguration; import org.apache.hadoop.yarn.exceptions.InvalidContainerReleaseException; import org.apache.hadoop.yarn.exceptions.InvalidResourceBlacklistRequestException; import org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException; import org.apache.hadoop.yarn.exceptions.YarnRuntimeException; import org.apache.hadoop.yarn.factories.RecordFactory; import org.apache.hadoop.yarn.factory.providers.RecordFactoryProvider; import org.apache.hadoop.yarn.security.YarnAuthorizationProvider; import org.apache.hadoop.yarn.server.resourcemanager.rmapp.RMAppState; import org.apache.hadoop.yarn.server.resourcemanager.rmapp.attempt.RMAppAttemptState; import org.apache.hadoop.yarn.server.resourcemanager.rmcontainer.RMContainer; import org.apache.hadoop.yarn.server.resourcemanager.rmnode.RMNode; import org.apache.hadoop.yarn.server.resourcemanager.scheduler.ResourceScheduler; import org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedContainerChangeRequest; import org.apache.hadoop.yarn.server.resourcemanager.scheduler.SchedulerUtils; import org.apache.hadoop.yarn.server.resourcemanager.scheduler.YarnScheduler; import org.apache.hadoop.yarn.server.utils.BuilderUtils; import org.apache.hadoop.yarn.util.resource.ResourceCalculator; import org.apache.hadoop.yarn.util.resource.Resources; /** * Utility methods to aid serving RM data through the REST and RPC APIs */ public class RMServerUtils { private static final String UPDATE_OUTSTANDING_ERROR = "UPDATE_OUTSTANDING_ERROR"; private static final String INCORRECT_CONTAINER_VERSION_ERROR = "INCORRECT_CONTAINER_VERSION_ERROR"; private static final String INVALID_CONTAINER_ID = "INVALID_CONTAINER_ID"; private static final String RESOURCE_OUTSIDE_ALLOWED_RANGE = "RESOURCE_OUTSIDE_ALLOWED_RANGE"; protected static final RecordFactory RECORD_FACTORY = RecordFactoryProvider.getRecordFactory(null); public static List<RMNode> queryRMNodes(RMContext context, EnumSet<NodeState> acceptedStates) { // nodes contains nodes that are NEW, RUNNING OR UNHEALTHY ArrayList<RMNode> results = new ArrayList<RMNode>(); if (acceptedStates.contains(NodeState.NEW) || acceptedStates.contains(NodeState.RUNNING) || acceptedStates.contains(NodeState.DECOMMISSIONING) || acceptedStates.contains(NodeState.UNHEALTHY)) { for (RMNode rmNode : context.getRMNodes().values()) { if (acceptedStates.contains(rmNode.getState())) { results.add(rmNode); } } } // inactiveNodes contains nodes that are DECOMMISSIONED, LOST, OR REBOOTED if (acceptedStates.contains(NodeState.DECOMMISSIONED) || acceptedStates.contains(NodeState.LOST) || acceptedStates.contains(NodeState.REBOOTED)) { for (RMNode rmNode : context.getInactiveRMNodes().values()) { if ((rmNode != null) && acceptedStates.contains(rmNode.getState())) { results.add(rmNode); } } } return results; } /** * Check if we have: * - Request for same containerId and different target resource * - If targetResources violates maximum/minimumAllocation * @param rmContext RM context * @param request Allocate Request * @param maximumAllocation Maximum Allocation * @param increaseResourceReqs Increase Resource Request * @param decreaseResourceReqs Decrease Resource Request * @return List of container Errors */ public static List<UpdateContainerError> validateAndSplitUpdateResourceRequests(RMContext rmContext, AllocateRequest request, Resource maximumAllocation, List<UpdateContainerRequest> increaseResourceReqs, List<UpdateContainerRequest> decreaseResourceReqs) { List<UpdateContainerError> errors = new ArrayList<>(); Set<ContainerId> outstandingUpdate = new HashSet<>(); for (UpdateContainerRequest updateReq : request.getUpdateRequests()) { RMContainer rmContainer = rmContext.getScheduler().getRMContainer(updateReq.getContainerId()); String msg = null; if (rmContainer == null) { msg = INVALID_CONTAINER_ID; } // Only allow updates if the requested version matches the current // version if (msg == null && updateReq.getContainerVersion() != rmContainer.getContainer().getVersion()) { msg = INCORRECT_CONTAINER_VERSION_ERROR + "|" + updateReq.getContainerVersion() + "|" + rmContainer.getContainer().getVersion(); } // No more than 1 container update per request. if (msg == null && outstandingUpdate.contains(updateReq.getContainerId())) { msg = UPDATE_OUTSTANDING_ERROR; } if (msg == null) { Resource original = rmContainer.getContainer().getResource(); Resource target = updateReq.getCapability(); if (Resources.fitsIn(target, original)) { // This is a decrease request if (validateIncreaseDecreaseRequest(rmContext, updateReq, maximumAllocation, false)) { decreaseResourceReqs.add(updateReq); outstandingUpdate.add(updateReq.getContainerId()); } else { msg = RESOURCE_OUTSIDE_ALLOWED_RANGE; } } else { // This is an increase request if (validateIncreaseDecreaseRequest(rmContext, updateReq, maximumAllocation, true)) { increaseResourceReqs.add(updateReq); outstandingUpdate.add(updateReq.getContainerId()); } else { msg = RESOURCE_OUTSIDE_ALLOWED_RANGE; } } } if (msg != null) { UpdateContainerError updateError = RECORD_FACTORY.newRecordInstance(UpdateContainerError.class); updateError.setReason(msg); updateError.setUpdateContainerRequest(updateReq); errors.add(updateError); } } return errors; } /** * Utility method to validate a list resource requests, by insuring that the * requested memory/vcore is non-negative and not greater than max */ public static void normalizeAndValidateRequests(List<ResourceRequest> ask, Resource maximumResource, String queueName, YarnScheduler scheduler, RMContext rmContext) throws InvalidResourceRequestException { // Get queue from scheduler QueueInfo queueInfo = null; try { queueInfo = scheduler.getQueueInfo(queueName, false, false); } catch (IOException e) { } for (ResourceRequest resReq : ask) { SchedulerUtils.normalizeAndvalidateRequest(resReq, maximumResource, queueName, scheduler, rmContext, queueInfo); } } /** * Validate increase/decrease request. This function must be called under * the queue lock to make sure that the access to container resource is * atomic. Refer to LeafQueue.decreaseContainer() and * CapacityScheduelr.updateIncreaseRequests() * <pre> * - Throw exception when any other error happens * </pre> */ public static void checkSchedContainerChangeRequest(SchedContainerChangeRequest request, boolean increase) throws InvalidResourceRequestException { RMContext rmContext = request.getRmContext(); ContainerId containerId = request.getContainerId(); RMContainer rmContainer = request.getRMContainer(); Resource targetResource = request.getTargetCapacity(); // Compare targetResource and original resource Resource originalResource = rmContainer.getAllocatedResource(); // Resource comparasion should be >= (or <=) for all resource vectors, for // example, you cannot request target resource of a <10G, 10> container to // <20G, 8> if (increase) { if (originalResource.getMemorySize() > targetResource.getMemorySize() || originalResource.getVirtualCores() > targetResource.getVirtualCores()) { String msg = "Trying to increase a container, but target resource has some" + " resource < original resource, target=" + targetResource + " original=" + originalResource + " containerId=" + containerId; throw new InvalidResourceRequestException(msg); } } else { if (originalResource.getMemorySize() < targetResource.getMemorySize() || originalResource.getVirtualCores() < targetResource.getVirtualCores()) { String msg = "Trying to decrease a container, but target resource has " + "some resource > original resource, target=" + targetResource + " original=" + originalResource + " containerId=" + containerId; throw new InvalidResourceRequestException(msg); } } // Target resource of the increase request is more than NM can offer ResourceScheduler scheduler = rmContext.getScheduler(); RMNode rmNode = request.getSchedulerNode().getRMNode(); if (!Resources.fitsIn(scheduler.getResourceCalculator(), scheduler.getClusterResource(), targetResource, rmNode.getTotalCapability())) { String msg = "Target resource=" + targetResource + " of containerId=" + containerId + " is more than node's total resource=" + rmNode.getTotalCapability(); throw new InvalidResourceRequestException(msg); } } /* * @throw <code>InvalidResourceBlacklistRequestException </code> if the * resource is not able to be added to the blacklist. */ public static void validateBlacklistRequest(ResourceBlacklistRequest blacklistRequest) throws InvalidResourceBlacklistRequestException { if (blacklistRequest != null) { List<String> plus = blacklistRequest.getBlacklistAdditions(); if (plus != null && plus.contains(ResourceRequest.ANY)) { throw new InvalidResourceBlacklistRequestException( "Cannot add " + ResourceRequest.ANY + " to the blacklist!"); } } } // Sanity check and normalize target resource private static boolean validateIncreaseDecreaseRequest(RMContext rmContext, UpdateContainerRequest request, Resource maximumAllocation, boolean increase) { if (request.getCapability().getMemorySize() < 0 || request.getCapability().getMemorySize() > maximumAllocation.getMemorySize()) { return false; } if (request.getCapability().getVirtualCores() < 0 || request.getCapability().getVirtualCores() > maximumAllocation.getVirtualCores()) { return false; } ResourceScheduler scheduler = rmContext.getScheduler(); ResourceCalculator rc = scheduler.getResourceCalculator(); Resource targetResource = Resources.normalize(rc, request.getCapability(), scheduler.getMinimumResourceCapability(), scheduler.getMaximumResourceCapability(), scheduler.getMinimumResourceCapability()); // Update normalized target resource request.setCapability(targetResource); return true; } /** * It will validate to make sure all the containers belong to correct * application attempt id. If not then it will throw * {@link InvalidContainerReleaseException} * * @param containerReleaseList containers to be released as requested by * application master. * @param appAttemptId Application attempt Id * @throws InvalidContainerReleaseException */ public static void validateContainerReleaseRequest(List<ContainerId> containerReleaseList, ApplicationAttemptId appAttemptId) throws InvalidContainerReleaseException { for (ContainerId cId : containerReleaseList) { if (!appAttemptId.equals(cId.getApplicationAttemptId())) { throw new InvalidContainerReleaseException("Cannot release container : " + cId.toString() + " not belonging to this application attempt : " + appAttemptId); } } } public static UserGroupInformation verifyAdminAccess(YarnAuthorizationProvider authorizer, String method, final Log LOG) throws IOException { // by default, this method will use AdminService as module name return verifyAdminAccess(authorizer, method, "AdminService", LOG); } /** * Utility method to verify if the current user has access based on the * passed {@link AccessControlList} * * @param authorizer the {@link AccessControlList} to check against * @param method the method name to be logged * @param module like AdminService or NodeLabelManager * @param LOG the logger to use * @return {@link UserGroupInformation} of the current user * @throws IOException */ public static UserGroupInformation verifyAdminAccess(YarnAuthorizationProvider authorizer, String method, String module, final Log LOG) throws IOException { UserGroupInformation user; try { user = UserGroupInformation.getCurrentUser(); } catch (IOException ioe) { LOG.warn("Couldn't get current user", ioe); RMAuditLogger.logFailure("UNKNOWN", method, "", "AdminService", "Couldn't get current user"); throw ioe; } if (!authorizer.isAdmin(user)) { LOG.warn("User " + user.getShortUserName() + " doesn't have permission" + " to call '" + method + "'"); RMAuditLogger.logFailure(user.getShortUserName(), method, "", module, RMAuditLogger.AuditConstants.UNAUTHORIZED_USER); throw new AccessControlException( "User " + user.getShortUserName() + " doesn't have permission" + " to call '" + method + "'"); } if (LOG.isTraceEnabled()) { LOG.trace(method + " invoked by user " + user.getShortUserName()); } return user; } public static YarnApplicationState createApplicationState(RMAppState rmAppState) { switch (rmAppState) { case NEW: return YarnApplicationState.NEW; case GENERATING_SECURITY_MATERIAL: return YarnApplicationState.GENERATING_SECURITY_MATERIAL; case NEW_SAVING: return YarnApplicationState.NEW_SAVING; case SUBMITTED: return YarnApplicationState.SUBMITTED; case ACCEPTED: return YarnApplicationState.ACCEPTED; case RUNNING: return YarnApplicationState.RUNNING; case FINISHING: case FINISHED: return YarnApplicationState.FINISHED; case KILLED: return YarnApplicationState.KILLED; case FAILED: return YarnApplicationState.FAILED; default: throw new YarnRuntimeException("Unknown state passed!"); } } public static YarnApplicationAttemptState createApplicationAttemptState(RMAppAttemptState rmAppAttemptState) { switch (rmAppAttemptState) { case NEW: return YarnApplicationAttemptState.NEW; case SUBMITTED: return YarnApplicationAttemptState.SUBMITTED; case SCHEDULED: return YarnApplicationAttemptState.SCHEDULED; case ALLOCATED: return YarnApplicationAttemptState.ALLOCATED; case LAUNCHED: return YarnApplicationAttemptState.LAUNCHED; case ALLOCATED_SAVING: case LAUNCHED_UNMANAGED_SAVING: return YarnApplicationAttemptState.ALLOCATED_SAVING; case RUNNING: return YarnApplicationAttemptState.RUNNING; case FINISHING: return YarnApplicationAttemptState.FINISHING; case FINISHED: return YarnApplicationAttemptState.FINISHED; case KILLED: return YarnApplicationAttemptState.KILLED; case FAILED: return YarnApplicationAttemptState.FAILED; default: throw new YarnRuntimeException("Unknown state passed!"); } } /** * Statically defined dummy ApplicationResourceUsageREport. Used as * a return value when a valid report cannot be found. */ public static final ApplicationResourceUsageReport DUMMY_APPLICATION_RESOURCE_USAGE_REPORT = BuilderUtils .newApplicationResourceUsageReport(-1, -1, Resources.createResource(-1, -1, -1), Resources.createResource(-1, -1, -1), Resources.createResource(-1, -1, -1), 0, 0, 0, 0, 0, 0); /** * Find all configs whose name starts with * YarnConfiguration.RM_PROXY_USER_PREFIX, and add a record for each one by * replacing the prefix with ProxyUsers.CONF_HADOOP_PROXYUSER */ public static void processRMProxyUsersConf(Configuration conf) { Map<String, String> rmProxyUsers = new HashMap<String, String>(); for (Map.Entry<String, String> entry : conf) { String propName = entry.getKey(); if (propName.startsWith(YarnConfiguration.RM_PROXY_USER_PREFIX)) { rmProxyUsers.put( ProxyUsers.CONF_HADOOP_PROXYUSER + "." + propName.substring(YarnConfiguration.RM_PROXY_USER_PREFIX.length()), entry.getValue()); } } for (Map.Entry<String, String> entry : rmProxyUsers.entrySet()) { conf.set(entry.getKey(), entry.getValue()); } } }