Merge pull request #85 from amorenoz/cookies

amorenoz · web-flow · commit a97d4b60bc0e · 2021-12-13T14:35:32.000+01:00
Extract cookie information from OVN
diff --git a/containers/k8s-ofparse/Dockerfile.dev b/containers/k8s-ofparse/Dockerfile.dev
@@ -0,0 +1,64 @@
+FROM quay.io/fedora/fedora:33-x86_64 as builder
+
+ARG OVN_REPO=https://github.com/ovn-org/ovn.git
+ARG OVN_BRANCH=main
+ARG OVS_REPO=https://github.com/openvswitch/ovs.git
+ARG OVS_BRANCH=master
+
+RUN dnf upgrade -y && dnf install --best --refresh -y --setopt=tsflags=nodocs \
+	python3-pyyaml python3-pip bind-utils procps-ng openssl numactl-libs firewalld-filesystem \
+        libpcap hostname kubernetes-client python3-openvswitch python3-pyOpenSSL  \
+        iptables iproute jq iputils strace socat\
+	@'Development Tools' rpm-build dnf-plugins-core kmod && \
+	dnf clean all && rm -rf /var/cache/dnf/*
+
+
+WORKDIR /root
+RUN git clone $OVS_REPO
+
+#Build OVS dependency
+WORKDIR /root/ovs
+RUN git fetch && git checkout $OVS_BRANCH && git log -n 1
+RUN sed -e 's/@VERSION@/0.0.1/' rhel/openvswitch-fedora.spec.in > /tmp/ovs.spec
+RUN dnf builddep /tmp/ovs.spec -y
+RUN rm -f /tmp/ovs.spec
+
+#Build OVS binaries and install
+RUN echo "Building OVS rpm"
+RUN ./boot.sh
+RUN ./configure --prefix=/usr --localstatedir=/var --sysconfdir=/etc --enable-ssl
+RUN make rpm-fedora
+
+#Clone OVN Source Code
+WORKDIR /root
+RUN git clone $OVN_REPO
+
+#Build OVN binaries and install
+WORKDIR /root/ovn/
+RUN git fetch && git checkout $OVN_BRANCH && git log -n 1
+RUN ./boot.sh
+RUN ./configure --prefix=/usr --localstatedir=/var --sysconfdir=/etc --with-ovs-source=/root/ovs/
+RUN make rpm-fedora
+
+
+FROM quay.io/fedora/fedora:33-x86_64
+COPY --from=builder /root/ovn/rpm/rpmbuild/RPMS /root/ovn-rpmbuild
+COPY --from=builder /root/ovs/rpm/rpmbuild/RPMS /root/ovs-rpmbuild
+
+RUN dnf upgrade -y && dnf install --best --refresh -y --setopt=tsflags=nodocs \
+	python3-pyyaml python3-pip jq findutils grep git hostname kubernetes-client && \
+	dnf clean all && rm -rf /var/cache/dnf/*
+
+RUN find /root/ovs-rpmbuild -name "*.rpm" | grep -v src | xargs dnf install -y
+RUN find /root/ovn-rpmbuild -name "*.rpm" | grep -v src | xargs dnf install -y
+
+# Install ovs-dbg
+ADD . /root/ovs-dbg
+WORKDIR /root/ovs-dbg
+RUN python3 -m pip install .
+
+WORKDIR /root
+RUN rm -rf /root/ovs /root/ovn
+
+ADD containers/k8s-ofparse/monitor.sh /root/
+ENTRYPOINT ["/root/monitor.sh"]
diff --git a/containers/k8s-ofparse/monitor.sh b/containers/k8s-ofparse/monitor.sh
@@ -40,7 +40,7 @@ monitor() {
 #!/bin/bash
 
 OFPARSE_ARGS="$ofparse_args"
-exec ofparse \$OFPARSE_ARGS \$@
+exec ofparse \$OFPARSE_ARGS "\$@"
 EOF
     chmod +x /usr/local/bin/k8s-ofparse
 
diff --git a/docs/source/ofparse.rst b/docs/source/ofparse.rst
@@ -151,13 +151,16 @@ Openflow parsing
 
 The openflow flow parsing supports this extra formats:
 
-**Logic**: To print the logical representation of a flow run:
+Logic format
+************
+
+**logic**: To print the logical representation of a flow run:
 
 ::
 
     ofparse openflow logic
 
-(run `ofparse --help` for more details)
+(run `ofparse openflow logic --help` for more details)
 
 
 When printing a logical representation of a flow list, flows are grouped into *logical flows* that:
@@ -167,6 +170,50 @@ When printing a logical representation of a flow list, flows are grouped into *l
 - execute the same actions (regardless of the actions' arguments, except for resubmit and output)
 - Optionally, the *cookie* can be counted as part of the logical flow as well (*--cookie*)
 
+Flows are sorted by table and then by logical flow:
+
+
+::
+
+    TABLE 1
+     -> logial flow ( x n )
+       -> flow 1
+       -> flow 2
+       ...
+	
+
+Cookie format
+*************
+Use **cookie** format to sort the flows by cookie and then by table
+
+::
+
+    Cookie 0xa
+     -> TABLE 1
+       -> flow 1
+       -> flow 2
+       ...
+    -> TABLE 2
+    ...
+
+
+ovn-detrace integration
+***********************
+Both **cookie** and **logic** formats support integration with OVN, in particular with ovn-detrace
+utility.
+
+You will need a recent OVN version that contains a specific `ovn-detrace patch`_ as well as locally
+accesible OVN Northbound and OVN Southbound ovsdb-server instances running.
+
+If you have all that, you can enable ovn-detrace support and ofparse will use ovn-detrace to
+extract the OVN information for each cookie and print it alogside the Openflow flows.
+
+See help for more information:
+
+::
+
+    ofparse openflow cookie --help
+
 
 HTML representation
 *******************
@@ -349,3 +396,4 @@ Note filtering is typically applied before the range is calculated.
 .. _ovs-actions: http://www.openvswitch.org/support/dist-docs/ovs-actions.7.html
 .. _ovs-fields: http://www.openvswitch.org/support/dist-docs/ovs-fields.7.html
 .. _ovs-ofctl: http://www.openvswitch.org/support/dist-docs/ovs-ofctl.8.txt
+.. _`ovn-detrace patch`: https://github.com/ovn-org/ovn/commit/d659b6538b00bd72aeca1fc5dd3a3c337ac53f37
diff --git a/k8s/k8s-ofparse.yaml b/k8s/k8s-ofparse.yaml
@@ -45,14 +45,18 @@ spec:
         path: /var/run/openvswitch
   containers:
   - name: k8s-ofparse
-    image: quay.io/amorenoz/k8s-ofparse
+    image: quay.io/amorenoz/k8s-ofparse-devel
     #imagePullPolicy: Always
     volumeMounts:
       - mountPath: /var/run/openvswitch/
         name: host-var-run-ovs
     env:
       - name: OVN_RUNDIR
         value: "/var/run/openvswitch"
+      - name: OVN_NB_DB
+        value: "unix:/var/run/openvswitch/ovnnb_db.sock"
+      - name: OVN_SB_DB
+        value: "unix:/var/run/openvswitch/ovnsb_db.sock"
       - name: OVS_RUNDIR
         value: "/var/run/openvswitch"
     command: ["/root/monitor.sh", "start"]
@@ -80,7 +84,7 @@ spec:
             path: /var/run/openvswitch
       containers:
       - name: k8s-ofparse
-        image: quay.io/amorenoz/k8s-ofparse
+        image: quay.io/amorenoz/k8s-ofparse-devel
         #imagePullPolicy: Always
         volumeMounts:
           - mountPath: /var/run/openvswitch/
diff --git a/ovs_dbg/odp.py b/ovs_dbg/odp.py
@@ -196,7 +196,7 @@ def _action_decoders(cls):
                         ),
                         "userdata": decode_default,
                         "actions": decode_flag,
-                        "tunnel_out_port": decode_int,
+                        "tunnel_out_port": decode_default,
                         "push_eth": nested_kv_decoder(
                             KVDecoders(
                                 {
diff --git a/ovs_dbg/ofparse/ofp.py b/ovs_dbg/ofparse/ofp.py
@@ -1,7 +1,8 @@
 import click
+import os
 
 from ovs_dbg.ofp import OFPFlowFactory
-from ovs_dbg.ofparse.ofp_logic import LogicFlowProcessor
+from ovs_dbg.ofparse.ofp_logic import LogicFlowProcessor, CookieProcessor
 from ovs_dbg.ofparse.main import maincli
 from ovs_dbg.ofparse.process import (
     FlowProcessor,
@@ -10,7 +11,6 @@
 )
 from ovs_dbg.ofparse.html import HTMLBuffer, HTMLFormatter, HTMLStyle
 
-
 factory = OFPFlowFactory()
 
 
@@ -49,7 +49,58 @@ def pretty(opts, heat_map):
     proc.print()
 
 
+def ovn_detrace_callback(ctx, param, value):
+    """click callback to add detrace information to config object and
+    set general ovn-detrace flag to True
+    """
+    ctx.obj[param.name] = value
+    if value != param.default:
+        ctx.obj["ovn_detrace_flag"] = True
+    return value
+
+
 @openflow.command()
+@click.option(
+    "-d",
+    "--ovn-detrace",
+    "ovn_detrace_flag",
+    is_flag=True,
+    show_default=True,
+    help="Use ovn-detrace to extract cookie information (implies '-c')",
+)
+@click.option(
+    "--ovn-detrace-path",
+    default="/usr/bin",
+    type=click.Path(),
+    help="Use an alternative path to where ovn_detrace.py is located. "
+    "Instead of using this option you can just set PYTHONPATH accordingly",
+    show_default=True,
+    callback=ovn_detrace_callback,
+)
+@click.option(
+    "--ovnnb-db",
+    default=os.getenv("OVN_NB_DB") or "unix:/var/run/ovn/ovnnb_db.sock",
+    help="Specify the OVN NB database string (implies -d). "
+    "If the OVN_NB_DB environment variable is set, it's used as default. "
+    "Otherwise, the default is unix:/var/run/ovn/ovnnb_db.sock",
+    callback=ovn_detrace_callback,
+)
+@click.option(
+    "--ovnsb-db",
+    default=os.getenv("OVN_SB_DB") or "unix:/var/run/ovn/ovnsb_db.sock",
+    help="Specify the OVN NB database string (implies -d). "
+    "If the OVN_NB_DB environment variable is set, it's used as default. "
+    "Otherwise, the default is unix:/var/run/ovn/ovnnb_db.sock",
+    callback=ovn_detrace_callback,
+)
+@click.option(
+    "-o",
+    "--ovn-filter",
+    help="Specify a filter to be run on ovn-detrace information (implied -d). "
+    "Format: python regular expression "
+    "(see https://docs.python.org/3/library/re.html)",
+    callback=ovn_detrace_callback,
+)
 @click.option(
     "-s",
     "--show-flows",
@@ -76,7 +127,17 @@ def pretty(opts, heat_map):
     help="Create heat-map with packet and byte counters (when -s is used)",
 )
 @click.pass_obj
-def logic(opts, show_flows, cookie_flag, heat_map):
+def logic(
+    opts,
+    ovn_detrace_flag,
+    ovn_detrace_path,
+    ovnnb_db,
+    ovnsb_db,
+    ovn_filter,
+    show_flows,
+    cookie_flag,
+    heat_map,
+):
     """
     Print the logical structure of the flows.
 
@@ -88,6 +149,11 @@ def logic(opts, show_flows, cookie_flag, heat_map):
     Optionally, the cookie can also be considered to be part of the logical
     flow.
     """
+    if ovn_detrace_flag:
+        opts["ovn_detrace_flag"] = True
+    if opts.get("ovn_detrace_flag"):
+        cookie_flag = True
+
     processor = LogicFlowProcessor(opts, factory, cookie_flag)
     processor.process()
     processor.print(show_flows, heat_map)
@@ -159,3 +225,58 @@ def html(opts):
     processor = HTMLProcessor(opts, factory)
     processor.process()
     print(processor.html())
+
+
+@openflow.command()
+@click.option(
+    "-d",
+    "--ovn-detrace",
+    "ovn_detrace_flag",
+    is_flag=True,
+    show_default=True,
+    help="Use ovn-detrace to extract cookie information",
+)
+@click.option(
+    "--ovn-detrace-path",
+    default="/usr/bin",
+    type=click.Path(),
+    help="Use an alternative path to where ovn_detrace.py is located. "
+    "Instead of using this option you can just set PYTHONPATH accordingly",
+    show_default=True,
+    callback=ovn_detrace_callback,
+)
+@click.option(
+    "--ovnnb-db",
+    default=os.getenv("OVN_NB_DB") or "unix:/var/run/ovn/ovnnb_db.sock",
+    help="Specify the OVN NB database string (implies -d). "
+    "If the OVN_NB_DB environment variable is set, it's used as default. "
+    "Otherwise, the default is unix:/var/run/ovn/ovnnb_db.sock",
+    callback=ovn_detrace_callback,
+)
+@click.option(
+    "--ovnsb-db",
+    default=os.getenv("OVN_SB_DB") or "unix:/var/run/ovn/ovnsb_db.sock",
+    help="Specify the OVN NB database string (implies -d). "
+    "If the OVN_NB_DB environment variable is set, it's used as default. "
+    "Otherwise, the default is unix:/var/run/ovn/ovnnb_db.sock",
+    callback=ovn_detrace_callback,
+)
+@click.option(
+    "-o",
+    "--ovn-filter",
+    help="Specify a filter to be run on ovn-detrace information (implied -d). "
+    "Format: python regular expression "
+    "(see https://docs.python.org/3/library/re.html)",
+    callback=ovn_detrace_callback,
+)
+@click.pass_obj
+def cookie(
+    opts, ovn_detrace_flag, ovn_detrace_path, ovnnb_db, ovnsb_db, ovn_filter
+):
+    """Print the flow tables sorted by cookie"""
+    if ovn_detrace_flag:
+        opts["ovn_detrace_flag"] = True
+
+    processor = CookieProcessor(opts, factory)
+    processor.process()
+    processor.print()
diff --git a/ovs_dbg/ofparse/ofp_logic.py b/ovs_dbg/ofparse/ofp_logic.py

Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ def _action_decoders(cls):`
`196`	`196`	`),`
`197`	`197`	`"userdata": decode_default,`
`198`	`198`	`"actions": decode_flag,`
`199`		`- "tunnel_out_port": decode_int,`
	`199`	`+ "tunnel_out_port": decode_default,`
`200`	`200`	`"push_eth": nested_kv_decoder(`
`201`	`201`	`KVDecoders(`
`202`	`202`	`{`