Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | /* |
| 18 | ONOS GUI -- Topology Model Module. |
| 19 | Auxiliary functions for the model of the topology; that is, our internal |
| 20 | representations of devices, hosts, links, etc. |
| 21 | */ |
| 22 | |
| 23 | (function () { |
| 24 | 'use strict'; |
| 25 | |
| 26 | // injected refs |
Simon Hunt | 08f841d0 | 2015-02-10 14:39:20 -0800 | [diff] [blame] | 27 | var $log, fs, rnd; |
| 28 | |
| 29 | // api to topoForce |
| 30 | var api; |
| 31 | /* |
| 32 | projection() |
| 33 | network {...} |
| 34 | restyleLinkElement( ldata ) |
| 35 | removeLinkElement( ldata ) |
| 36 | */ |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 37 | |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 38 | // shorthand |
Bri Prebilic Cole | aeeb33e | 2015-07-09 15:15:54 -0700 | [diff] [blame] | 39 | var lu, rlk, nodes, links, linksByDevice; |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 40 | |
Simon Hunt | 08f841d0 | 2015-02-10 14:39:20 -0800 | [diff] [blame] | 41 | var dim; // dimensions of layout [w,h] |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 42 | |
| 43 | // configuration 'constants' |
| 44 | var defaultLinkType = 'direct', |
| 45 | nearDist = 15; |
| 46 | |
| 47 | |
| 48 | function coordFromLngLat(loc) { |
| 49 | var p = api.projection(); |
Bri Prebilic Cole | 6b95a3f | 2015-06-04 09:15:00 -0700 | [diff] [blame] | 50 | // suspected cause of ONOS-2109 |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 51 | return p ? p([loc.lng, loc.lat]) : [0, 0]; |
| 52 | } |
| 53 | |
| 54 | function lngLatFromCoord(coord) { |
| 55 | var p = api.projection(); |
| 56 | return p ? p.invert(coord) : [0, 0]; |
| 57 | } |
| 58 | |
| 59 | function positionNode(node, forUpdate) { |
| 60 | var meta = node.metaUi, |
| 61 | x = meta && meta.x, |
| 62 | y = meta && meta.y, |
| 63 | xy; |
| 64 | |
| 65 | // If we have [x,y] already, use that... |
| 66 | if (x && y) { |
| 67 | node.fixed = true; |
| 68 | node.px = node.x = x; |
| 69 | node.py = node.y = y; |
| 70 | return; |
| 71 | } |
| 72 | |
| 73 | var location = node.location, |
| 74 | coord; |
| 75 | |
| 76 | if (location && location.type === 'latlng') { |
| 77 | coord = coordFromLngLat(location); |
| 78 | node.fixed = true; |
| 79 | node.px = node.x = coord[0]; |
| 80 | node.py = node.y = coord[1]; |
| 81 | return true; |
| 82 | } |
| 83 | |
| 84 | // if this is a node update (not a node add).. skip randomizer |
| 85 | if (forUpdate) { |
| 86 | return; |
| 87 | } |
| 88 | |
| 89 | // Note: Placing incoming unpinned nodes at exactly the same point |
| 90 | // (center of the view) causes them to explode outwards when |
| 91 | // the force layout kicks in. So, we spread them out a bit |
| 92 | // initially, to provide a more serene layout convergence. |
| 93 | // Additionally, if the node is a host, we place it near |
| 94 | // the device it is connected to. |
| 95 | |
| 96 | function rand() { |
| 97 | return { |
| 98 | x: rnd.randDim(dim[0]), |
| 99 | y: rnd.randDim(dim[1]) |
| 100 | }; |
| 101 | } |
| 102 | |
| 103 | function near(node) { |
| 104 | return { |
| 105 | x: node.x + nearDist + rnd.spread(nearDist), |
| 106 | y: node.y + nearDist + rnd.spread(nearDist) |
| 107 | }; |
| 108 | } |
| 109 | |
| 110 | function getDevice(cp) { |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 111 | var d = lu[cp.device]; |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 112 | return d || rand(); |
| 113 | } |
| 114 | |
| 115 | xy = (node.class === 'host') ? near(getDevice(node.cp)) : rand(); |
| 116 | angular.extend(node, xy); |
| 117 | } |
| 118 | |
| 119 | function mkSvgCls(dh, t, on) { |
| 120 | var ndh = 'node ' + dh, |
| 121 | ndht = t ? ndh + ' ' + t : ndh; |
| 122 | return on ? ndht + ' online' : ndht; |
| 123 | } |
| 124 | |
| 125 | function createDeviceNode(device) { |
| 126 | var node = device; |
| 127 | |
| 128 | // Augment as needed... |
| 129 | node.class = 'device'; |
| 130 | node.svgClass = mkSvgCls('device', device.type, device.online); |
| 131 | positionNode(node); |
| 132 | return node; |
| 133 | } |
| 134 | |
| 135 | function createHostNode(host) { |
| 136 | var node = host; |
| 137 | |
| 138 | // Augment as needed... |
| 139 | node.class = 'host'; |
| 140 | if (!node.type) { |
| 141 | node.type = 'endstation'; |
| 142 | } |
| 143 | node.svgClass = mkSvgCls('host', node.type); |
| 144 | positionNode(node); |
| 145 | return node; |
| 146 | } |
| 147 | |
| 148 | function createHostLink(host) { |
| 149 | var src = host.id, |
| 150 | dst = host.cp.device, |
| 151 | id = host.ingress, |
| 152 | lnk = linkEndPoints(src, dst); |
| 153 | |
| 154 | if (!lnk) { |
| 155 | return null; |
| 156 | } |
| 157 | |
| 158 | // Synthesize link ... |
| 159 | angular.extend(lnk, { |
| 160 | key: id, |
| 161 | class: 'link', |
Simon Hunt | 5f36108 | 2015-02-25 11:36:38 -0800 | [diff] [blame] | 162 | // NOTE: srcPort left undefined (host end of the link) |
| 163 | tgtPort: host.cp.port, |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 164 | |
| 165 | type: function () { return 'hostLink'; }, |
| 166 | online: function () { |
| 167 | // hostlink target is edge switch |
| 168 | return lnk.target.online; |
| 169 | }, |
| 170 | linkWidth: function () { return 1; } |
| 171 | }); |
| 172 | return lnk; |
| 173 | } |
| 174 | |
| 175 | function createLink(link) { |
| 176 | var lnk = linkEndPoints(link.src, link.dst); |
| 177 | |
| 178 | if (!lnk) { |
| 179 | return null; |
| 180 | } |
| 181 | |
| 182 | angular.extend(lnk, { |
| 183 | key: link.id, |
| 184 | class: 'link', |
| 185 | fromSource: link, |
Simon Hunt | 5f36108 | 2015-02-25 11:36:38 -0800 | [diff] [blame] | 186 | srcPort: link.srcPort, |
| 187 | tgtPort: link.dstPort, |
Bri Prebilic Cole | aeeb33e | 2015-07-09 15:15:54 -0700 | [diff] [blame] | 188 | position: { |
| 189 | x1: 0, |
| 190 | y1: 0, |
| 191 | x2: 0, |
| 192 | y2: 0 |
| 193 | }, |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 194 | |
| 195 | // functions to aggregate dual link state |
| 196 | type: function () { |
| 197 | var s = lnk.fromSource, |
| 198 | t = lnk.fromTarget; |
| 199 | return (s && s.type) || (t && t.type) || defaultLinkType; |
| 200 | }, |
| 201 | online: function () { |
| 202 | var s = lnk.fromSource, |
| 203 | t = lnk.fromTarget, |
| 204 | both = lnk.source.online && lnk.target.online; |
| 205 | return both && ((s && s.online) || (t && t.online)); |
| 206 | }, |
| 207 | linkWidth: function () { |
| 208 | var s = lnk.fromSource, |
| 209 | t = lnk.fromTarget, |
| 210 | ws = (s && s.linkWidth) || 0, |
| 211 | wt = (t && t.linkWidth) || 0; |
Bri Prebilic Cole | 038aedd | 2015-07-13 15:25:16 -0700 | [diff] [blame] | 212 | return lnk.position.multiLink ? 5 : Math.max(ws, wt); |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 213 | } |
| 214 | }); |
| 215 | return lnk; |
| 216 | } |
| 217 | |
| 218 | |
| 219 | function linkEndPoints(srcId, dstId) { |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 220 | var srcNode = lu[srcId], |
| 221 | dstNode = lu[dstId], |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 222 | sMiss = !srcNode ? missMsg('src', srcId) : '', |
| 223 | dMiss = !dstNode ? missMsg('dst', dstId) : ''; |
| 224 | |
| 225 | if (sMiss || dMiss) { |
| 226 | $log.error('Node(s) not on map for link:' + sMiss + dMiss); |
| 227 | //logicError('Node(s) not on map for link:\n' + sMiss + dMiss); |
| 228 | return null; |
| 229 | } |
| 230 | return { |
| 231 | source: srcNode, |
Simon Hunt | 5f36108 | 2015-02-25 11:36:38 -0800 | [diff] [blame] | 232 | target: dstNode |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 233 | }; |
| 234 | } |
| 235 | |
| 236 | function missMsg(what, id) { |
| 237 | return '\n[' + what + '] "' + id + '" missing'; |
| 238 | } |
| 239 | |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 240 | |
| 241 | function makeNodeKey(d, what) { |
| 242 | var port = what + 'Port'; |
| 243 | return d[what] + '/' + d[port]; |
| 244 | } |
| 245 | |
| 246 | function makeLinkKey(d, flipped) { |
| 247 | var one = flipped ? makeNodeKey(d, 'dst') : makeNodeKey(d, 'src'), |
| 248 | two = flipped ? makeNodeKey(d, 'src') : makeNodeKey(d, 'dst'); |
| 249 | return one + '-' + two; |
| 250 | } |
| 251 | |
| 252 | function findLinkById(id) { |
| 253 | // check to see if this is a reverse lookup, else default to given id |
| 254 | var key = rlk[id] || id; |
| 255 | return key && lu[key]; |
| 256 | } |
| 257 | |
| 258 | function findLink(linkData, op) { |
| 259 | var key = makeLinkKey(linkData), |
| 260 | keyrev = makeLinkKey(linkData, 1), |
| 261 | link = lu[key], |
| 262 | linkRev = lu[keyrev], |
| 263 | result = {}, |
| 264 | ldata = link || linkRev, |
| 265 | rawLink; |
| 266 | |
| 267 | if (op === 'add') { |
| 268 | if (link) { |
| 269 | // trying to add a link that we already know about |
| 270 | result.ldata = link; |
| 271 | result.badLogic = 'addLink: link already added'; |
| 272 | |
| 273 | } else if (linkRev) { |
| 274 | // we found the reverse of the link to be added |
| 275 | result.ldata = linkRev; |
| 276 | if (linkRev.fromTarget) { |
| 277 | result.badLogic = 'addLink: link already added'; |
| 278 | } |
| 279 | } |
| 280 | } else if (op === 'update') { |
| 281 | if (!ldata) { |
| 282 | result.badLogic = 'updateLink: link not found'; |
| 283 | } else { |
| 284 | rawLink = link ? ldata.fromSource : ldata.fromTarget; |
| 285 | result.updateWith = function (data) { |
| 286 | angular.extend(rawLink, data); |
| 287 | api.restyleLinkElement(ldata); |
| 288 | } |
| 289 | } |
| 290 | } else if (op === 'remove') { |
| 291 | if (!ldata) { |
| 292 | result.badLogic = 'removeLink: link not found'; |
| 293 | } else { |
| 294 | rawLink = link ? ldata.fromSource : ldata.fromTarget; |
| 295 | |
| 296 | if (!rawLink) { |
| 297 | result.badLogic = 'removeLink: link not found'; |
| 298 | |
| 299 | } else { |
| 300 | result.removeRawLink = function () { |
Bri Prebilic Cole | aeeb33e | 2015-07-09 15:15:54 -0700 | [diff] [blame] | 301 | // remove link out of aggregate linksByDevice list |
| 302 | var linksForDevPair = linksByDevice[ldata.devicePair], |
| 303 | rmvIdx = fs.find(ldata.key, linksForDevPair, 'key'); |
Bri Prebilic Cole | 8040176 | 2015-07-16 11:36:18 -0700 | [diff] [blame] | 304 | if (rmvIdx >= 0) { |
| 305 | linksForDevPair.splice(rmvIdx, 1); |
| 306 | } |
| 307 | ldata.position.multilink = linksForDevPair.length >= 5; |
Bri Prebilic Cole | aeeb33e | 2015-07-09 15:15:54 -0700 | [diff] [blame] | 308 | |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 309 | if (link) { |
| 310 | // remove fromSource |
| 311 | ldata.fromSource = null; |
| 312 | if (ldata.fromTarget) { |
| 313 | // promote target into source position |
| 314 | ldata.fromSource = ldata.fromTarget; |
| 315 | ldata.fromTarget = null; |
| 316 | ldata.key = keyrev; |
| 317 | delete lu[key]; |
| 318 | lu[keyrev] = ldata; |
| 319 | delete rlk[keyrev]; |
| 320 | } |
| 321 | } else { |
| 322 | // remove fromTarget |
| 323 | ldata.fromTarget = null; |
| 324 | delete rlk[keyrev]; |
| 325 | } |
| 326 | if (ldata.fromSource) { |
| 327 | api.restyleLinkElement(ldata); |
| 328 | } else { |
| 329 | api.removeLinkElement(ldata); |
| 330 | } |
| 331 | } |
| 332 | } |
| 333 | } |
| 334 | } |
| 335 | return result; |
| 336 | } |
| 337 | |
| 338 | function findDevices(offlineOnly) { |
| 339 | var a = []; |
| 340 | nodes.forEach(function (d) { |
| 341 | if (d.class === 'device' && !(offlineOnly && d.online)) { |
| 342 | a.push(d); |
| 343 | } |
| 344 | }); |
| 345 | return a; |
| 346 | } |
| 347 | |
| 348 | function findAttachedHosts(devId) { |
| 349 | var hosts = []; |
| 350 | nodes.forEach(function (d) { |
| 351 | if (d.class === 'host' && d.cp.device === devId) { |
| 352 | hosts.push(d); |
| 353 | } |
| 354 | }); |
| 355 | return hosts; |
| 356 | } |
| 357 | |
| 358 | function findAttachedLinks(devId) { |
Simon Hunt | 86b7c88 | 2015-04-02 23:06:08 -0700 | [diff] [blame] | 359 | var lnks = []; |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 360 | links.forEach(function (d) { |
| 361 | if (d.source.id === devId || d.target.id === devId) { |
Simon Hunt | 86b7c88 | 2015-04-02 23:06:08 -0700 | [diff] [blame] | 362 | lnks.push(d); |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 363 | } |
| 364 | }); |
Simon Hunt | 86b7c88 | 2015-04-02 23:06:08 -0700 | [diff] [blame] | 365 | return lnks; |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 366 | } |
| 367 | |
Simon Hunt | 86b7c88 | 2015-04-02 23:06:08 -0700 | [diff] [blame] | 368 | // returns one-way links or where the internal link types differ |
| 369 | function findBadLinks() { |
| 370 | var lnks = [], |
| 371 | src, tgt; |
| 372 | links.forEach(function (d) { |
| 373 | // NOTE: skip edge links, which are synthesized |
| 374 | if (d.type() !== 'hostLink') { |
| 375 | delete d.bad; |
| 376 | src = d.fromSource; |
| 377 | tgt = d.fromTarget; |
| 378 | if (src && !tgt) { |
| 379 | d.bad = 'missing link'; |
| 380 | } else if (src.type !== tgt.type) { |
| 381 | d.bad = 'type mismatch'; |
| 382 | } |
| 383 | if (d.bad) { |
| 384 | lnks.push(d); |
| 385 | } |
| 386 | } |
| 387 | }); |
| 388 | return lnks; |
| 389 | } |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 390 | |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 391 | // ========================== |
| 392 | // Module definition |
| 393 | |
| 394 | angular.module('ovTopo') |
Simon Hunt | 75ec969 | 2015-02-11 16:40:36 -0800 | [diff] [blame] | 395 | .factory('TopoModelService', |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 396 | ['$log', 'FnService', 'RandomService', |
| 397 | |
| 398 | function (_$log_, _fs_, _rnd_) { |
| 399 | $log = _$log_; |
| 400 | fs = _fs_; |
| 401 | rnd = _rnd_; |
| 402 | |
| 403 | function initModel(_api_, _dim_) { |
| 404 | api = _api_; |
| 405 | dim = _dim_; |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 406 | lu = api.network.lookup; |
| 407 | rlk = api.network.revLinkToKey; |
| 408 | nodes = api.network.nodes; |
| 409 | links = api.network.links; |
Bri Prebilic Cole | aeeb33e | 2015-07-09 15:15:54 -0700 | [diff] [blame] | 410 | linksByDevice = api.network.linksByDevice; |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 411 | } |
| 412 | |
| 413 | function newDim(_dim_) { |
| 414 | dim = _dim_; |
| 415 | } |
| 416 | |
Simon Hunt | f542d84 | 2015-02-11 16:20:33 -0800 | [diff] [blame] | 417 | function destroyModel() { } |
| 418 | |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 419 | return { |
| 420 | initModel: initModel, |
| 421 | newDim: newDim, |
Simon Hunt | f542d84 | 2015-02-11 16:20:33 -0800 | [diff] [blame] | 422 | destroyModel: destroyModel, |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 423 | |
| 424 | positionNode: positionNode, |
| 425 | createDeviceNode: createDeviceNode, |
| 426 | createHostNode: createHostNode, |
| 427 | createHostLink: createHostLink, |
| 428 | createLink: createLink, |
| 429 | coordFromLngLat: coordFromLngLat, |
| 430 | lngLatFromCoord: lngLatFromCoord, |
Simon Hunt | dc6adea | 2015-02-09 22:29:36 -0800 | [diff] [blame] | 431 | findLink: findLink, |
| 432 | findLinkById: findLinkById, |
| 433 | findDevices: findDevices, |
| 434 | findAttachedHosts: findAttachedHosts, |
Simon Hunt | 86b7c88 | 2015-04-02 23:06:08 -0700 | [diff] [blame] | 435 | findAttachedLinks: findAttachedLinks, |
| 436 | findBadLinks: findBadLinks |
Simon Hunt | 3a6eec0 | 2015-02-09 21:16:43 -0800 | [diff] [blame] | 437 | } |
| 438 | }]); |
| 439 | }()); |