]> Dogcows Code - chaz/tar/blob - src/common.h
Merge changes from gnulib for file system sub-second time stamps.
[chaz/tar] / src / common.h
1 /* Common declarations for the tar program.
2
3 Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,
4 2003, 2004, 2005 Free Software Foundation, Inc.
5
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any later
9 version.
10
11 This program is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
14 Public License for more details.
15
16 You should have received a copy of the GNU General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
19
20 /* Declare the GNU tar archive format. */
21 #include "tar.h"
22
23 /* The checksum field is filled with this while the checksum is computed. */
24 #define CHKBLANKS " " /* 8 blanks, no null */
25
26 /* Some constants from POSIX are given names. */
27 #define NAME_FIELD_SIZE 100
28 #define PREFIX_FIELD_SIZE 155
29 #define UNAME_FIELD_SIZE 32
30 #define GNAME_FIELD_SIZE 32
31
32
33 \f
34 /* Some various global definitions. */
35
36 /* Name of file to use for interacting with user. */
37
38 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
39 modules. Here, we merely set it to "extern" if it is not already set.
40 GNU tar does depend on the system loader to preset all GLOBAL variables to
41 neutral (or zero) values, explicit initialization is usually not done. */
42 #ifndef GLOBAL
43 # define GLOBAL extern
44 #endif
45
46 #define TAREXIT_SUCCESS PAXEXIT_SUCCESS
47 #define TAREXIT_DIFFERS PAXEXIT_DIFFERS
48 #define TAREXIT_FAILURE PAXEXIT_FAILURE
49
50 \f
51 #include "arith.h"
52 #include <backupfile.h>
53 #include <exclude.h>
54 #include <full-write.h>
55 #include <modechange.h>
56 #include <quote.h>
57 #include <safe-read.h>
58 #include <stat-time.h>
59 #include <timespec.h>
60 #define obstack_chunk_alloc xmalloc
61 #define obstack_chunk_free free
62 #include <obstack.h>
63
64 #include <paxlib.h>
65
66 /* Log base 2 of common values. */
67 #define LG_8 3
68 #define LG_64 6
69 #define LG_256 8
70 \f
71 /* Information gleaned from the command line. */
72
73 /* Name of this program. */
74 GLOBAL const char *program_name;
75
76 /* Main command option. */
77
78 enum subcommand
79 {
80 UNKNOWN_SUBCOMMAND, /* none of the following */
81 APPEND_SUBCOMMAND, /* -r */
82 CAT_SUBCOMMAND, /* -A */
83 CREATE_SUBCOMMAND, /* -c */
84 DELETE_SUBCOMMAND, /* -D */
85 DIFF_SUBCOMMAND, /* -d */
86 EXTRACT_SUBCOMMAND, /* -x */
87 LIST_SUBCOMMAND, /* -t */
88 UPDATE_SUBCOMMAND /* -u */
89 };
90
91 GLOBAL enum subcommand subcommand_option;
92
93 /* Selected format for output archive. */
94 GLOBAL enum archive_format archive_format;
95
96 /* Either NL or NUL, as decided by the --null option. */
97 GLOBAL char filename_terminator;
98
99 /* Size of each record, once in blocks, once in bytes. Those two variables
100 are always related, the second being BLOCKSIZE times the first. They do
101 not have _option in their name, even if their values is derived from
102 option decoding, as these are especially important in tar. */
103 GLOBAL int blocking_factor;
104 GLOBAL size_t record_size;
105
106 GLOBAL bool absolute_names_option;
107
108 /* Display file times in UTC */
109 GLOBAL bool utc_option;
110
111 /* This variable tells how to interpret newer_mtime_option, below. If zero,
112 files get archived if their mtime is not less than newer_mtime_option.
113 If nonzero, files get archived if *either* their ctime or mtime is not less
114 than newer_mtime_option. */
115 GLOBAL int after_date_option;
116
117 GLOBAL bool atime_preserve_option;
118
119 GLOBAL bool backup_option;
120
121 /* Type of backups being made. */
122 GLOBAL enum backup_type backup_type;
123
124 GLOBAL bool block_number_option;
125
126 GLOBAL bool checkpoint_option;
127
128 /* Specified name of compression program, or "gzip" as implied by -z. */
129 GLOBAL const char *use_compress_program_option;
130
131 GLOBAL bool dereference_option;
132
133 /* Print a message if not all links are dumped */
134 GLOBAL int check_links_option;
135
136 /* Patterns that match file names to be excluded. */
137 GLOBAL struct exclude *excluded;
138
139 /* Exclude directories containing a cache directory tag. */
140 GLOBAL bool exclude_caches_option;
141
142 /* Specified value to be put into tar file in place of stat () results, or
143 just -1 if such an override should not take place. */
144 GLOBAL gid_t group_option;
145
146 GLOBAL bool ignore_failed_read_option;
147
148 GLOBAL bool ignore_zeros_option;
149
150 GLOBAL bool incremental_option;
151
152 /* Specified name of script to run at end of each tape change. */
153 GLOBAL const char *info_script_option;
154
155 GLOBAL bool interactive_option;
156
157 /* If nonzero, extract only Nth occurrence of each named file */
158 GLOBAL uintmax_t occurrence_option;
159
160 enum old_files
161 {
162 DEFAULT_OLD_FILES, /* default */
163 NO_OVERWRITE_DIR_OLD_FILES, /* --no-overwrite-dir */
164 OVERWRITE_OLD_FILES, /* --overwrite */
165 UNLINK_FIRST_OLD_FILES, /* --unlink-first */
166 KEEP_OLD_FILES, /* --keep-old-files */
167 KEEP_NEWER_FILES /* --keep-newer-files */
168 };
169 GLOBAL enum old_files old_files_option;
170
171 /* Specified file name for incremental list. */
172 GLOBAL const char *listed_incremental_option;
173
174 /* Specified mode change string. */
175 GLOBAL struct mode_change *mode_option;
176
177 /* Initial umask, if needed for mode change string. */
178 GLOBAL mode_t initial_umask;
179
180 GLOBAL bool multi_volume_option;
181
182 /* Specified threshold date and time. Files having an older time stamp
183 do not get archived (also see after_date_option above). */
184 GLOBAL struct timespec newer_mtime_option;
185
186 /* Return true if newer_mtime_option is initialized. */
187 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
188
189 /* Return true if the struct stat ST's M time is less than
190 newer_mtime_option. */
191 #define OLDER_STAT_TIME(st, m) \
192 (timespec_cmp (get_stat_##m##time (&st), newer_mtime_option) < 0)
193
194 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
195 GLOBAL int recursion_option;
196
197 GLOBAL bool numeric_owner_option;
198
199 GLOBAL bool one_file_system_option;
200
201 /* Specified value to be put into tar file in place of stat () results, or
202 just -1 if such an override should not take place. */
203 GLOBAL uid_t owner_option;
204
205 GLOBAL bool recursive_unlink_option;
206
207 GLOBAL bool read_full_records_option;
208
209 GLOBAL bool remove_files_option;
210
211 /* Specified rmt command. */
212 GLOBAL const char *rmt_command_option;
213
214 /* Specified remote shell command. */
215 GLOBAL const char *rsh_command_option;
216
217 GLOBAL bool same_order_option;
218
219 /* If positive, preserve ownership when extracting. */
220 GLOBAL int same_owner_option;
221
222 /* If positive, preserve permissions when extracting. */
223 GLOBAL int same_permissions_option;
224
225 /* When set, strip the given number of file name components from the file name
226 before extracting */
227 GLOBAL size_t strip_name_components;
228
229 GLOBAL bool show_omitted_dirs_option;
230
231 GLOBAL bool sparse_option;
232
233 GLOBAL bool starting_file_option;
234
235 /* Specified maximum byte length of each tape volume (multiple of 1024). */
236 GLOBAL tarlong tape_length_option;
237
238 GLOBAL bool to_stdout_option;
239
240 GLOBAL bool totals_option;
241
242 GLOBAL bool touch_option;
243
244 GLOBAL char *to_command_option;
245 GLOBAL bool ignore_command_error_option;
246
247 /* Return true if the extracted files are not being written to disk */
248 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
249
250 /* Count how many times the option has been set, multiple setting yields
251 more verbose behavior. Value 0 means no verbosity, 1 means file name
252 only, 2 means file name and all attributes. More than 2 is just like 2. */
253 GLOBAL int verbose_option;
254
255 GLOBAL bool verify_option;
256
257 /* Specified name of file containing the volume number. */
258 GLOBAL const char *volno_file_option;
259
260 /* Specified value or pattern. */
261 GLOBAL const char *volume_label_option;
262 \f
263 /* Other global variables. */
264
265 /* File descriptor for archive file. */
266 GLOBAL int archive;
267
268 /* Nonzero when outputting to /dev/null. */
269 GLOBAL bool dev_null_output;
270
271 /* Timestamp for when we started execution. */
272 GLOBAL struct timespec start_time;
273
274 GLOBAL struct tar_stat_info current_stat_info;
275
276 /* List of tape drive names, number of such tape drives, allocated number,
277 and current cursor in list. */
278 GLOBAL const char **archive_name_array;
279 GLOBAL int archive_names;
280 GLOBAL int allocated_archive_names;
281 GLOBAL const char **archive_name_cursor;
282
283 /* Output index file name. */
284 GLOBAL char const *index_file_name;
285
286 /* Structure for keeping track of filenames and lists thereof. */
287 struct name
288 {
289 struct name *next;
290 size_t length; /* cached strlen(name) */
291 uintmax_t found_count; /* number of times a matching file has
292 been found */
293 int isdir;
294 char firstch; /* first char is literally matched */
295 char regexp; /* this name is a regexp, not literal */
296 int change_dir; /* set with the -C option */
297 char const *dir_contents; /* for incremental_option */
298 char fake; /* dummy entry */
299 char name[1];
300 };
301
302 /* Obnoxious test to see if dimwit is trying to dump the archive. */
303 GLOBAL dev_t ar_dev;
304 GLOBAL ino_t ar_ino;
305
306 GLOBAL bool seekable_archive;
307
308 GLOBAL dev_t root_device;
309
310 /* Unquote filenames */
311 GLOBAL bool unquote_option;
312 \f
313 /* Declarations for each module. */
314
315 /* FIXME: compare.c should not directly handle the following variable,
316 instead, this should be done in buffer.c only. */
317
318 enum access_mode
319 {
320 ACCESS_READ,
321 ACCESS_WRITE,
322 ACCESS_UPDATE
323 };
324 extern enum access_mode access_mode;
325
326 /* Module buffer.c. */
327
328 extern FILE *stdlis;
329 extern char *save_name;
330 extern off_t save_sizeleft;
331 extern off_t save_totsize;
332 extern bool write_archive_to_stdout;
333
334 size_t available_space_after (union block *);
335 off_t current_block_ordinal (void);
336 void close_archive (void);
337 void closeout_volume_number (void);
338 union block *find_next_block (void);
339 void flush_read (void);
340 void flush_write (void);
341 void flush_archive (void);
342 void init_volume_number (void);
343 void open_archive (enum access_mode);
344 void print_total_written (void);
345 void reset_eof (void);
346 void set_next_block_after (union block *);
347 void clear_read_error_count (void);
348 void xclose (int fd);
349 void archive_write_error (ssize_t) __attribute__ ((noreturn));
350 void archive_read_error (void);
351 off_t seek_archive (off_t size);
352 void set_start_time (void);
353
354 /* Module create.c. */
355
356 enum dump_status
357 {
358 dump_status_ok,
359 dump_status_short,
360 dump_status_fail,
361 dump_status_not_implemented
362 };
363
364 bool file_dumpable_p (struct tar_stat_info *);
365 void create_archive (void);
366 void pad_archive (off_t size_left);
367 void dump_file (char *, int, dev_t);
368 union block *start_header (struct tar_stat_info *st);
369 void finish_header (struct tar_stat_info *, union block *, off_t);
370 void simple_finish_header (union block *header);
371 union block *start_private_header (const char *name, size_t size);
372 void write_eot (void);
373 void check_links (void);
374
375 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
376 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
377 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
378 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
379 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
380 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
381 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
382 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
383 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
384 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
385 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
386
387 void gid_to_chars (gid_t, char *, size_t);
388 void major_to_chars (major_t, char *, size_t);
389 void minor_to_chars (minor_t, char *, size_t);
390 void mode_to_chars (mode_t, char *, size_t);
391 void off_to_chars (off_t, char *, size_t);
392 void size_to_chars (size_t, char *, size_t);
393 void time_to_chars (time_t, char *, size_t);
394 void uid_to_chars (uid_t, char *, size_t);
395 void uintmax_to_chars (uintmax_t, char *, size_t);
396 void string_to_chars (char const *, char *, size_t);
397
398 /* Module diffarch.c. */
399
400 extern bool now_verifying;
401
402 void diff_archive (void);
403 void diff_init (void);
404 void verify_volume (void);
405
406 /* Module extract.c. */
407
408 void extr_init (void);
409 void extract_archive (void);
410 void extract_finish (void);
411
412 /* Module delete.c. */
413
414 void delete_archive_members (void);
415
416 /* Module incremen.c. */
417
418 char *get_directory_contents (char *, dev_t);
419 void read_directory_file (void);
420 void write_directory_file (void);
421 void purge_directory (char const *);
422 void list_dumpdir (char *buffer, size_t size);
423
424 /* Module list.c. */
425
426 enum read_header
427 {
428 HEADER_STILL_UNREAD, /* for when read_header has not been called */
429 HEADER_SUCCESS, /* header successfully read and checksummed */
430 HEADER_SUCCESS_EXTENDED, /* likewise, but we got an extended header */
431 HEADER_ZERO_BLOCK, /* zero block where header expected */
432 HEADER_END_OF_FILE, /* true end of file while header expected */
433 HEADER_FAILURE /* ill-formed header, or bad checksum */
434 };
435
436 struct xheader
437 {
438 struct obstack *stk;
439 size_t size;
440 char *buffer;
441 };
442
443 GLOBAL struct xheader extended_header;
444 extern union block *current_header;
445 extern enum archive_format current_format;
446 extern size_t recent_long_name_blocks;
447 extern size_t recent_long_link_blocks;
448
449 void decode_header (union block *, struct tar_stat_info *,
450 enum archive_format *, int);
451 char const *tartime (struct timespec, bool);
452
453 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
454 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
455 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
456 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
457 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
458 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
459 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
460 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
461 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
462
463 gid_t gid_from_header (const char *, size_t);
464 major_t major_from_header (const char *, size_t);
465 minor_t minor_from_header (const char *, size_t);
466 mode_t mode_from_header (const char *, size_t);
467 off_t off_from_header (const char *, size_t);
468 size_t size_from_header (const char *, size_t);
469 time_t time_from_header (const char *, size_t);
470 uid_t uid_from_header (const char *, size_t);
471 uintmax_t uintmax_from_header (const char *, size_t);
472
473 void list_archive (void);
474 void print_for_mkdir (char *, int, mode_t);
475 void print_header (struct tar_stat_info *, off_t);
476 void read_and (void (*) (void));
477 enum read_header read_header (bool);
478 enum read_header tar_checksum (union block *header, bool silent);
479 void skip_file (off_t);
480 void skip_member (void);
481
482 /* Module mangle.c. */
483
484 void extract_mangle (void);
485
486 /* Module misc.c. */
487
488 void assign_string (char **, const char *);
489 char *quote_copy_string (const char *);
490 int unquote_string (char *);
491
492 void code_ns_fraction (int, char *);
493
494 size_t dot_dot_prefix_len (char const *);
495
496 enum remove_option
497 {
498 ORDINARY_REMOVE_OPTION,
499 RECURSIVE_REMOVE_OPTION,
500
501 /* FIXME: The following value is never used. It seems to be intended
502 as a placeholder for a hypothetical option that should instruct tar
503 to recursively remove subdirectories in purge_directory(),
504 as opposed to the functionality of --recursive-unlink
505 (RECURSIVE_REMOVE_OPTION value), which removes them in
506 prepare_to_extract() phase. However, with the addition of more
507 meta-info to the incremental dumps, this should become unnecessary */
508 WANT_DIRECTORY_REMOVE_OPTION
509 };
510 int remove_any_file (const char *, enum remove_option);
511 bool maybe_backup_file (const char *, int);
512 void undo_last_backup (void);
513
514 int deref_stat (bool, char const *, struct stat *);
515
516 int chdir_arg (char const *);
517 void chdir_do (int);
518
519 void close_diag (char const *name);
520 void open_diag (char const *name);
521 void read_diag_details (char const *name, off_t offset, size_t size);
522 void readlink_diag (char const *name);
523 void savedir_diag (char const *name);
524 void seek_diag_details (char const *, off_t);
525 void stat_diag (char const *name);
526 void write_error_details (char const *, size_t, size_t);
527 void write_fatal (char const *) __attribute__ ((noreturn));
528 void write_fatal_details (char const *, ssize_t, size_t)
529 __attribute__ ((noreturn));
530
531 pid_t xfork (void);
532 void xpipe (int[2]);
533
534 void *page_aligned_alloc (void **, size_t);
535
536 /* Module names.c. */
537
538 extern struct name *gnu_list_name;
539
540 void gid_to_gname (gid_t, char **gname);
541 int gname_to_gid (char const *, gid_t *);
542 void uid_to_uname (uid_t, char **uname);
543 int uname_to_uid (char const *, uid_t *);
544
545 void init_names (void);
546 void name_add (const char *);
547 void name_init (void);
548 void name_term (void);
549 char *name_next (int);
550 void name_gather (void);
551 struct name *addname (char const *, int);
552 int name_match (const char *);
553 void names_notfound (void);
554 void collect_and_sort_names (void);
555 struct name *name_scan (const char *);
556 char *name_from_list (void);
557 void blank_name_list (void);
558 char *new_name (const char *, const char *);
559 size_t stripped_prefix_len (char const *file_name, size_t num);
560 bool all_names_found (struct tar_stat_info *);
561
562 bool excluded_name (char const *);
563
564 void add_avoided_name (char const *);
565 bool is_avoided_name (char const *);
566 bool is_individual_file (char const *);
567
568 bool contains_dot_dot (char const *);
569
570 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
571 (c)->found_count == occurrence_option)
572 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
573 (c)->found_count >= occurrence_option)
574
575 /* Module tar.c. */
576
577 void usage (int);
578
579 int confirm (const char *, const char *);
580 void request_stdin (const char *);
581
582 void tar_stat_init (struct tar_stat_info *st);
583 void tar_stat_destroy (struct tar_stat_info *st);
584 void usage (int) __attribute__ ((noreturn));
585
586 /* Module update.c. */
587
588 extern char *output_start;
589
590 void update_archive (void);
591
592 /* Module xheader.c. */
593
594 void xheader_decode (struct tar_stat_info *);
595 void xheader_decode_global (void);
596 void xheader_store (char const *, struct tar_stat_info const *, void *);
597 void xheader_read (union block *, size_t);
598 void xheader_write (char type, char *name, struct xheader *xhdr);
599 void xheader_write_global (void);
600 void xheader_finish (struct xheader *);
601 void xheader_destroy (struct xheader *);
602 char *xheader_xhdr_name (struct tar_stat_info *st);
603 char *xheader_ghdr_name (void);
604 void xheader_write (char, char *, struct xheader *);
605 void xheader_write_global (void);
606 void xheader_set_option (char *string);
607
608 /* Module system.c */
609
610 void sys_detect_dev_null_output (void);
611 void sys_save_archive_dev_ino (void);
612 void sys_drain_input_pipe (void);
613 void sys_wait_for_child (pid_t);
614 void sys_spawn_shell (void);
615 bool sys_compare_uid (struct stat *a, struct stat *b);
616 bool sys_compare_gid (struct stat *a, struct stat *b);
617 bool sys_file_is_archive (struct tar_stat_info *p);
618 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
619 int sys_truncate (int fd);
620 pid_t sys_child_open_for_compress (void);
621 pid_t sys_child_open_for_uncompress (void);
622 size_t sys_write_archive_buffer (void);
623 bool sys_get_archive_stat (void);
624 int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st);
625 void sys_wait_command (void);
626
627 /* Module compare.c */
628 void report_difference (struct tar_stat_info *st, const char *message, ...);
629
630 /* Module sparse.c */
631 bool sparse_file_p (struct tar_stat_info *);
632 bool sparse_member_p (struct tar_stat_info *);
633 bool sparse_fixup_header (struct tar_stat_info *);
634 enum dump_status sparse_dump_file (int, struct tar_stat_info *);
635 enum dump_status sparse_extract_file (int, struct tar_stat_info *, off_t *);
636 enum dump_status sparse_skip_file (struct tar_stat_info *);
637 bool sparse_diff_file (int, struct tar_stat_info *);
638
639 /* Module utf8.c */
640 bool string_ascii_p (const char *str);
641 bool utf8_convert (bool to_utf, char const *input, char **output);
This page took 0.068928 seconds and 5 git commands to generate.