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