added steps to run example in ns-3 by Vineet1101 · Pull Request #713 · p4lang/tutorials

Vineet1101 · 2026-02-03T12:51:50Z

No description provided.

Vineet1101 · 2026-02-03T12:52:35Z

@jafingerhut @fruffy I have added the steps to run p4 programs inside ns-3

Dscano · 2026-02-15T09:46:30Z

doc/P4sim/README.md


+---
+##  5. Run an Example
+Before running the example you need to **copy and paste** that particular example inside `ns3's scratch` folder then you can run a built-in example using:


Can you add the commands to copy exampleA? In other words, I would provide the exact set of commands that you need to follow at each step.

I added more details can you review it and tell if anything else is required

Dscano

Can you provide a clear explanation of why those changes are needed and what is the purpose of this PR?

Dscano · 2026-02-15T11:03:42Z

doc/P4sim/README.md

 ```

 ---
+## 4. Running an example 


Why section 4 and 5 have the same name? Which should be the difference?

@Vineet1101 why this?

I meant to write Prepare an example but forgot to replace that

Dscano · 2026-02-15T11:05:31Z

doc/P4sim/README.md


+---
+##  5. Run an Example
+Before running the example you need to **copy and paste** that particular example inside `ns3's scratch` folder then you can run a example using:


Can you add also the commands for copy paste the execise?

they are just ctrl+c and ctrl+v. Should I add them??

I’m suggesting you add a bash commands to do that, so people can easily copy and paste the example.

Dscano · 2026-02-15T11:05:59Z

doc/P4sim/README.md

+  std::string p4JsonPath = "/home/p4/workdir/ns3.39/contrib/p4sim/examples/p4src/p4_basic/p4_basic.json";
+  std::string flowTableDirPath ="/home/p4/workdir/ns3.39/contrib/p4sim/examples/p4src/p4_basic/";// path to flow table folder where all flow tables are located.
+  std::string topoInput ="/home/p4/workdir/ns3.39/contrib/p4sim/examples/p4src/p4_basic/topo.txt";//path to topo file that the example uses
+  // This is for p4-basic-controller.cc file


Why previusly you remove this line and now you added them again?

Vineet1101 · 2026-02-15T11:31:26Z

Can you provide a clear explanation of why those changes are needed and what is the purpose of this PR?

ok the previous PR was for installing ns-3 and p4sim and this PR is for adding more detailed instructions on how to run a program inside ns-3

Dscano · 2026-02-15T12:11:36Z

doc/P4sim/README.md

 ```

 ---
+## 4. Running an example 


@Vineet1101 why this?

Signed-off-by: Vineet1101 <Vineetgoel692@gmail.com>

Vineet1101 · 2026-02-17T03:20:18Z

@Dscano I have added bash script for copy and paste commands and also added more and clear details for running an example. Please review it and tell if anything else is needed

Signed-off-by: Vineet1101 <Vineetgoel692@gmail.com>

Dscano

Can you combine sections 4 and 5 into a single section, section 4, and titled it "Run a Simulation Example".

Signed-off-by: Vineet1101 <Vineetgoel692@gmail.com>

Vineet1101 · 2026-02-17T09:53:38Z

Can you combine sections 4 and 5 into a single section, section 4, and titled it "Run a Simulation Example".

done

Dscano · 2026-02-17T16:02:18Z

doc/P4sim/README.md

 ```

-### 7. Run a Simulation Example  
+### 7. Run a Simulation Example


You have repeated twice section 7

yes because the original P4Sim documentation repeats this section so I kept it that way. Should I remove one and make a reference to the other??

Dscano · 2026-02-17T16:18:34Z

@jafingerhut can you merge this PR, I'm not authorized to push it.

jafingerhut · 2026-02-17T18:05:19Z

@jafingerhut can you merge this PR, I'm not authorized to push it.

I am authorized to do so, but I would really appreciate if the submitter would consider simplifying the steps to run an example, based upon a comment I have made twice so far:

