]> git.sur5r.net Git - bacula/bacula/blob - bacula/kernstodo
Fix list nextvol to find Pool from run record
[bacula/bacula] / bacula / kernstodo
1                  Kern's ToDo List
2                 30 September 2003 
3
4 Documentation to do: (any release a little bit at a time)
5 - Document running a test version.
6 - Document query file format.
7 - Document static linking
8 - Document problems with Verify and pruning.
9 - Document how to use multiple databases.
10 - For FreeBSD typical /dev/nrsa0 and for mtx /dev/pass1
11 - VXA drives have a "cleaning required"
12   indicator, but Exabyte recommends preventive cleaning after every 75
13   hours of operation.
14 - Lookup HP cleaning recommendations.
15 - Lookup HP tape replacement recommendations (see trouble shooting autochanger)
16           
17 Testing to do: (painful)
18 - that ALL console command line options work and are always implemented
19 - blocksize recognition code.
20 - Test if rewind at end of tape waits for tape to rewind.
21 - Test cancel at EOM.       
22 - Test not zeroing Autochanger slot when it is wrong.
23 - Figure out how to use ssh or stunnel to protect Bacula communications.
24 - Test connect timeouts.
25
26 For 1.33 Testing/Documentation:
27 - Document to start higher priorty jobs before lower ones.
28 - suppress "Do not forget to mount the drive!!!" if error
29 - Document new records in Director. SDAddress SDDeviceName, SDPassword.
30   FDPassword, FDAddress, DBAddress, DBPort, DBPassword.
31 - Document new Include/Exclude ...
32 - Add test of exclusion, test multiple Include {} statements.
33 - Add counter variable test.
34                 
35 For 1.33
36 - Eliminate orphaned jobs: dbcheck, normal pruning, delet job command.
37   Hm.  Well, there are the remaining orphaned job records:
38
39      |   105 | Llioness Save  | 0000-00-00 00:00:00 | B    | D     |        0 |             0 | f         |
40      |   110 | Llioness Save  | 0000-00-00 00:00:00 | B    | I     |        0 |             0 | f         |
41      |   115 | Llioness Save  | 2003-09-10 02:22:03 | B    | I     |        0 |             0 | A         |
42      |   128 | Catalog Save   | 2003-09-11 03:53:32 | B    | I     |        0 |             0 | C         |
43      |   131 | Catalog Save   | 0000-00-00 00:00:00 | B    | I     |        0 |             0 | f         |
44
45      As you can see, three of the five are failures.  I already deleted the
46      one restore and one other failure using the by-client option.  Deciding
47      what is an orphaned job is a tricky problem though, I agree.  All these
48      records have or had 0 files/ 0 bytes, except for the restore.  With no
49      files, of course, I don't know of the job ever actually becomes
50      associated with a Volume.
51
52      (I'm not sure if this is documented anywhere -- what are the meanings of
53      all the possible JobStatus codes?)
54
55      Looking at my database, it appears to me as though all the "orphaned"
56      jobs fit into one of two categories:
57
58      1)  The Job record has a StartTime but no EndTime, and the job is not
59          currently running;
60      or
61      2)  The Job record has an EndTime, indicating that it completed, but
62          it has no associated JobMedia record.
63
64
65      This does suggest an approach.  If failed jobs (or jobs that, for some
66      other reason, write no files) are associated with a volume via a
67      JobMedia record, then they should be purged when the associated volume
68      is purged.  I see two ways to handle jobs that are NOT associated with a
69      specific volume:
70
71      1)  purge them automatically whenever any volume is manually purged;
72      or
73      2)  add an option to the purge command to manually purge all jobs with
74          no associated volume.
75
76 - Implement Label Format in Add and Label console commands.
77 - make "btape /tmp" work.
78 - Make sure a rescheduled job is properly reported by status.
79 - Walk through the Pool records rather than the Job records
80   in dird.c to create/update pools.
81 - Figure out a way to move Volumes from one pool to another.
82 - What to do about "list files job=xxx".
83 - Implement delete Job.
84 - Document need to put LabelFormat in quotes.
85 - Implement scan: for every slot it finds, zero the slot of
86   Volume other volume having that slot.
87 - When job rescheduled, status gives is waiting for Client Rufus 
88   to connect to Storage File. Dir needs to inform SD that job
89   is rescheduled.
90 - Fix get_storage_from_media_type (ua_restore) to use command line     
91   storage=
92 - Enhance "update slots" to include a "scan" feature
93   scan 1; scan 1-5; scan 1,2,4 ...  to update the catalog 
94 - Allow a slot or range of slots on the label barcodes command.
95 - Don't print "Warning: Wrong Volume mounted ..." if mounting second volume.
96 - Make Dmsg look at global before calling subroutine.
97 - Enable trace output at runtime for Win32
98 - Make sure that Volumes are recycled based on "Least recently used"
99   rather than lowest MediaId.
100 - Available volumes for autochangers (see patrick@baanboard.com 3 Sep 03 
101   and 4 Sep) scan slots.
102 - Upgrade to cygwin 1.5
103 - Get MySQL 3.23.58
104 - Get and test MySQL 4.0
105 - Do a complete audit of all pthreads_mutex, cond, ... to ensure that
106   any that are dynamically initialized are destroyed when no longer used.
107 - Write a mini-readline with history and editing.
108 - Look at how fuser works and /proc/PID/fd that is how Nic found the
109   file descriptor leak in Bacula.
110 - Implement WrapCounters in Counters.
111 - Turn on SIGHUP in dird.c and test.
112 - Use system dependent calls to get more precise info on tape errors.
113 - Add heartbeat from FD to SD if hb interval expires.
114 - Suppress read error on blank tape when doing a label.
115 - Can we dynamically change FileSets.
116 - If pool specified to label command and Label Format is specified,
117   automatically generate the Volume name.
118 - Take a careful look a the Basic recycling algorithm.  When Bacula
119   chooses, the order should be:
120    - Look for Append
121    - Look for Recycle or Purged
122    - Prune volumes
123    - Look for purged
124   Instead of using lowest media Id, find the least recently used
125   volume.
126
127   When the tape is mounted and Bacula requests the status
128   - Do everything possible to use it.
129
130   Define a "available" status, which is the currently mounted 
131   Volume and all volumes that are currently in the autochanger.
132
133 - Why can't SQL do the filename sort for restore?
134 - Is a pool specification really needed for a restore?  Yes, and
135   you may want to exclude archive Pools.
136 - Look at libkse (man kse) for FreeBSD threading.
137 - Look into Microsoft Volume Shadowcopy Service VSS for backing
138   up system state components (Active Directory, System Volume, ...)
139 - Add ExhautiveRestoreSearch
140 - Look at the possibility of loading only the necessary 
141   data into the restore tree (i.e. do it one directory at a
142   time as the user walks through the tree).
143 - Possibly use the hash code if the user selects all for a restore command.
144 - Orphaned Dir buffer at parse_conf.c:373 =>  store_dir
145 - Implement some way for the File daemon to contact the Director 
146   to start a job or pass its DHCP obtained IP number.
147 - Implement multiple Consoles.
148 - Add Console usr permissions.
149 - Fix "restore all" to bypass building the tree.
150 - Fix restore to list errors if Invalid block found, and if # files
151   restored does not match # expected.
152 - Prohibit backing up archive device (findlib/find_one.c:128)
153 - Implement Release Device in the Job resource to unmount a drive.
154 - Implement Acquire Device in the Job resource to mount a drive,
155   be sure this works with admin jobs so that the user can get
156   prompted to insert the correct tape.  Possibly some way to say to
157   run the job but don't save the files.
158 - Add JobName= to VerifyToCatalog so that all verifies can be done at the end.
159 - Implement FileOptions (see end of this document)
160 - Make things like list where a file is saved case independent for
161   Windows.
162 - Edit the Client/Storage name into authentication failure messages.
163 - Implement job in VerifyToCatalog
164 - Implement migrate
165 - Implement a PostgreSQL driver.
166 - Bacula needs to propagate SD errors.
167   > > cluster-dir: Start Backup JobId 252, Job=REUTERS.2003-08-11_15.04.12
168   > > prod4-sd: REUTERS.2003-08-11_15.04.12 Error: Write error on device 
169        /dev/nst0. ERR=Input/output error.
170   > > prod4-sd: REUTERS.2003-08-11_15.04.12 Error: Re-read of last block failed. 
171        Last block=5162 Current block=5164.
172   > > prod4-sd: End of medium on Volume "REU007" Bytes=16,303,521,933 
173
174 - Use autochanger to handle multiple devices.
175 - Fix packet too big problem.
176 - Add SuSE install doc to list.
177 - Check and rechedk "Invalid block number"
178 - Make bextract release the drive properly between tapes 
179   so that an autochanger can be made to work.
180 - User wants to NOT backup up certain big files (email files).
181 - Maybe remove multiple simultaneous devices code in SD.
182 - On Windows with very long path names, it may be impossible to create 
183   a file (and thus restore it) because the total length is too long.
184   We must cd into the directory then create the file without the
185   full path name.
186 - lstat() is not going to work on Win32 for testing date.
187 - Something is not right in last block of fill command.
188 - Implement a Recycle command
189 - Add FileSet to command line arguments for restore.
190 - Allow multiple Storage specifications (or multiple names on
191   a single Storage specification) in the Job record. Thus a job 
192   can be backed up to a number of storage devices.
193 - Add client name to cram-md5 challenge so Director can immediately
194   verify if it is the correct client.
195 - Implement ClientRunBeforeJob and ClientRunAfterJob.
196 - Add JobLevel in FD status (but make sure it is defined).
197 - Audit all UA commands to ensure that we always prompt where possible.
198 - Restrict characters permitted in a Resource name, and don't permit
199   duplicate names.
200 - Check Jmsg in bnet, may not work, must dup bsock.
201 - Suppress Job Name in Jmsg for console
202 - Create Pools that are referenced in a Run statement at startup if possible.
203 - Use runbeforejob to unload, then reload a volume previously used,
204   then the next job run gets an error reading the drive.
205 - Make bootstrap filename unique.
206 - Test a second language e.g. french.
207 - Start working on Base jobs.
208 - Make "make binary-release" work from any directory.
209 - Implement UnsavedFiles DB record.
210 - Implement argc/argv for daemon command line scanning using table driven
211   stuff below.
212 - Implement table driven single argc/argv scanner to pickup all arguments.
213   Much like xxx_conf.c scan table.
214   keyword, handler(store_routine), store_address, code, flags, default.
215 - From Phil Stracchino:
216   It would probably be a per-client option, and would be called
217   something like, say, "Automatically purge obsoleted jobs".  What it
218   would do is, when you successfully complete a Differential backup of a
219   client, it would automatically purge all Incremental backups for that
220   client that are rendered redundant by that Differential.  Likewise,
221   when a Full backup on a client completed, it would automatically purge
222   all Differential and Incremental jobs obsoleted by that Full backup.
223   This would let people minimize the number of tapes they're keeping on
224   hand without having to master the art of retention times.
225 - Implement new serialize subroutines
226    send(socket, "string", &Vol, "uint32", &i, NULL)
227 - Scratch Pool where the volumes can be re-assigned to any Pool.
228 - Implement a M_SECURITY message class.
229 - Implement forward spacing block/file: position_device(bsr) --
230   just before read_block_from_device();
231 - When doing a Backup send all attributes back to the Director, who
232   would then figure out what files have been deleted.
233 - Currently in mount.c:236 the SD simply creates a Volume. It should have
234   explicit permission to do so.  It should also mark the tape in error
235   if there is an error.
236 - Make sure all restore counters are working correctly in the FD.
237 - SD Bytes Read is wrong.
238 - Look at ALL higher level routines that call block.c to be sure
239   they don't expect something in errmsg.
240 - Investigate doing RAW backup of Win32 partition.
241 - Add thread specific data to hold the jcr -- send error messages from
242   low level routines by accessing it and using Jmsg().
243 - Cancel waiting for Client connect in SD if FD goes away.
244
245 - Add Progress command that periodically reports the progress of
246   a job or all jobs.
247 - One block was orphaned in the SD probably after cancel.
248
249
250 - Examine Bare Metal restore problem (a FD crash exists somewhere ...).
251 - Implement timeout in response() when it should come quickly.
252 - Implement console @echo command.
253 - Implement a Slot priority (loaded/not loaded).
254 - Implement "vacation" Incremental only saves.
255 - Implement single pane restore (much like the Gftp panes).
256 - Implement Automatic Mount even in operator wait.
257 - Implement create "FileSet"?
258 - Fix watchdog pthread crash on Win32 (this is pthread_kill() Cygwin bug)
259 - Implement "scratch pool" where tapes are defined and can be
260   taken by any pool that needs them.
261 - Implement restore "current system", but take all files without
262   doing selection tree -- so that jobs without File records can
263   be restored.
264 - Implement disk spooling. Two parts: 1. Spool to disk then
265   immediately to tape to speed up tape operations. 2. Spool to
266   disk only when the tape is full, then when a tape is hung move
267   it to tape.
268 - Implement a relocatable bacula.spec 
269 - Implement dump/print label to UA
270 - Add prefixlinks to where or not where absolute links to FD.
271 - Issue message to mount a new tape before the rewind.
272 - Simplified client job initiation for portables.
273 - If SD cannot open a drive, make it periodically retry.
274 - Implement LabelTemplate (at least first cut).
275 - Add more of the config info to the tape label.
276 - Implement a Mount Command and an Unmount Command where
277   the users could specify a system command to be performed
278   to do the mount, after which Bacula could attempt to
279   read the device. This is for Removeable media such as a CDROM.
280   - Most likely, this mount command would be invoked explicitly
281   by the user using the current Console "mount" and "unmount" 
282   commands -- the Storage Daemon would do the right thing 
283   depending on the exact nature of the device.
284   - As with tape drives, when Bacula wanted a new removable
285   disk mounted, it would unmount the old one, and send a message
286   to the user, who would then use "mount" as described above 
287   once he had actually inserted the disk.
288
289 - If tape is marked read-only, then try opening it read-only rather than
290   failing, and remember that it cannot be written.
291 - Refine SD waiting output:
292     Device is being positioned
293     >     Device is being positioned for append
294     >     Device is being positioned to file x
295     > 
296 - Figure out some way to estimate output size and to avoid splitting
297   a backup across two Volumes -- this could be useful for writing CDROMs
298   where you really prefer not to have it split -- not serious.
299 - Have SD compute MD5 or SHA1 and compare to what FD computes.
300 - Make VolumeToCatalog calculate an MD5 or SHA1 from the 
301   actual data on the Volume and compare it.                  
302 - Implement Bacula plugins -- design API
303 - Make bcopy read through bad tape records.
304 - Program files (i.e. execute a program to read/write files).
305   Pass read date of last backup, size of file last time.
306 - Add Signature type to File DB record.
307 - CD into subdirectory when open()ing files for backup to
308   speed up things.  Test with testfind().
309 - Priority job to go to top of list.
310 - Why are save/restore of device different sizes (sparse?)   Yup! Fix it.
311 - Implement some way for the Console to dynamically create a job.
312 - Restore to a particular time -- e.g. before date, after date. 
313 - Solaris -I on tar for include list
314 - Need a verbose mode in restore, perhaps to bsr.
315 - bscan without -v is too quiet -- perhaps show jobs.
316 - Add code to reject whole blocks if not wanted on restore.
317 - Check if we can increase Bacula FD priorty in Win2000
318 - Make sure the MaxVolFiles is fully implemented in SD
319 - Check if both CatalogFiles and UseCatalog are set to SD.
320 - Figure out how to do a bare metal Windows restore
321 - Possibly add email to Watchdog if drive is unmounted too
322   long and a job is waiting on the drive.
323 - Restore program that errs in SD due to no tape, reports
324   OK incorrectly in output.
325 - After unmount, if restore job started, ask to mount.
326 - Convert all %x substitution variables, which are hard to remember
327   and read to %(variable-name).  Idea from TMDA.
328 - Remove NextId for SQLite. Optimize.
329 - Move all SQL statements into a single location.
330 - Add UA rc and history files.
331 - put termcap (used by console) in ./configure and
332   allow -with-termcap-dir.
333 - Enhance time and size scanning routines.
334 - Fix Autoprune for Volumes to respect need for full save.
335 - Fix Win32 config file definition name on /install
336 - Compare tape to Client files (attributes, or attributes and data) 
337 - Make all database Ids 64 bit.
338 - Write an applet for Linux.
339 - Implement new inter-daemon communications protocol.
340 - Allow console commands to detach or run in background.
341 - Fix status delay on storage daemon during rewind.
342 - Add SD message variables to control operator wait time
343   - Maximum Operator Wait
344   - Minimum Message Interval
345   - Maximum Message Interval
346 - Send Operator message when cannot read tape label.
347 - Verify level=Volume (scan only), level=Data (compare of data to file).
348   Verify level=Catalog, level=InitCatalog
349 - Events file
350 - Add keyword search to show command in Console.
351 - Events : tape has more than xxx bytes.
352 - Complete code in Bacula Resources -- this will permit
353   reading a new config file at any time.
354 - Handle ctl-c in Console
355 - Implement script driven addition of File daemon to config files.
356 - Think about how to make Bacula work better with File (non-tape) archives.
357 - Write Unix emulator for Windows.
358 - Put memory utilization in Status output of each daemon
359   if full status requested or if some level of debug on.
360 - Make database type selectable by .conf files i.e. at runtime
361 - Set flag for uname -a.  Add to Volume label.
362 - Implement throttled work queue.
363 - Restore files modified after date
364 - SET LD_RUN_PATH=$HOME/mysql/lib/mysql
365 - Implement Restore FileSet=
366 - Create a protocol.h and protocol.c where all protocol messages
367   are concentrated.
368 - Remove duplicate fields from jcr (e.g. jcr.level and jcr.jr.Level, ...).
369 - Timout a job or terminate if link goes down, or reopen link and query.
370 - Concept of precious tapes (cannot be reused).
371 - Make bcopy copy with a single tape drive.
372 - Permit changing ownership during restore.
373
374 - From Phil:
375   > My suggestion:  Add a feature on the systray menu-icon menu to request
376   > an immediate backup now.  This would be useful for laptop users who may
377   > not be on the network when the regular scheduled backup is run.
378   > 
379   > My wife's suggestion: Add a setting to the win32 client to allow it to
380   > shut down the machine after backup is complete (after, of course,
381   > displaying a "System will shut down in one minute, click here to cancel"
382   > warning dialog).  This would be useful for sites that want user
383   > woorkstations to be shut down overnight to save power.
384   > 
385
386 - From Terry Manderson <terry@apnic.net>
387    jobset { # new structure
388    name = "monthlyUnixBoxen"
389    type = backup
390    level = full
391    jobs = "wakame;durian;soy;wasabi;miso" #new!
392    schedule = monthly
393    storage = DLT
394    messages = Standard
395    pool = MonthlyPool
396    priority = 10
397    }
398
399    job {
400    name = "wakame"
401     fileset = "genericUnixSet"
402    client = wakame-fd
403    }
404
405    job {
406    name = "durian"
407    fileset = "genericUnixSet"
408    client = durian-fd
409    }
410
411    job {
412    name = "soy"
413    fileset = "UnixDevelBoxSet"
414    client = soy-fd
415    }
416
417
418 - Autolabel should be specified by DIR instead of SD.
419 - Storage daemon    
420   - Add media capacity
421   - AutoScan (check checksum of tape)
422   - Format command = "format /dev/nst0"
423   - MaxRewindTime
424   - MinRewindTime
425   - MaxBufferSize
426   - Seek resolution (usually corresponds to buffer size)
427   - EODErrorCode=ENOSPC or code
428   - Partial Read error code
429   - Partial write error code
430   - Nonformatted read error
431   - Nonformatted write error
432   - WriteProtected error
433   - IOTimeout
434   - OpenRetries
435   - OpenTimeout
436   - IgnoreCloseErrors=yes
437   - Tape=yes
438   - NoRewind=yes
439 - Pool
440   - Maxwrites
441   - Recycle period
442 - Job
443   - MaxWarnings
444   - MaxErrors (job?)
445 =====
446 - FD sends unsaved file list to Director at end of job (see
447   RFC below).
448 - File daemon should build list of files skipped, and then
449   at end of save retry and report any errors.
450 - Write a Storage daemon that uses pipes and
451   standard Unix programs to write to the tape.
452   See afbackup.
453 - Need something that monitors the JCR queue and
454   times out jobs by asking the deamons where they are.
455 - Enhance Jmsg code to permit buffering and saving to disk.
456 - device driver = "xxxx" for drives.
457 - Verify from Volume
458 - Ensure that /dev/null works
459 - Need report class for messages. Perhaps
460   report resource where report=group of messages
461 - enhance scan_attrib and rename scan_jobtype, and
462   fill in code for "since" option 
463 - Director needs a time after which the report status is sent
464   anyway -- or better yet, a retry time for the job.
465 - Don't reschedule a job if previous incarnation is still running.
466 - Some way to automatically backup everything is needed????
467 - Need a structure for pending actions:
468   - buffered messages
469   - termination status (part of buffered msgs?)
470 - Drive management
471   Read, Write, Clean, Delete
472 - Login to Bacula; Bacula users with different permissions:
473    owner, group, user, quotas
474 - Store info on each file system type (probably in the job header on tape.
475   This could be the output of df; or perhaps some sort of /etc/mtab record.
476
477 Longer term to do:
478 - Design at hierarchial storage for Bacula. Migration and Clone. 
479 - Implement FSM (File System Modules).
480 - Audit M_ error codes to ensure they are correct and consistent.
481 - Add variable break characters to lex analyzer.
482   Either a bit mask or a string of chars so that
483   the caller can change the break characters.
484 - Make a single T_BREAK to replace T_COMMA, etc.
485 - Ensure that File daemon and Storage daemon can
486   continue a save if the Director goes down (this
487   is NOT currently the case). Must detect socket error,
488   buffer messages for later. 
489 - Enhance time/duration input to allow multiple qualifiers e.g. 3d2h
490 - Add ability to backup to two Storage devices (two SD sessions) at
491   the same time -- e.g. onsite, offsite.
492 - Add the ability to consolidate old backup sets (basically do a restore
493   to tape and appropriately update the catalog). Compress Volume sets.
494   Might need to spool via file is only one drive is available.
495 - Compress or consolidate Volumes of old possibly deleted files. Perhaps
496   someway to do so with every volume that has less than x% valid 
497   files.
498
499
500 Migration: Move a backup from one Volume to another
501 Clone:     Copy a backup -- two Volumes
502
503 Bacula Migration is based on Jobs (apparently Networker is file by file).
504
505 Migration triggered by:
506   Number of Jobs
507   Number of Volumes
508   Age of Jobs
509   Highwater mark (keep total size)
510   Lowwater mark
511   
512 Projects:
513             Bacula Projects Roadmap 
514                17 August 2002
515            last update 8 May 2003
516
517 Item 1:   Multiple simultaneous Jobs. (done)
518 Done -- Restore part needs better implementation to work correctly
519         Also, it needs considerable testing
520
521   What:   Permit multiple simultaneous jobs in Bacula.
522
523   Why:    An enterprise level solution needs to go fast without the
524           need for the system administrator to carefully tweak
525           timing.  Based on the benchmarks, during a full
526           backup, NetWorker typically hit 10 times the bandwidth to
527           the tape compared to Bacula--largely. This is probably due to
528           running parallel jobs and multi-threaded filling of buffers
529           and writing them to tape.  This should also make things work
530           better when you have a mix of fast and slow machines backing
531           up at the same time.
532
533   Notes:  Bacula was designed to run multiple simultaneous jobs. Thus
534           implementing this is a matter of some small cleanups and
535           careful testing.
536
537
538 Item 2:   Make the Storage daemon use intermediate file storage to buffer data.
539 Deferred -- not necessary yet -- possibly implement with Migration.
540
541   What:   If data is coming into the SD too fast, buffer it to 
542           disk if the user has configured this option.
543
544   Why:    This would be nice, especially if it more or less falls out
545           when implementing (1) above.  If not, it probably should not
546           be given a high priority because fundamentally the backup time
547           is limited by the tape bandwidth.  Even though you may finish a
548           client job quicker by spilling to disk, you still have to
549           eventually get it onto tape.  If intermediate disk buffering
550           allows us to improve write bandwidth to tape, it may make
551           sense.
552
553   Notes:  Whether or not this is implemented will depend upon performance
554           testing after item 1 is implemented.
555
556
557 Item 3:   Write the bscan program -- also write a bcopy program.
558 Done
559
560   What:   Write a program that reads a Bacula tape and puts all the 
561           appropriate data into the catalog. This allows recovery
562           from a tape that is no longer in the database, or it allows
563           re-creation of a database if lost.
564
565   Why:    This is a fundamental robustness and disaster recovery tool
566           which will increase the comfort level of a sysadmin
567           considering adopting Bacula.
568
569   Notes:  A skeleton of this program already exists, but much work
570           needs to be done. Implementing this will also make apparent
571           any deficiencies in the current Bacula tape format.
572
573
574 Item 4:   Implement Base jobs.
575
576   What:   A base job is sort of like a Full save except that you 
577           will want the FileSet to contain only files that are unlikely
578           to change in the future (i.e. a snapshot of most of your
579           system after installing it). After the base job has been run,
580           when you are doing a Full save, you can specify to exclude
581           all files saved by the base job that have not been modified.
582
583   Why:    This is something none of the competition does, as far as we know
584           (except BackupPC, which is a Perl program that saves to disk
585           only).  It is big win for the user, it makes Bacula stand out
586           as offering a unique optimization that immediately saves time
587           and money.
588
589   Notes:  Big savings in tape usage. Will require more resources because
590           the e. DIR must send FD a list of files/attribs, and the FD must
591           search the list and compare it for each file to be saved.
592
593
594 Item 5:   Implement Label templates
595 Done 
596
597   What:   This is a mechanism whereby Bacula can automatically create
598           a tape label for new tapes according to a detailed specification
599           provided by the user.
600
601   Why:    It is a major convenience item for folks who use automated label
602           creation.
603
604   Notes:  Bacula already has a working form of automatic tape label
605           creation, but it is very crude. The design for the complete
606           tape labeling project is already documented in the manual.
607
608
609 Item 6:   Write a regression script.
610 Done --   Continue to expand its testing.
611
612   What:   This is an automatic script that runs and tests as many features
613           of Bacula as possible. The output is compared to previous
614           versions of Bacula and any differences are reported.
615
616   Why:    This is an enormous help in preventing introduction of new
617           errors in parts of the program that already work correctly.
618
619   Notes:  This probably should be ranked higher, it's something the typical
620           user doesn't see.  Depending on how it's implemented, it may
621           make sense to defer it until the archival tape format and
622           user interface mature.
623
624
625 Item 7:   GUI for interactive restore
626 Item 8:   GUI for interactive backup
627
628   What:   The current interactive restore is implemented with a tty
629           interface. It would be much nicer to be able to "see" the
630           list of files backed up in typical GUI tree format.
631           The same mechanism could also be used for creating 
632           ad-hoc backup FileSets (item 8).
633
634   Why:    Ease of use -- especially for the end user.
635
636   Notes:  Rather than implementing in Gtk, we probably should go directly
637           for a Browser implementation, even if doing so meant the
638           capability wouldn't be available until much later.  Not only
639           is there the question of Windows sites, most
640           Solaris/HP/IRIX, etc,  shops can't currently run Gtk programs
641           without installing lots of stuff admins are very wary about.
642           Real sysadmins will always use the command line anyway, and
643           the user who's doing an interactive restore or backup of his
644           own files will in most cases be on a Windows machine running
645           Exploder.
646
647
648 Item 9:   Add SSL to daemon communications.
649
650   What:   This provides for secure communications between the daemons.
651
652   Why:    This would allow doing backup across the Internet without
653           privacy concerns (or with much less concern).
654
655   Notes:  The vast majority of near term potential users will be backing up
656           a single site over a LAN and, correctly or not, they probably
657           won't be concerned with security, at least not enough to go to
658           the trouble to set up keys, etc. to screw things down.  We suspect
659           that many users genuinely interested in multi-site backup
660           already run some form of VPN software in their internetwork
661           connections, and are willing to delegate security to that layer.
662
663
664 Item 10:  Define definitive tape format.
665 Done (version 1.27)
666
667   What:   Define that definitive tape format that will not change 
668           for the next millennium.
669
670   Why:    Stability, security.
671
672   Notes:  See notes for item 11 below.
673
674
675 Item 11:  New daemon communication protocol.
676
677   What:   The current daemon to daemon protocol is basically an ASCII
678           printf() and sending the buffer. On the receiving end, the
679           buffer is sscanf()ed to unpack it. The new scheme would
680           be a binary format that allows quick packing and unpacking
681           of any data type with named fields.
682
683   Why:    Using binary packing would be faster. Named fields will permit
684           error checking to ensure that what is sent is what the 
685           receiver really wants.
686
687   Notes:  These are internal improvements in the interest of the
688           long-term stability and evolution of the program.  On the one
689           hand, the sooner they're done, the less code we have to rip
690           up when the time comes to install them.  On the other hand, they
691           don't bring an immediately perceptible benefit to potential
692           users.  Item 10 and possibly item 11 should be deferred until Bacula
693           is well established with a growing user community more or
694           less happy with the feature set.  At that time, it will make a
695           good "next generation" upgrade in the interest of data
696           immortality.
697
698
699
700
701 ======================================================
702         Base Jobs design
703 It is somewhat like a Full save becomes an incremental since
704 the Base job (or jobs) plus other non-base files.
705 Need:
706 - New BaseFile table that contains:
707     JobId, BaseJobId, FileId (from Base).
708   i.e. for each base file that exists but is not saved because
709   it has not changed, the File daemon sends the JobId, BaseId,
710   and FileId back to the Director who creates the DB entry.
711 - To initiate a Base save, the Director sends the FD 
712   the FileId, and full filename for each file in the Base.
713 - When the FD finds a Base file, he requests the Director to
714   send him the full File entry (stat packet plus MD5), or
715   conversely, the FD sends it to the Director and the Director
716   says yes or no. This can be quite rapid if the FileId is kept
717   by the FD for each Base Filename.          
718 - It is probably better to have the comparison done by the FD
719   despite the fact that the File entry must be sent across the
720   network.
721 - An alternative would be to send the FD the whole File entry
722   from the start. The disadvantage is that it requires a lot of
723   space. The advantage is that it requires less communications
724   during the save.
725 - The Job record must be updated to indicate that one or more
726   Bases were used.
727 - At end of Job, FD returns:   
728    1. Count of base files/bytes not written to tape (i.e. matches)
729    2. Count of base file that were saved i.e. had changed.
730 - No tape record would be written for a Base file that matches, in the
731   same way that no tape record is written for Incremental jobs where
732   the file is not saved because it is unchanged.
733 - On a restore, all the Base file records must explicitly be
734   found from the BaseFile tape. I.e. for each Full save that is marked
735   to have one or more Base Jobs, search the BaseFile for all occurrences
736   of JobId.
737 - An optimization might be to make the BaseFile have:
738      JobId
739      BaseId
740      FileId
741   plus
742      FileIndex
743   This would avoid the need to explicitly fetch each File record for
744   the Base job.  The Base Job record will be fetched to get the
745   VolSessionId and VolSessionTime.
746 =========================================================  
747
748   
749
750 =============================================================
751
752                 Request For Comments For File Backup Options
753                    10 November 2002
754
755 Subject: File Backup Options
756
757 Problem: 
758   A few days ago, a Bacula user who is backing up to file volumes and
759   using compression asked if it was possible to suppress compressing
760   all .gz files since it was a waste of CPU time. Although Bacula
761   currently permits using different options (compression, ...) on
762   a directory by directory basis, it cannot do it on a file by 
763   file basis, which is clearly what was desired.   
764
765 Proposed Implementation:
766   To solve this problem, I propose the following:
767
768   - Add a new Director resource type called Options.  
769
770   - The Options resource will have records for all
771     options that can currently be specified on the Include record 
772     (in a FileSet).  Examples below.
773
774   - The Options resource will permit an exclude option as well
775     as a number of additional options.
776
777   - The heart of the Options resource is the ability to
778     supply any number of Match records which specify POSIX
779     regular expressions.  These Match regular expressions are
780     applied to the fully qualified filename (path and all). If
781     one matches, then the Options will be used.
782
783   - When an Match specification matches an included file, the
784     options specified in the Options resource will override
785     the default options specified on the Include record.
786
787   - Include records will be modified to permit referencing one or
788     more Options resources.  The Options will be used
789     in the order listed on the Include record and the first
790     one that matches will be applied.
791
792   - Options (or specifications) currently supplied on the Include
793     record will be deprecated (i.e. removed in a later version a
794     year or so from now).
795
796   - The Exclude record will be deprecated as the same functionality
797     can be obtained by using an Exclude = yes in the Options.
798
799 Options records:
800   The following records can appear in the Options resource. An
801   asterisk preceding the name indicates a feature not currently
802   implemented.
803
804   For Backup Jobs:
805     - Compression= (GZIP, ...)
806     - Signature=   (MD5, SHA1, ...)
807     - *Encryption=
808     - OneFs=      (yes/no)    - remain on one filesystem
809     - Recurse=    (yes/no)    - recurse into subdirectories
810     - Sparse=     (yes/no)    - do sparse file backup
811     - *Exclude=   (yes/no)    - exclude file from being saved
812     - *Reader=    (filename)  - external read (backup) program
813     - *Plugin=    (filename)  - read/write plugin module
814
815   For Verify Jobs:
816     - verify=     (ipnougsamc5) - verify options
817
818   For Restore Jobs:
819     - replace= (always/ifnewer/ifolder/never) - replace options currently
820                                                 implemented in 1.31
821     - *Writer= (filename)   - external write (restore) program
822
823
824 Implementation:
825   Currently options specifying compression, MD5 signatures, recursion,
826   ... of a FileSet are supplied on the Include record. These will now
827   all be collected into a Options resource, which will be
828   specified in the Include in place of the options. Multiple Options
829   may be specified.  Since the Options may contain regular expressions
830   that are applied to the full filename, this will give the ability
831   to specify backup options on a file by file basis to whatever level
832   of detail you wish.
833
834 Example:
835
836   Today:
837
838     FileSet {
839       Name = "FullSet"
840       Include = compression=GZIP signature=MD5 {
841         /
842       }
843     }
844
845   Proposal:
846
847     FileSet {
848       Name = "FullSet"
849       Include {
850         Compression = GZIP;
851         Signature = MD5
852         Match = /*.?*/                # matches all files.
853         File = /
854       }
855     }
856
857   That's a lot more to do the same thing, but it gives the ability to
858   apply options on a file by file basis.  For example, suppose you
859   want to compress all files but not any file with extensions .gz or .Z.
860   In that case, you will need to group two sets of options using
861   the Options resource as follows:
862
863
864     FileSet {
865       Name = "FullSet"
866       Include {
867         Options {
868           Signature = MD5
869           # Note multiple Matches are ORed
870           Match = /*.gz/   # matches .gz files */
871           Match = /*.Z/    # matches .Z files */
872         }
873         Options {
874           Compression = GZIP
875           Signature = MD5
876           Match = /*.?*/   # matches all files
877         }
878         File = /
879       }
880     }
881
882   Now, since the no Compression option is specified in the
883   first group of Options, *.gz or *.Z file will have an MD5 signature computed,
884   but will not be compressed. For all other files, the *.gz *.Z will not
885   match, so the second group of options will be used which will include GZIP
886   compression.
887
888 Questions:
889   - Is it necessary to provide some means of ANDing regular expressions
890     and negation?  (not currently planned)
891
892     e.g.  Match = /*.gz/ && !/big.gz/
893
894   - I see that Networker has a "null" module which, if specified, does not 
895     backup the file, but does make an record of the file in the catalog
896     so that the catalog will reflect an exact picture of the filesystem.
897     The result is that the file can be "seen" when "browsing" the save
898     sets, but it cannot be restored.
899     
900     Is this really useful?  Should it be implemented in Bacula?
901   
902 Results:
903   After implementing the above, the user will be able to specify
904   on a file by file basis (using regular expressions) what options are
905   applied for the backup.
906
907
908 =============================================
909
910 ========================================================== 
911     Unsaved File design
912 For each Incremental job that is run, there may be files that
913 were found but not saved because they were locked (this applies
914 only to Windows). Such a system could send back to the Director
915 a list of Unsaved files.
916 Need:
917 - New UnSavedFiles table that contains:
918   JobId
919   PathId
920   FilenameId
921 - Then in the next Incremental job, the list of Unsaved Files will be
922   feed to the FD, who will ensure that they are explicitly chosen even
923   if standard date/time check would not have selected them.
924 =============================================================
925
926
927 Done: (see kernsdone for more)
928 - Implement new alist in FileSet scanning.
929 - bls should continue reading even if it finds Win32 data on the tape.
930   The error should be Warning rather the Error.
931 - Add user configurable timeout for connecting to SD.
932 - Unsaved Flag in Job record (use JobMissingFiles).
933 - Base Flag in Job record.
934 - Configure mtx-changer to have correct path to mtx.
935 - Add all command line arguments to "update", e.g. slot=nn volStatus=append, ...
936 - Make some way so that if a machine is skipped because it is not up 
937   that Bacula will continue retrying for a specified period of time --
938   periodically.
939 - Implement all command line args on run.
940 - Implement command line "restore" args.
941 - Implement "restore current select=no"
942 - Restore file modified before date
943 - Restore -- do nothing but show what would happen
944 - Add estimate to Console commands
945 - Use read_record.c in SD code.
946 - Fix read_record to handle multiple sessions.
947 - Tip from Steve Allam
948   mt -f /dev/nst0 defblksize 0
949 - Document "status" in the console.
950 - Document driving console from shell script.
951 - Write JobMedia records with max file size is reached on tape.
952 - Handle the case of multiple JobMedia records pending (i.e. the
953   thread is slow and multiple situations requiring a JobMedia
954   record occur).
955 - Do performance analysis on the restore tree routines.
956 - Fix maximum file size (block.c) to generate JobMedia records.
957 - Make the default file size 1GB on the tape.
958 - Implement forward spacing between files.
959 - Add Machine type (Linux/Windows) to Status report for daemons. 
960   Look at src/host.h
961 - Use repositioning at the beginning of the tape.                   
962 - Do full check the command line args in update (e.g. VolStatus ...).
963 - Specify list of files to restore
964 - Implement ClientRunBeforeJob and ClientRunAfterJob.
965 - Make | and < work on FD side.
966 - Check to see if "blocked" is set during restore.
967 - Figure out what is interrupting sql command in console.
968 - Make new job print warning User Unmounted Tape.
969 - Test recycling and purging (code changed in db_find_next_volume and
970   in recycle.c).
971 - Document SDConnectTimeout (in FD).
972 - Add restore by filename test.
973 - Document restore by files.
974 - Make variable expansion work correctly.
975 - Implement List Volume Job=xxx  or List scheduled volumes or Status Director 
976 - Copy static programs into install directory.
977 - Think about changing Storage resource Device record to be
978   SDDeviceName.
979 - Add RunBeforeJob and RunAfterJob to the Client program.
980 - Need return status on read_cb() from read_records(). Need multiple
981   records -- one per Job, maybe a JCR or some other structure with
982   a block and a record.
983 - LabelFormat on tape volume apparently creates the db record but 
984   never actually labels the volume.
985 - Recycling a volume when two jobs are using it is going to break. Fixed.
986 - Document list nextvol and new format status dir.
987 - Client files in Win32 with Unix eol conventions doesn't work.
988 - Either fix or document that fill command in btape can be
989   compressed enormously by the hardware - a 36GB tape wrote 750GB!
990 - Add multiple character duration qualifiers.
991 - Require some modifer.
992 - Restrict characters permitted in a Resource name, and don't permit
993   duplicate names.
994 - Figure out some way to ignore or get past checksum errors in
995   reading.
996 - The SD spooling file gets created even if it is not used.
997 - Look at Cleaning tape in ua_label.c for media create/update 
998 - Add regression testing to the manual
999 - End time: in job output of rescheduled job is time of first run.
1000 - Document list nextvol and status output.
1001 - Separate Dir heartbeat in FD from the SD heartbeat.
1002 - Fix sparse file handeling so that it always reads a multiple
1003   of 512. Currently, it subtracts 8 bytes (for faddr).
1004   Kludged with #ifdef for FreeBSD.
1005 - Document that Volume pruning can delete last Full backup and
1006   hence you will not have a valid backup.
1007 - Clarify the fact that having the Bacula cygwin1.dll loaded
1008   is not the same as having cygwin installed.
1009 - Document that it is safe to use the drive when the lights stop flashing.
1010 - Document all the status codes JobLevel, JobType, JobStatus.
1011 - Add GUI interface to manual