/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.controller;
import static org.jboss.as.controller.ControllerLogger.MGMT_OP_LOGGER;
import static org.jboss.as.controller.ControllerLogger.ROOT_LOGGER;
import static org.jboss.as.controller.ControllerMessages.MESSAGES;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.ALLOW_RESOURCE_SERVICE_RESTART;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.CANCELLED;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OPERATION_HEADERS;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP_ADDR;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OUTCOME;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.PROCESS_STATE;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.RESPONSE_HEADERS;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.ROLLBACK_ON_RUNTIME_FAILURE;
import java.io.IOException;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Executor;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import org.jboss.as.controller.client.ModelControllerClient;
import org.jboss.as.controller.client.Operation;
import org.jboss.as.controller.client.OperationAttachments;
import org.jboss.as.controller.client.OperationMessageHandler;
import org.jboss.as.controller.extension.ExtensionAddHandler;
import org.jboss.as.controller.extension.ParallelExtensionAddHandler;
import org.jboss.as.controller.operations.common.Util;
import org.jboss.as.controller.persistence.ConfigurationPersistenceException;
import org.jboss.as.controller.persistence.ConfigurationPersister;
import org.jboss.as.controller.registry.ManagementResourceRegistration;
import org.jboss.as.controller.registry.Resource;
import org.jboss.dmr.ModelNode;
import org.jboss.msc.service.ServiceListener;
import org.jboss.msc.service.ServiceRegistry;
import org.jboss.msc.service.ServiceTarget;
import org.jboss.threads.AsyncFuture;
import org.jboss.threads.AsyncFutureTask;
/**
* Default {@link ModelController} implementation.
*
* @author <a href="mailto:david.lloyd@redhat.com">David M. Lloyd</a>
*/
class ModelControllerImpl implements ModelController {
private final ServiceRegistry serviceRegistry;
private final ServiceTarget serviceTarget;
private final ManagementResourceRegistration rootRegistration;
private final Lock writeLock = new ReentrantLock();
private final ContainerStateMonitor stateMonitor;
private final RootResource model = new RootResource();
private final ConfigurationPersister persister;
private final ProcessType processType;
private final RunningModeControl runningModeControl;
private final AtomicBoolean bootingFlag = new AtomicBoolean(true);
private final OperationStepHandler prepareStep;
private final ControlledProcessState processState;
private final ExecutorService executorService;
private final ExpressionResolver expressionResolver;
ModelControllerImpl(final ServiceRegistry serviceRegistry, final ServiceTarget serviceTarget, final ManagementResourceRegistration rootRegistration,
final ContainerStateMonitor stateMonitor, final ConfigurationPersister persister,
final ProcessType processType, final RunningModeControl runningModeControl,
final OperationStepHandler prepareStep, final ControlledProcessState processState, final ExecutorService executorService,
final ExpressionResolver expressionResolver) {
this.serviceRegistry = serviceRegistry;
this.serviceTarget = serviceTarget;
this.rootRegistration = rootRegistration;
this.stateMonitor = stateMonitor;
this.persister = persister;
this.processType = processType;
this.runningModeControl = runningModeControl;
this.prepareStep = prepareStep == null ? new DefaultPrepareStepHandler() : prepareStep;
this.processState = processState;
this.serviceTarget.addListener(ServiceListener.Inheritance.ALL, stateMonitor);
this.executorService = executorService;
this.expressionResolver = expressionResolver;
}
public ModelNode execute(final ModelNode operation, final OperationMessageHandler handler, final OperationTransactionControl control, final OperationAttachments attachments) {
final ModelNode headers = operation.has(OPERATION_HEADERS) ? operation.get(OPERATION_HEADERS) : null;
final boolean rollbackOnFailure = headers == null || !headers.hasDefined(ROLLBACK_ON_RUNTIME_FAILURE) || headers.get(ROLLBACK_ON_RUNTIME_FAILURE).asBoolean();
final EnumSet<OperationContextImpl.ContextFlag> contextFlags = rollbackOnFailure ? EnumSet.of(OperationContextImpl.ContextFlag.ROLLBACK_ON_FAIL) : EnumSet.noneOf(OperationContextImpl.ContextFlag.class);
final boolean restartResourceServices = headers != null && headers.hasDefined(ALLOW_RESOURCE_SERVICE_RESTART) && headers.get(ALLOW_RESOURCE_SERVICE_RESTART).asBoolean();
if (restartResourceServices) {
contextFlags.add(OperationContextImpl.ContextFlag.ALLOW_RESOURCE_SERVICE_RESTART);
}
OperationContextImpl context = new OperationContextImpl(this, processType, runningModeControl.getRunningMode(), contextFlags, handler, attachments, model, control, processState, bootingFlag.get());
ModelNode response = new ModelNode();
context.addStep(response, operation, prepareStep, OperationContext.Stage.MODEL);
context.completeStep();
ControlledProcessState.State state = processState.getState();
switch (state) {
case RELOAD_REQUIRED:
case RESTART_REQUIRED:
response.get(RESPONSE_HEADERS, PROCESS_STATE).set(state.toString());
break;
default:
break;
}
return response;
}
boolean boot(final List<ModelNode> bootList, final OperationMessageHandler handler, final OperationTransactionControl control,
final boolean rollbackOnRuntimeFailure) {
EnumSet<OperationContextImpl.ContextFlag> contextFlags = rollbackOnRuntimeFailure
? EnumSet.of(OperationContextImpl.ContextFlag.ROLLBACK_ON_FAIL)
: EnumSet.noneOf(OperationContextImpl.ContextFlag.class);
final OperationContextImpl context = new OperationContextImpl(this, processType, runningModeControl.getRunningMode(),
contextFlags, handler, null, model, control, processState, bootingFlag.get());
// Add to the context all ops prior to the first ExtensionAddHandler as well as all ExtensionAddHandlers; save the rest.
// This gets extensions registered before proceeding to other ops that count on these registrations
List<ParsedBootOp> postExtensionOps = organizeBootOperations(bootList, context);
// Run the steps up to the last ExtensionAddHandler
OperationContext.ResultAction resultAction = context.completeStep();
if (resultAction == OperationContext.ResultAction.KEEP && postExtensionOps != null) {
// Success. Now any extension handlers are registered. Continue with remaining ops
final OperationContextImpl postExtContext = new OperationContextImpl(this, processType, runningModeControl.getRunningMode(),
contextFlags, handler, null, model, control, processState, bootingFlag.get());
for (ParsedBootOp parsedOp : postExtensionOps) {
final OperationStepHandler stepHandler = parsedOp.handler == null ? rootRegistration.getOperationHandler(parsedOp.address, parsedOp.operationName) : parsedOp.handler;
if (stepHandler == null) {
ROOT_LOGGER.noHandler(parsedOp.operationName, parsedOp.address);
postExtContext.setRollbackOnly();
// stop
break;
} else {
postExtContext.addStep(parsedOp.response, parsedOp.operation, stepHandler, OperationContext.Stage.MODEL);
}
}
resultAction = postExtContext.completeStep();
}
return resultAction == OperationContext.ResultAction.KEEP;
}
/**
* Organizes the list of boot operations such that all extension add operations are executed in the given context,
* while all non-extension add operations found after the first extension add are stored for subsequent invocation
* in a separate context. Also:
* <ol>
* <li>Ensures that any operations affecting interfaces or sockets are run before any operations affecting
* subsystems. This improves boot performance by ensuring required services are available as soon as possible.
* </li>
* <li>If an executor service is available, organizes all extension add ops so the extension initialization
* can be done in parallel by the executor service.
* </li>
* <li>If an executor service is available and the controller type is SERVER, organizes all subsystem ops so
* they can be done in parallel by the executor service.
* </li>
* </ol>
*
* @param bootList the list of boot operations
* @param context operation context to use for all ops prior to the last extension add operation.
*
* @return a list of operations to execute in a separate context, or {@code null} if there are no such ops
*/
private List<ParsedBootOp> organizeBootOperations(List<ModelNode> bootList, OperationContextImpl context) {
final ModelNode result = new ModelNode().setEmptyList();
boolean sawExtensionAdd = false;
List<ParsedBootOp> postExtensionOps = null;
ParallelExtensionAddHandler parallelExtensionAddHandler = executorService == null ? null : new ParallelExtensionAddHandler(executorService);
ParallelBootOperationStepHandler parallelSubsystemHandler = (executorService != null && processType.isServer() && runningModeControl.getRunningMode() == RunningMode.NORMAL)
? new ParallelBootOperationStepHandler(executorService, rootRegistration, processState) : null;
boolean registeredParallelSubsystemHandler = false;
int subsystemIndex = 0;
for (ModelNode bootOp : bootList) {
final ParsedBootOp parsedOp = new ParsedBootOp(bootOp, result.add());
if (postExtensionOps != null) {
// Handle cases like AppClient where extension adds are interleaved with subsystem ops
if (parsedOp.isExtensionAdd()) {
final ExtensionAddHandler stepHandler = (ExtensionAddHandler) rootRegistration.getOperationHandler(parsedOp.address, parsedOp.operationName);
if (parallelExtensionAddHandler != null) {
parallelExtensionAddHandler.addParsedOp(parsedOp, stepHandler);
} else {
context.addStep(parsedOp.response, parsedOp.operation, stepHandler, OperationContext.Stage.MODEL);
}
} else {
if (parallelSubsystemHandler == null || !parallelSubsystemHandler.addSubsystemOperation(parsedOp)) {
// Put any interface/socket op before the subsystem op
if (registeredParallelSubsystemHandler && (parsedOp.isInterfaceOperation() || parsedOp.isSocketOperation())) {
postExtensionOps.add(subsystemIndex++, parsedOp);
} else {
postExtensionOps.add(parsedOp);
}
} else if (!registeredParallelSubsystemHandler) {
ModelNode op = Util.getEmptyOperation("parallel-subsystem-boot", new ModelNode().setEmptyList());
postExtensionOps.add(new ParsedBootOp(op, parallelSubsystemHandler, result.add()));
subsystemIndex = postExtensionOps.size() - 1;
registeredParallelSubsystemHandler = true;
}
}
} else {
final OperationStepHandler stepHandler = rootRegistration.getOperationHandler(parsedOp.address, parsedOp.operationName);
if (!sawExtensionAdd && stepHandler == null) {
// Odd case. An op prior to the first extension add where there is no handler. This would really
// only happen during AS development
ROOT_LOGGER.noHandler(parsedOp.operationName, parsedOp.address);
context.setRollbackOnly();
// stop
break;
} else if (stepHandler instanceof ExtensionAddHandler) {
if (parallelExtensionAddHandler != null) {
parallelExtensionAddHandler.addParsedOp(parsedOp, (ExtensionAddHandler) stepHandler);
if (!sawExtensionAdd) {
ModelNode op = Util.getEmptyOperation("parallel-extension-add", new ModelNode().setEmptyList());
context.addStep(result.add(), op, parallelExtensionAddHandler, OperationContext.Stage.MODEL);
}
} else {
context.addStep(parsedOp.response, parsedOp.operation, stepHandler, OperationContext.Stage.MODEL);
}
sawExtensionAdd = true;
} else if (!sawExtensionAdd) {
// An operation prior to the first Extension Add
context.addStep(result.add(), bootOp, stepHandler, OperationContext.Stage.MODEL);
} else {
// Start the postExtension list
postExtensionOps = new ArrayList<ParsedBootOp>();
if (parallelSubsystemHandler == null || !parallelSubsystemHandler.addSubsystemOperation(parsedOp)) {
postExtensionOps.add(parsedOp);
} else {
// First subsystem op; register the parallel handler and add the op to it
ModelNode op = Util.getEmptyOperation("parallel-subsystem-boot", new ModelNode().setEmptyList());
postExtensionOps.add(new ParsedBootOp(op, parallelSubsystemHandler, result.add()));
registeredParallelSubsystemHandler = true;
}
}
}
}
return postExtensionOps;
}
void finishBoot() {
bootingFlag.set(false);
}
public Resource getRootResource() {
return model;
}
ManagementResourceRegistration getRootRegistration() {
return rootRegistration;
}
public ModelControllerClient createClient(final Executor executor) {
return new ModelControllerClient() {
@Override
public void close() throws IOException {
// whatever
}
@Override
public ModelNode execute(ModelNode operation) throws IOException {
return execute(operation, null);
}
@Override
public ModelNode execute(Operation operation) throws IOException {
return execute(operation, null);
}
@Override
public ModelNode execute(final ModelNode operation, final OperationMessageHandler messageHandler) {
return ModelControllerImpl.this.execute(operation, messageHandler, OperationTransactionControl.COMMIT, null);
}
@Override
public ModelNode execute(Operation operation, OperationMessageHandler messageHandler) throws IOException {
return ModelControllerImpl.this.execute(operation.getOperation(), messageHandler, OperationTransactionControl.COMMIT, operation);
}
@Override
public AsyncFuture<ModelNode> executeAsync(ModelNode operation, OperationMessageHandler messageHandler) {
return executeAsync(operation, messageHandler, null);
}
@Override
public AsyncFuture<ModelNode> executeAsync(final Operation operation, final OperationMessageHandler messageHandler) {
return executeAsync(operation.getOperation(), messageHandler, operation);
}
private AsyncFuture<ModelNode> executeAsync(final ModelNode operation, final OperationMessageHandler messageHandler, final OperationAttachments attachments) {
if (executor == null) {
throw MESSAGES.nullAsynchronousExecutor();
}
final AtomicReference<Thread> opThread = new AtomicReference<Thread>();
class OpTask extends AsyncFutureTask<ModelNode> {
OpTask() {
super(executor);
}
public void asyncCancel(final boolean interruptionDesired) {
Thread thread = opThread.getAndSet(Thread.currentThread());
if (thread == null) {
setCancelled();
} else {
// Interrupt the request execution
thread.interrupt();
// Wait for the cancellation to clear opThread
boolean interrupted = false;
synchronized (opThread) {
while (opThread.get() != null) {
try {
opThread.wait();
} catch (InterruptedException ie) {
interrupted = true;
}
}
}
setCancelled();
if (interrupted) {
Thread.currentThread().interrupt();
}
}
}
void handleResult(final ModelNode result) {
if (result != null && result.hasDefined(OUTCOME) && CANCELLED.equals(result.get(OUTCOME).asString())) {
setCancelled();
} else {
setResult(result);
}
}
}
final OpTask opTask = new OpTask();
executor.execute(new Runnable() {
public void run() {
try {
if (opThread.compareAndSet(null, Thread.currentThread())) {
ModelNode response = ModelControllerImpl.this.execute(operation, messageHandler, OperationTransactionControl.COMMIT, attachments);
opTask.handleResult(response);
}
} finally {
synchronized (opThread) {
opThread.set(null);
opThread.notifyAll();
}
}
}
});
return opTask;
}
};
}
ConfigurationPersister.PersistenceResource writeModel(final Resource resource, Set<PathAddress> affectedAddresses) throws ConfigurationPersistenceException {
final ModelNode newModel = Resource.Tools.readModel(resource); // Get the model representation
final ConfigurationPersister.PersistenceResource delegate = persister.store(newModel, affectedAddresses);
return new ConfigurationPersister.PersistenceResource() {
@Override
public void commit() {
model.set(resource);
delegate.commit();
}
@Override
public void rollback() {
delegate.rollback();
}
};
}
void acquireLock(final boolean interruptibly) throws InterruptedException {
if (interruptibly) {
//noinspection LockAcquiredButNotSafelyReleased
writeLock.lockInterruptibly();
} else {
//noinspection LockAcquiredButNotSafelyReleased
writeLock.lock();
}
}
void releaseLock() {
writeLock.unlock();
}
void acquireContainerMonitor() {
stateMonitor.acquire();
}
void releaseContainerMonitor() {
stateMonitor.release();
}
void awaitContainerMonitor(final boolean interruptibly, final int count) throws InterruptedException {
if (interruptibly) {
stateMonitor.await(count);
} else {
stateMonitor.awaitUninterruptibly(count);
}
}
ContainerStateMonitor.ContainerStateChangeReport awaitContainerStateChangeReport(final int count) throws InterruptedException {
return stateMonitor.awaitContainerStateChangeReport(count);
}
ServiceRegistry getServiceRegistry() {
return serviceRegistry;
}
ServiceTarget getServiceTarget() {
return serviceTarget;
}
ModelNode resolveExpressions(ModelNode node) throws OperationFailedException {
return expressionResolver.resolveExpressions(node);
}
private class DefaultPrepareStepHandler implements OperationStepHandler {
@Override
public void execute(OperationContext context, ModelNode operation) throws OperationFailedException {
if (MGMT_OP_LOGGER.isTraceEnabled()) {
MGMT_OP_LOGGER.trace("Executing " + operation.get(OP) + " " + operation.get(OP_ADDR));
}
final PathAddress address = PathAddress.pathAddress(operation.get(OP_ADDR));
final String operationName = operation.require(OP).asString();
final OperationStepHandler stepHandler = rootRegistration.getOperationHandler(address, operationName);
if(stepHandler != null) {
context.addStep(stepHandler, OperationContext.Stage.MODEL);
} else {
context.getFailureDescription().set(MESSAGES.noHandler(operationName, address));
}
context.completeStep();
}
}
/**
* The root resource, maintains a read-only reference to the current model. All write operations have to performed
* after acquiring the write lock on a clone of the underlying model.
*/
private class RootResource implements Resource {
private final AtomicReference<Resource> modelReference = new AtomicReference<Resource>(Resource.Factory.create());
void set(Resource resource){
modelReference.set(resource);
}
@SuppressWarnings({"CloneDoesntCallSuperClone"})
@Override
public Resource clone() {
return getDelegate().clone();
}
public Resource getChild(PathElement element) {
return getDelegate().getChild(element);
}
public Set<Resource.ResourceEntry> getChildren(String childType) {
return getDelegate().getChildren(childType);
}
public Set<String> getChildrenNames(String childType) {
return getDelegate().getChildrenNames(childType);
}
public Set<String> getChildTypes() {
return getDelegate().getChildTypes();
}
public ModelNode getModel() {
return getDelegate().getModel();
}
public boolean hasChild(PathElement element) {
return getDelegate().hasChild(element);
}
public boolean hasChildren(String childType) {
return getDelegate().hasChildren(childType);
}
public boolean isModelDefined() {
return getDelegate().isModelDefined();
}
public boolean isProxy() {
return getDelegate().isProxy();
}
public boolean isRuntime() {
return getDelegate().isRuntime();
}
public Resource navigate(PathAddress address) {
return getDelegate().navigate(address);
}
public void registerChild(PathElement address, Resource resource) {
getDelegate().registerChild(address, resource);
}
public Resource removeChild(PathElement address) {
return getDelegate().removeChild(address);
}
public Resource requireChild(PathElement element) {
return getDelegate().requireChild(element);
}
public void writeModel(ModelNode newModel) {
getDelegate().writeModel(newModel);
}
private Resource getDelegate() {
return this.modelReference.get();
}
}
}