native fds fixes/cleanups
[wimlib] / src / util.c
1 /*
2  * util.c
3  */
4
5 /*
6  * Copyright (C) 2012, 2013 Eric Biggers
7  *
8  * This file is part of wimlib, a library for working with WIM files.
9  *
10  * wimlib is free software; you can redistribute it and/or modify it under the
11  * terms of the GNU General Public License as published by the Free
12  * Software Foundation; either version 3 of the License, or (at your option)
13  * any later version.
14  *
15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17  * A PARTICULAR PURPOSE. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with wimlib; if not, see http://www.gnu.org/licenses/.
22  */
23
24 #include "config.h"
25
26
27 #undef _GNU_SOURCE
28 /* Make sure the POSIX-compatible strerror_r() is declared, rather than the GNU
29  * version, which has a different return type. */
30 #include <string.h>
31
32 #define _GNU_SOURCE
33
34 #include "endianness.h"
35 #include "timestamp.h"
36 #include "wimlib_internal.h"
37
38 #include <ctype.h>
39 #include <errno.h>
40 #include <stdarg.h>
41 #include <stdlib.h>
42 #include <sys/uio.h>
43 #include <unistd.h>
44
45
46 #ifdef __WIN32__
47 #include "win32.h"
48 #endif
49
50 static size_t
51 utf16le_strlen(const utf16lechar *s)
52 {
53         const utf16lechar *p = s;
54         while (*p)
55                 p++;
56         return (p - s) * sizeof(utf16lechar);
57 }
58
59 #ifdef __WIN32__
60 #  define wimlib_vfprintf vfwprintf
61 #else
62 /* Handle %W for UTF16-LE printing.
63  *
64  * TODO: this is not yet done properly--- it's assumed that if the format string
65  * contains %W, then it contains no other format specifiers.
66  */
67 static int
68 wimlib_vfprintf(FILE *fp, const tchar *format, va_list va)
69 {
70         const tchar *p;
71         int n;
72
73         for (p = format; *p; p++)
74                 if (*p == T('%') && *(p + 1) == T('W'))
75                         goto special;
76         return tvfprintf(fp, format, va);
77 special:
78         n = 0;
79         for (p = format; *p; p++) {
80                 if (*p == T('%') && (*(p + 1) == T('W'))) {
81                         int ret;
82                         tchar *tstr;
83                         size_t tstr_nbytes;
84                         utf16lechar *ucs = va_arg(va, utf16lechar*);
85
86                         if (ucs) {
87                                 size_t ucs_nbytes = utf16le_strlen(ucs);
88
89                                 ret = utf16le_to_tstr(ucs, ucs_nbytes,
90                                                       &tstr, &tstr_nbytes);
91                                 if (ret) {
92                                         ret = tfprintf(fp, T("??????"));
93                                 } else {
94                                         ret = tfprintf(fp, T("%"TS), tstr);
95                                         FREE(tstr);
96                                 }
97                                 if (ret < 0)
98                                         return -1;
99                                 else
100                                         n += ret;
101                         } else {
102                                 n += tfprintf(fp, T("(null)"));
103                         }
104                         p++;
105                 } else {
106                         if (tputc(*p, fp) == EOF)
107                                 return -1;
108                         n++;
109                 }
110         }
111         return n;
112 }
113
114 int
115 wimlib_printf(const tchar *format, ...)
116 {
117         int ret;
118         va_list va;
119
120         va_start(va, format);
121         ret = wimlib_vfprintf(stdout, format, va);
122         va_end(va);
123         return ret;
124 }
125
126 int
127 wimlib_fprintf(FILE *fp, const tchar *format, ...)
128 {
129         int ret;
130         va_list va;
131
132         va_start(va, format);
133         ret = wimlib_vfprintf(fp, format, va);
134         va_end(va);
135         return ret;
136 }
137 #endif
138
139 #if defined(ENABLE_ERROR_MESSAGES) || defined(ENABLE_DEBUG)
140 static void
141 wimlib_vmsg(const tchar *tag, const tchar *format,
142             va_list va, bool perror)
143 {
144 #ifndef DEBUG
145         if (wimlib_print_errors) {
146 #endif
147                 int errno_save = errno;
148                 fflush(stdout);
149                 tfputs(tag, stderr);
150                 wimlib_vfprintf(stderr, format, va);
151                 if (perror && errno_save != 0) {
152                         tchar buf[50];
153                         int res;
154                         res = tstrerror_r(errno_save, buf, sizeof(buf));
155                         if (res) {
156                                 tsprintf(buf,
157                                          T("unknown error (errno=%d)"),
158                                          errno_save);
159                         }
160                         tfprintf(stderr, T(": %"TS), buf);
161                 }
162                 tputc(T('\n'), stderr);
163                 fflush(stderr);
164                 errno = errno_save;
165 #ifndef DEBUG
166         }
167 #endif
168 }
169 #endif
170
171 /* True if wimlib is to print an informational message when an error occurs.
172  * This can be turned off by calling wimlib_set_print_errors(false). */
173 #ifdef ENABLE_ERROR_MESSAGES
174 static bool wimlib_print_errors = false;
175
176
177 void
178 wimlib_error(const tchar *format, ...)
179 {
180         va_list va;
181
182         va_start(va, format);
183         wimlib_vmsg(T("\r[ERROR] "), format, va, false);
184         va_end(va);
185 }
186
187 void
188 wimlib_error_with_errno(const tchar *format, ...)
189 {
190         va_list va;
191
192         va_start(va, format);
193         wimlib_vmsg(T("\r[ERROR] "), format, va, true);
194         va_end(va);
195 }
196
197 void
198 wimlib_warning(const tchar *format, ...)
199 {
200         va_list va;
201
202         va_start(va, format);
203         wimlib_vmsg(T("\r[WARNING] "), format, va, false);
204         va_end(va);
205 }
206
207 void
208 wimlib_warning_with_errno(const tchar *format, ...)
209 {
210         va_list va;
211
212         va_start(va, format);
213         wimlib_vmsg(T("\r[WARNING] "), format, va, true);
214         va_end(va);
215 }
216
217 #endif
218
219 #if defined(ENABLE_DEBUG) || defined(ENABLE_MORE_DEBUG)
220 void wimlib_debug(const tchar *file, int line, const char *func,
221                   const tchar *format, ...)
222 {
223         va_list va;
224         tchar buf[tstrlen(file) + strlen(func) + 30];
225
226         tsprintf(buf, T("[%"TS" %d] %s(): "), file, line, func);
227
228         va_start(va, format);
229         wimlib_vmsg(buf, format, va, false);
230         va_end(va);
231 }
232 #endif
233
234 WIMLIBAPI int
235 wimlib_set_print_errors(bool show_error_messages)
236 {
237 #ifdef ENABLE_ERROR_MESSAGES
238         wimlib_print_errors = show_error_messages;
239         return 0;
240 #else
241         if (show_error_messages)
242                 return WIMLIB_ERR_UNSUPPORTED;
243         else
244                 return 0;
245 #endif
246 }
247
248 static const tchar *error_strings[] = {
249         [WIMLIB_ERR_SUCCESS]
250                 = T("Success"),
251         [WIMLIB_ERR_ALREADY_LOCKED]
252                 = T("The WIM is already locked for writing"),
253         [WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE]
254                 = T("Lookup table is compressed"),
255         [WIMLIB_ERR_DECOMPRESSION]
256                 = T("Failed to decompress compressed data"),
257         [WIMLIB_ERR_DELETE_STAGING_DIR]
258                 = T("Failed to delete staging directory"),
259         [WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED]
260                 = T("The process servicing the mounted WIM has crashed"),
261         [WIMLIB_ERR_FORK]
262                 = T("Failed to fork another process"),
263         [WIMLIB_ERR_FUSE]
264                 = T("An error was returned by fuse_main()"),
265         [WIMLIB_ERR_FUSERMOUNT]
266                 = T("Could not execute the `fusermount' program, or it exited "
267                         "with a failure status"),
268         [WIMLIB_ERR_ICONV_NOT_AVAILABLE]
269                 = T("The iconv() function does not seem to work. "
270                   "Maybe check to make sure the directory /usr/lib/gconv exists"),
271         [WIMLIB_ERR_IMAGE_COUNT]
272                 = T("Inconsistent image count among the metadata "
273                         "resources, the WIM header, and/or the XML data"),
274         [WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT]
275                 = T("User does not have sufficient privileges to correctly extract the data"),
276         [WIMLIB_ERR_IMAGE_NAME_COLLISION]
277                 = T("Tried to add an image with a name that is already in use"),
278         [WIMLIB_ERR_INTEGRITY]
279                 = T("The WIM failed an integrity check"),
280         [WIMLIB_ERR_INVALID_CAPTURE_CONFIG]
281                 = T("The capture configuration string was invalid"),
282         [WIMLIB_ERR_INVALID_CHUNK_SIZE]
283                 = T("The WIM is compressed but does not have a chunk "
284                         "size of 32768"),
285         [WIMLIB_ERR_INVALID_COMPRESSION_TYPE]
286                 = T("The WIM is compressed, but is not marked as having LZX or "
287                         "XPRESS compression"),
288         [WIMLIB_ERR_INVALID_DENTRY]
289                 = T("A directory entry in the WIM was invalid"),
290         [WIMLIB_ERR_INVALID_HEADER_SIZE]
291                 = T("The WIM header was not 208 bytes"),
292         [WIMLIB_ERR_INVALID_IMAGE]
293                 = T("Tried to select an image that does not exist in the WIM"),
294         [WIMLIB_ERR_INVALID_INTEGRITY_TABLE]
295                 = T("The WIM's integrity table is invalid"),
296         [WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY]
297                 = T("An entry in the WIM's lookup table is invalid"),
298         [WIMLIB_ERR_INVALID_MULTIBYTE_STRING]
299                 = T("A string was not valid in the current locale's character encoding"),
300         [WIMLIB_ERR_INVALID_OVERLAY]
301                 = T("Conflicting files in overlay when creating a WIM image"),
302         [WIMLIB_ERR_INVALID_PARAM]
303                 = T("An invalid parameter was given"),
304         [WIMLIB_ERR_INVALID_PART_NUMBER]
305                 = T("The part number or total parts of the WIM is invalid"),
306         [WIMLIB_ERR_INVALID_REPARSE_DATA]
307                 = T("The reparse data of a reparse point was invalid"),
308         [WIMLIB_ERR_INVALID_RESOURCE_HASH]
309                 = T("The SHA1 message digest of a WIM resource did not match the expected value"),
310         [WIMLIB_ERR_INVALID_RESOURCE_SIZE]
311                 = T("A resource entry in the WIM has an invalid size"),
312         [WIMLIB_ERR_INVALID_SECURITY_DATA]
313                 = T("The table of security descriptors in the WIM is invalid"),
314         [WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE]
315                 = T("The version of wimlib that has mounted a WIM image is incompatible with the "
316                   "version being used to unmount it"),
317         [WIMLIB_ERR_INVALID_UTF8_STRING]
318                 = T("A string provided as input by the user was not a valid UTF-8 string"),
319         [WIMLIB_ERR_INVALID_UTF16_STRING]
320                 = T("A string in a WIM dentry is not a valid UTF-16LE string"),
321         [WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE]
322                 = T("libxml2 was unable to find a character encoding conversion handler "
323                   "for UTF-16LE"),
324         [WIMLIB_ERR_LINK]
325                 = T("Failed to create a hard or symbolic link when extracting "
326                         "a file from the WIM"),
327         [WIMLIB_ERR_MKDIR]
328                 = T("Failed to create a directory"),
329         [WIMLIB_ERR_MQUEUE]
330                 = T("Failed to create or use a POSIX message queue"),
331         [WIMLIB_ERR_NOMEM]
332                 = T("Ran out of memory"),
333         [WIMLIB_ERR_NOTDIR]
334                 = T("Expected a directory"),
335         [WIMLIB_ERR_NOT_A_WIM_FILE]
336                 = T("The file did not begin with the magic characters that "
337                         "identify a WIM file"),
338         [WIMLIB_ERR_NO_FILENAME]
339                 = T("The WIM is not identified with a filename"),
340         [WIMLIB_ERR_NTFS_3G]
341                 = T("NTFS-3g encountered an error (check errno)"),
342         [WIMLIB_ERR_OPEN]
343                 = T("Failed to open a file"),
344         [WIMLIB_ERR_OPENDIR]
345                 = T("Failed to open a directory"),
346         [WIMLIB_ERR_READ]
347                 = T("Could not read data from a file"),
348         [WIMLIB_ERR_READLINK]
349                 = T("Could not read the target of a symbolic link"),
350         [WIMLIB_ERR_RENAME]
351                 = T("Could not rename a file"),
352         [WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED]
353                 = T("Unable to complete reparse point fixup"),
354         [WIMLIB_ERR_RESOURCE_ORDER]
355                 = T("The components of the WIM were arranged in an unexpected order"),
356         [WIMLIB_ERR_SPECIAL_FILE]
357                 = T("Encountered a special file that cannot be archived"),
358         [WIMLIB_ERR_SPLIT_INVALID]
359                 = T("The WIM is part of an invalid split WIM"),
360         [WIMLIB_ERR_SPLIT_UNSUPPORTED]
361                 = T("The WIM is part of a split WIM, which is not supported for this operation"),
362         [WIMLIB_ERR_STAT]
363                 = T("Could not read the metadata for a file or directory"),
364         [WIMLIB_ERR_TIMEOUT]
365                 = T("Timed out while waiting for a message to arrive from another process"),
366         [WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE]
367                 = T("A Unicode string could not be represented in the current locale's encoding"),
368         [WIMLIB_ERR_UNKNOWN_VERSION]
369                 = T("The WIM file is marked with an unknown version number"),
370         [WIMLIB_ERR_UNSUPPORTED]
371                 = T("The requested operation is unsupported"),
372         [WIMLIB_ERR_VOLUME_LACKS_FEATURES]
373                 = T("The volume did not support a feature necessary to complete the operation"),
374         [WIMLIB_ERR_WRITE]
375                 = T("Failed to write data to a file"),
376         [WIMLIB_ERR_XML]
377                 = T("The XML data of the WIM is invalid"),
378 };
379
380 WIMLIBAPI const tchar *
381 wimlib_get_error_string(enum wimlib_error_code code)
382 {
383         if (code < 0 || code >= ARRAY_LEN(error_strings))
384                 return NULL;
385         else
386                 return error_strings[code];
387 }
388
389
390
391 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
392 void *(*wimlib_malloc_func) (size_t)         = malloc;
393 void  (*wimlib_free_func)   (void *)         = free;
394 void *(*wimlib_realloc_func)(void *, size_t) = realloc;
395
396 void *
397 wimlib_calloc(size_t nmemb, size_t size)
398 {
399         size_t total_size = nmemb * size;
400         void *p = MALLOC(total_size);
401         if (p)
402                 memset(p, 0, total_size);
403         return p;
404 }
405
406 char *
407 wimlib_strdup(const char *str)
408 {
409         size_t size;
410         char *p;
411
412         size = strlen(str);
413         p = MALLOC(size + 1);
414         if (p)
415                 memcpy(p, str, size + 1);
416         return p;
417 }
418
419 #ifdef __WIN32__
420 wchar_t *
421 wimlib_wcsdup(const wchar_t *str)
422 {
423         size_t size;
424         wchar_t *p;
425
426         size = wcslen(str);
427         p = MALLOC((size + 1) * sizeof(wchar_t));
428         if (p)
429                 memcpy(p, str, (size + 1) * sizeof(wchar_t));
430         return p;
431 }
432 #endif
433
434 extern void
435 xml_set_memory_allocator(void *(*malloc_func)(size_t),
436                          void (*free_func)(void *),
437                          void *(*realloc_func)(void *, size_t));
438 #endif
439
440 WIMLIBAPI int
441 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
442                             void (*free_func)(void *),
443                             void *(*realloc_func)(void *, size_t))
444 {
445 #ifdef ENABLE_CUSTOM_MEMORY_ALLOCATOR
446         wimlib_malloc_func  = malloc_func  ? malloc_func  : malloc;
447         wimlib_free_func    = free_func    ? free_func    : free;
448         wimlib_realloc_func = realloc_func ? realloc_func : realloc;
449
450         xml_set_memory_allocator(wimlib_malloc_func, wimlib_free_func,
451                                  wimlib_realloc_func);
452         return 0;
453 #else
454         ERROR("Cannot set custom memory allocator functions:");
455         ERROR("wimlib was compiled with the --without-custom-memory-allocator "
456               "flag");
457         return WIMLIB_ERR_UNSUPPORTED;
458 #endif
459 }
460
461 static bool seeded = false;
462
463 static void
464 seed_random()
465 {
466         srand(time(NULL) * getpid());
467         seeded = true;
468 }
469
470 /* Fills @n characters pointed to by @p with random alphanumeric characters. */
471 void
472 randomize_char_array_with_alnum(tchar p[], size_t n)
473 {
474         if (!seeded)
475                 seed_random();
476         while (n--) {
477                 int r = rand() % 62;
478                 if (r < 26)
479                         *p++ = r + 'a';
480                 else if (r < 52)
481                         *p++ = r - 26 + 'A';
482                 else
483                         *p++ = r - 52 + '0';
484         }
485 }
486
487 /* Fills @n bytes pointer to by @p with random numbers. */
488 void
489 randomize_byte_array(u8 *p, size_t n)
490 {
491         if (!seeded)
492                 seed_random();
493         while (n--)
494                 *p++ = rand();
495 }
496
497 const tchar *
498 path_basename_with_len(const tchar *path, size_t len)
499 {
500         const tchar *p = &path[len] - 1;
501
502         /* Trailing slashes. */
503         while (1) {
504                 if (p == path - 1)
505                         return T("");
506                 if (*p != T('/'))
507                         break;
508                 p--;
509         }
510
511         while ((p != path - 1) && *p != T('/'))
512                 p--;
513
514         return p + 1;
515 }
516
517 /* Like the basename() function, but does not modify @path; it just returns a
518  * pointer to it. */
519 const tchar *
520 path_basename(const tchar *path)
521 {
522         return path_basename_with_len(path, tstrlen(path));
523 }
524
525 /*
526  * Returns a pointer to the part of @path following the first colon in the last
527  * path component, or NULL if the last path component does not contain a colon.
528  */
529 const tchar *
530 path_stream_name(const tchar *path)
531 {
532         const tchar *base = path_basename(path);
533         const tchar *stream_name = tstrchr(base, T(':'));
534         if (!stream_name)
535                 return NULL;
536         else
537                 return stream_name + 1;
538 }
539
540 u64
541 get_wim_timestamp()
542 {
543         struct timeval tv;
544         gettimeofday(&tv, NULL);
545         return timeval_to_wim_timestamp(tv);
546 }
547
548 void
549 wim_timestamp_to_str(u64 timestamp, tchar *buf, size_t len)
550 {
551         struct tm tm;
552         time_t t = wim_timestamp_to_unix(timestamp);
553         gmtime_r(&t, &tm);
554         tstrftime(buf, len, T("%a %b %d %H:%M:%S %Y UTC"), &tm);
555 }
556
557 void
558 zap_backslashes(tchar *s)
559 {
560         if (s) {
561                 while (*s != T('\0')) {
562                         if (*s == T('\\'))
563                                 *s = T('/');
564                         s++;
565                 }
566         }
567 }
568
569 /* Like read(), but keep trying until everything has been written or we know for
570  * sure that there was an error (or end-of-file). */
571 size_t
572 full_read(int fd, void *buf, size_t count)
573 {
574         ssize_t bytes_read;
575         size_t bytes_remaining;
576
577         for (bytes_remaining = count;
578              bytes_remaining != 0;
579              bytes_remaining -= bytes_read, buf += bytes_read)
580         {
581                 bytes_read = read(fd, buf, bytes_remaining);
582                 if (bytes_read <= 0) {
583                         if (bytes_read == 0)
584                                 errno = EIO;
585                         else if (errno == EINTR)
586                                 continue;
587                         break;
588                 }
589         }
590         return count - bytes_remaining;
591 }
592
593 /* Like write(), but keep trying until everything has been written or we know
594  * for sure that there was an error. */
595 size_t
596 full_write(int fd, const void *buf, size_t count)
597 {
598         ssize_t bytes_written;
599         size_t bytes_remaining;
600
601         for (bytes_remaining = count;
602              bytes_remaining != 0;
603              bytes_remaining -= bytes_written, buf += bytes_written)
604         {
605                 bytes_written = write(fd, buf, bytes_remaining);
606                 if (bytes_written < 0) {
607                         if (errno == EINTR)
608                                 continue;
609                         break;
610                 }
611         }
612         return count - bytes_remaining;
613 }
614
615 /* Like pread(), but keep trying until everything has been read or we know for
616  * sure that there was an error (or end-of-file) */
617 size_t
618 full_pread(int fd, void *buf, size_t count, off_t offset)
619 {
620         ssize_t bytes_read;
621         size_t bytes_remaining;
622
623         for (bytes_remaining = count;
624              bytes_remaining != 0;
625              bytes_remaining -= bytes_read, buf += bytes_read,
626                 offset += bytes_read)
627         {
628                 bytes_read = pread(fd, buf, bytes_remaining, offset);
629                 if (bytes_read <= 0) {
630                         if (bytes_read == 0)
631                                 errno = EIO;
632                         else if (errno == EINTR)
633                                 continue;
634                         break;
635                 }
636         }
637         return count - bytes_remaining;
638 }
639
640 /* Like pwrite(), but keep trying until everything has been written or we know
641  * for sure that there was an error. */
642 size_t
643 full_pwrite(int fd, const void *buf, size_t count, off_t offset)
644 {
645         ssize_t bytes_written;
646         size_t bytes_remaining;
647
648         for (bytes_remaining = count;
649              bytes_remaining != 0;
650              bytes_remaining -= bytes_written, buf += bytes_written,
651                 offset += bytes_written)
652         {
653                 bytes_written = pwrite(fd, buf, bytes_remaining, offset);
654                 if (bytes_written < 0) {
655                         if (errno == EINTR)
656                                 continue;
657                         break;
658                 }
659         }
660         return count - bytes_remaining;
661 }
662
663 /* Like writev(), but keep trying until everything has been written or we know
664  * for sure that there was an error. */
665 size_t
666 full_writev(int fd, struct iovec *iov, int iovcnt)
667 {
668         size_t total_bytes_written = 0;
669         while (iovcnt > 0) {
670                 ssize_t bytes_written;
671
672                 bytes_written = writev(fd, iov, iovcnt);
673                 if (bytes_written < 0) {
674                         if (errno == EINTR)
675                                 continue;
676                         break;
677                 }
678                 total_bytes_written += bytes_written;
679                 while (bytes_written) {
680                         if (bytes_written >= iov[0].iov_len) {
681                                 bytes_written -= iov[0].iov_len;
682                                 iov++;
683                                 iovcnt--;
684                         } else {
685                                 iov[0].iov_base += bytes_written;
686                                 iov[0].iov_len -= bytes_written;
687                                 bytes_written = 0;
688                         }
689                 }
690         }
691         return total_bytes_written;
692 }
693
694 off_t
695 filedes_offset(filedes_t fd)
696 {
697         return lseek(fd, 0, SEEK_CUR);
698 }