1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
/*
* Copyright (c) 2016 Cisco and/or its affiliates.
*
* 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 io.fd.honeycomb.v3po.impl.data;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.AsyncFunction;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import io.fd.honeycomb.v3po.impl.LoggingFuturesCallBack;
import io.fd.honeycomb.v3po.impl.trans.DefaultVppWriter;
import io.fd.honeycomb.v3po.impl.trans.VppInterfacesReader;
import java.util.Collection;
import java.util.Collections;
import javassist.ClassPool;
import javax.annotation.Nonnull;
import org.opendaylight.controller.md.sal.binding.api.DataBroker;
import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
import org.opendaylight.controller.sal.core.api.Broker;
import org.opendaylight.controller.sal.core.api.Provider;
import org.opendaylight.controller.sal.core.api.model.SchemaService;
import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
import org.opendaylight.yangtools.binding.data.codec.gen.impl.DataObjectSerializerGenerator;
import org.opendaylight.yangtools.binding.data.codec.gen.impl.StreamWriterGenerator;
import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
import org.opendaylight.yangtools.concepts.ObjectRegistration;
import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
import org.opendaylight.yangtools.sal.binding.generator.util.JavassistUtils;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Creates VppDataBroker which uses DataTree instead of DataStore internally in order to obtain better control over the
* data processing in Honeycomb agent
*/
public final class VppDataBrokerInitializationProvider implements Provider, AutoCloseable {
private static final Logger LOG = LoggerFactory.getLogger(VppDataBrokerInitializationProvider.class);
private final TopologyId VPP_TOPOLOGY_ID = TopologyId.getDefaultInstance("vpp-topology");
private final NodeId VPP_TOPOLOGY_NODE_ID = NodeId.getDefaultInstance("vpp");
private final DataBroker bindingBroker;
private final InstanceIdentifier<Node> mountPointPath;
private ObjectRegistration<DOMMountPoint> mountPointRegistration;
public VppDataBrokerInitializationProvider(@Nonnull final DataBroker bindingBroker) {
this.bindingBroker = Preconditions.checkNotNull(bindingBroker, "bindingBroker should not be null");
this.mountPointPath = getMountPointPath();
}
// TODO make configurable
private InstanceIdentifier<Node> getMountPointPath() {
final InstanceIdentifier<NetworkTopology> networkTopology =
InstanceIdentifier.builder(NetworkTopology.class).build();
final KeyedInstanceIdentifier<Topology, TopologyKey> topology =
networkTopology.child(Topology.class, new TopologyKey(VPP_TOPOLOGY_ID));
return topology.child(Node.class, new NodeKey(VPP_TOPOLOGY_NODE_ID));
}
@Override
public void onSessionInitiated(final Broker.ProviderSession providerSession) {
LOG.info("Session initialized, providerSession={}", providerSession);
Preconditions.checkState(!isMountPointRegistered(), "Mount point is already registered");
final DOMMountPointService mountPointService = providerSession.getService(DOMMountPointService.class);
final SchemaService schemaService = providerSession.getService(SchemaService.class);
final SchemaContext globalContext = schemaService.getGlobalContext();
final BindingNormalizedNodeSerializer serializer = initSerializer(globalContext);
final YangInstanceIdentifier path = serializer.toYangInstanceIdentifier(mountPointPath);
final DOMMountPointService.DOMMountPointBuilder mountPointBuilder = mountPointService.createMountPoint(path);
mountPointBuilder.addInitialSchemaContext(globalContext);
final DOMDataBroker broker = initVppDataBroker(globalContext, serializer);
mountPointBuilder.addService(DOMDataBroker.class, broker);
mountPointRegistration = mountPointBuilder.register();
final DOMMountPoint mountPoint = mountPointRegistration.getInstance();
LOG.debug("Created mountPoint: identifier={}, schemaContext={}", mountPoint.getIdentifier(),
mountPoint.getSchemaContext());
createMountPointPlaceholder();
initialVppStateSynchronization(broker);
}
@Override
public Collection<ProviderFunctionality> getProviderFunctionality() {
return Collections.EMPTY_LIST;
}
private boolean isMountPointRegistered() {
final ReadOnlyTransaction readTx = bindingBroker.newReadOnlyTransaction();
try {
final Optional<Node> cfgPlaceholder =
readTx.read(LogicalDatastoreType.CONFIGURATION, mountPointPath).checkedGet();
final Optional<Node> operPlaceholder =
readTx.read(LogicalDatastoreType.OPERATIONAL, mountPointPath).checkedGet();
return cfgPlaceholder.isPresent() || operPlaceholder.isPresent();
} catch (ReadFailedException e) {
throw new IllegalStateException("Failed to read mountpoint placeholder data", e);
}
}
private BindingNormalizedNodeSerializer initSerializer(final SchemaContext globalContext) {
final JavassistUtils utils = JavassistUtils.forClassPool(ClassPool.getDefault());
// TODO this produces ClassNotFoundException
//final GeneratedClassLoadingStrategy loading = GeneratedClassLoadingStrategy.getTCCLClassLoadingStrategy();
// FIXME get global class loader instance
final GeneratedClassLoadingStrategy loadingStrategy =
new GeneratedClassLoadingStrategy() {
@Override
public Class<?> loadClass(final String fullyQualifiedName)
throws ClassNotFoundException {
return Class.forName(fullyQualifiedName);
}
};
final DataObjectSerializerGenerator generator = StreamWriterGenerator.create(utils);
// TODO make configurable:
final BindingNormalizedNodeCodecRegistry serializer = new BindingNormalizedNodeCodecRegistry(generator);
final BindingRuntimeContext context = BindingRuntimeContext.create(loadingStrategy, globalContext);
serializer.onBindingRuntimeContextUpdated(context);
return serializer;
}
private DOMDataBroker initVppDataBroker(final SchemaContext globalContext,
final BindingNormalizedNodeSerializer serializer) {
final ReadableVppDataTree operationalData =
new VppOperationalDataTree(serializer, new VppInterfacesReader()); // TODO make configurable
final DataTree dataTree =
InMemoryDataTreeFactory.getInstance().create(TreeType.CONFIGURATION); // TODO make configurable
dataTree.setSchemaContext(globalContext);
final VppDataTree configDataProxy = new VppConfigDataTree(serializer, dataTree,
new DefaultVppWriter()); // TODO make configurable
return new VppDataBroker(operationalData, configDataProxy);
}
/**
* Writes placeholder data into MD-SAL's global datastore to indicate the presence of VPP mountpoint.
*/
private void createMountPointPlaceholder() {
final NodeBuilder nodeBuilder = new NodeBuilder();
nodeBuilder.setKey(new NodeKey(VPP_TOPOLOGY_NODE_ID));
final Node node = nodeBuilder.build();
final WriteTransaction writeTx = bindingBroker.newWriteOnlyTransaction();
writeTx.merge(LogicalDatastoreType.CONFIGURATION, mountPointPath, node, true);
writeTx.merge(LogicalDatastoreType.OPERATIONAL, mountPointPath, node, true);
try {
writeTx.submit().checkedGet();
} catch (TransactionCommitFailedException e) {
throw new IllegalStateException("Failed to create mountpoint placeholder", e);
}
}
// TODO operational and config models are not 1-1
// decide what part of operational data should be written to config during initialization
private void initialVppStateSynchronization(final DOMDataBroker broker) {
// read from operational
final DOMDataReadOnlyTransaction readTx = broker.newReadOnlyTransaction();
final YangInstanceIdentifier interfacesID = YangInstanceIdentifier.of(Interfaces.QNAME);
final ListenableFuture<Void> writeFuture = Futures.transform(
readTx.read(LogicalDatastoreType.OPERATIONAL, interfacesID),
new AsyncFunction<Optional<NormalizedNode<?, ?>>, Void>() {
@Override
public ListenableFuture<Void> apply(final Optional<NormalizedNode<?, ?>> readResult)
throws Exception {
if (readResult.isPresent()) {
final DOMDataWriteTransaction writeTx = broker.newWriteOnlyTransaction();
writeTx.put(LogicalDatastoreType.CONFIGURATION, interfacesID, readResult.get());
return writeTx.submit();
} else {
return Futures
.immediateFailedFuture(
new IllegalStateException("Failed to read data from VPP."));
}
}
});
Futures.addCallback(writeFuture,
new LoggingFuturesCallBack<Void>("Initializing VPP config DataTree failed", LOG));
}
@Override
public void close() throws Exception {
if (mountPointRegistration != null) {
mountPointRegistration.close();
}
// remove MD-SAL placeholder data for VPP mount point:
final WriteTransaction rwTx = bindingBroker.newWriteOnlyTransaction();
// does not fail if data is not present:
rwTx.delete(LogicalDatastoreType.CONFIGURATION, mountPointPath);
try {
rwTx.submit().checkedGet();
} catch (TransactionCommitFailedException e) {
throw new IllegalStateException("Failed to remove mountpoint's placeholder from MD-SAL's global datastore",
e);
}
}
}
|
