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