1 package org.opendaylight.groupbasedpolicy.neutron.mapper.infrastructure;
3 import java.util.ArrayList;
4 import java.util.HashSet;
8 import javax.annotation.Nullable;
10 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
11 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
12 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.MappingUtils;
13 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.Utils;
14 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.EtherTypeClassifier;
15 import org.opendaylight.groupbasedpolicy.util.IidFactory;
16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierName;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClauseName;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ContractId;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Description;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.EndpointGroupId;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Name;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ParameterName;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.RuleName;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SelectorName;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SubjectName;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.HasDirection.Direction;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.classifier.refs.ClassifierRef;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.classifier.refs.ClassifierRefBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.endpoint.identification.constraints.EndpointIdentificationConstraintsBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.endpoint.identification.constraints.endpoint.identification.constraints.L3EndpointIdentificationConstraints;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.endpoint.identification.constraints.endpoint.identification.constraints.L3EndpointIdentificationConstraintsBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.endpoint.identification.constraints.endpoint.identification.constraints.l3.endpoint.identification.constraints.PrefixConstraintBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.instance.ParameterValue;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.instance.ParameterValueBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.Contract;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.ContractBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.EndpointGroup;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.EndpointGroup.IntraGroupPolicy;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.EndpointGroupBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.Clause;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.ClauseBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.Subject;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.SubjectBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.clause.ConsumerMatchers;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.clause.ConsumerMatchersBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.clause.ProviderMatchers;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.clause.ProviderMatchersBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.subject.Rule;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.contract.subject.RuleBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.endpoint.group.ConsumerNamedSelector;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.endpoint.group.ConsumerNamedSelectorBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.endpoint.group.ProviderNamedSelector;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.endpoint.group.ProviderNamedSelectorBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.subject.feature.instances.ClassifierInstance;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.subject.feature.instances.ClassifierInstanceBuilder;
59 import com.google.common.collect.ImmutableList;
63 private static final ClassifierName IPV4_NAME = new ClassifierName("IPv4");
64 private static final ClassifierName IPV6_NAME = new ClassifierName("IPv6");
65 private static final SubjectName ROUTER_SUBJECT_NAME = new SubjectName("ALLOW_IPv4_IPv6");
66 private static final Description ROUTER_CONTRACT_DESC =
67 new Description("Allow IPv4 and IPv6 communication between router interfaces and endpoints.");
69 * ID of {@link Contract}
71 public static final ContractId CONTRACT_ID = new ContractId("111bc60e-1110-11e5-885d-feff819cdc9f");
73 * Contains rules with action {@link MappingUtils#ACTION_REF_ALLOW} matching IPv4 and IPv6
74 * communication in both directions
76 public static final Contract CONTRACT;
78 private static final Name ROUTER_EPG_NAME = new Name("ROUTER_PORTS");
79 private static final Description ROUTER_EPG_DESC = new Description("Represents router's interfaces.");
83 public static final EndpointGroupId EPG_ID = new EndpointGroupId("1118172e-cd84-4933-a35f-749f9a651de9");
85 * Router endpoint-group providing {@link #CONTRACT}
87 public static final EndpointGroup EPG;
89 * {@link ConsumerNamedSelector} pointing to {@link #CONTRACT}
91 public static final ConsumerNamedSelector CONTRACT_CONSUMER_SELECTOR;
94 CONTRACT = createContractRouter();
95 CONTRACT_CONSUMER_SELECTOR = createConsumerSelector(CONTRACT);
96 EPG = createRouterEpg();
99 private static EndpointGroup createRouterEpg() {
100 ProviderNamedSelector routerProviderSelector = createProviderSelector(CONTRACT);
101 return new EndpointGroupBuilder().setId(EPG_ID)
102 .setName(ROUTER_EPG_NAME)
103 .setProviderNamedSelector(ImmutableList.of(routerProviderSelector))
104 .setIntraGroupPolicy(IntraGroupPolicy.RequireContract)
105 .setDescription(ROUTER_EPG_DESC)
109 private static ProviderNamedSelector createProviderSelector(Contract contract) {
110 SelectorName selectorName = new SelectorName(contract.getSubject().get(0).getName().getValue());
111 return new ProviderNamedSelectorBuilder().setName(selectorName)
112 .setContract(ImmutableList.of(contract.getId()))
116 private static ConsumerNamedSelector createConsumerSelector(Contract contract) {
117 SelectorName selectorName = new SelectorName(contract.getSubject().get(0).getName().getValue());
118 return new ConsumerNamedSelectorBuilder().setName(selectorName)
119 .setContract(ImmutableList.of(contract.getId()))
123 private static Contract createContractRouter() {
124 Rule endpointRouterIpv4Rule = createRuleAllow(IPV4_NAME, Direction.In);
125 Rule routerEndpointIpv4Rule = createRuleAllow(IPV4_NAME, Direction.Out);
126 Rule endpointRouterIpv6Rule = createRuleAllow(IPV6_NAME, Direction.In);
127 Rule routerEndpointIpv6Rule = createRuleAllow(IPV6_NAME, Direction.Out);
128 Subject subject = new SubjectBuilder().setName(ROUTER_SUBJECT_NAME)
130 .setRule(ImmutableList.of(endpointRouterIpv4Rule, routerEndpointIpv4Rule, endpointRouterIpv6Rule,
131 routerEndpointIpv6Rule))
133 return new ContractBuilder().setId(CONTRACT_ID)
134 .setSubject(ImmutableList.of(subject))
135 .setDescription(ROUTER_CONTRACT_DESC)
139 private static Rule createRuleAllow(ClassifierName classifierName, Direction direction) {
140 ClassifierName name =
141 new ClassifierName(direction.name() + MappingUtils.NAME_DOUBLE_DELIMETER + classifierName.getValue());
142 ClassifierRef classifierRef = new ClassifierRefBuilder().setName(name)
143 .setInstanceName(classifierName)
144 .setDirection(direction)
146 return new RuleBuilder().setName(new RuleName(name))
147 .setActionRef(MappingUtils.ACTION_REF_ALLOW)
148 .setClassifierRef(ImmutableList.of(classifierRef))
153 * puts clause with {@link L3EndpointIdentificationConstraints} in {@link ConsumerMatchers}
154 * and {@link ProviderMatchers}. This clause points to subject in {@link #CONTRACT}.
156 * @param tenantId location of {@link #CONTRACT}
157 * @param ipPrefix used in {@link L3EndpointIdentificationConstraints}
158 * @param wTx transaction where entities are written
160 public static void writeRouterClauseWithConsProvEic(TenantId tenantId, @Nullable IpPrefix ipPrefix,
161 WriteTransaction wTx) {
162 Clause clause = createClauseWithConsProvEic(ipPrefix, ROUTER_SUBJECT_NAME);
163 wTx.put(LogicalDatastoreType.CONFIGURATION, IidFactory.clauseIid(tenantId, CONTRACT_ID, clause.getName()),
167 private static Clause createClauseWithConsProvEic(@Nullable IpPrefix ipPrefix, SubjectName subjectName) {
168 ConsumerMatchers consumerMatchers = null;
169 ProviderMatchers providerMatchers = null;
170 StringBuilder clauseName = new StringBuilder();
171 clauseName.append(subjectName.getValue());
172 if (ipPrefix != null) {
173 clauseName.append(MappingUtils.NAME_DOUBLE_DELIMETER).append(Utils.getStringIpPrefix(ipPrefix));
175 new ConsumerMatchersBuilder()
176 .setEndpointIdentificationConstraints(new EndpointIdentificationConstraintsBuilder()
177 .setL3EndpointIdentificationConstraints(new L3EndpointIdentificationConstraintsBuilder()
178 .setPrefixConstraint(
179 ImmutableList.of(new PrefixConstraintBuilder().setIpPrefix(ipPrefix).build()))
184 new ProviderMatchersBuilder()
185 .setEndpointIdentificationConstraints(new EndpointIdentificationConstraintsBuilder()
186 .setL3EndpointIdentificationConstraints(new L3EndpointIdentificationConstraintsBuilder()
187 .setPrefixConstraint(
188 ImmutableList.of(new PrefixConstraintBuilder().setIpPrefix(ipPrefix).build()))
193 return new ClauseBuilder().setName(new ClauseName(clauseName.toString()))
194 .setSubjectRefs(ImmutableList.of(subjectName))
195 .setConsumerMatchers(consumerMatchers)
196 .setProviderMatchers(providerMatchers)
201 * Puts router entities (classifier-instances, {@link #CONTRACT} and {@link #EPG}) to
202 * {@link LogicalDatastoreType#CONFIGURATION}
204 * @param tenantId location of router entities
205 * @param wTx transaction where router entities are written
207 public static void writeRouterEntitiesToTenant(TenantId tenantId, WriteTransaction wTx) {
208 Set<ClassifierInstance> classifierInstances = getAllClassifierInstances();
209 for (ClassifierInstance ci : classifierInstances) {
210 wTx.put(LogicalDatastoreType.CONFIGURATION, IidFactory.classifierInstanceIid(tenantId, ci.getName()), ci,
213 wTx.put(LogicalDatastoreType.CONFIGURATION, IidFactory.contractIid(tenantId, CONTRACT_ID), CONTRACT, true);
214 wTx.put(LogicalDatastoreType.CONFIGURATION, IidFactory.endpointGroupIid(tenantId, EPG_ID), EPG, true);
218 * @return All classifier-instances used in {@link CONTRACT}
220 public static Set<ClassifierInstance> getAllClassifierInstances() {
221 HashSet<ClassifierInstance> cis = new HashSet<>();
222 cis.add(createIpv4());
223 cis.add(createIpv6());
227 private static ClassifierInstance createIpv4() {
228 return new ClassifierInstanceBuilder().setName(IPV4_NAME)
229 .setClassifierDefinitionId(EtherTypeClassifier.DEFINITION.getId())
230 .setParameterValue(createParams(EtherTypeClassifier.IPv4_VALUE))
234 private static ClassifierInstance createIpv6() {
235 return new ClassifierInstanceBuilder().setName(IPV6_NAME)
236 .setClassifierDefinitionId(EtherTypeClassifier.DEFINITION.getId())
237 .setParameterValue(createParams(EtherTypeClassifier.IPv6_VALUE))
241 private static List<ParameterValue> createParams(long etherType) {
242 List<ParameterValue> params = new ArrayList<>();
243 params.add(new ParameterValueBuilder().setName(new ParameterName(EtherTypeClassifier.ETHERTYPE_PARAM))
244 .setIntValue(etherType)