core/net/src/main/java/org/onosproject/net/pi/impl/PiTranslationServiceImpl.java

/*
 * Copyright 2017-present Open Networking Foundation
 *
 * Licensed 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.onosproject.net.pi.impl;

import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Deactivate;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.ReferenceCardinality;
import org.apache.felix.scr.annotations.Service;
import org.onosproject.net.Device;
import org.onosproject.net.DeviceId;
import org.onosproject.net.device.DeviceService;
import org.onosproject.net.flow.FlowRule;
import org.onosproject.net.group.Group;
import org.onosproject.net.pi.model.PiPipeconf;
import org.onosproject.net.pi.model.PiPipeconfId;
import org.onosproject.net.pi.runtime.PiActionGroup;
import org.onosproject.net.pi.runtime.PiTableEntry;
import org.onosproject.net.pi.service.PiTranslatable;
import org.onosproject.net.pi.service.PiTranslationService;
import org.onosproject.net.pi.service.PiTranslationStore;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Optional;

/**
 * Implementation of the protocol-independent translation service.
 */
@Component(immediate = true)
@Service
public class PiTranslationServiceImpl implements PiTranslationService {

    private final Logger log = LoggerFactory.getLogger(this.getClass());

    // TODO: implement cache to speed up translation.

    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected DeviceService deviceService;

    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    private PiTranslationStore translationStore;

    @Activate
    public void activate() {
        log.info("Started");
    }

    @Deactivate
    public void deactivate() {
        log.info("Stopped");
    }

    @Override
    public PiTableEntry translate(FlowRule rule, PiPipeconf pipeconf)
            throws PiTranslationException {
        final PiTableEntry piTableEntry = PiFlowRuleTranslator
                .translate(rule, pipeconf, getDevice(rule.deviceId()));
        translationStore.addOrUpdate(rule, piTableEntry, pipeconf.id());
        return piTableEntry;
    }

    @Override
    public Optional<FlowRule> lookup(PiTableEntry piTableEntry,
                                     PiPipeconfId pipeconfId) {
        final PiTranslatable original = translationStore
                .lookup(piTableEntry, pipeconfId);
        return original == null
                ? Optional.empty()
                : Optional.of((FlowRule) original);
    }

    @Override
    public PiActionGroup translate(Group group, PiPipeconf pipeconf)
            throws PiTranslationException {
        return PiGroupTranslator.translate(group, pipeconf,
                                           getDevice(group.deviceId()));
    }

    @Override
    public Optional<Group> lookup(PiActionGroup piActionGroup,
                                  PiPipeconfId pipeconfId) {
        // TODO: implement learning and lookup of groups
        return Optional.empty();
    }

    private Device getDevice(DeviceId deviceId) throws PiTranslationException {
        final Device device = deviceService.getDevice(deviceId);
        if (device == null) {
            throw new PiTranslationException(
                    "Unable to get device " + deviceId);
        }
        return device;
    }
}