DebuggingNetworkManager

Differences between revisions 40 and 53 (spanning 13 versions)
Revision 40 as of 2011-10-26 21:19:20
Size: 7894
Editor: cyphermox
Comment:
Revision 53 as of 2016-08-02 09:34:57
Size: 4131
Editor: penalvch
Comment: Due to LP1607571 updated test case to not be pinned to Upstart.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Available languages: [[https://wiki.ubuntu.com/DebuggingNetworkManager_it| Italiano]],
Line 3: Line 4:
== Bug Summary ==
= Bug Summary =
Line 11: Line 13:
== Understanding your bug and getting more information == = Understanding your bug and getting more information =
Line 13: Line 15:
 * There is a lot of debugging information available on the GNOME Live wiki: [[http://live.gnome.org/NetworkManager/Debugging|NetworkManager/Debugging]].  * There is a lot of debugging information available on the GNOME Live wiki: [[https://wiki.gnome.org/Projects/NetworkManager/Debugging|NetworkManager/Debugging]].
Line 16: Line 18:
 * The similar reason/status code data for wpasupplicant is available here: [[http://hostap.epitest.fi/gitweb/gitweb.cgi?p=hostap.git;a=blob;f=src/common/ieee802_11_defs.h|ieee802_11_defs.h]]
Line 17: Line 20:
== Getting debug logs ==
Line 19: Line 21:
First, make sure you have the debug helper script: [[http://cgit.freedesktop.org/NetworkManager/NetworkManager/tree/test/debug-helper.py]]. = Getting debug logs =
Line 23: Line 25:
=== Getting NetworkManager debug logs === == Getting NetworkManager debug logs ==
Line 26: Line 28:
sudo python debug-helper.py --nm debug sudo /usr/lib/NetworkManager/debug-helper.py --nm debug
Line 31: Line 33:
==== If you know what you're doing... ====

If you already have a good idea of what part of NetworkManager is not working right, you can also include specific domains to enable logging for, see '''''sudo /usr/sbin/NetworkManager --help''''':
== Getting ModemManager debug logs ==
Line 36: Line 36:
sudo python debug-helper.py --nm debug --domains core ip4 ip6
}}}

In general though, it's just easier to turn debugging on for ''everything'', and just work with the extra details.

=== Getting ModemManager debug logs ===

{{{
sudo python debug-helper.py --mm debug
sudo /usr/lib/NetworkManager/debug-helper.py --mm debug
Line 51: Line 43:
=== Getting wpasupplicant debug logs === == Getting wpasupplicant debug logs ==
Line 54: Line 46:
sudo python debug-helper.py --wpa debug sudo /usr/lib/NetworkManager/debug-helper.py --wpa msgdump
Line 59: Line 51:
=== Getting a capture of syslog === == Getting a capture of syslog ==
Line 82: Line 74:
=== Handling 3G / modem issues === == Handling 3G / modem issues ==
Line 96: Line 88:
== A Testcase == = A Testcase =
Line 100: Line 92:
Stop NetworkManager

{{{
  sudo stop network-manager
First, stop NetworkManager: {{{
sudo service network-manager stop
}}} Then unload your driver:{{{
sudo modprobe -r DRIVER
}}} Next, load the driver:{{{
sudo modprobe DRIVER
}}} and finally start NetworkManager:{{{
sudo service network-manager start
Line 105: Line 101:

To unload your driver {{{ sudo modprobe -r DRIVER }}}.

Then load the driver {{{ sudo modprobe DRIVER }}} and start NetworkManager:

{{{
  sudo start network-manager
}}}


== Debugging Crashes ==


To install debug symbols, add the following line to your {{{/etc/apt/sources.list}}}

{{{
deb http://ddebs.ubuntu.com/ natty main universe
}}}

or

{{{
deb http://ddebs.ubuntu.com/ oneiric main universe
}}}


Then install the appropriate dbgsym packages:

{{{
  sudo apt-get update
  sudo apt-get install network-manager-dbgsym libnm-util2-dbgsym libnm-glib4-dbgsym libglib2.0-0-dbgsym
}}}

Then stop NetworkManager:
{{{
sudo stop network-manager
}}}

Run NetworkManager in a debugger
{{{
sudo gdb /usr/sbin/NetworkManager
...
(gdb) run --no-daemon
}}}

Once it crashes get a backtrace
{{{
(gdb) bt
...
(gdb) bt full
...
(gdb) thread apply all bt full
...
}}}

and attach the backtrace above together with your {{{/var/log/syslog}}} to the bug.


== Bug Tags ==

These tags allow isolation of bugs into smaller groups, providing an easier and faster way to work on specific issues.

||<rowbgcolor="#FFEBBB"> '''Tag''' || '''Use case''' ||
|| [[https://launchpad.net/ubuntu/+bugs?field.tag=driver-madwifi|`driver-madwifi`]] || Bugs in which the madwifi driver is in use ||
|| [[https://launchpad.net/ubuntu/+bugs?field.tag=driver-ndiswrapper|`driver-ndiswrapper`]] || Bugs in which the ndiswrapper driver is in use ||
|| [[https://launchpad.net/ubuntu/+bugs?field.tag=vpn|`vpn`]] || Bugs related to either openvpn, vpnc or pptp network-manager vpn modules ||
|| [[https://launchpad.net/ubuntu/+bugs?field.tag=encryption-wep|`encryption-wep`]] || Bugs in which WEP encryption is used ||
|| [[https://launchpad.net/ubuntu/+bugs?field.tag=encryption-wpa|`encryption-wpa`]] || Bugs in which WPA encryption is used ||
|| [[https://launchpad.net/ubuntu/+bugs?field.tag=encryption-wpa2|`encryption-wpa2`]] || Bugs in which WPA2 encryption is used ||

The previously described tags are specific to the [[NetworkManager]] application, if you need more general tags please visit [[Bugs/Tags]] page.


== Testing a patch ==

It's often a good idea to check in the [[https://edge.launchpad.net/~network-manager/+archive/trunk|NM trunk PPA]] to see if an updated version of NetworkManager fixes the bugs you see. Be careful though, as those are daily builds that may break other things, and are to be considered unstable.

Sometimes a developer might ask you to test a quick patch he came up with. Below an example how to do that for network-manager. If your bug is for network-manager-applet or some other package, just replace the package name

See [[DebuggingModemmanager]] for the same instructions for ModemManager.

{{{
# get build dependencies
sudo apt-get install build-essential fakeroot devscripts
sudo apt-get build-dep network-manager

# get sources
sudo apt-get source network-manager

# cd into the source directory
cd network-manager-*/

# apply the patch (note that -p1 could also be -p0 if the patch was created without an extra prefix in the diff path)
patch -p1 < /tmp/yourdownloadedpatch.diff

# build binaries only without signing
debuild -b -uc

# packages are produced in parent directory
cd ../


# install all nm packages
sudo dpkg -i network-manager*.deb libnm-*.deb
}}}

Note that you didnt change the version of the package. so to get back to the "official" current version you need to do something like:
{{{
  sudo apt-get install --reinstall network-manager libnm-util2 libnm-glib4
}}}

if you installed other packages from the build, do the same for them.

----
CategoryBugSquad

Available languages: Italiano,

Debugging Central

This page is part of the debugging series — pages with debugging details for a variety of Ubuntu packages.

Bug Summary

If a network-manager bug report is about not being able to connect the title or summary should be in the format:

"[CHIPSET] cannot connect to (ENCRYPT_METHOD)"

where the CHIPSET is the wireless driver used and ENCRYPT_METHOD is the encryption method used by your wireless network.

Understanding your bug and getting more information

Getting debug logs

You can then follow developers' intructions on a bug report for the exact command line to use; or run it directly as such:

Getting NetworkManager debug logs

sudo /usr/lib/NetworkManager/debug-helper.py --nm debug

Then get the logs which will be written to /var/log/syslog. To disable it, pass info instead of debug in the above command, or reboot.

Getting ModemManager debug logs

sudo /usr/lib/NetworkManager/debug-helper.py --mm debug

Then get the logs which will be written to /var/log/syslog. To disable it, pass info instead of debug in the above command, or reboot.

See also DebuggingModemmanager.

Getting wpasupplicant debug logs

sudo /usr/lib/NetworkManager/debug-helper.py --wpa msgdump

Then get the logs which will be written to /var/log/syslog. To disable it, pass info instead of debug in the above command, or reboot.

Getting a capture of syslog

Mixing and mashing the above is perfectly acceptable as well if you want to see how NetworkManager and other parts of the stack interact together.

In order to understand whats going on and track down issues, its good to have a full log. To do so, capture the complete test case and submit the whole file (don't cut out what you think is important). Please add markers in the log file so the bug triager can easily see what actions the user takes at what point of time (this isn't essential, but helps a lot).

To capture the syslog, do:

 tail -n0 -f /var/log/syslog > /tmp/syslog

and to stop capturing do Ctrl-C (you will have to type your other commands in an other window or tab)

Adding markers is just like adding new lines with an editor that show the triager what happened at what point of time. You can also do this on the fly as you test with the command logger "[ clicked on wireless network 'ubuntu']" .

Example marker:

Sep  6 08:12:30 ...

[ clicked on wireless network 'ubuntu']

Sep  6 08:12:31 ...
...

Handling 3G / modem issues

An few extra things that are very helpful to add in case of issues with 3G:

The output of udevadm for tty devices, and output of lsusb:

$ udevadm info --query=all --path=/sys/class/tty/... --attribute-walk

$ lsusb

A Testcase

A good testcase is a step by step instruction to reproduce your bug starting with driver unloaded and NetworkManager stopped.

First, stop NetworkManager:

sudo service network-manager stop

Then unload your driver:

sudo modprobe -r DRIVER

Next, load the driver:

sudo modprobe DRIVER

and finally start NetworkManager:

sudo service network-manager start

DebuggingNetworkManager (last edited 2023-06-27 20:21:45 by hellsworth)