modules/admin-full/luasrc/model/cbi/admin_network/vlan.lua

   1 --[[
   2 LuCI - Lua Configuration Interface
   3
   4 Copyright 2008 Steven Barth <steven@midlink.org>
   5 Copyright 2010-2011 Jo-Philipp Wich <xm@subsignal.org>
   6
   7 Licensed under the Apache License, Version 2.0 (the "License");
   8 you may not use this file except in compliance with the License.
   9 You may obtain a copy of the License at
  10
  11         http://www.apache.org/licenses/LICENSE-2.0
  12
  13 $Id$
  14 ]]--
  15
  16 m = Map("network", translate("Switch"), translate("The network ports on your router can be combined to several <abbr title=\"Virtual Local Area Network\">VLAN</abbr>s in which computers can communicate directly with each other. <abbr title=\"Virtual Local Area Network\">VLAN</abbr>s are often used to separate different network segments. Often there is by default one Uplink port for a connection to the next greater network like the internet and other ports for a local network."))
  17
  18 m.uci:foreach("network", "switch",
  19         function(x)
  20                 local switch_name = x.name or x['.name']
  21                 local has_vlan    = nil
  22                 local has_learn   = nil
  23                 local has_vlan4k  = nil
  24                 local has_ptpvid  = nil
  25                 local has_jumbo3  = nil
  26                 local min_vid     = 0
  27                 local max_vid     = 16
  28                 local num_vlans   = 16
  29                 local num_ports   = 6
  30                 local cpu_port    = 5
  31
  32                 local enable_vlan4k = false
  33
  34                 -- Parse some common switch properties from swconfig help output.
  35                 local swc = io.popen("swconfig dev %q help 2>/dev/null" % switch_name)
  36                 if swc then
  37
  38                         local is_port_attr = false
  39                         local is_vlan_attr = false
  40
  41                         while true do
  42                                 local line = swc:read("*l")
  43                                 if not line then break end
  44
  45                                 if line:match("^%s+%-%-vlan") then
  46                                         is_vlan_attr = true
  47
  48                                 elseif line:match("^%s+%-%-port") then
  49                                         is_vlan_attr = false
  50                                         is_port_attr = true
  51
  52                                 elseif line:match("^Switch %d+:") then
  53                                         num_ports, cpu_port, num_vlans =
  54                                                 line:match("ports: (%d+) %(cpu @ (%d+)%), vlans: (%d+)")
  55
  56                                         num_ports  = tonumber(num_ports) or  6
  57                                         num_vlans  = tonumber(num_vlans) or 16
  58                                         cpu_port   = tonumber(cpu_port)  or  5
  59                                         min_vid    = 1
  60
  61                                 elseif line:match(": pvid") or line:match(": tag") or line:match(": vid") then
  62                                         if is_vlan_attr then has_vlan4k = line:match(": (%w+)") end
  63                                         if is_port_attr then has_ptpvid = line:match(": (%w+)") end
  64
  65                                 elseif line:match(": enable_vlan4k") then
  66                                         enable_vlan4k = true
  67
  68                                 elseif line:match(": enable_vlan") then
  69                                         has_vlan = "enable_vlan"
  70
  71                                 elseif line:match(": enable_learning") then
  72                                         has_learn = "enable_learning"
  73
  74                                 elseif line:match(": max_length") then
  75                                         has_jumbo3 = "max_length"
  76                                 end
  77                         end
  78
  79                         swc:close()
  80                 end
  81
  82
  83                 -- The PVID options (if any) are added to this table so that
  84                 -- section create below can add the just created vlan to the
  85                 -- choice list of the PVID options...
  86                 local pvid_opts = { }
  87
  88                 -- This function re-reads all existing vlan ids and populates
  89                 -- PVID options choice lists
  90                 local function populate_pvids()
  91                         local vlan_ids = { }
  92                         m.uci:foreach("network", "switch_vlan",
  93                                 function(s)
  94                                         local vid = s[has_vlan4k or "vlan"] or s["vlan"]
  95                                         if vid ~= nil then
  96                                                 vlan_ids[#vlan_ids+1] = vid
  97                                         end
  98                                 end)
  99
 100                         local opt, vid
 101                         for _, opt in ipairs(pvid_opts) do
 102                                 opt:reset_values()
 103                                 opt:value("", translate("none"))
 104                                 for _, vid in luci.util.vspairs(vlan_ids) do
 105                                         opt:value(vid, translatef("VLAN %d", tonumber(vid)))
 106                                 end
 107                         end
 108                 end
 109
 110                 -- Switch properties
 111                 s = m:section(NamedSection, x['.name'], "switch", translatef("Switch %q", switch_name))
 112                 s.addremove = false
 113
 114                 if has_vlan then
 115                         s:option(Flag, has_vlan, translate("Enable VLAN functionality"))
 116                 end
 117
 118                 if enable_vlan4k then
 119                         s:option(Flag, "enable_vlan4k", translate("Enable 4K VLANs"))
 120                 end
 121
 122                 if has_learn then
 123                         x = s:option(Flag, has_learn, translate("Enable learning and aging"))
 124                         x.default = x.enabled
 125                 end
 126
 127                 if has_jumbo3 then
 128                         x = s:option(Flag, has_jumbo3, translate("Enable Jumbo Frame passthrough"))
 129                         x.enabled = "3"
 130                         x.rmempty = true
 131                 end
 132
 133
 134                 -- VLAN table
 135                 s = m:section(TypedSection, "switch_vlan", translatef("VLANs on %q", switch_name))
 136                 s.template = "cbi/tblsection"
 137                 s.addremove = true
 138                 s.anonymous = true
 139
 140                 -- Override cfgsections callback to enforce row ordering by vlan id.
 141                 s.cfgsections = function(self)
 142                         local osections = TypedSection.cfgsections(self)
 143                         local sections = { }
 144                         local section
 145
 146                         for _, section in luci.util.spairs(
 147                                 osections,
 148                                 function(a, b)
 149                                         return (tonumber(m.uci:get("network", osections[a], has_vlan4k or "vlan")) or 9999)
 150                                                 <  (tonumber(m.uci:get("network", osections[b], has_vlan4k or "vlan")) or 9999)
 151                                 end
 152                         ) do
 153                                 sections[#sections+1] = section
 154                         end
 155
 156                         return sections
 157                 end
 158
 159                 -- When creating a new vlan, preset it with the highest found vid + 1.
 160                 -- Repopulate the PVID choice lists afterwards.
 161                 s.create = function(self, section)
 162                         local sid = TypedSection.create(self, section)
 163
 164                         local max_nr = 0
 165                         local max_id = 0
 166
 167                         m.uci:foreach("network", "switch_vlan",
 168                                 function(s)
 169                                         local nr = tonumber(s.vlan)
 170                                         local id = has_vlan4k and tonumber(s[has_vlan4k])
 171                                         if nr ~= nil and nr > max_nr then max_nr = nr end
 172                                         if id ~= nil and id > max_id then max_id = id end
 173                                 end)
 174
 175                         m.uci:set("network", sid, "vlan", max_nr + 1)
 176
 177                         if has_vlan4k then
 178                                 m.uci:set("network", sid, has_vlan4k, max_id + 1)
 179                         end
 180
 181                         -- add newly created vlan to the pvid choice list
 182                         populate_pvids()
 183
 184                         return sid
 185                 end
 186
 187                 -- Repopulate PVId choice lists if a vlan gets removed.
 188                 s.remove = function(self, section)
 189                         local rv = TypedSection.remove(self, section)
 190
 191                         -- repopulate pvid choices
 192                         populate_pvids()
 193
 194                         return rv
 195                 end
 196
 197
 198                 local port_opts = { }
 199                 local untagged  = { }
 200
 201                 -- Parse current tagging state from the "ports" option.
 202                 local portvalue = function(self, section)
 203                         local pt
 204                         for pt in (m.uci:get("network", section, "ports") or ""):gmatch("%w+") do
 205                                 local pc, tu = pt:match("^(%d+)([tu]*)")
 206                                 if pc == self.option then return (#tu > 0) and tu or "u" end
 207                         end
 208                         return ""
 209                 end
 210
 211                 -- Validate port tagging. Ensure that a port is only untagged once,
 212                 -- bail out if not.
 213                 local portvalidate = function(self, value, section)
 214                         -- ensure that the ports appears untagged only once
 215                         if value == "u" then
 216                                 if not untagged[self.option] then
 217                                         untagged[self.option] = true
 218                                 elseif min_vid > 0 or tonumber(self.option) ~= cpu_port then -- enable multiple untagged cpu ports due to weird broadcom default setup
 219                                         return nil,
 220                                                 translatef("Port %d is untagged in multiple VLANs!", tonumber(self.option) + 1)
 221                                 end
 222                         end
 223                         return value
 224                 end
 225
 226
 227                 local vid = s:option(Value, has_vlan4k or "vlan", "VLAN ID")
 228
 229                 vid.rmempty = false
 230                 vid.forcewrite = true
 231
 232                 -- Validate user provided VLAN ID, make sure its within the bounds
 233                 -- allowed by the switch.
 234                 vid.validate = function(self, value, section)
 235                         local v = tonumber(value)
 236                         local m = has_vlan4k and 4094 or (num_vlans - 1)
 237                         if v ~= nil and v >= min_vid and v <= m then
 238                                 return value
 239                         else
 240                                 return nil,
 241                                         translatef("Invalid VLAN ID given! Only IDs between %d and %d are allowed.", min_vid, m)
 242                         end
 243                 end
 244
 245                 -- When writing the "vid" or "vlan" option, serialize the port states
 246                 -- as well and write them as "ports" option to uci.
 247                 vid.write = function(self, section, value)
 248                         local o
 249                         local p = { }
 250
 251                         for _, o in ipairs(port_opts) do
 252                                 local v = o:formvalue(section)
 253                                 if v == "t" then
 254                                         p[#p+1] = o.option .. v
 255                                 elseif v == "u" then
 256                                         p[#p+1] = o.option
 257                                 end
 258                         end
 259
 260                         m.uci:set("network", section, "ports", table.concat(p, " "))
 261                         return Value.write(self, section, value)
 262                 end
 263
 264                 -- Fallback to "vlan" option if "vid" option is supported but unset.
 265                 vid.cfgvalue = function(self, section)
 266                         return m.uci:get("network", section, has_vlan4k or "vlan")
 267                                 or m.uci:get("network", section, "vlan")
 268                 end
 269
 270                 -- Build per-port off/untagged/tagged choice lists.
 271                 local pt
 272                 for pt = 0, num_ports - 1 do
 273                         local po = s:option(ListValue, tostring(pt),
 274                                 (pt == cpu_port) and translate("CPU") or translatef("Port %d", (pt + 1)))
 275
 276                         po:value("", translate("off"))
 277                         po:value("u" % pt, translate("untagged"))
 278                         po:value("t" % pt, translate("tagged"))
 279
 280                         po.cfgvalue = portvalue
 281                         po.validate = portvalidate
 282                         po.write    = function() end
 283
 284                         port_opts[#port_opts+1] = po
 285                 end
 286
 287
 288                 -- Does this switch support PVIDs?
 289                 if has_ptpvid then
 290
 291                         -- Spawn a "virtual" section. We just attach it to the global
 292                         -- switch section here, the overrides below take care of writing
 293                         -- the actual values to the correct uci sections.
 294                         s = m:section(TypedSection, "switch",
 295                                 translatef("Port PVIDs on %q", switch_name),
 296                                 translate("Port <abbr title=\"Primary VLAN IDs\">PVIDs</abbr> specify " ..
 297                                         "the default VLAN ID added to received untagged frames."))
 298
 299                         s.template  = "cbi/tblsection"
 300                         s.addremove = false
 301                         s.anonymous = true
 302
 303                         -- Build port list, store pointers to the option objects in the
 304                         -- pvid_opts array so that other callbacks can repopulate their
 305                         -- choice lists.
 306                         local pt
 307                         for pt = 0, num_ports - 1 do
 308                                 local po = s:option(ListValue, tostring(pt),
 309                                         (pt == cpu_port) and translate("CPU") or translatef("Port %d", (pt + 1)))
 310
 311                                 -- When cbi queries the current config value for this post,
 312                                 -- lookup the associated switch_port section (if any) and
 313                                 -- return its "pvid" or "vlan" option value.
 314                                 po.cfgvalue = function(self, section)
 315                                         local val
 316                                         m.uci:foreach("network", "switch_port",
 317                                                 function(s)
 318                                                         if s.port == self.option then
 319                                                                 val = s[has_ptpvid]
 320                                                                 return false
 321                                                         end
 322                                                 end)
 323                                         return val
 324                                 end
 325
 326                                 -- On write, find the actual switch_port section associated
 327                                 -- to this port and set the value there. Create a new
 328                                 -- switch_port section for this port if there is none yet.
 329                                 po.write = function(self, section, value)
 330                                         local found = false
 331
 332                                         m.uci:foreach("network", "switch_port",
 333                                                 function(s)
 334                                                         if s.port == self.option then
 335                                                                 m.uci:set("network", s['.name'], has_ptpvid, value)
 336                                                                 found = true
 337                                                                 return false
 338                                                         end
 339                                                 end)
 340
 341                                         if not found then
 342                                                 m.uci:section("network", "switch_port", nil, {
 343                                                         ["port"]     = self.option,
 344                                                         [has_ptpvid] = value
 345                                                 })
 346                                         end
 347                                 end
 348
 349                                 -- If the user cleared the PVID value on this port, find
 350                                 -- the associated switch_port section and clear it.
 351                                 -- If the section does not contain any other unrelated
 352                                 -- options (like led or blinkrate) then remove it completely,
 353                                 -- else just clear out the "pvid" option.
 354                                 po.remove = function(self, section)
 355                                         m.uci:foreach("network", "switch_port",
 356                                                 function(s)
 357                                                         if s.port == self.option then
 358                                                                 local k, found
 359                                                                 local empty = true
 360
 361                                                                 for k, _ in pairs(s) do
 362                                                                         if k:sub(1,1) ~= "." and k ~= "port" and k ~= has_ptpvid then
 363                                                                                 empty = false
 364                                                                                 break
 365                                                                         end
 366                                                                 end
 367
 368                                                                 if empty then
 369                                                                         m.uci:delete("network", s['.name'])
 370                                                                 else
 371                                                                         m.uci:delete("network", s['.name'], has_ptpvid)
 372                                                                 end
 373
 374                                                                 return false
 375                                                         end
 376                                                 end)
 377                                 end
 378
 379                                 -- The referenced VLAN might just have been removed, simply
 380                                 -- return "" (none) in this case to avoid triggering a
 381                                 -- validation error.
 382                                 po.validate = function(...)
 383                                         return ListValue.validate(...) or ""
 384                                 end
 385
 386                                 pvid_opts[#pvid_opts+1] = po
 387                         end
 388
 389                         populate_pvids()
 390                 end
 391         end
 392 )
 393
 394 return m