docs/htmldocs/bugreport.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 35. Reporting Bugs</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"><link rel="home" href="samba-doc.html" title="SAMBA Project Documentation"><link rel="up" href="troubleshooting.html" title="Part V. Troubleshooting"><link rel="previous" href="problems.html" title="Chapter 34. Analysing and solving samba problems"><link rel="next" href="Appendixes.html" title="Part VI. Appendixes"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 35. Reporting Bugs</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="problems.html">Prev</a> </td><th width="60%" align="center">Part V. Troubleshooting</th><td width="20%" align="right"> <a accesskey="n" href="Appendixes.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="bugreport"></a>Chapter 35. Reporting Bugs</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jelmer</span> <span class="othername">R.</span> <span class="surname">Vernooij</span></h3><div class="affiliation"><span class="orgname">The Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:jelmer@samba.org">jelmer@samba.org</a>&gt;</tt></p></div></div></div></div><div><div class="author"><h3 class="author"><span class="firstname">Andrew</span> <span class="surname">Tridgell</span></h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:tridge@samba.org">tridge@samba.org</a>&gt;</tt></p></div></div></div></div><div><p class="pubdate"> 27 June 1997 </p></div></div><div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="bugreport.html#id2960613">Introduction</a></dt><dt><a href="bugreport.html#id2960681">General info</a></dt><dt><a href="bugreport.html#id2960718">Debug levels</a></dt><dt><a href="bugreport.html#id2960926">Internal errors</a></dt><dt><a href="bugreport.html#id2961060">Attaching to a running process</a></dt><dt><a href="bugreport.html#id2961107">Patches</a></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2960613"></a>Introduction</h2></div></div><div></div></div><p>Please report bugs using
   2         <a href="https://bugzilla.samba.org/" target="_top">bugzilla</a>.</p><p>
   3 Please take the time to read this file before you submit a bug
   4 report. Also, please see if it has changed between releases, as we
   5 may be changing the bug reporting mechanism at some time.
   6 </p><p>
   7 Please also do as much as you can yourself to help track down the
   8 bug. Samba is maintained by a dedicated group of people who volunteer
   9 their time, skills and efforts. We receive far more mail about it than
  10 we can possibly answer, so you have a much higher chance of an answer
  11 and a fix if you send us a &quot;developer friendly&quot; bug report that lets
  12 us fix it fast.
  13 </p><p>
  14 Do not assume that if you post the bug to the comp.protocols.smb
  15 newsgroup or the mailing list that we will read it. If you suspect that your
  16 problem is not a bug but a configuration problem then it is better to send
  17 it to the Samba mailing list, as there are (at last count) 5000 other users on
  18 that list that may be able to help you.
  19 </p><p>
  20 You may also like to look though the recent mailing list archives,
  21 which are conveniently accessible on the Samba web pages
  22 at <a href="http://samba.org/samba/" target="_top">http://samba.org/samba/</a>.
  23 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2960681"></a>General info</h2></div></div><div></div></div><p>
  24 Before submitting a bug report check your config for silly
  25 errors. Look in your log files for obvious messages that tell you that
  26 you've misconfigured something and run testparm to test your config
  27 file for correct syntax.
  28 </p><p>
  29 Have you run through the <a href="diagnosis.html" title="Chapter 33. The Samba checklist">diagnosis</a>?
  30 This is very important.
  31 </p><p>
  32 If you include part of a log file with your bug report then be sure to
  33 annotate it with exactly what you were doing on the client at the
  34 time, and exactly what the results were.
  35 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2960718"></a>Debug levels</h2></div></div><div></div></div><p>
  36 If the bug has anything to do with Samba behaving incorrectly as a
  37 server (like refusing to open a file) then the log files will probably
  38 be very useful. Depending on the problem a log level of between 3 and
  39 10 showing the problem may be appropriate. A higher level gives more
  40 detail, but may use too much disk space.
  41 </p><p>
  42 To set the debug level use the <a class="indexterm" name="id2960739"></a><i class="parameter"><tt>log level</tt></i> in your
  43 <tt class="filename">smb.conf</tt>. You may also find it useful to set the log
  44 level higher for just one machine and keep separate logs for each machine.
  45 To do this add the following lines to your main <tt class="filename">smb.conf</tt> file:
  46 </p><table class="simplelist" border="0" summary="Simple list"><tr><td><i class="parameter"><tt>log level = 10</tt></i></td></tr><tr><td><i class="parameter"><tt>log file = /usr/local/samba/lib/log.%m</tt></i></td></tr><tr><td><i class="parameter"><tt>include = /usr/local/samba/lib/smb.conf.%m</tt></i></td></tr></table><p>
  47 then create a file
  48 <tt class="filename">/usr/local/samba/lib/smb.conf.<i class="replaceable"><tt>machine</tt></i></tt> where
  49 <i class="replaceable"><tt>machine</tt></i> is the name of the client you wish to debug. In that file
  50 put any <tt class="filename">smb.conf</tt> commands you want, for example
  51 <a class="indexterm" name="id2960830"></a><i class="parameter"><tt>log level</tt></i> may be useful. This also allows you to
  52 experiment with different security systems, protocol levels etc on just
  53 one machine.
  54 </p><p>
  55 The <tt class="filename">smb.conf</tt> entry <a class="indexterm" name="id2960857"></a><i class="parameter"><tt>log level</tt></i>
  56 is synonymous with the parameter <a class="indexterm" name="id2960872"></a><i class="parameter"><tt>debuglevel</tt></i> that has
  57 been used in older versions of Samba and is being retained for backwards
  58 compatibility of <tt class="filename">smb.conf</tt> files.
  59 </p><p>
  60 As the <a class="indexterm" name="id2960897"></a><i class="parameter"><tt>log level</tt></i> value is increased you will record
  61 a significantly increasing level of debugging information. For most
  62 debugging operations you may not need a setting higher than
  63 <tt class="constant">3</tt>. Nearly
  64 all bugs can be tracked at a setting of <tt class="constant">10</tt>, but be
  65 prepared for a VERY large volume of log data.
  66 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2960926"></a>Internal errors</h2></div></div><div></div></div><p>
  67 If you get a <span class="errorname">INTERNAL ERROR</span> message in your log files
  68 it means that Samba got an unexpected signal while running. It is probably a
  69 segmentation fault and almost certainly means a bug in Samba (unless
  70 you have faulty hardware or system software).
  71 </p><p>
  72 If the message came from smbd then it will probably be accompanied by
  73 a message which details the last SMB message received by smbd. This
  74 info is often very useful in tracking down the problem so please
  75 include it in your bug report.
  76 </p><p>
  77 You should also detail how to reproduce the problem, if
  78 possible. Please make this reasonably detailed.
  79 </p><a class="indexterm" name="id2960962"></a><p>
  80 You may also find that a core file appeared in a <tt class="filename">corefiles</tt>
  81 subdirectory of the directory where you keep your samba log
  82 files. This file is the most useful tool for tracking down the bug. To
  83 use it you do this:
  84 </p><a class="indexterm" name="id2960984"></a><a class="indexterm" name="id2960993"></a><pre class="screen">
  85 <tt class="prompt">$ </tt><b class="userinput"><tt>gdb smbd core</tt></b>
  86 </pre><p>
  87 adding appropriate paths to smbd and core so gdb can find them. If you
  88 don't have gdb then try <b class="userinput"><tt>dbx</tt></b>. Then within the debugger
  89 use the command <b class="command">where</b> to give a stack trace of where the
  90 problem occurred. Include this in your report.
  91 </p><p>
  92 If you know any assembly language then do a
  93 <b class="command">disass</b> of the routine
  94 where the problem occurred (if its in a library routine then
  95 disassemble the routine that called it) and try to work out exactly
  96 where the problem is by looking at the surrounding code. Even if you
  97 don't know assembly, including this info in the bug report can be
  98 useful.
  99 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2961060"></a>Attaching to a running process</h2></div></div><div></div></div><p>
 100 Unfortunately some unixes (in particular some recent linux kernels)
 101 refuse to dump a core file if the task has changed uid (which smbd
 102 does often). To debug with this sort of system you could try to attach
 103 to the running process using
 104 <b class="userinput"><tt>gdb smbd <i class="replaceable"><tt>PID</tt></i></tt></b> where you get
 105 <i class="replaceable"><tt>PID</tt></i> from <span class="application">smbstatus</span>.
 106 Then use <b class="command">c</b> to continue and try to cause the core dump
 107 using the client. The debugger should catch the fault and tell you
 108 where it occurred.
 109 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2961107"></a>Patches</h2></div></div><div></div></div><a class="indexterm" name="id2961114"></a><a class="indexterm" name="id2961123"></a><p>
 110 The best sort of bug report is one that includes a fix! If you send us
 111 patches please use <b class="userinput"><tt>diff -u</tt></b> format if your version of
 112 diff supports it, otherwise use <b class="userinput"><tt>diff -c4</tt></b>. Make sure
 113 you do the diff against a clean version of the source and let me know
 114 exactly what version you used.
 115 </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="problems.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="troubleshooting.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="Appendixes.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 34. Analysing and solving samba problems </td><td width="20%" align="center"><a accesskey="h" href="samba-doc.html">Home</a></td><td width="40%" align="right" valign="top"> Part VI. Appendixes</td></tr></table></div></body></html>