Network Simulator - ns-3 - Revision history

Artturin: Improve nix expr for cross compilation combatibility, builds without clang, make the makefile work.

2024-10-29T18:05:20Z

Improve nix expr for cross compilation combatibility, builds without clang, make the makefile work.

← Older revision		Revision as of 18:05, 29 October 2024
Line 3:		Line 3:
	== Developing with ns-3 ==		== Developing with ns-3 ==
	ns-3 heavily relies on way for running simulations (examples, tutorials, etc.), but we can start developing using a simple Makefile and a shell.nix.		ns-3 heavily relies on way for running simulations (examples, tutorials, etc.), but we can start developing using a simple Makefile and a shell.nix.
	We will use [https://www.nsnam.org/doxygen/hello-simulator_8cc_source.html hello-simulator.cc] for this example.		We will use [https://www.nsnam.org/docs/release/3.43/doxygen/d4/d87/hello-simulator_8cc_source.html hello-simulator.cc] for this example.

	First create a <code>shell.nix</code>, with the requirements to compile our simulation.		First create a <code>shell.nix</code>, with the requirements to compile our simulation.

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	~~with~~ import <nixpkgs> {};		{
			pkgs ? import <nixpkgs> { },
	~~mkShell {~~		}:
	~~nativeBuildInputs = [~~		pkgs.callPackage (
	~~llvmPackages_latest.clang~~		{
	pkg-config		mkShell,
	];		pkg-config,
	buildInputs = [ ns-3 ];		ns-3,
	}		}:
			mkShell {
			strictDeps = true;
			nativeBuildInputs = [ pkg-config ];
			buildInputs = [ ns-3 ];
			}
			) { }
	</syntaxhighlight>		</syntaxhighlight>

	Then we can create our <code>Makefile</code>, do note the LIBS argument, which is the modules required (not all are build by default, might have to override some settings in ns-3).		Then we can create our <code>Makefile</code>, do note the LIBS argument, which is the modules required (not all are build by default, might have to override some settings in ns-3).

	<syntaxhighlight lang=~~Make~~>		<syntaxhighlight lang="make">
	~~# the compiler:~~ gcc ~~for C program, define as~~ g~~++ for C~~++		CC ?= gcc
	CC = ~~clang++~~		CXX ?= g++
			PKG_CONFIG ?= pkg-config

	DEBUG=-DNS3_LOG_ENABLE		DEBUG=-DNS3_LOG_ENABLE

	LIBS = ~~libns3-dev~~-core~~-debug~~		LIBS = ns3-core

	# compiler flags:		# compiler flags:
	# -g adds debugging information to the executable file		# -g adds debugging information to the executable file
	# -Wall turns on most, but not all, compiler warnings		# -Wall turns on most, but not all, compiler warnings
	CFLAGS = -g -Wall -Wextra $(shell ~~pkg-config~~ --cflags $(LIBS))		CFLAGS = -g -Wall -Wextra $(shell $(PKG_CONFIG) --cflags $(LIBS))
	LDFLAGS=$(shell ~~pkg-config~~ --libs $(LIBS))		LDFLAGS=$(shell $(PKG_CONFIG) --libs $(LIBS))

	# the build target executable:		# the build target executable:
Line 41:		Line 48:

	$(TARGET): $(TARGET).cc		$(TARGET): $(TARGET).cc
	$(CC) $(DEBUG) $(CFLAGS) $(LDFLAGS) -o $(TARGET) $(TARGET).cc		$(CXX) $(DEBUG) $(CFLAGS) $(LDFLAGS) -o $(TARGET) $(TARGET).cc

	clean:		clean:

Klinger: Category:Applications

2024-04-24T20:19:40Z

Category:Applications

← Older revision		Revision as of 20:19, 24 April 2024
Line 56:		Line 56:

	Please keep in mind our flag when we compile, regarding debug <code>NS3_LOG_ENABLE</code>.		Please keep in mind our flag when we compile, regarding debug <code>NS3_LOG_ENABLE</code>.
			[[Category:Applications]]

imported>Mic92: syntax highlighting; revisit nix shell

2020-10-28T18:07:08Z

syntax highlighting; revisit nix shell

← Older revision		Revision as of 18:07, 28 October 2020
Line 11:		Line 11:

	mkShell {		mkShell {
	~~buildInputs~~ = ~~with pkgs;~~ [		nativeBuildInputs = [
	~~ns-3~~		llvmPackages_latest.clang
	clang
	pkg-config		pkg-config
	];		];
			buildInputs = [ ns-3 ];
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Line 21:		Line 21:
	Then we can create our <code>Makefile</code>, do note the LIBS argument, which is the modules required (not all are build by default, might have to override some settings in ns-3).		Then we can create our <code>Makefile</code>, do note the LIBS argument, which is the modules required (not all are build by default, might have to override some settings in ns-3).

	<syntaxhighlight>		<syntaxhighlight lang=Make>
	# the compiler: gcc for C program, define as g++ for C++		# the compiler: gcc for C program, define as g++ for C++
	CC = clang++		CC = clang++

imported>EyJhb: ns-3 is a discrete-event network simulator for Internet systems, targeted primarily for research and educational use. This shows how to do development using ns-3

2020-10-28T14:22:37Z

ns-3 is a discrete-event network simulator for Internet systems, targeted primarily for research and educational use. This shows how to do development using ns-3

New page

This is for discrete-event network simulator [https://www.nsnam.org/ ns-3].

== Developing with ns-3 ==
ns-3 heavily relies on way for running simulations (examples, tutorials, etc.), but we can start developing using a simple Makefile and a shell.nix.
We will use [https://www.nsnam.org/doxygen/hello-simulator_8cc_source.html hello-simulator.cc] for this example.

First create a <code>shell.nix</code>, with the requirements to compile our simulation.

<syntaxhighlight lang="nix">
with import <nixpkgs> {};

mkShell {
buildInputs = with pkgs; [
ns-3
clang
pkg-config
];
}
</syntaxhighlight>

Then we can create our <code>Makefile</code>, do note the LIBS argument, which is the modules required (not all are build by default, might have to override some settings in ns-3).

<syntaxhighlight>
# the compiler: gcc for C program, define as g++ for C++
CC = clang++

DEBUG=-DNS3_LOG_ENABLE

LIBS = libns3-dev-core-debug

# compiler flags:
# -g adds debugging information to the executable file
# -Wall turns on most, but not all, compiler warnings
CFLAGS = -g -Wall -Wextra $(shell pkg-config --cflags $(LIBS))
LDFLAGS=$(shell pkg-config --libs $(LIBS))

# the build target executable:
TARGET = hello-simulator

all: $(TARGET)

$(TARGET): $(TARGET).cc
$(CC) $(DEBUG) $(CFLAGS) $(LDFLAGS) -o $(TARGET) $(TARGET).cc

clean:
$(RM) $(TARGET)
</syntaxhighlight>

Then just place <code>hello-simulator.cc</code> in the same directory as the other files, then run the following commands.

{{Commands|
$ nix-shell
$ make
$ ./hello-simulator
}}

Please keep in mind our flag when we compile, regarding debug <code>NS3_LOG_ENABLE</code>.