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