Documentation / netlink / specs / ovs_datapath.yaml


Based on kernel version 6.11. Page generated on 2024-09-24 08:21 EST.

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
# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)

name: ovs_datapath
version: 2
protocol: genetlink-legacy
uapi-header: linux/openvswitch.h

doc:
  OVS datapath configuration over generic netlink.

definitions:
  -
    name: ovs-header
    type: struct
    members:
      -
        name: dp-ifindex
        type: u32
  -
    name: user-features
    type: flags
    name-prefix: ovs-dp-f-
    enum-name:
    entries:
      -
        name: unaligned
        doc: Allow last Netlink attribute to be unaligned
      -
        name: vport-pids
        doc: Allow datapath to associate multiple Netlink PIDs to each vport
      -
        name: tc-recirc-sharing
        doc: Allow tc offload recirc sharing
      -
        name: dispatch-upcall-per-cpu
        doc: Allow per-cpu dispatch of upcalls
  -
    name: datapath-stats
    enum-name: ovs-dp-stats
    type: struct
    members:
      -
        name: n-hit
        type: u64
      -
        name: n-missed
        type: u64
      -
        name: n-lost
        type: u64
      -
        name: n-flows
        type: u64
  -
    name: megaflow-stats
    enum-name: ovs-dp-megaflow-stats
    type: struct
    members:
      -
        name: n-mask-hit
        type: u64
      -
        name: n-masks
        type: u32
      -
        name: padding
        type: u32
      -
        name: n-cache-hit
        type: u64
      -
        name: pad1
        type: u64

attribute-sets:
  -
    name: datapath
    name-prefix: ovs-dp-attr-
    enum-name: ovs-datapath-attrs
    attributes:
      -
        name: name
        type: string
      -
        name: upcall-pid
        doc: upcall pid
        type: u32
      -
        name: stats
        type: binary
        struct: datapath-stats
      -
        name: megaflow-stats
        type: binary
        struct: megaflow-stats
      -
        name: user-features
        type: u32
        enum: user-features
        enum-as-flags: true
      -
        name: pad
        type: unused
      -
        name: masks-cache-size
        type: u32
      -
        name: per-cpu-pids
        type: binary
        sub-type: u32
      -
        name: ifindex
        type: u32

operations:
  fixed-header: ovs-header
  name-prefix: ovs-dp-cmd-
  list:
    -
      name: get
      doc: Get / dump OVS data path configuration and state
      value: 3
      attribute-set: datapath
      do: &dp-get-op
        request:
          attributes:
            - name
        reply:
          attributes:
            - name
            - upcall-pid
            - stats
            - megaflow-stats
            - user-features
            - masks-cache-size
            - per-cpu-pids
      dump: *dp-get-op
    -
      name: new
      doc: Create new OVS data path
      value: 1
      attribute-set: datapath
      do:
        request:
          attributes:
            - name
            - upcall-pid
            - user-features
    -
      name: del
      doc: Delete existing OVS data path
      value: 2
      attribute-set: datapath
      do:
        request:
          attributes:
            - name

mcast-groups:
  list:
    -
      name: ovs_datapath