]> git.sur5r.net Git - bacula/bacula/blob - bacula/kernstodo
Doc updates
[bacula/bacula] / bacula / kernstodo
1                  Kern's ToDo List
2                  10 November 2002
3
4 To do:    
5 - Document to have patience when SD first starts.
6 - Document running a test version.
7 - Document saving MySQL databases, where to find code for shutting 
8   down and saving other databases.
9   http://www.backupcentral.com/free-backup-software1.html
10
11 Test:
12 - that restore options work in FD.
13 - that mod of restore options works.
14 - that console command line options work
15 - blocksize recognition code.
16
17 For 1.27 release:
18 - Implement FileOptions.
19 - Need return status on read_cb() from read_records(). Need multiple
20   records -- one per Job, maybe a JCR or some other structure with
21   a block and a record.
22 - Continue improving the restore process (handling
23   of tapes, efficiency improvements e.g. use FSF to
24   position the tape, ...)
25 - Work more on how to to a Bacula restore beginning with
26   just a Bacula tape and a boot floppy (bare metal recovery).
27 - Try bare metal Windows restore
28
29 - Write bcopy program -- recovery of bad tape.
30 - Fix read_record to handle multiple sessions.
31
32 - Program files (i.e. execute a program to read/write files).
33   Pass read date of last backup, size of file last time.
34
35 - Put system type returned by FD into catalog.
36 - Decide what to do with JobTDate in catalog (make real btime_t?)
37 - Add VOLUME_CAT_INFO to the EOS tape record (as
38   well as to the EOD record).
39 - Add code to fast seek to proper place on tape/file
40   when doing Restore. If it doesn't work, try linear
41   search as before.
42 - Add code to reject whole blocks if not wanted on restore.
43 - Possibly add email to Watchdog if drive is unmounted too
44   long and a job is waiting on the drive.
45 - Strip trailing slashes from Include directory names in the FD.
46 - Use read_record.c in SD code.
47 - Add EOM records ???????
48 - Why don't we get an error message from Win32 FD when bootstrap 
49   file cannot be created for restore command?
50 - Put MaximumVolumeSize in Director (MaximumVolumeJobs, MaximumVolumeFiles,
51    MaximumFileSize).
52 - When Marking a file in Restore that is a hard link, also
53   mark the link so that the data will be reloaded.
54 - Restore program that errors in SD due to no tape reports
55   OK incorrectly in output.
56 - Make BSR accept count (total files to be restored).
57 - Make BSR return next_block when it knows record is not
58   in block, done when count is reached, and possibly other
59   optimizations. I.e. add a state word.
60
61
62 After 1.27
63 - Figure out how compress everything except .gz,... files.
64 - Make bcopy copy with a single tape drive.
65 - Make sure catalog doesn't keep growing.
66 - Permit changing ownership during restore.
67 - After unmount, if restore job started, ask to mount.
68 - Fix db_get_fileset in cats/sql_get.c for multiple records.
69 - Fix start/end blocks for File devices
70 - Add new code to scheduler.c and run_conf.c
71 - Fix catalog filename truncation in sql_get and sql_create. Use
72   only a single filename split routine.
73 - Add command to reset VolFiles to a larger value (don't allow
74   a smaller number or print big warning).
75 - Make Restore report an error if FD or SD term codes are not OK.
76 - Convert all %x substitution variables, which are hard to remember
77   and read to %(variable-name).  Idea from TMDA.
78 - Add JobLevel in FD status (but make sure it is defined).
79 - Make Pool resource handle Counter resources.
80 - Remove NextId for SQLite. Optimize.
81 - Fix gethostbyname() to use gethostbyname_r()
82 - Implement ./configure --with-client-only
83 - Strip trailing / from Include
84 - Move all SQL statements into a single location.
85 - Cleanup db_update_media and db_update_pool
86 - Add UA rc and history files.
87 - put termcap (used by console) in ./configure and
88   allow -with-termcap-dir.
89 - Remove JobMediaId it is not used.
90 - Enhance time and size scanning routines.
91 - Fix Autoprune for Volumes to respect need for full save.
92 - DateWritten field on tape may be wrong.
93 - Fix Win32 config file definition name on /install
94 - No READLINE_SRC if found in alternate directory.
95 - Add Client FS/OS id (Linux, Win95/98, ...).
96
97   
98 Projects:
99             Bacula Projects Roadmap 
100                17 August 2002
101            last update 7 October 2002
102
103 Item 1:   Multiple simultaneous Jobs. (done)
104 Done
105
106   What:   Permit multiple simultaneous jobs in Bacula.
107
108   Why:    An enterprise level solution needs to go fast without the
109           need for the system administrator to carefully tweak
110           timing.  Based on the benchmarks, during a full
111           backup, NetWorker typically hit 10 times the bandwidth to
112           the tape compared to Bacula--largely. This is probably due to
113           running parallel jobs and multi-threaded filling of buffers
114           and writing them to tape.  This should also make things work
115           better when you have a mix of fast and slow machines backing
116           up at the same time.
117
118   Notes:  Bacula was designed to run multiple simultaneous jobs. Thus
119           implementing this is a matter of some small cleanups and
120           careful testing.
121
122
123 Item 2:   Make the Storage daemon use intermediate file storage to buffer data.
124 Deferred -- not necessary yet.
125
126   What:   If data is coming into the SD too fast, buffer it to 
127           disk if the user has configured this option.
128
129   Why:    This would be nice, especially if it more or less falls out
130           when implementing (1) above.  If not, it probably should not
131           be given a high priority because fundamentally the backup time
132           is limited by the tape bandwidth.  Even though you may finish a
133           client job quicker by spilling to disk, you still have to
134           eventually get it onto tape.  If intermediate disk buffering
135           allows us to improve write bandwidth to tape, it may make
136           sense.
137
138   Notes:  Whether or not this is implemented will depend upon performance
139           testing after item 1 is implemented.
140
141
142 Item 3:   Write the bscan program.
143 Done
144
145   What:   Write a program that reads a Bacula tape and puts all the 
146           appropriate data into the catalog. This allows recovery
147           from a tape that is no longer in the database, or it allows
148           re-creation of a database if lost.
149
150   Why:    This is a fundamental robustness and disaster recovery tool
151           which will increase the comfort level of a sysadmin
152           considering adopting Bacula.
153
154   Notes:  A skeleton of this program already exists, but much work
155           needs to be done. Implementing this will also make apparent
156           any deficiencies in the current Bacula tape format.
157
158
159 Item 4:   Implement Base jobs.
160
161   What:   A base job is sort of like a Full save except that you 
162           will want the FileSet to contain only files that are unlikely
163           to change in the future (i.e. a snapshot of most of your
164           system after installing it). After the base job has been run,
165           when you are doing a Full save, you can specify to exclude
166           all files saved by the base job that have not been modified.
167
168   Why:    This is something none of the competition does, as far as we know
169           (except BackupPC, which is a Perl program that saves to disk
170           only).  It is big win for the user, it makes Bacula stand out
171           as offering a unique optimization that immediately saves time
172           and money.
173
174   Notes:  Big savings in tape usage. Will require more resources because
175           the e. DIR must send FD a list of files/attribs, and the FD must
176           search the list and compare it for each file to be saved.
177
178
179 Item 5:   Implement Label templates
180
181   What:   This is a mechanism whereby Bacula can automatically create
182           a tape label for new tapes according to a detailed specification
183           provided by the user.
184
185   Why:    It is a major convenience item for folks who use automated label
186           creation.
187
188   Notes:  Bacula already has a working form of automatic tape label
189           creation, but it is very crude. The design for the complete
190           tape labeling project is already documented in the manual.
191
192
193 Item 6:   Write a regression script.
194 Started
195
196   What:   This is an automatic script that runs and tests as many features
197           of Bacula as possible. The output is compared to previous
198           versions of Bacula and any differences are reported.
199
200   Why:    This is an enormous help in preventing introduction of new
201           errors in parts of the program that already work correctly.
202
203   Notes:  This probably should be ranked higher, it's something the typical
204           user doesn't see.  Depending on how it's implemented, it may
205           make sense to defer it until the archival tape format and
206           user interface mature.
207
208
209 Item 7:   GUI for interactive restore
210 Item 8:   GUI for interactive backup
211
212   What:   The current interactive restore is implemented with a tty
213           interface. It would be much nicer to be able to "see" the
214           list of files backed up in typical GUI tree format.
215           The same mechanism could also be used for creating 
216           ad-hoc backup FileSets (item 8).
217
218   Why:    Ease of use -- especially for the end user.
219
220   Notes:  Rather than implementing in Gtk, we probably should go directly
221           for a Browser implementation, even if doing so meant the
222           capability wouldn't be available until much later.  Not only
223           is there the question of Windows sites, most
224           Solaris/HP/IRIX, etc,  shops can't currently run Gtk programs
225           without installing lots of stuff admins are very wary about.
226           Real sysadmins will always use the command line anyway, and
227           the user who's doing an interactive restore or backup of his
228           own files will in most cases be on a Windows machine running
229           Exploder.
230
231
232 Item 9:   Add SSL to daemon communications.
233
234   What:   This provides for secure communications between the daemons.
235
236   Why:    This would allow doing backup across the Internet without
237           privacy concerns (or with much less concern).
238
239   Notes:  The vast majority of near term potential users will be backing up
240           a single site over a LAN and, correctly or not, they probably
241           won't be concerned with security, at least not enough to go to
242           the trouble to set up keys, etc. to screw things down.  We suspect
243           that many users genuinely interested in multi-site backup
244           already run some form of VPN software in their internetwork
245           connections, and are willing to delegate security to that layer.
246
247
248 Item 10:  Define definitive tape format.
249 Mostly done (version 1.27)
250
251   What:   Define that definitive tape format that will not change 
252           for the next millennium.
253
254   Why:    Stability, security.
255
256   Notes:  See notes for item 11 below.
257
258
259 Item 11:  New daemon communication protocol.
260
261   What:   The current daemon to daemon protocol is basically an ASCII
262           printf() and sending the buffer. On the receiving end, the
263           buffer is sscanf()ed to unpack it. The new scheme would
264           be a binary format that allows quick packing and unpacking
265           of any data type with named fields.
266
267   Why:    Using binary packing would be faster. Named fields will permit
268           error checking to ensure that what is sent is what the 
269           receiver really wants.
270
271   Notes:  These are internal improvements in the interest of the
272           long-term stability and evolution of the program.  On the one
273           hand, the sooner they're done, the less code we have to rip
274           up when the time comes to install them.  On the other hand, they
275           don't bring an immediately perceptible benefit to potential
276           users.  Item 10 and possibly item 11 should be deferred until Bacula
277           is well established with a growing user community more or
278           less happy with the feature set.  At that time, it will make a
279           good "next generation" upgrade in the interest of data
280           immortality.
281
282
283
284 I haven't put these in any particular order.
285
286 Small projects:
287 - Rework Storage daemon with new rwl_lock routines.
288 - Compare tape to Client files (attributes, or attributes and data) 
289 - Restore options (overwrite, overwrite if older,
290    overwrite if newer, never overwrite, ...)
291 - Restore to a particular time -- e.g. before date, after date. 
292 - Make all database Ids 64 bit.
293 - Write an applet for Linux.
294 - Add estimate to Console commands
295 - Find solution to blank filename (i.e. path only) problem.
296 - Implement new daemon communications protocol.
297
298 Dump:
299   mysqldump -f  --opt bacula >bacula
300
301
302 To be done:
303 - Remove PoolId from Job table, it exists in Media.
304 - Allow console commands to detach or run in background.
305 - Fix status delay on storage daemon during rewind.
306 - Add SD message variables to control operator wait time
307   - Maximum Operator Wait
308   - Minimum Message Interval
309   - Maximum Message Interval
310 - Add EOM handling variables
311   - Write EOD records
312   - Require EOD records
313 - Send Operator message when cannot read tape label.
314 - Think about how to handle I/O error on MTEOM.
315 - Verify level=Volume (scan only), level=Data (compare of data to file).
316   Verify level=Catalog, level=InitCatalog
317 - Events file
318 - Add keyword search to show command in Console.
319 - Fix Win2000 error with no messages during startup.
320 - Events : tape has more than xxx bytes.
321 - Write general list maintenance subroutines.
322 - Restrict characters permitted in a Resource name.
323 - Complete  code in Bacula Resources -- this will permit
324   reading a new config file at any time.
325 - Handle ctl-c in Console
326 - Implement LabelTemplate (at least first cut).
327 - Implement script driven addition of File daemon to config files.
328
329 - see setgroup and user for Bacula p4-5 of stunnel.c
330 - Implement new serialize subroutines
331    send(socket, "string", &Vol, "uint32", &i, NULL)
332 - On I/O error, write EOF, then try to write again ????
333 - Audit all UA commands to ensure that we always prompt where possible.
334 - If ./btape is called without /dev, assume argument is a Storage resource name.
335 - Put memory utilization in Status output of each daemon
336   if full status requested or if some level of debug on.
337 - Make database type selectable by .conf files i.e. at runtime
338 - gethostbyname failure in bnet_connect() continues
339   generating errors -- should stop.
340 - Add HOST to Volume label.
341 - Set flag for uname -a.  Add to Volume label.
342 - Implement throttled work queue.
343 - Check for EOT at ENOSPC or EIO or ENXIO (unix Pc)
344 - Allow multiple Storage specifications (or multiple names on
345   a single Storage specification) in the Job record. Thus a job 
346   can be backed up to a number of storage devices.
347 - Implement full MediaLabel code.
348 - Implement dump label to UA
349 - Copy volume using single drive.
350 - Copy volume with multiple driven (same or different block size).     
351 - Add block size (min, max) to Vol label.
352 - Concept of VolumeSet during restore which is a list
353   of Volume names needed.
354 - Restore files modified after date
355 - Restore file modified before date
356 - Emergency restore info:
357   - Backup Bacula
358   - Backup working directory
359   - Backup Catalog
360 - Restore options (do not overwrite)
361 - Restore -- do nothing but show what would happen
362 - SET LD_RUN_PATH=$HOME/mysql/lib/mysql
363 - Implement Restore FileSet=
364 - Write a scanner for the UA (keyword, scan-routine, result, prompt).
365 - Create a protocol.h and protocol.c where all protocol messages
366   are concentrated.
367 - If SD cannot open a drive, make it periodically retry.
368 - Put Bacula version somewhere in Job stream, probably Start Session
369   Labels.
370 - Remove duplicate fields from jcr (e.g. jcr.level and jcr.jr.Level, ...).
371 - Timout a job or terminate if link goes down, or reopen link and query.
372 - Fill all fields in Vol/Job Header -- ensure that everything
373   needed is written to tape. Think about restore to Catalog
374   from tape.  Client record needs improving.
375 - Find general solution for sscanf size problems (as well
376   as sprintf. Do at run time?
377 - Concept of precious tapes (cannot be reused).
378 - Allow FD to run from inetd ???
379
380 - Restore should get Device and Pool information from
381   job record rather than from config.
382 - Autolabel should be specified by DR instead of SD.
383 - Find out how to get the system tape block limits, e.g.:
384   Apr 22 21:22:10 polymatou kernel: st1: Block limits 1 - 245760 bytes.  
385   Apr 22 21:22:10 polymatou kernel: st0: Block limits 2 - 16777214 bytes.
386 - Storage daemon    
387   - Add media capacity
388   - AutoScan (check checksum of tape)
389   - Format command = "format /dev/nst0"
390   - MaxRewindTime
391   - MinRewindTime
392   - MaxBufferSize
393   - Seek resolution (usually corresponds to buffer size)
394   - EODErrorCode=ENOSPC or code
395   - Partial Read error code
396   - Partial write error code
397   - Nonformatted read error
398   - Nonformatted write error
399   - WriteProtected error
400   - IOTimeout
401   - OpenRetries
402   - OpenTimeout
403   - IgnoreCloseErrors=yes
404   - Tape=yes
405   - NoRewind=yes
406 - Pool
407   - Maxwrites
408   - Recycle period
409 - Job
410   - MaxWarnings
411   - MaxErrors (job?)
412 =====
413 - FD sends unsaved file list to Director at end of job. 
414 - Write a Storage daemon that uses pipes and
415   standard Unix programs to write to the tape.
416   See afbackup.
417 - Need something that monitors the JCR queue and
418   times out jobs by asking the deamons where they are.
419
420 - Enhance Jmsg code to permit buffering and saving to disk.
421 - device driver = "xxxx" for drives.
422 - restart: paranoid: read label fsf to
423   eom read append block, and go
424   super-paranoid: read label, read all files
425   in between, read append block, and go
426   verify: backspace, read append block, and go
427   permissive: same as above but frees drive
428   if tape is not valid.
429 - Verify from Volume
430 - Ensure that /dev/null works
431 - File daemon should build list of files skipped, and then
432   at end of save retry and report any errors.
433 - Need report class for messages. Perhaps
434   report resource where report=group of messages
435 - enhance scan_attrib and rename scan_jobtype, and
436   fill in code for "since" option 
437 - To buffer messages, we need associated jobid and Director name.
438 - Need to save contents of FileSet to tape?
439 - Director needs a time after which the report status is sent
440   anyway -- or better yet, a retry time for the job.
441   Don't reschedule a job if previous incarnation is still running.
442 - Figure out how to save the catalog (possibly a special FileSet).
443 - Figure out how to restore the catalog.
444 - Some way to automatically backup everything is needed????
445 - Need a structure for pending actions:
446   - buffered messages
447   - termination status (part of buffered msgs?)
448 - Concept of grouping Storage devices and job can use
449   any of a number of devices
450 - Drive management
451   Read, Write, Clean, Delete
452 - Login to Bacula; Bacula users with different permissions:
453    owner, group, user, quotas
454 - Tape recycle destination
455 - Job Schedule Status
456   - Automatic
457   - Manual
458   - Running
459 - Store info on each file system type (probably in the job header on tape.
460   This could be the output of df; or perhaps some sort of /etc/mtab record.
461
462 Longer term to do:
463 - Use media 1 time (so that we can do 6 days of incremental
464   backups before switching to another tape) (already)
465   specify # times (jobs)
466   specify bytes (already)
467   specify time (seconds, hours, days)
468 - Implement FSM (File System Modules).
469 - Identify unchanged or "system" files and save them to a
470   special tape thus removing them from the standard 
471   backup FileSet -- BASE backup.
472 - Turn virutally all sprintfs into snprintfs.
473 - Heartbeat between daemons.
474 - Audit M_ error codes to ensure they are correct and consistent.
475 - Add variable break characters to lex analyzer.
476   Either a bit mask or a string of chars so that
477   the caller can change the break characters.
478 - Make a single T_BREAK to replace T_COMMA, etc.
479 - Ensure that File daemon and Storage daemon can
480   continue a save if the Director goes down (this
481   is NOT currently the case). Must detect socket error,
482   buffer messages for later. 
483
484
485 Done: (see kernsdone for more)
486 - Document bscan.
487 - Document Restore.
488 - Check if GZIP1 is working -- check speed.
489 - Document forcing a new tape to be used.
490 - Ensure that AcceptAnyVolume works.
491 - Document running multiple Jobs
492 - Preserve block number when EOT and writing on next tape.
493 - Document how to cancel a job that is waiting on a Volume. 
494   Must "cancel" then "mount".
495 - Document Volume Bytes shows bytes on last volume written in Job summary.
496 - Restore all Windows attributes. Leave hooks for ACLs and security.
497   (Handle x = (HANDLE)get_osfhandle(fd);
498 - Test Windows restore.
499 - Look into MinGW
500 - Implement sparse files.
501 - Document sparse files.
502 - Document better Include  (does it cross file systems ?).
503 - Document default config file locations.
504 - Document specifically how to add new File daemon to config files.
505 - Add VerNo to each Session label record. 
506 - Add Job to Session records.
507 - Cold start full restore (restore catalog then
508   user selects what to restore).  Write summary file containing only
509   Job, Media, and Catalog information. Store on another machine.
510 - Dump/Restore database
511 - Write bscan program that will syncronize the DB Media record with
512   the contents of the Volume -- for use after a crash.
513 - Figure out how to put a Volume into the catalog (from the tape)
514 - Figure out how to do a restore from a Volume
515 - Report compression % and other compression statistics if turned on.
516 - Put Windows files in Windows stream?
517 - Ensure that everyone uses btime routines (mostly done).
518 - Put Job statistics in End Session Label (files saved,
519   total bytes, start time, ...).     
520 - Put FileSet name in the SOS label.
521 - Eliminate duplicate File records to shrink database.
522 - If Storage daemon aborts a job, ensure that this
523   is printed in the error message.
524 - Add save type to Session label.
525 - Correct date on Session label.
526 - Test restore of Windows backup
527 - Ability to recreate the catalog from a tape.
528 - Bug: anonymous Volumes requires mount in some cases.
529 - Define how we handle times to avoid problem with Unix dates (2049 ?).
530 - Add daemon JCR JobId=0 to have a daemon context
531 - Implement full restoration of all Windows attributes
532   (such as Hidden, System, creation dates, ...)
533 - Handle sparse files (i.e. files with holes in them)
534 - Enhance testing for Bacula compatibility with   
535   tape drives.
536 - Turn on new BB02 tape format implemented in 1.26 but
537   not yet turned on.
538 - More testing of restoring on Unix systems.
539 - Implement additional tape format enhancements to better 
540   support Windows and other non-Unix systems e.g. 
541   extended attributes.
542 - Upgrade to latest version of cygwin. (not possible)
543 - Add configure for gettimeofday.
544 - At line 51 of ua_input.c, why is = 0 necessary. Previously without
545   it, if cancel gnome-console during sql command, DIR crashed.  However,
546   with it, blank line input for Where: is not possible.
547 - Make SD disallow writing on Volume with fewer files than in
548   the catalog.
549 - Label (asks for slot, return and it stops).
550 - Make SD reject writing on tape where Catalog and tape # files
551   don't agree (possibly OK if tape > catalog).
552 - Document all daemon tools MUST have a config file.
553 - Why does btape error when pointed to a file?
554 - Disallow compile if long long not 64 bits.
555 - Send Volumes needed during restore to Console (just after
556   create_volume_list) -- also in restore command?
557 - File system type from File daemon
558 - Move block size code from block.c to init_dev().
559 - Add FileSet MD5 to bscan.
560 - Finish implementation of restore "replace" options, and document.
561 - Rework Web site.
562 - Document buffer size considerations with Sparse files --
563 - that restore prints volumes.
564 - Document that two Verifys at same time on same client do not work.
565 - bscan   
566 - MD5 in bscan is set in FileSet.
567 - that Bacula won't write on tape where tape/catalog files differ.
568 - Document how to recycle a tape in 7 days even if the backup takes a long time.
569 - Document tape cycling 
570