Without copying any files at all after installing ns3, I was able to run the command below, and it gave lots of output that seem like it did something:

./ns3 run contrib/p4sim/examples/p4-basic-controller.cc

If that works for you, too, without copying any files, I would recommend giving the command above as an example, and OMIT all of the instructions for copying files, running sed, etc. They seem unnecessarily complicated to me, if the single command above works.

Vineet1101 · 2026-02-17T23:33:55Z

@jafingerhut can you merge this PR, I'm not authorized to push it.

I am authorized to do so, but I would really appreciate if the submitter would consider simplifying the steps to run an example, based upon a comment I have made twice so far:

Without copying any files at all after installing ns3, I was able to run the command below, and it gave lots of output that seem like it did something:
./ns3 run contrib/p4sim/examples/p4-basic-controller.cc
If that works for you, too, without copying any files, I would recommend giving the command above as an example, and OMIT all of the instructions for copying files, running sed, etc. They seem unnecessarily complicated to me, if the single command above works.

@jafingerhut There is a difference between the two approaches:

When an example is placed in the scratch folder, ns-3 automatically handles building the file and linking dependencies, so it can be run directly. This approach is convenient for quick testing and prototyping.

When an example is placed inside a module directory such as contrib/p4sim/examples, it must be declared in the corresponding CMakeLists.txt file. This allows ns-3 to build and integrate it properly. The reason p4-basic-controller.cc can be run directly is that it is already declared in the CMakeLists.txt file. This is the intended approach when contributing examples to the repository.

fruffy approved these changes Feb 6, 2026

View reviewed changes

Dscano requested changes Feb 15, 2026

View reviewed changes

Vineet1101 requested a review from Dscano February 15, 2026 10:09

Dscano requested changes Feb 15, 2026

View reviewed changes

doc/P4sim/README.md Outdated

```

---

## 4. Running an example

Copy link

Contributor

Dscano Feb 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Vineet1101 why this?

Vineet1101 added 3 commits February 17, 2026 08:45

added steps to run example in ns-3

95ce23a

Signed-off-by: Vineet1101 <Vineetgoel692@gmail.com>

added more details to run examples

4883788

Signed-off-by: Vineet1101 <Vineetgoel692@gmail.com>

added more details and bash script to run p4sim examples

089af33

Signed-off-by: Vineet1101 <Vineetgoel692@gmail.com>

Vineet1101 force-pushed the master branch from e97f6db to 089af33 Compare February 17, 2026 03:17

Vineet1101 requested a review from Dscano February 17, 2026 03:20

removed repeated parts in the docs and added bash script

b40167e

Signed-off-by: Vineet1101 <Vineetgoel692@gmail.com>

Vineet1101 mentioned this pull request Feb 17, 2026

Reworked documentation HapCommSys/p4sim#7

Closed

Dscano requested changes Feb 17, 2026

View reviewed changes

merged section 4 and 5 of the documentaion

93006f9

Signed-off-by: Vineet1101 <Vineetgoel692@gmail.com>

Vineet1101 requested a review from Dscano February 17, 2026 15:28

Dscano requested changes Feb 17, 2026

View reviewed changes

Dscano approved these changes Feb 17, 2026

View reviewed changes

Conversation

Vineet1101 commented Feb 3, 2026

Uh oh!

Vineet1101 commented Feb 3, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vineet1101 Feb 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Dscano left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vineet1101 Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vineet1101 commented Feb 15, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vineet1101 commented Feb 17, 2026

Uh oh!

Dscano left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vineet1101 commented Feb 17, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vineet1101 Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Dscano commented Feb 17, 2026

Uh oh!

jafingerhut commented Feb 17, 2026

Uh oh!

Vineet1101 commented Feb 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

Vineet1101 Feb 15, 2026 •

edited

Loading

Vineet1101 Feb 17, 2026 •

edited

Loading

Dscano left a comment •

edited

Loading

Vineet1101 Feb 17, 2026 •

edited

Loading