4 \chapter{Bacula Developer Notes}
5 \label{_ChapterStart10}
6 \index{Bacula Developer Notes}
7 \index{Notes!Bacula Developer}
8 \addcontentsline{toc}{section}{Bacula Developer Notes}
10 This document is intended mostly for developers and describes the the general
11 framework of making Bacula source changes.
13 \subsection{Contributions}
15 \addcontentsline{toc}{subsubsection}{Contributions}
17 Contributions from programmers are broken into two groups. The first are
18 contributions that are aids and not essential to Bacula. In general, these
19 will be scripts or will go into and examples or contributions directory.
20 For these kinds of non-essential contributions there is no obligation to do
21 a copyright assignment as described below. However, a copyright assignment
22 would still be appreciated.
24 The second class of contributions are those which will be integrated with
25 Bacula and become an essential part. Within this class of contributions, there
26 are two hurdles to surmount. One is getting your patch accepted, and two is
27 dealing with copyright issues. The following text describes some of the
28 requirements for such code.
32 \addcontentsline{toc}{subsubsection}{Patches}
34 Subject to the copyright assignment described below, your patches should be
35 sent in {\bf diff -u} format relative to the current contents of the Source
36 Forge SVN, which is the easiest to understand and integrate.
37 Please be sure to use the Bacula indenting standard (see below).
38 If you have checked out the source with SVN, you can get a diff using:
42 svn diff > change.patch
45 If you plan on doing significant development work over a period of time,
46 after having your first patch reviewed and approved, you will be eligible
47 for having developer SVN access so that you can commit your changes
48 directly to the SVN repository. To do so, you will need a userid on Source
51 \subsection{Copyrights}
53 \addcontentsline{toc}{subsubsection}{Copyrights}
55 To avoid future problems concerning changing licensing or
56 copyrights, all code contributions more than a hand full of lines
57 must be in the Public Domain or have the copyright transferred to
58 the Free Software Foundation Europe e.V. with a Fiduciary License
59 Agreement (FLA) as in the current code. Note, prior to
60 November 2004, the code was copyrighted by Kern Sibbald and John
61 Walker. After November 2004, the code was copyrighted by Kern
62 Sibbald, then on the 15th of November 2006, the copyright was
63 transferred to the Free Software Foundation Europe e.V.
65 Your name should be clearly indicated as the author of the code, and you
66 must be extremely careful not to violate any copyrights or use other
67 people's code without acknowledging it. The purpose of this requirement is
68 to avoid future copyright, patent, or intellectual property problems.
69 Please read the LICENSE agreement in the main source code
70 directory. When you sign the Fiduciary License Agreement (FLA)
71 and send it in, you are argeeing to the terms of that LICENSE
74 To understand the possible source of future problems, please
75 examine the difficulties Mozilla is (was?) having finding
76 previous contributors at \elink{
77 http://www.mozilla.org/MPL/missing.html}
78 {http://www.mozilla.org/MPL/missing.html}. The other important issue is to
79 avoid copyright, patent, or intellectual property violations as are currently
80 (May 2003) being claimed by SCO against IBM.
82 Although the copyright will be held by the Free Software
83 Foundation Europe e.V., each developer is expected to indicate
84 that he wrote and/or modified a particular module (or file) and
85 any other sources. The copyright assignment may seem a bit
86 unusual, but in reality, it is not. Most large projects require
89 If you have any doubts about this, please don't hesitate to ask. The
90 objective is to assure the long term servival of the Bacula project.
92 Items not needing a copyright assignment are: most small changes,
93 enhancements, or bug fixes of 5-10 lines of code, which amount to
94 less than 20% of any particular file.
96 \subsection{Copyright Assignment -- Fiduciary License Agreement}
97 \index{Copyright Assignment}
98 \index{Assignment!Copyright}
99 \addcontentsline{toc}{subsubsection}{Copyright Assignment -- Fiduciary License Agreement}
101 Since this is not a commercial enterprise, and we prefer to believe in
102 everyone's good faith, previously developers could assign the copyright by
103 explicitly acknowledging that they do so in their first submission. This
104 was sufficient if the developer is independent, or an employee of a
105 not-for-profit organization or a university. However, in an effort to
106 ensure that the Bacula code is really clean, beginning in August 2006, all
107 previous and future developers with SVN access will be asked to submit a
108 copyright assignment (or Fiduciary License Agreement -- FLA),
109 which means you agree to the LICENSE in the main source
110 directory. It also means that you receive back the right to use
111 the code that you have submitted.
113 Any developer who wants to contribute and is employed by a company should
114 either list the employer as the owner of the code, or get
115 explicit permission from him to sign the copyright assignment.
116 This is because in many
117 countries, all work that an employee does whether on company time or in the
118 employee's free time is considered to be Intellectual Property of the
119 company. Obtaining official approval or an FLA from the company will avoid
120 misunderstandings between the employee, the company, and the Bacula
121 project. A good number of companies have already followed this procedure.
123 The Fiduciary License Agreement is posted on the Bacula web site at:
124 \elink{http://www.bacula.org/en/FLA-bacula.en.pdf}{http://www.bacula.org/en/FLA-bacula.en.pdf}
126 The instructions for filling out this agreement are also at:
127 \elink{http://www.bacula.org/?page=fsfe}{http://www.bacula.org/?page=fsfe}
129 It should be filled out, then sent to:
133 Cotes-de-Montmoiret 9
138 Please note that the above address is different from the officially
139 registered office mentioned in the document. When you send in such a
140 complete document, please notify me: kern at sibbald dot com.
143 \section{The Development Cycle}
144 \index{Developement Cycle}
145 \index{Cycle!Developement}
146 \addcontentsline{toc}{subsubsection}{Development Cycle}
148 As I noted in the 1.38 ReleaseNotes, version 1.38 was different from prior
149 versions because it had a lot more contributions. I expect that this trend
150 will continue. As a consequence, I am going to modify how I normally do
151 development, and instead of making a list of all the features that I will
152 implement in the next version, I will personally sign up for one (maybe
153 two) projects at a time, and when they are complete, I will release a new
156 The difference is that I will have more time to review the new code that is
157 being contributed, and will be able to devote more time to a smaller number
158 of projects (1.38 had too many new features for me to handle correctly).
160 I expect that future release schedules will be much the same, and the
161 number of new features will also be much the same providing that the
162 contributions continue to come -- and they show no signs of let up :-)
164 \index{Feature Requests}
165 {\bf Feature Requests:} \\
166 In addition, I would like to "formalize" the feature requests a bit.
168 Instead of me maintaining an informal list of everything I run into
169 (kernstodo), I would like to maintain a "formal" list of projects. This
170 means that all new feature requests, including those recently discussed on
171 the email lists, must be formally submitted and approved.
173 Formal submission of feature requests will take two forms: \\
174 1. non-mandatory, but highly recommended is to discuss proposed new features
175 on the mailing list.\\
176 2. Formal submission of an Feature Request in a special format.
177 I'll give an example of this below, but you can also find it on the web
178 site under "Support -\gt{} Feature Requests". Since it takes a bit of time to
179 properly fill out a Feature Request form, you probably should check on the email list
182 Once the Feature Request is received by the keeper of the projects list, it
183 will be sent to me, and I will either accept it, send it back
184 asking for clarification, send it to the email list asking for opinions, or
187 If it is accepted, it will go in the "projects" file (a simple ASCII file)
188 maintained in the main Bacula source directory.
190 {\bf Implementation of Feature Requests:}\\
191 Any qualified developer can sign up for a project. The project must have
192 an entry in the projects file, and the developer's name will appear in the
195 {\bf How Feature Requests are accepted:}\\
196 Acceptance of Feature Requests depends on several things: \\
197 1. feedback from users. If it is negative, the Feature Request will probably not be
199 2. the difficulty of the project. A project that is so
200 difficult that I cannot imagine finding someone to implement probably won't
202 3. whether or not the Feature Request fits within the
203 current stategy of Bacula (for example an Feature Request that requests changing the
204 tape to tar format would not be accepted, ...)
206 {\bf How Feature Requests are prioritized:}\\
207 Once an Feature Request is accepted, it needs to be implemented. If you
208 can find a developer for it, or one signs up for implementing it, then the
209 Feature Request becomes top priority (at least for that developer).
211 Between releases of Bacula, we will generally solicit Feature Request input
212 for the next version, and by way of this email, we suggest that you send
213 discuss and send in your Feature Requests for the next release. Please
214 verify that the Feature Request is not in the current list (attached to this email).
216 Once users have had several weeks to submit Feature Requests, the keeper of the
218 organize them, and request users to vote on them. This will allow fixing
219 prioritizing the Feature Requests. Having a priority is one thing, but
220 getting it implement is another thing -- we are hoping that the Bacula
221 community will take more responsibility for assuring the implementation of
222 accepted Feature Requests.
224 Feature Request format:
226 ============= Empty Feature Request form ===========
227 Item n: One line summary ...
229 Origin: Name and email of originator.
232 What: More detailed explanation ...
234 Why: Why it is important ...
236 Notes: Additional notes or features (omit if not used)
237 ============== End Feature Request form ==============
241 ============= Example Completed Feature Request form ===========
242 Item 1: Implement a Migration job type that will move the job
243 data from one device to another.
244 Origin: Sponsored by Riege Sofware International GmbH. Contact:
245 Daniel Holtkamp <holtkamp at riege dot com>
246 Date: 28 October 2005
247 Status: Partially coded in 1.37 -- much more to do. Assigned to
250 What: The ability to copy, move, or archive data that is on a
251 device to another device is very important.
253 Why: An ISP might want to backup to disk, but after 30 days
254 migrate the data to tape backup and delete it from
255 disk. Bacula should be able to handle this
256 automatically. It needs to know what was put where,
257 and when, and what to migrate -- it is a bit like
258 retention periods. Doing so would allow space to be
259 freed up for current backups while maintaining older
262 Notes: Migration could be triggered by:
266 Highwater size (keep total size)
268 =================================================
272 \section{Bacula Code Submissions and Projects}
273 \index{Submissions and Projects}
274 \addcontentsline{toc}{subsection}{Code Submissions and Projects}
276 Getting code implemented in Bacula works roughly as follows:
280 \item Kern is the project manager, but prefers not to be a "gate keeper".
281 This means that the developers are expected to be self-motivated,
282 and once they have experience submit directly to the SVN. However,
283 it is a good idea to have your patches reviewed prior to submitting,
284 and it is a bad idea to submit monster patches because no one will
285 be able to properly review them. See below for more details on this.
287 \item There are growing numbers of contributions (very good).
289 \item Some contributions come in the form of relatively small patches,
290 which Kern reviews, integrates, documents, tests, and maintains.
292 \item All Bacula developers take full
293 responsibility for writing the code, posting as patches so that I can
294 review it as time permits, integrating it at an appropriate time,
295 responding to my requests for tweaking it (name changes, ...),
296 document it in the code, document it in the manual (even though
297 their mother tongue is not English), test it, develop and commit
298 regression scripts, and answer in a timely fashion all bug reports --
299 even occassionally accepting additional bugs :-)
301 This is a sustainable way of going forward with Bacula, and the
302 direction that the project will be taking more and more. For
303 example, in the past, we have had some very dedicated programmers
304 who did major projects. However, these
305 programmers due to outside obligations (job responsibilities change of
306 job, school duties, ...) could not continue to maintain the code. In
307 those cases, the code suffers from lack of maintenance, sometimes I
308 patch it, sometimes not. In the end, the code gets dropped from the
309 project (there are two such contributions that are heading in that
310 direction). When ever possible, we would like to avoid this, and
311 ensure a continuation of the code and a sharing of the development,
312 debugging, documentation, and maintenance responsibilities.
315 \section{Patches for Released Versions}
316 \index{Patches for Released Versions}
317 \addcontentsline{toc}{subsection}{Patches for Released Versions}
318 If you fix a bug in a released version, you should, unless it is
319 an absolutely trivial bug, create and release a patch file for the
320 bug. The procedure is as follows:
322 Fix the bug in the branch and in the trunk.
324 Make a patch file for the branch and add the branch patch to
325 the patches directory in both the branch and the trunk.
326 The name should be 2.2.4-xxx.patch where xxx is unique, in this case it can
327 be "restore", e.g. 2.2.4-restore.patch. Add to the top of the
328 file a brief description and instructions for applying it -- see for example
329 2.2.4-poll-mount.patch. The best way to create the patch file is as
333 (edit) 2.2.4-restore.patch
337 svn diff >>2.2.4-restore.patch
340 check to make sure no extra junk got put into the patch file (i.e.
341 it should have the patch for that bug only).
343 If there is not a bug report on the problem, create one, then add the
344 patch to the bug report.
346 Uthen upload it to the 2.2.x release of bacula-patches.
348 So, end the end, the patch file is:
350 \item Attached to the bug report
352 \item In Branch-2.2/bacula/patches/...
356 \item Loaded on Source Forge bacula-patches 2.2.x release. When
357 you add it, click on the check box to send an Email so that all the
358 users that are monitoring SF patches get notified.
365 \addcontentsline{toc}{subsection}{SVN Usage}
367 Please note that if you are familar with CVS, SVN is very
368 similar (and better), but there can be a few surprising
371 The *entire* Bacula SourceForge.net Subversion repository can be
372 checked out through SVN with the following command:
375 svn checkout https://bacula.svn.sourceforge.net/svnroot/bacula bacula
378 With the above command, you will get everything, which is a very large
400 Note, you should NEVER commit code to any checkout that you have
401 done of a tag. All tags (e.g. Release-1.1, ... Release-2.0.2)
402 should be considered read-only.
404 You may commit code to the most recent item in
405 branches (in the above the most recent one is Branch-2.0). If
406 you want to commit code to an older branch, then please contact
409 You may create your own tags and/or branches, but they should
410 have a name clearly distinctive from Branch-, Release-, or Beta-,
411 which are official names used by the project. If you create a
412 tag, then you should NEVER commit code to it, for the same
413 reason noted above -- it should serve as a marker for something
414 you released. If you create a branch, then you are free to
415 commit to it as you wish.
417 You may, of course, commit to the trunk.
429 are reserved names to be created only by the project manager (or
430 with his OK), where the nnn is any sequence of numbers and
431 periods (e.g. 2.0, 2.0.1, ...).
433 In addition all tags even those that you create are read-only
434 forever. Typically tags represent release points either in the
435 trunc or in a branch.
438 Coming back to getting source code.
439 If you only want the current Bacula source code, you could use:
442 svn checkout https://bacula.svn.sourceforge.net/svnroot/bacula/trunk/bacula bacula
445 To view what is in the SVN, point your browser at the following URL:
446 http://bacula.svn.sourceforge.net/viewvc/bacula/
448 Many of the Subversion (svn) commands are almost identical to those that
449 you have used for cvs, but some (such as a checkout) can have surprising
450 results, so you should take a careful look at the documentation.
452 The following documentation on the new
453 svn repository will help you know how to use it:
455 Here is the list of branches:
472 Release-1.1 Release-1.19 Release-1.19a Release-1.19b
473 Release-1.20 Release-1.21 Release-1.22 Release-1.23
474 Release-1.23a Release-1.24 Release-1.25 Release-1.25a
475 Release-1.26 Release-1.27 Release-1.27a Release-1.27b
476 Release-1.27c Release-1.28 Release-1.29 Release-1.30
477 Release-1.31 Release-1.31a Release-1.32 Release-1.32a
478 Release-1.32b Release-1.32c Release-1.32d Release-1.32e
479 Release-1.32f Release-1.32f-2 Release-1.32f-3 Release-1.32f-4
480 Release-1.32f-5 Release-1.34.0 Release-1.34.1 Release-1.34.3
481 Release-1.34.4 Release-1.34.5 Release-1.34.6 Release-1.35.1
482 Release-1.35.2 Release-1.35.3 Release-1.35.6 Release-1.35.7
483 Release-1.35.8 Release-1.36.0 Release-1.36.1 Release-1.36.2
484 Release-1.36.3 Release-1.38.0 Release-1.38.1 Release-1.38.10
485 Release-1.38.11 Release-1.38.2 Release-1.38.3 Release-1.38.4
486 Release-1.38.5 Release-1.38.6 Release-1.38.7 Release-1.38.8
487 Release-1.38.9 Release-1.8.1 Release-1.8.2 Release-1.8.3
488 Release-1.8.4 Release-1.8.5 Release-1.8.6 Release-2.0.0
489 Release-2.0.1 Release-2.0.2
492 Here is a list of commands to get you started. The recommended book is
493 "Version Control with Subversion", by Ben Collins-Sussmann,
494 Brian W. Fitzpatrick, and Michael Pilato, O'Reilly. The book is
495 Open Source, so it is also available on line at:
498 http://svnbook.red-bean.com
501 Get a list of commands
507 Get a help with a command
513 Checkout the HEAD revision of all modules from the project into the
517 svn co https://bacula.svn.sourceforge.net/svnroot/bacula/trunk bacula.new
520 Checkout the HEAD revision of the bacula module into the bacula subdirectory
523 svn checkout https://bacula.svn.sourceforge.net/svnroot/bacula/trunk/bacula
526 See which files have changed in the working copy
532 See which files are out of date
538 Add a new file file.c
544 Create a new directory
550 Delete an obsolete file
559 svn move file.c newfile.c
562 Move a file to a new location
565 svn move file.c ../newdir/file.c
568 Copy a file retaining the original history in the new file
571 svn copy file.c newfile.c
574 Update the working copy with the outstanding changes
580 Compare working copy with the repository
586 Commit the changes in the local working copy
592 Specify which files are ignored in the current directory
595 svn propedit svn:ignore .
598 Mark a file to be executable
601 svn propset svn:executable '*' prog.sh
604 Unmark a file as executable
607 svn propdel svn:executable prog.sh
610 List a file's properties
616 Create a branch for a new version
619 svn copy https://bacula.svn.sourceforge.net/svnroot/bacula/trunk \
620 https://bacula.svn.sourceforge.net/svnroot/bacula/branches/Branch-2.1
623 Tag a version for a new release
626 svn copy https://bacula.svn.sourceforge.net/svnroot/bacula/branches/Branch-2.1 \
627 https://bacula.svn.sourceforge.net/svnroot/bacula/branches/Release-2.1
631 Let's say you are working in the directory scripts. You would then do:
638 when you are happy with your changes, you can do the following:
641 cd bacula (to your top level directory)
642 svn diff my-changes.patch
645 When the command is done, you can look in the file my-changes.patch
646 and you will see all the changes you have made to your copy of the
647 repository. Make sure that you understand all the changes that
648 it reports before proceeding. If you modified files that you do
649 do not want to commit to the main repository, you can simply delete
650 them from your local directory, and they will be restored from the
651 repository with the "svn update" that is shown below. Normally, you
652 should not find changes to files that you do not want to commit, and
653 if you find yourself in that position a lot, you are probably doing
656 Let's assume that now you want to commit your changes to the main
666 When you do this, it will pull any changes made by other developers into
667 your local copy of the repository, and it will check for conflicts. If there
668 are any, it will tell you, and you will need to resolve them. The problems
669 of resolving conflicts are a bit more than this document can cover, but
670 you can examine the files it claims have conflicts and look for \lt{}\lt{}\lt{}\lt{}
671 or look in the .rej files that it creates. If you have problems, just ask
672 on the developer's list.
674 Note, doing the above "svn update" is not absolutely necessary. There are
675 times when you may be working on code and you want to commit it, but you
676 explicitly do not want to move up to the latest version of the code in
677 the SVN. If that is the case, you can simply skip the "svn update" and
678 do the commit shown below. If the commit fails because of a conflict, it
679 will tell you, and you must resolve the conflict before it will permit
680 you to do the commit.
682 Once your local copy of the repository has been updated, you can now
686 svn commit -m "Some comment about what you changed"
689 or if you really only want to commit a single file, you can
693 svn commit -m "comment" scripts/file-I-edited
696 Note, if you have done a build in your directory, or you have added
697 other new files, the commit will update only the files that are
698 actually in the repository. For example, none of the object files
699 are stored in the repository, so when you do a commit, those object
700 files will simply be ignored.
702 If you want to add new files or remove files from the main SVN
703 repository, and you are not experienced with SVN, please ask Kern
704 to do it. If you follow the simple steps above, it is unlikely that
705 you will do any damage to the repository, and if you do, it is always
706 possible for us to recover, but it can be painful.
708 If you are only working in one subdirectory of say the bacula project,
709 for example, the scripts directory, you can do your commit from
710 that subdirectory, and only the changes in that directory and all its
711 subdirectories will be committed. This can be helpful for translators.
712 If you are doing a French translation, you will be working in
713 docs/manual-fr, and if you are always cd'ed into that directory when
714 doing your commits, your commit will effect only that directory. As
715 long as you are careful only to change files that you want changed,
716 you have little to worry about.
718 \section{Subversion Resources}
719 \index{Subversion (svn) Resources}
720 \addcontentsline{toc}{subsection}{Subversion Resources}
722 Main Subversion Web Page
723 \elink{http://subversion.tigris.org}{http://subversion.tigris.org}
726 \elink{http://svnbook.red-bean.com}{http://svnbook.red-bean.com}
729 \elink{http://subversion.tigris.org/project\_packages.html}{http://subversion.tigris.org/project\_packages.html}
731 (For Windows users the TortoiseSVN package is awesome)
734 \elink{http://rapidsvn.tigris.org/}{http://rapidsvn.tigris.org/}
736 A nice KDE GUI client:
741 \section{Developing Bacula}
742 \index{Developing Bacula}
743 \index{Bacula!Developing}
744 \addcontentsline{toc}{subsubsection}{Developing Bacula}
746 Typically the simplest way to develop Bacula is to open one xterm window
747 pointing to the source directory you wish to update; a second xterm window at
748 the top source directory level, and a third xterm window at the bacula
749 directory \lt{}top\gt{}/src/bacula. After making source changes in one of the
750 directories, in the top source directory xterm, build the source, and start
751 the daemons by entering:
755 ./startit then in the enter:
759 ./gnome-console to start the Console program. Enter any commands for testing.
760 For example: run kernsverify full.
762 Note, the instructions here to use {\bf ./startit} are different from using a
763 production system where the administrator starts Bacula by entering {\bf
764 ./bacula start}. This difference allows a development version of {\bf Bacula}
765 to be run on a computer at the same time that a production system is running.
766 The {\bf ./startit} strip starts {\bf Bacula} using a different set of
767 configuration files, and thus permits avoiding conflicts with any production
770 To make additional source changes, exit from the Console program, and in the
771 top source directory, stop the daemons by entering:
773 ./stopit then repeat the process.
775 \subsection{Debugging}
777 \addcontentsline{toc}{subsubsection}{Debugging}
779 Probably the first thing to do is to turn on debug output.
781 A good place to start is with a debug level of 20 as in {\bf ./startit -d20}.
782 The startit command starts all the daemons with the same debug level.
783 Alternatively, you can start the appropriate daemon with the debug level you
784 want. If you really need more info, a debug level of 60 is not bad, and for
785 just about everything a level of 200.
787 \subsection{Using a Debugger}
788 \index{Using a Debugger}
789 \index{Debugger!Using a}
790 \addcontentsline{toc}{subsubsection}{Using a Debugger}
792 If you have a serious problem such as a segmentation fault, it can usually be
793 found quickly using a good multiple thread debugger such as {\bf gdb}. For
794 example, suppose you get a segmentation violation in {\bf bacula-dir}. You
795 might use the following to find the problem:
797 \lt{}start the Storage and File daemons\gt{}
800 run -f -s -c ./dird.conf
801 \lt{}it dies with a segmentation fault\gt{}
803 The {\bf -f} option is specified on the {\bf run} command to inhibit {\bf
804 dird} from going into the background. You may also want to add the {\bf -s}
805 option to the run command to disable signals which can potentially interfere
808 As an alternative to using the debugger, each {\bf Bacula} daemon has a built
809 in back trace feature when a serious error is encountered. It calls the
810 debugger on itself, produces a back trace, and emails the report to the
811 developer. For more details on this, please see the chapter in the main Bacula
812 manual entitled ``What To Do When Bacula Crashes (Kaboom)''.
814 \subsection{Memory Leaks}
817 \addcontentsline{toc}{subsubsection}{Memory Leaks}
819 Because Bacula runs routinely and unattended on client and server machines, it
820 may run for a long time. As a consequence, from the very beginning, Bacula
821 uses SmartAlloc to ensure that there are no memory leaks. To make detection of
822 memory leaks effective, all Bacula code that dynamically allocates memory MUST
823 have a way to release it. In general when the memory is no longer needed, it
824 should be immediately released, but in some cases, the memory will be held
825 during the entire time that Bacula is executing. In that case, there MUST be a
826 routine that can be called at termination time that releases the memory. In
827 this way, we will be able to detect memory leaks. Be sure to immediately
828 correct any and all memory leaks that are printed at the termination of the
831 \subsection{Special Files}
832 \index{Files!Special}
833 \index{Special Files}
834 \addcontentsline{toc}{subsubsection}{Special Files}
836 Kern uses files named 1, 2, ... 9 with any extension as scratch files. Thus
837 any files with these names are subject to being rudely deleted at any time.
839 \subsection{When Implementing Incomplete Code}
840 \index{Code!When Implementing Incomplete}
841 \index{When Implementing Incomplete Code}
842 \addcontentsline{toc}{subsubsection}{When Implementing Incomplete Code}
844 Please identify all incomplete code with a comment that contains
850 where there are three asterisks (*) before and after the word
851 FIXME (in capitals) and no intervening spaces. This is important as it allows
852 new programmers to easily recognize where things are partially implemented.
854 \subsection{Bacula Source File Structure}
855 \index{Structure!Bacula Source File}
856 \index{Bacula Source File Structure}
857 \addcontentsline{toc}{subsubsection}{Bacula Source File Structure}
859 The distribution generally comes as a tar file of the form {\bf
860 bacula.x.y.z.tar.gz} where x, y, and z are the version, release, and update
861 numbers respectively.
863 Once you detar this file, you will have a directory structure as follows:
870 |- mtx (autochanger control program + tape drive info)
871 |- sqlite (SQLite database program)
875 |- pthreads (Native win32 pthreads library -- dll)
876 |- zlib (Native win32 zlib library)
877 |- wx (wxWidgets source code)
880 |- bacula (main source directory containing configuration
881 | and installation files)
882 |- autoconf (automatic configuration files, not normally used
884 |- intl (programs used to translate)
885 |- platforms (OS specific installation files)
886 |- redhat (Red Hat installation)
887 |- solaris (Sun installation)
888 |- freebsd (FreeBSD installation)
889 |- irix (Irix installation -- not tested)
890 |- unknown (Default if system not identified)
891 |- po (translations of source strings)
892 |- src (source directory; contains global header files)
893 |- cats (SQL catalog database interface directory)
894 |- console (bacula user agent directory)
895 |- dird (Director daemon)
896 |- filed (Unix File daemon)
897 |- win32 (Win32 files to make bacula-fd be a service)
898 |- findlib (Unix file find library for File daemon)
899 |- gnome-console (GNOME version of console program)
900 |- lib (General Bacula library)
901 |- stored (Storage daemon)
902 |- tconsole (Tcl/tk console program -- not yet working)
903 |- testprogs (test programs -- normally only in Kern's tree)
904 |- tools (Various tool programs)
905 |- win32 (Native Win32 File daemon)
906 |- baculafd (Visual Studio project file)
907 |- compat (compatibility interface library)
908 |- filed (links to src/filed)
909 |- findlib (links to src/findlib)
910 |- lib (links to src/lib)
911 |- console (beginning of native console program)
912 |- wx-console (wxWidget console Win32 specific parts)
913 |- wx-console (wxWidgets console main source program)
916 |- regress (Regression scripts)
917 |- bin (temporary directory to hold Bacula installed binaries)
918 |- build (temporary directory to hold Bacula source)
919 |- scripts (scripts and .conf files)
920 |- tests (test scripts)
921 |- tmp (temporary directory for temp files)
922 |- working (temporary working directory for Bacula daemons)
925 |- docs (documentation directory)
926 |- developers (Developer's guide)
927 |- home-page (Bacula's home page source)
928 |- manual (html document directory)
929 |- manual-fr (French translation)
930 |- manual-de (German translation)
931 |- techlogs (Technical development notes);
934 |- rescue (Bacula rescue CDROM)
935 |- linux (Linux rescue CDROM)
936 |- cdrom (Linux rescue CDROM code)
938 |- solaris (Solaris rescue -- incomplete)
939 |- freebsd (FreeBSD rescue -- incomplete)
942 |- gui (Bacula GUI projects)
943 |- bacula-web (Bacula web php management code)
944 |- bimagemgr (Web application for burning CDROMs)
950 \subsection{Header Files}
953 \addcontentsline{toc}{subsubsection}{Header Files}
955 Please carefully follow the scheme defined below as it permits in general only
956 two header file includes per C file, and thus vastly simplifies programming.
957 With a large complex project like Bacula, it isn't always easy to ensure that
958 the right headers are invoked in the right order (there are a few kludges to
959 make this happen -- i.e. in a few include files because of the chicken and egg
960 problem, certain references to typedefs had to be replaced with {\bf void} ).
962 Every file should include {\bf bacula.h}. It pulls in just about everything,
963 with very few exceptions. If you have system dependent ifdefing, please do it
964 in {\bf baconfig.h}. The version number and date are kept in {\bf version.h}.
966 Each of the subdirectories (console, cats, dird, filed, findlib, lib, stored,
967 ...) contains a single directory dependent include file generally the name of
968 the directory, which should be included just after the include of {\bf
969 bacula.h}. This file (for example, for the dird directory, it is {\bf dird.h})
970 contains either definitions of things generally needed in this directory, or
971 it includes the appropriate header files. It always includes {\bf protos.h}.
974 Each subdirectory contains a header file named {\bf protos.h}, which contains
975 the prototypes for subroutines exported by files in that directory. {\bf
976 protos.h} is always included by the main directory dependent include file.
978 \subsection{Programming Standards}
979 \index{Standards!Programming}
980 \index{Programming Standards}
981 \addcontentsline{toc}{subsubsection}{Programming Standards}
983 For the most part, all code should be written in C unless there is a burning
984 reason to use C++, and then only the simplest C++ constructs will be used.
985 Note, Bacula is slowly evolving to use more and more C++.
987 Code should have some documentation -- not a lot, but enough so that I can
988 understand it. Look at the current code, and you will see that I document more
989 than most, but am definitely not a fanatic.
991 I prefer simple linear code where possible. Gotos are strongly discouraged
992 except for handling an error to either bail out or to retry some code, and
993 such use of gotos can vastly simplify the program.
995 Remember this is a C program that is migrating to a {\bf tiny} subset of C++,
996 so be conservative in your use of C++ features.
998 \subsection{Do Not Use}
1001 \addcontentsline{toc}{subsubsection}{Do Not Use}
1004 \item STL -- it is totally incomprehensible.
1007 \subsection{Avoid if Possible}
1008 \index{Possible!Avoid if}
1009 \index{Avoid if Possible}
1010 \addcontentsline{toc}{subsubsection}{Avoid if Possible}
1013 \item Using {\bf void *} because this generally means that one must
1014 using casting, and in C++ casting is rather ugly. It is OK to use
1015 void * to pass structure address where the structure is not known
1016 to the routines accepting the packet (typically callback routines).
1017 However, declaring "void *buf" is a bad idea. Please use the
1018 correct types whenever possible.
1020 \item Using undefined storage specifications such as (short, int, long,
1021 long long, size\_t ...). The problem with all these is that the number of bytes
1022 they allocate depends on the compiler and the system. Instead use
1023 Bacula's types (int8\_t, uint8\_t, int32\_t, uint32\_t, int64\_t, and
1024 uint64\_t). This guarantees that the variables are given exactly the
1025 size you want. Please try at all possible to avoid using size\_t ssize\_t
1026 and the such. They are very system dependent. However, some system
1027 routines may need them, so their use is often unavoidable.
1029 \item Returning a malloc'ed buffer from a subroutine -- someone will forget
1032 \item Heap allocation (malloc) unless needed -- it is expensive. Use
1035 \item Templates -- they can create portability problems.
1037 \item Fancy or tricky C or C++ code, unless you give a good explanation of
1040 \item Too much inheritance -- it can complicate the code, and make reading it
1041 difficult (unless you are in love with colons)
1045 \subsection{Do Use Whenever Possible}
1046 \index{Possible!Do Use Whenever}
1047 \index{Do Use Whenever Possible}
1048 \addcontentsline{toc}{subsubsection}{Do Use Whenever Possible}
1051 \item Locking and unlocking within a single subroutine.
1053 \item A single point of exit from all subroutines. A goto is
1054 perfectly OK to use to get out early, but only to a label
1055 named bail\_out, and possibly an ok\_out. See current code
1058 \item Malloc and free within a single subroutine.
1060 \item Comments and global explanations on what your code or algorithm does.
1064 \subsection{Indenting Standards}
1065 \index{Standards!Indenting}
1066 \index{Indenting Standards}
1067 \addcontentsline{toc}{subsubsection}{Indenting Standards}
1069 I cannot stand code indented 8 columns at a time. This makes the code
1070 unreadable. Even 4 at a time uses a lot of space, so I have adopted indenting
1071 3 spaces at every level. Note, indention is the visual appearance of the
1072 source on the page, while tabbing is replacing a series of up to 8 spaces from
1075 The closest set of parameters for the Linux {\bf indent} program that will
1076 produce reasonably indented code are:
1080 -nbad -bap -bbo -nbc -br -brs -c36 -cd36 -ncdb -ce -ci3 -cli0
1081 -cp36 -d0 -di1 -ndj -nfc1 -nfca -hnl -i3 -ip0 -l85 -lp -npcs
1082 -nprs -npsl -saf -sai -saw -nsob -nss -nbc -ncs -nbfda
1086 You can put the above in your .indent.pro file, and then just invoke indent on
1087 your file. However, be warned. This does not produce perfect indenting, and it
1088 will mess up C++ class statements pretty badly.
1090 Braces are required in all if statements (missing in some very old code). To
1091 avoid generating too many lines, the first brace appears on the first line
1092 (e.g. of an if), and the closing brace is on a line by itself. E.g.
1102 Just follow the convention in the code. Originally I indented case clauses
1103 under a switch(), but now I prefer non-indented cases.
1120 Avoid using // style comments except for temporary code or turning off debug
1121 code. Standard C comments are preferred (this also keeps the code closer to
1124 Attempt to keep all lines less than 85 characters long so that the whole line
1125 of code is readable at one time. This is not a rigid requirement.
1127 Always put a brief description at the top of any new file created describing
1128 what it does and including your name and the date it was first written. Please
1129 don't forget any Copyrights and acknowledgments if it isn't 100\% your code.
1130 Also, include the Bacula copyright notice that is in {\bf src/c}.
1132 In general you should have two includes at the top of the an include for the
1133 particular directory the code is in, for includes are needed, but this should
1136 In general (except for self-contained packages), prototypes should all be put
1137 in {\bf protos.h} in each directory.
1139 Always put space around assignment and comparison operators.
1150 but your can compress things in a {\bf for} statement:
1154 for (i=0; i < del.num_ids; i++) {
1159 Don't overuse the inline if (?:). A full {\bf if} is preferred, except in a
1160 print statement, e.g.:
1164 if (ua->verbose \&& del.num_del != 0) {
1165 bsendmsg(ua, _("Pruned %d %s on Volume %s from catalog.\n"), del.num_del,
1166 del.num_del == 1 ? "Job" : "Jobs", mr->VolumeName);
1171 Leave a certain amount of debug code (Dmsg) in code you submit, so that future
1172 problems can be identified. This is particularly true for complicated code
1173 likely to break. However, try to keep the debug code to a minimum to avoid
1174 bloating the program and above all to keep the code readable.
1176 Please keep the same style in all new code you develop. If you include code
1177 previously written, you have the option of leaving it with the old indenting
1178 or re-indenting it. If the old code is indented with 8 spaces, then please
1179 re-indent it to Bacula standards.
1181 If you are using {\bf vim}, simply set your tabstop to 8 and your shiftwidth
1184 \subsection{Tabbing}
1186 \addcontentsline{toc}{subsubsection}{Tabbing}
1188 Tabbing (inserting the tab character in place of spaces) is as normal on all
1189 Unix systems -- a tab is converted space up to the next column multiple of 8.
1190 My editor converts strings of spaces to tabs automatically -- this results in
1191 significant compression of the files. Thus, you can remove tabs by replacing
1192 them with spaces if you wish. Please don't confuse tabbing (use of tab
1193 characters) with indenting (visual alignment of the code).
1197 \addcontentsline{toc}{subsubsection}{Don'ts}
1212 They are system dependent and un-safe. These should be replaced by the Bacula
1217 char *bstrncpy(char *dest, char *source, int dest_size);
1218 char *bstrncat(char *dest, char *source, int dest_size);
1219 int bsnprintf(char *buf, int32_t buf_len, const char *fmt, ...);
1220 int bvsnprintf(char *str, int32_t size, const char *format, va_list ap);
1224 See src/lib/bsys.c for more details on these routines.
1226 Don't use the {\bf \%lld} or the {\bf \%q} printf format editing types to edit
1227 64 bit integers -- they are not portable. Instead, use {\bf \%s} with {\bf
1228 edit\_uint64()}. For example:
1233 uint64_t num = something;
1235 bsnprintf(buf, sizeof(buf), "Num=%s\n", edit_uint64(num, ed1));
1239 The edit buffer {\bf ed1} must be at least 27 bytes long to avoid overflow.
1240 See src/lib/edit.c for more details. If you look at the code, don't start
1241 screaming that I use {\bf lld}. I actually use subtle trick taught to me by
1242 John Walker. The {\bf lld} that appears in the editing routine is actually
1243 {\bf \#define} to a what is needed on your OS (usually ``lld'' or ``q'') and
1244 is defined in autoconf/configure.in for each OS. C string concatenation causes
1245 the appropriate string to be concatenated to the ``\%''.
1247 Also please don't use the STL or Templates or any complicated C++ code.
1249 \subsection{Message Classes}
1250 \index{Classes!Message}
1251 \index{Message Classes}
1252 \addcontentsline{toc}{subsubsection}{Message Classes}
1254 Currently, there are five classes of messages: Debug, Error, Job, Memory,
1257 \subsection{Debug Messages}
1258 \index{Messages!Debug}
1259 \index{Debug Messages}
1260 \addcontentsline{toc}{subsubsection}{Debug Messages}
1262 Debug messages are designed to be turned on at a specified debug level and are
1263 always sent to STDOUT. There are designed to only be used in the development
1264 debug process. They are coded as:
1266 DmsgN(level, message, arg1, ...) where the N is a number indicating how many
1267 arguments are to be substituted into the message (i.e. it is a count of the
1268 number arguments you have in your message -- generally the number of percent
1269 signs (\%)). {\bf level} is the debug level at which you wish the message to
1270 be printed. message is the debug message to be printed, and arg1, ... are the
1271 arguments to be substituted. Since not all compilers support \#defines with
1272 varargs, you must explicitly specify how many arguments you have.
1274 When the debug message is printed, it will automatically be prefixed by the
1275 name of the daemon which is running, the filename where the Dmsg is, and the
1276 line number within the file.
1278 Some actual examples are:
1280 Dmsg2(20, ``MD5len=\%d MD5=\%s\textbackslash{}n'', strlen(buf), buf);
1282 Dmsg1(9, ``Created client \%s record\textbackslash{}n'', client->hdr.name);
1284 \subsection{Error Messages}
1285 \index{Messages!Error}
1286 \index{Error Messages}
1287 \addcontentsline{toc}{subsubsection}{Error Messages}
1289 Error messages are messages that are related to the daemon as a whole rather
1290 than a particular job. For example, an out of memory condition my generate an
1291 error message. They should be very rarely needed. In general, you should be
1292 using Job and Job Queued messages (Jmsg and Qmsg). They are coded as:
1294 EmsgN(error-code, level, message, arg1, ...) As with debug messages, you must
1295 explicitly code the of arguments to be substituted in the message. error-code
1296 indicates the severity or class of error, and it may be one of the following:
1298 \addcontentsline{lot}{table}{Message Error Code Classes}
1299 \begin{longtable}{lp{3in}}
1300 {{\bf M\_ABORT} } & {Causes the daemon to immediately abort. This should be
1301 used only in extreme cases. It attempts to produce a traceback. } \\
1302 {{\bf M\_ERROR\_TERM} } & {Causes the daemon to immediately terminate. This
1303 should be used only in extreme cases. It does not produce a traceback. } \\
1304 {{\bf M\_FATAL} } & {Causes the daemon to terminate the current job, but the
1305 daemon keeps running } \\
1306 {{\bf M\_ERROR} } & {Reports the error. The daemon and the job continue
1308 {{\bf M\_WARNING} } & {Reports an warning message. The daemon and the job
1309 continue running } \\
1310 {{\bf M\_INFO} } & {Reports an informational message.}
1314 There are other error message classes, but they are in a state of being
1315 redesigned or deprecated, so please do not use them. Some actual examples are:
1318 Emsg1(M\_ABORT, 0, ``Cannot create message thread: \%s\textbackslash{}n'',
1321 Emsg3(M\_WARNING, 0, ``Connect to File daemon \%s at \%s:\%d failed. Retrying
1322 ...\textbackslash{}n'', client-\gt{}hdr.name, client-\gt{}address,
1325 Emsg3(M\_FATAL, 0, ``bdird\lt{}filed: bad response from Filed to \%s command:
1326 \%d \%s\textbackslash{}n'', cmd, n, strerror(errno));
1328 \subsection{Job Messages}
1329 \index{Job Messages}
1330 \index{Messages!Job}
1331 \addcontentsline{toc}{subsubsection}{Job Messages}
1333 Job messages are messages that pertain to a particular job such as a file that
1334 could not be saved, or the number of files and bytes that were saved. They
1337 Jmsg(jcr, M\_FATAL, 0, "Text of message");
1339 A Jmsg with M\_FATAL will fail the job. The Jmsg() takes varargs so can
1340 have any number of arguments for substituted in a printf like format.
1341 Output from the Jmsg() will go to the Job report.
1343 If the Jmsg is followed with a number such as Jmsg1(...), the number
1344 indicates the number of arguments to be substituted (varargs is not
1345 standard for \#defines), and what is more important is that the file and
1346 line number will be prefixed to the message. This permits a sort of debug
1349 \subsection{Queued Job Messages}
1350 \index{Queued Job Messages}
1351 \index{Messages!Job}
1352 \addcontentsline{toc}{subsubsection}{Queued Job Messages}
1353 Queued Job messages are similar to Jmsg()s except that the message is
1354 Queued rather than immediately dispatched. This is necessary within the
1355 network subroutines and in the message editing routines. This is to prevent
1356 recursive loops, and to ensure that messages can be delivered even in the
1357 event of a network error.
1360 \subsection{Memory Messages}
1361 \index{Messages!Memory}
1362 \index{Memory Messages}
1363 \addcontentsline{toc}{subsubsection}{Memory Messages}
1365 Memory messages are messages that are edited into a memory buffer. Generally
1366 they are used in low level routines such as the low level device file dev.c in
1367 the Storage daemon or in the low level Catalog routines. These routines do not
1368 generally have access to the Job Control Record and so they return error
1369 essages reformatted in a memory buffer. Mmsg() is the way to do this.
1371 \subsection{Bugs Database}
1372 \index{Database!Bugs}
1373 \index{Bugs Database}
1374 \addcontentsline{toc}{subsubsection}{Bugs Database}
1375 We have a bugs database which is at:
1376 \elink{http://bugs.bacula.org}{http://bugs.bacula.org}, and as
1377 a developer you will need to respond to bugs, perhaps bugs in general
1378 if you have time, otherwise just bugs that correspond to code that
1381 If you need to answer bugs, please be sure to ask the Project Manager
1382 (currently Kern) to give you Developer access to the bugs database. This
1383 allows you to modify statuses and close bugs.
1385 The first thing is if you want to take over a bug, rather than just make a
1386 note, you should assign the bug to yourself. This helps other developers
1387 know that you are the principal person to deal with the bug. You can do so
1388 by going into the bug and clicking on the {\bf Update Issue} button. Then
1389 you simply go to the {\bf Assigned To} box and select your name from the
1390 drop down box. To actually update it you must click on the {\bf Update
1391 Information} button a bit further down on the screen, but if you have other
1392 things to do such as add a Note, you might wait before clicking on the {\bf
1393 Update Information} button.
1395 Generally, we set the {\bf Status} field to either acknowledged, confirmed,
1396 or feedback when we first start working on the bug. Feedback is set when
1397 we expect that the user should give us more information.
1399 Normally, once you are reasonably sure that the bug is fixed, and a patch
1400 is made and attached to the bug report, and/or in the SVN, you can close
1401 the bug. If you want the user to test the patch, then leave the bug open,
1402 otherwise close it and set {\bf Resolution} to {\bf Fixed}. We generally
1403 close bug reports rather quickly, even without confirmation, especially if
1404 we have run tests and can see that for us the problem is fixed. However,
1405 in doing so, it avoids misunderstandings if you leave a note while you are
1406 closing the bug that says something to the following effect:
1407 We are closing this bug because ... If for some reason, it does not fix
1408 your problem, please feel free to reopen it, or to open a new bug report
1409 describing the problem".
1411 We do not recommend that you attempt to edit any of the bug notes that have
1412 been submitted, nor to delete them or make them private. In fact, if
1413 someone accidentally makes a bug note private, you should ask the reason
1414 and if at all possible (with his agreement) make the bug note public.
1416 If the user has not properly filled in most of the important fields
1417 (platorm, OS, Product Version, ...) please do not hesitate to politely ask
1418 him. Also, if the bug report is a request for a new feature, please
1419 politely send the user to the Feature Request menu item on www.bacula.org.
1420 The same applies to a support request (we answer only bugs), you might give
1421 the user a tip, but please politely refer him to the manual and the
1422 Getting Support page of www.bacula.org.