Commit | Line | Data |
---|---|---|
46ef7d1d | 1 | -*- indented-text -*- |
a0365806 | 2 | |
abb0b532 | 3 | FEATURES ------------------------------------------------------------ |
abb0b532 S |
4 | Use chroot only if supported |
5 | Allow supplementary groups in rsyncd.conf 2002/04/09 | |
6 | Handling IPv6 on old machines | |
47f480b6 | 7 | Other IPv6 stuff |
abb0b532 | 8 | Add ACL support 2001/12/02 |
abb0b532 S |
9 | proxy authentication 2002/01/23 |
10 | SOCKS 2002/01/23 | |
11 | FAT support | |
abb0b532 | 12 | --diff david.e.sewell 2002/03/15 |
22832c30 | 13 | Add daemon --no-fork option |
47f480b6 | 14 | Create more granular verbosity 2003/05/15 |
abb0b532 S |
15 | |
16 | DOCUMENTATION -------------------------------------------------------- | |
abb0b532 | 17 | Keep list of open issues and todos on the web site |
abb0b532 S |
18 | Perhaps redo manual as SGML |
19 | ||
20 | LOGGING -------------------------------------------------------------- | |
abb0b532 S |
21 | Memory accounting |
22 | Improve error messages | |
47f480b6 | 23 | Better statistics Rasmus 2002/03/08 |
abb0b532 | 24 | Perhaps flush stdout like syslog |
abb0b532 | 25 | Log child death on signal |
abb0b532 | 26 | verbose output David Stein 2001/12/20 |
abb0b532 S |
27 | internationalization |
28 | ||
29 | DEVELOPMENT -------------------------------------------------------- | |
30 | Handling duplicate names | |
31 | Use generic zlib 2002/02/25 | |
47f480b6 | 32 | TDB 2002/03/12 |
abb0b532 | 33 | Splint 2002/03/12 |
abb0b532 S |
34 | |
35 | PERFORMANCE ---------------------------------------------------------- | |
abb0b532 | 36 | Traverse just one directory at a time |
abb0b532 S |
37 | Allow skipping MD4 file_sum 2002/04/08 |
38 | Accelerate MD4 | |
abb0b532 S |
39 | |
40 | TESTING -------------------------------------------------------------- | |
41 | Torture test | |
42 | Cross-test versions 2001/08/22 | |
43 | Test on kernel source | |
44 | Test large files | |
45 | Create mutator program for testing | |
46 | Create configure option to enable dangerous tests | |
abb0b532 S |
47 | Create pipe program for testing |
48 | Create test makefile target for some tests | |
abb0b532 S |
49 | |
50 | RELATED PROJECTS ----------------------------------------------------- | |
51 | rsyncsh | |
52 | http://rsync.samba.org/rsync-and-debian/ | |
53 | rsyncable gzip patch | |
54 | rsyncsplit as alternative to real integration with gzip? | |
55 | reverse rsync over HTTP Range | |
56 | ||
259c3e72 | 57 | |
abb0b532 | 58 | |
abb0b532 | 59 | FEATURES ------------------------------------------------------------ |
a6a3c3df | 60 | |
a6a3c3df | 61 | |
abb0b532 | 62 | Use chroot only if supported |
a6a3c3df | 63 | |
abb0b532 | 64 | If the platform doesn't support it, then don't even try. |
a6a3c3df | 65 | |
abb0b532 S |
66 | If running as non-root, then don't fail, just give a warning. |
67 | (There was a thread about this a while ago?) | |
a6a3c3df | 68 | |
abb0b532 S |
69 | http://lists.samba.org/pipermail/rsync/2001-August/thread.html |
70 | http://lists.samba.org/pipermail/rsync/2001-September/thread.html | |
a6a3c3df | 71 | |
abb0b532 | 72 | -- -- |
a6a3c3df | 73 | |
a6a3c3df | 74 | |
abb0b532 | 75 | Allow supplementary groups in rsyncd.conf 2002/04/09 |
a6a3c3df | 76 | |
abb0b532 S |
77 | Perhaps allow supplementary groups to be specified in rsyncd.conf; |
78 | then make the first one the primary gid and all the rest be | |
79 | supplementary gids. | |
a2d2e5c0 | 80 | |
abb0b532 | 81 | -- -- |
a2d2e5c0 | 82 | |
bde47ca7 | 83 | |
411acbbc | 84 | Handling IPv6 on old machines |
bde47ca7 | 85 | |
411acbbc MP |
86 | The KAME IPv6 patch is nice in theory but has proved a bit of a |
87 | nightmare in practice. The basic idea of their patch is that rsync | |
88 | is rewritten to use the new getaddrinfo()/getnameinfo() interface, | |
89 | rather than gethostbyname()/gethostbyaddr() as in rsync 2.4.6. | |
90 | Systems that don't have the new interface are handled by providing | |
91 | our own implementation in lib/, which is selectively linked in. | |
c7d692c3 | 92 | |
411acbbc MP |
93 | The problem with this is that it is really hard to get right on |
94 | platforms that have a half-working implementation, so redefining | |
95 | these functions clashes with system headers, and leaving them out | |
96 | breaks. This affects at least OSF/1, RedHat 5, and Cobalt, which | |
97 | are moderately improtant. | |
98 | ||
99 | Perhaps the simplest solution would be to have two different files | |
100 | implementing the same interface, and choose either the new or the | |
101 | old API. This is probably necessary for systems that e.g. have | |
102 | IPv6, but gethostbyaddr() can't handle it. The Linux manpage claims | |
103 | this is currently the case. | |
104 | ||
105 | In fact, our internal sockets interface (things like | |
106 | open_socket_out(), etc) is much narrower than the getaddrinfo() | |
107 | interface, and so probably simpler to get right. In addition, the | |
108 | old code is known to work well on old machines. | |
109 | ||
110 | We could drop the rather large lib/getaddrinfo files. | |
111 | ||
abb0b532 S |
112 | -- -- |
113 | ||
411acbbc | 114 | |
47f480b6 | 115 | Other IPv6 stuff |
411acbbc | 116 | |
c33e3e39 MP |
117 | Implement suggestions from http://www.kame.net/newsletter/19980604/ |
118 | and ftp://ftp.iij.ad.jp/pub/RFC/rfc2553.txt | |
119 | ||
120 | If a host has multiple addresses, then listen try to connect to all | |
121 | in order until we get through. (getaddrinfo may return multiple | |
c10b0bdd | 122 | addresses.) This is kind of implemented already. |
c33e3e39 MP |
123 | |
124 | Possibly also when starting as a server we may need to listen on | |
125 | multiple passive addresses. This might be a bit harder, because we | |
126 | may need to select on all of them. Hm. | |
127 | ||
abb0b532 | 128 | -- -- |
b17dd0c4 MP |
129 | |
130 | ||
abb0b532 | 131 | Add ACL support 2001/12/02 |
5575de14 | 132 | |
5575de14 MP |
133 | Transfer ACLs. Need to think of a standard representation. |
134 | Probably better not to even try to convert between NT and POSIX. | |
135 | Possibly can share some code with Samba. | |
80ffc3de | 136 | NOTE: there is a patch that implements this in the "patches" subdir. |
5aafd07b | 137 | |
abb0b532 S |
138 | -- -- |
139 | ||
140 | ||
abb0b532 | 141 | proxy authentication 2002/01/23 |
92325ada MP |
142 | |
143 | Allow RSYNC_PROXY to be http://user:pass@proxy.foo:3128/, and do | |
a577af90 | 144 | HTTP Basic Proxy-Authentication. |
92325ada MP |
145 | |
146 | Multiple schemes are possible, up to and including the insanity that | |
147 | is NTLM, but Basic probably covers most cases. | |
148 | ||
abb0b532 S |
149 | -- -- |
150 | ||
151 | ||
152 | SOCKS 2002/01/23 | |
92325ada MP |
153 | |
154 | Add --with-socks, and then perhaps a command-line option to put them | |
155 | on or off. This might be more reliable than LD_PRELOAD hacks. | |
156 | ||
abb0b532 S |
157 | -- -- |
158 | ||
159 | ||
5ba268ef MP |
160 | FAT support |
161 | ||
a577af90 PG |
162 | rsync to a FAT partition on a Unix machine doesn't work very well at |
163 | the moment. I think we get errors about invalid filenames and | |
5ba268ef MP |
164 | perhaps also trying to do atomic renames. |
165 | ||
a577af90 PG |
166 | I guess the code to do this is currently #ifdef'd on Windows; |
167 | perhaps we ought to intelligently fall back to it on Unix too. | |
5ba268ef | 168 | |
abb0b532 | 169 | -- -- |
5ba268ef | 170 | |
27741d9f | 171 | |
abb0b532 | 172 | --diff david.e.sewell 2002/03/15 |
3c1edccb MP |
173 | |
174 | Allow people to specify the diff command. (Might want to use wdiff, | |
175 | gnudiff, etc.) | |
176 | ||
177 | Just diff the temporary file with the destination file, and delete | |
178 | the tmp file rather than moving it into place. | |
179 | ||
180 | Interaction with --partial. | |
181 | ||
182 | Security interactions with daemon mode? | |
183 | ||
abb0b532 | 184 | -- -- |
3c1edccb MP |
185 | |
186 | ||
22832c30 | 187 | Add daemon --no-fork option |
a628b069 | 188 | |
abb0b532 S |
189 | Very useful for debugging. Also good when running under a |
190 | daemon-monitoring process that tries to restart the service when the | |
191 | parent exits. | |
6d19c674 | 192 | |
abb0b532 | 193 | -- -- |
6d19c674 | 194 | |
16a3fec0 | 195 | |
47f480b6 | 196 | Create more granular verbosity 2003/05/15 |
16a3fec0 S |
197 | |
198 | Control output with the --report option. | |
199 | ||
200 | The option takes as a single argument (no whitespace) a | |
201 | comma delimited lists of keywords. | |
202 | ||
203 | This would separate debugging from "logging" as well as | |
204 | fine grained selection of statistical reporting and what | |
205 | actions are logged. | |
206 | ||
207 | http://lists.samba.org/archive/rsync/2003-May/006059.html | |
208 | ||
209 | -- -- | |
210 | ||
abb0b532 | 211 | DOCUMENTATION -------------------------------------------------------- |
6d19c674 | 212 | |
6479c2ed | 213 | |
abb0b532 | 214 | Keep list of open issues and todos on the web site |
bd0ad74f | 215 | |
abb0b532 | 216 | -- -- |
bd0ad74f | 217 | |
bd0ad74f | 218 | |
abb0b532 | 219 | Perhaps redo manual as SGML |
bd0ad74f | 220 | |
abb0b532 S |
221 | The man page is getting rather large, and there is more information |
222 | that ought to be added. | |
bd0ad74f | 223 | |
abb0b532 | 224 | TexInfo source is probably a dying format. |
6479c2ed | 225 | |
abb0b532 S |
226 | Linuxdoc looks like the most likely contender. I know DocBook is |
227 | favoured by some people, but it's so bloody verbose, even with emacs | |
228 | support. | |
a628b069 | 229 | |
abb0b532 | 230 | -- -- |
a2d2e5c0 | 231 | |
abb0b532 | 232 | LOGGING -------------------------------------------------------------- |
a2d2e5c0 | 233 | |
abb0b532 S |
234 | |
235 | Memory accounting | |
236 | ||
237 | At exit, show how much memory was used for the file list, etc. | |
238 | ||
239 | Also we do a wierd exponential-growth allocation in flist.c. I'm | |
240 | not sure this makes sense with modern mallocs. At any rate it will | |
241 | make us allocate a huge amount of memory for large file lists. | |
242 | ||
243 | -- -- | |
244 | ||
245 | ||
246 | Improve error messages | |
247 | ||
248 | If we hang or get SIGINT, then explain where we were up to. Perhaps | |
249 | have a static buffer that contains the current function name, or | |
250 | some kind of description of what we were trying to do. This is a | |
251 | little easier on people than needing to run strace/truss. | |
252 | ||
253 | "The dungeon collapses! You are killed." Rather than "unexpected | |
254 | eof" give a message that is more detailed if possible and also more | |
255 | helpful. | |
256 | ||
257 | If we get an error writing to a socket, then we should perhaps | |
258 | continue trying to read to see if an error message comes across | |
259 | explaining why the socket is closed. I'm not sure if this would | |
260 | work, but it would certainly make our messages more helpful. | |
261 | ||
262 | What happens if a directory is missing -x attributes. Do we lose | |
263 | our load? (Debian #28416) Probably fixed now, but a test case would | |
264 | be good. | |
a2d2e5c0 | 265 | |
abb0b532 | 266 | -- -- |
0e23e41d | 267 | |
abb0b532 | 268 | |
47f480b6 | 269 | Better statistics Rasmus 2002/03/08 |
abb0b532 S |
270 | |
271 | <Rasmus> | |
272 | hey, how about an rsync option that just gives you the | |
273 | summary without the list of files? And perhaps gives | |
274 | more information like the number of new files, number | |
275 | of changed, deleted, etc. ? | |
276 | ||
277 | <mbp> | |
278 | nice idea there is --stats but at the moment it's very | |
279 | tridge-oriented rather than user-friendly it would be | |
280 | nice to improve it that would also work well with | |
281 | --dryrun | |
282 | ||
283 | -- -- | |
284 | ||
285 | ||
286 | Perhaps flush stdout like syslog | |
287 | ||
288 | Perhaps flush stdout after each filename, so that people trying to | |
289 | monitor progress in a log file can do so more easily. See | |
290 | http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=48108 | |
291 | ||
292 | -- -- | |
293 | ||
294 | ||
abb0b532 S |
295 | Log child death on signal |
296 | ||
297 | If a child of the rsync daemon dies with a signal, we should notice | |
298 | that when we reap it and log a message. | |
299 | ||
300 | -- -- | |
301 | ||
302 | ||
abb0b532 S |
303 | verbose output David Stein 2001/12/20 |
304 | ||
abb0b532 S |
305 | At end of transfer, show how many files were or were not transferred |
306 | correctly. | |
307 | ||
308 | -- -- | |
309 | ||
310 | ||
abb0b532 S |
311 | internationalization |
312 | ||
313 | Change to using gettext(). Probably need to ship this for platforms | |
314 | that don't have it. | |
315 | ||
316 | Solicit translations. | |
317 | ||
318 | Does anyone care? Before we bother modifying the code, we ought to | |
319 | get the manual translated first, because that's possibly more useful | |
320 | and at any rate demonstrates desire. | |
321 | ||
322 | -- -- | |
323 | ||
324 | DEVELOPMENT -------------------------------------------------------- | |
325 | ||
326 | Handling duplicate names | |
327 | ||
80ffc3de WD |
328 | Some folks would like rsync to be deterministic in how it handles |
329 | duplicate names that come from mering multiple source directories | |
330 | into a single destination directory; e.g. the last name wins. We | |
331 | could do this by switching our sort algorithm to one that will | |
332 | guarantee that the names won't be reordered. Alternately, we could | |
333 | assign an ever-increasing number to each item as we insert it into | |
334 | the list and then make sure that we leave the largest number when | |
335 | cleaning the file list (see clean_flist()). Another solution would | |
336 | be to add a hash table, and thus never put any duplicate names into | |
337 | the file list (and bump the protocol to handle this). | |
abb0b532 S |
338 | |
339 | -- -- | |
340 | ||
341 | ||
342 | Use generic zlib 2002/02/25 | |
343 | ||
344 | Perhaps don't use our own zlib. | |
345 | ||
346 | Advantages: | |
347 | ||
348 | - will automatically be up to date with bugfixes in zlib | |
349 | ||
350 | - can leave it out for small rsync on e.g. recovery disks | |
351 | ||
352 | - can use a shared library | |
353 | ||
354 | - avoids people breaking rsync by trying to do this themselves and | |
355 | messing up | |
356 | ||
357 | Should we ship zlib for systems that don't have it, or require | |
358 | people to install it separately? | |
359 | ||
360 | Apparently this will make us incompatible with versions of rsync | |
361 | that use the patched version of rsync. Probably the simplest way to | |
362 | do this is to just disable gzip (with a warning) when talking to old | |
363 | versions. | |
364 | ||
365 | -- -- | |
366 | ||
367 | ||
47f480b6 | 368 | TDB 2002/03/12 |
abb0b532 S |
369 | |
370 | Rather than storing the file list in memory, store it in a TDB. | |
371 | ||
372 | This *might* make memory usage lower while building the file list. | |
373 | ||
374 | Hashtable lookup will mean files are not transmitted in order, | |
375 | though... hm. | |
376 | ||
377 | This would neatly eliminate one of the major post-fork shared data | |
378 | structures. | |
379 | ||
380 | -- -- | |
381 | ||
382 | ||
383 | Splint 2002/03/12 | |
0e23e41d MP |
384 | |
385 | Build rsync with SPLINT to try to find security holes. Add | |
386 | annotations as necessary. Keep track of the number of warnings | |
387 | found initially, and see how many of them are real bugs, or real | |
388 | security bugs. Knowing the percentage of likely hits would be | |
389 | really interesting for other projects. | |
390 | ||
abb0b532 | 391 | -- -- |
f5a95bb5 | 392 | |
abb0b532 | 393 | PERFORMANCE ---------------------------------------------------------- |
25ff30e8 | 394 | |
abb0b532 | 395 | Traverse just one directory at a time |
e9c4c301 | 396 | |
abb0b532 | 397 | Traverse just one directory at a time. Tridge says it's possible. |
e9c4c301 | 398 | |
abb0b532 S |
399 | At the moment rsync reads the whole file list into memory at the |
400 | start, which makes us use a lot of memory and also not pipeline | |
401 | network access as much as we could. | |
e9c4c301 | 402 | |
abb0b532 | 403 | -- -- |
b73b51a9 | 404 | |
599dc93c | 405 | |
abb0b532 | 406 | Allow skipping MD4 file_sum 2002/04/08 |
33d213bb | 407 | |
abb0b532 S |
408 | If we're doing a local transfer, or using -W, then perhaps don't |
409 | send the file checksum. If we're doing a local transfer, then | |
410 | calculating MD4 checksums uses 90% of CPU and is unlikely to be | |
411 | useful. | |
5aafd07b | 412 | |
80ffc3de WD |
413 | We should not allow it to be disabled separately from -W, though |
414 | as it is the only thing that lets us know when the rsync algorithm | |
415 | got out of sync and messed the file up (i.e. if the basis file | |
416 | changed between checksum generation and reception). | |
a2d2e5c0 | 417 | |
abb0b532 | 418 | -- -- |
a2d2e5c0 | 419 | |
62b68c80 | 420 | |
abb0b532 | 421 | Accelerate MD4 |
62b68c80 | 422 | |
abb0b532 | 423 | Perhaps borrow an assembler MD4 from someone? |
62b68c80 | 424 | |
abb0b532 S |
425 | Make sure we call MD4 with properly-sized blocks whenever possible |
426 | to avoid copying into the residue region? | |
a2d2e5c0 | 427 | |
abb0b532 | 428 | -- -- |
50f2f002 | 429 | |
abb0b532 | 430 | TESTING -------------------------------------------------------------- |
8ff9d697 | 431 | |
abb0b532 | 432 | Torture test |
8ff9d697 | 433 | |
abb0b532 S |
434 | Something that just keeps running rsync continuously over a data set |
435 | likely to generate problems. | |
8ff9d697 | 436 | |
abb0b532 | 437 | -- -- |
62b68c80 | 438 | |
62b68c80 | 439 | |
abb0b532 | 440 | Cross-test versions 2001/08/22 |
62b68c80 | 441 | |
abb0b532 S |
442 | Part of the regression suite should be making sure that we |
443 | don't break backwards compatibility: old clients vs new | |
444 | servers and so on. Ideally we would test both up and down | |
445 | from the current release to all old versions. | |
62b68c80 | 446 | |
abb0b532 | 447 | Run current rsync versions against significant past releases. |
3d90ec14 | 448 | |
abb0b532 S |
449 | We might need to omit broken old versions, or versions in which |
450 | particular functionality is broken | |
a2d2e5c0 | 451 | |
abb0b532 S |
452 | It might be sufficient to test downloads from well-known public |
453 | rsync servers running different versions of rsync. This will give | |
454 | some testing and also be the most common case for having different | |
455 | versions and not being able to upgrade. | |
a2d2e5c0 | 456 | |
abb0b532 | 457 | The new --protocol option may help in this. |
a2d2e5c0 | 458 | |
abb0b532 S |
459 | -- -- |
460 | ||
461 | ||
462 | Test on kernel source | |
463 | ||
464 | Download all versions of kernel; unpack, sync between them. Also | |
465 | sync between uncompressed tarballs. Compare directories after | |
466 | transfer. | |
467 | ||
468 | Use local mode; ssh; daemon; --whole-file and --no-whole-file. | |
469 | ||
470 | Use awk to pull out the 'speedup' number for each transfer. Make | |
471 | sure it is >= x. | |
472 | ||
473 | -- -- | |
474 | ||
475 | ||
476 | Test large files | |
477 | ||
478 | Sparse and non-sparse | |
479 | ||
480 | -- -- | |
481 | ||
482 | ||
483 | Create mutator program for testing | |
484 | ||
485 | Insert bytes, delete bytes, swap blocks, ... | |
486 | ||
487 | -- -- | |
488 | ||
489 | ||
490 | Create configure option to enable dangerous tests | |
491 | ||
492 | -- -- | |
493 | ||
494 | ||
abb0b532 S |
495 | Create pipe program for testing |
496 | ||
497 | Create pipe program that makes slow/jerky connections for | |
498 | testing Versions of read() and write() that corrupt the | |
499 | stream, or abruptly fail | |
500 | ||
501 | -- -- | |
502 | ||
503 | ||
504 | Create test makefile target for some tests | |
505 | ||
506 | Separate makefile target to run rough tests -- or perhaps | |
507 | just run them every time? | |
508 | ||
509 | -- -- | |
510 | ||
abb0b532 | 511 | RELATED PROJECTS ----------------------------------------------------- |
3d90ec14 | 512 | |
a577af90 | 513 | rsyncsh |
46ef7d1d MP |
514 | |
515 | Write a small emulation of interactive ftp as a Pythonn program | |
516 | that calls rsync. Commands such as "cd", "ls", "ls *.c" etc map | |
517 | fairly directly into rsync commands: it just needs to remember the | |
518 | current host, directory and so on. We can probably even do | |
519 | completion of remote filenames. | |
25ff30e8 | 520 | |
abb0b532 | 521 | -- -- |
25ff30e8 | 522 | |
25ff30e8 MP |
523 | |
524 | http://rsync.samba.org/rsync-and-debian/ | |
525 | ||
abb0b532 S |
526 | |
527 | -- -- | |
528 | ||
529 | ||
25ff30e8 MP |
530 | rsyncable gzip patch |
531 | ||
532 | Exhaustive, tortuous testing | |
533 | ||
534 | Cleanups? | |
535 | ||
abb0b532 S |
536 | -- -- |
537 | ||
538 | ||
25ff30e8 MP |
539 | rsyncsplit as alternative to real integration with gzip? |
540 | ||
abb0b532 S |
541 | -- -- |
542 | ||
543 | ||
25ff30e8 MP |
544 | reverse rsync over HTTP Range |
545 | ||
546 | Goswin Brederlow suggested this on Debian; I think tridge and I | |
547 | talked about it previous in relation to rproxy. | |
a577af90 | 548 | |
80ffc3de WD |
549 | Addendum: It looks like someone is working on a version of this: |
550 | ||
551 | http://zsync.moria.org.uk/ | |
552 | ||
abb0b532 | 553 | -- -- |
a577af90 | 554 |