Add vm-ubuntu-24.04 directory (#615)

* Support negative-valued action parameters
by converting them in the Python helper code into a positive value
whose bit pattern is the 2's complement representation of the negative
value.

* Add initial version of vm-ubuntu-24.04 directory

Author: jafingerhut

vm-ubuntu-24.04/README.md

@@ -0,0 +1,255 @@
+# Introduction
+
+This directory is still new and a bit experimental at this point.
+Feel free to try it out and report problems if you find any.
+
+Known issues that anyone who knows how to fix is welcome to suggest
+improvements:
+
++ The VM created has a GUI desktop with icons, but the icon images are
+  "blank".
+
+
+# Creating the VM
+
++ Below are the steps to create a brand new VM using Vagrant:
+  + Install [Vagrant](https://developer.hashicorp.com/vagrant/docs/installation) on your system if it's not already installed.
+  + Navigate to the directory where you want to create the new VM.
+  + Run the below command in the terminal.
+    
+    ```bash
+    vagrant up dev
+    ```
+
+  - This command will initiate the creation of a development VM.
+  - The VM will include P4 software installed built from source code.
+
++ `vagrant up` is not supported, as there are not currently
+  pre-compiled Ubuntu 24.04 packages being created by anyone.
+
+*Note* that creating a development VM can take several hours,
+depending upon the speed of your computer and Internet connection.
+
+
+# Creating a VM image for distribution to others
+
+If you are creating the VM for your own use, there is no need to read
+further below.  All later instructions are for those who wish to
+create a VM image for others to download and use.
+
+Some of these steps could probably be automated with programs, and
+changes to the `vagrant` scripts that can do so are welcome.  I
+perform these steps manually to create a VM image, simply to avoid the
+experimentation and time required to automate them.  I typically only
+create new VM images once per month.
+
++ Log in as user p4 (password p4)
++ Upgrade Ubuntu packages if newer ones are available:
+
+  ```bash
+  sudo apt update
+  sudo apt upgrade
+  ```
+
++ Reboot the system.
++ This is optional, but if you want to save a little disk space, use
+  
+  ```bash
+  sudo apt purge <list of packages>
+  ```
+  
+  to remove older version of Linux
+  kernel, if the upgrade installed a newer one.
++ Clean the local repository of retrieved package files to free up disk space
+  
+  ```bash
+  sudo apt clean
+  ```
+  
++ Log in as user p4 (password p4)
++ Start menu -> Preferences -> LXQt settings -> Monitor settings
+  + Change resolution from initial 800x600 to 1024x768.  Apply the changes.
+  + Close monitor settings window
+  + *Note*: For some reason I do not know, these settings seem to be
+    undone, even if I use the "Save" button.  They are temporarily in
+    effect if I shut down the system and log back in, but then in a few
+    seconds it switches back to 800x600.  Strange.
++ Start menu -> Preferences -> LXQt settings -> Desktop
+  + Click "Background" tab
+  + To the right of "Wallpaper image file" name, click "Browse"
+    button.  Find and choose "lxqt-default-wallpaper.png" from the
+    list and click "Open".
+  + In "Wallpaper mode" popup menu, choose "Center on the screen".
+  + Click Apply button
+  + Close "Desktop preferences" window
++ The desktop "icons" are some kind of strange invisible or
+  non-existent icon images.  If you know how to fix this, please let
+  me know.
++ Several of the icons on the desktop have an exclamation mark on
+  them.  If you try double-clicking those icons, it pops up a window
+  saying "This file 'Wireshark' seems to be a desktop entry.  What do
+  you want to do with it?" with buttons for "Open", "Execute", and
+  "Cancel".  Clicking "Execute" executes the associated command.
+  If you do a mouse middle click on one of these desktop icons, a
+  popup menu appears where the second-to-bottom choice is "Trust this
+  executable".  Selecting that causes the exclamation mark to go away,
+  and future double-clicks of the icon execute the program without
+  first popping up a window to choose between Open/Execute/Cancel.  I
+  did that for each of these desktop icons:
+  + Terminal
+  + Wireshark
++ Log off
+
++ Log in as user vagrant (password vagrant)
++ Change monitor settings and wallpaper mode as described above for
+  user p4.
++ Open a terminal.
+  + Run the command
+    
+    ```bash
+    ./clean.sh
+    ```
+    which removes about 6 to 7 GBytes of
+    files created while building the projects.
++ Log off
+
+
+# Notes on test results for the VM
+
+I have run the tests below on every VM image I release, before
+releasing it.  You need not run them again, unless you are curious how
+to do so.
+
+
+## p4c testing results
+
+Steps to run the p4c tests:
+
++ Log in as user vagrant (password vagrant)
++ In a new terminal, execute these commands:
+
+If you are testing on a Release VM image, first get a copy of the p4c
+source code using the following command.  This is unnecessary with a
+Development VM image, as there is already a `p4c` directory with the
+version of source code used to create that image already included in
+the home directory of the `vagrant` user account:
+
+```bash
+# for Release VM image only 
+git clone --recursive https://github.com/p4lang/p4c
+```
+
+The following steps are common for both Release and Development VM
+images:
+
+```bash
+# Compile p4c again from source, since the clean.sh step reduced disk
+# space by deleting the p4c/build directory.
+git clone https://github.com/jafingerhut/p4-guide
+cd p4c
+~/p4-guide/bin/build-p4c.sh
+
+# Run the p4c tests
+cd build
+make -j2 check |& tee out1.txt
+
+# The above fails about 500 tests that require root.  Re-run those tests
+# as root using the next command.
+sudo PATH=${PATH} VIRTUAL_ENV=${VIRTUAL_ENV} ${P4GUIDE_SUDO_OPTS} make -j2 recheck |& tee out2.txt
+```
+
+As of 2024-05-30, the p4c compiler passes all but about 15 of its
+included tests when built using the steps above.
+
+
+## Send ping packets in the solution to `basic` exercise of `p4lang/tutorials` repository
+
+With the version of the [tutorials](https://github.com/p4lang/tutorials) repository
+that comes pre-installed in the `p4` user account of this VM, the
+following tests pass.
+
+First log in as the user `p4` (password `p4`) and open a terminal
+window.
+```bash
+$ cd tutorials/exercises/basic
+$ cp solution/basic.p4 basic.p4
+$ make run
+```
+
+If at the end of many lines of logging output you see a prompt
+`mininet>`, you can try entering the command `h1 ping h2` to ping from
+virtual host `h1` in the exercise to `h2`, and it should report a
+successful ping every second.  It will not stop on its own.  You can
+type Control-C to stop it and return to the `mininet>` prompt, and you
+can type Control-D to exit from mininet and get back to the original
+shell prompt.  To ensure that any processes started by the above steps
+are terminated, you can run this command:
+```bash
+$ make stop
+```
+
+
+# Creating a single file image of the VM
+
+These notes are primarily here as a reminder for people creating VM
+images for distribution.  If you downloaded a VM image, these steps
+were already performed, and there is no reason you need to perform
+them again.
+
+For the particular case of creating the VM named:
+
++ 'P4 Tutorial Development 2024-06-01'
++ created on June 1, 2024
+
+here were the host OS details, in case it turns out that matters to
+the finished VM image for some reason:
+
++ Windows 10 Enterprise
++ VirtualBox 6.1.30 r148432
++ Vagrant 2.2.18
+
+In the VirtualBox GUI interface:
+
++ Choose menu item File -> Export Appliance ...
++ Select the VM named 'P4 Tutorial Development 2024-06-01' and click
+  Continue button
+
++ Format
+  + I used: Open Virtualization Format 1.0
+  + Other available options were:
+    + Open Virtualization Format 0.9
+    + Open Virtualization Format 2.0
++ Target file
+  + I used: /Users/andy/Documents/P4 Tutorials Development 2024-06-01.ova
++ Mac Address Policy
+  + I used: Include only NAT network adapter MAC addresses
+  + Other available options were:
+    + Include all network adapter MAC addresses
+    + Strip all network adapter MAC addresses
++ Additionally
+  + Write Manifest file: checked
+  + Include ISO image files: unchecked
+
+Clicked "Continue" button.
+
+Virtual system settings:
+
++ Name: P4 Tutorial 2024-06-01
++ Product: I left this blank
++ Product-URL: I left this blank
++ Vendor: P4.org - P4 Language Consortium
++ Vendor-URL: https://p4.org
++ Version: 2024-06-01
++ Description:
+
+```
+Open source P4 development tools built from latest source code as of 2024-Jun-01 and packaged into an Ubuntu 20.04 Desktop Linux VM for the AMD64 architecture.
+```
+
++ License
+
+```
+Open source code available hosted at https://github.com/p4lang is released under the Apache 2.0 license.  Libraries it depends upon, such as Protobuf, Thrift, gRPC, Ubuntu Linux, etc. are released under their own licenses.
+```
+
+Clicked "Export" button.

vm-ubuntu-24.04/Vagrantfile

@@ -0,0 +1,50 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure(2) do |config|
+  config.vm.box = "bento/ubuntu-24.04"
+
+  config.vm.synced_folder '.', '/vagrant', disabled: true
+  config.vm.hostname = "p4"
+  config.vm.provision "file", source: "p4-logo.png",   destination: "/home/vagrant/p4-logo.png"
+  config.vm.provision "file", source: "p4_16-mode.el", destination: "/home/vagrant/p4_16-mode.el"
+  config.vm.provision "file", source: "p4.vim",        destination: "/home/vagrant/p4.vim"
+
+  config.vm.define "dev", autostart: false do |dev|
+    dev.vm.provider "virtualbox" do |v|
+      v.name = "P4 Tutorial Development" + Time.now.strftime(" %Y-%m-%d")
+    end
+    dev.vm.provision "file", source: "patches/behavioral-model-support-venv.patch", destination: "/home/vagrant/patches/behavioral-model-support-venv.patch"
+    dev.vm.provision "file", source: "patches/mininet-patch-for-2023-jun-enable-venv.patch", destination: "/home/vagrant/patches/mininet-patch-for-2023-jun-enable-venv.patch"
+    dev.vm.provision "file", source: "patches/tutorials-support-venv.patch", destination: "/home/vagrant/patches/tutorials-support-venv.patch"
+    dev.vm.provision "file", source: "patches/p4runtime-shell-2023-changes.patch", destination: "/home/vagrant/patches/p4runtime-shell-2023-changes.patch"
+    dev.vm.provision "file", source: "clean.sh", destination: "/home/vagrant/clean.sh"
+    dev.vm.provision "shell", inline: "chmod 755 /home/vagrant/clean.sh"
+    dev.vm.provision "shell", path: "root-dev-bootstrap.sh"
+    dev.vm.provision "shell", path: "root-common-bootstrap.sh"
+    dev.vm.provision "shell", privileged: false, path: "user-dev-bootstrap.sh"
+    dev.vm.provision "shell", privileged: false, path: "user-common-bootstrap.sh"
+    # Install p4 logo as wallpaper
+    dev.vm.provision "shell", inline: "mv /home/vagrant/p4-logo.png /usr/share/lubuntu/wallpapers/lubuntu-default-wallpaper.png"
+  end
+
+  config.vm.provider "virtualbox" do |vb|
+    vb.gui = true
+    # Larger memory and vcpus helps build p4c from source
+    # significantly faster.  Reduce this using VirtualBox settings
+    # before creating VM image if desired.
+    vb.memory = 8192
+    vb.cpus = 4
+    vb.customize ["modifyvm", :id, "--cableconnected1", "on"]
+    vb.customize [
+      "storageattach", :id,
+      "--storagectl", "IDE Controller",
+      "--port", "0",
+      "--device", "0",
+      "--type", "dvddrive",
+      "--medium", "emptydrive"
+    ]
+    vb.customize ["modifyvm", :id, "--vram", "64"]
+  end
+
+end

vm-ubuntu-24.04/clean.sh

@@ -0,0 +1,45 @@
+#! /bin/bash
+
+# To reduce disk space used by the virtual machine, delete many build
+# files created during execution of install scripts.
+
+# This script is _not_ automatically run during creation of the VM, so
+# that if anything goes wrong during the build, all of the resulting
+# files are left behind for examination.
+
+DF1_BEFORE=`df -h .`
+DF2_BEFORE=`df -BM .`
+
+# Remove protobuf and grpc sources completely, since they are large
+# and easily downloadable.
+/bin/rm -fr protobuf grpc
+
+cd behavioral-model
+make clean
+cd ..
+
+cd p4c
+/bin/rm -fr build
+cd ..
+
+/bin/rm usr-local-*.txt pip3-list-2b-*.txt
+
+sudo apt autoremove
+sudo apt clean
+
+# Zero out unused disk blocks.  Results in significantly smaller VM
+# image files.
+
+echo "Writing zeros to unused disk blocks (be patient) ..."
+FNAME=`mktemp --tmpdir big-empty-zero-file-XXXXXXXX`
+dd if=/dev/zero of=${FNAME} bs=4096k
+/bin/rm -f ${FNAME}
+
+echo "Disk usage before running this script:"
+echo "$DF1_BEFORE"
+echo "$DF2_BEFORE"
+
+echo ""
+echo "Disk usage after running this script:"
+df -h .
+df -BM .