lib/bup/_helpers.c

   1 #define _LARGEFILE64_SOURCE 1
   2 #define PY_SSIZE_T_CLEAN 1
   3 #undef NDEBUG
   4 #include "../../config/config.h"
   5
   6 // According to Python, its header has to go first:
   7 //   http://docs.python.org/2/c-api/intro.html#include-files
   8 #include <Python.h>
   9
  10 #include <arpa/inet.h>
  11 #include <assert.h>
  12 #include <errno.h>
  13 #include <fcntl.h>
  14 #include <grp.h>
  15 #include <pwd.h>
  16 #include <stddef.h>
  17 #include <stdint.h>
  18 #include <stdlib.h>
  19 #include <stdio.h>
  20 #include <string.h>
  21
  22 #ifdef HAVE_SYS_MMAN_H
  23 #include <sys/mman.h>
  24 #endif
  25 #ifdef HAVE_SYS_TYPES_H
  26 #include <sys/types.h>
  27 #endif
  28 #ifdef HAVE_SYS_STAT_H
  29 #include <sys/stat.h>
  30 #endif
  31 #ifdef HAVE_UNISTD_H
  32 #include <unistd.h>
  33 #endif
  34 #ifdef HAVE_SYS_TIME_H
  35 #include <sys/time.h>
  36 #endif
  37
  38 #ifdef HAVE_LINUX_FS_H
  39 #include <linux/fs.h>
  40 #endif
  41 #ifdef HAVE_SYS_IOCTL_H
  42 #include <sys/ioctl.h>
  43 #endif
  44
  45 #ifdef HAVE_TM_TM_GMTOFF
  46 #include <time.h>
  47 #endif
  48
  49 #if defined(BUP_RL_EXPECTED_XOPEN_SOURCE) \
  50     && (!defined(_XOPEN_SOURCE) || _XOPEN_SOURCE < BUP_RL_EXPECTED_XOPEN_SOURCE)
  51 # warning "_XOPEN_SOURCE version is incorrect for readline"
  52 #endif
  53
  54 #ifdef BUP_HAVE_READLINE
  55 # pragma GCC diagnostic push
  56 # pragma GCC diagnostic ignored "-Wstrict-prototypes"
  57 # ifdef BUP_READLINE_INCLUDES_IN_SUBDIR
  58 #   include <readline/readline.h>
  59 #   include <readline/history.h>
  60 # else
  61 #   include <readline.h>
  62 #   include <history.h>
  63 # endif
  64 # pragma GCC diagnostic pop
  65 #endif
  66
  67 #include "bupsplit.h"
  68
  69 #if defined(FS_IOC_GETFLAGS) && defined(FS_IOC_SETFLAGS)
  70 #define BUP_HAVE_FILE_ATTRS 1
  71 #endif
  72
  73 /*
  74  * Check for incomplete UTIMENSAT support (NetBSD 6), and if so,
  75  * pretend we don't have it.
  76  */
  77 #if !defined(AT_FDCWD) || !defined(AT_SYMLINK_NOFOLLOW)
  78 #undef HAVE_UTIMENSAT
  79 #endif
  80
  81 #ifndef FS_NOCOW_FL
  82 // Of course, this assumes it's a bitfield value.
  83 #define FS_NOCOW_FL 0
  84 #endif
  85
  86
  87 typedef unsigned char byte;
  88
  89
  90 typedef struct {
  91     int istty2;
  92 } state_t;
  93
  94 // cstr_argf: for byte vectors without null characters (e.g. paths)
  95 // rbuf_argf: for read-only byte vectors
  96 // wbuf_argf: for mutable byte vectors
  97
  98 #if PY_MAJOR_VERSION < 3
  99 static state_t state;
 100 #  define get_state(x) (&state)
 101 #  define cstr_argf "s"
 102 #  define rbuf_argf "s#"
 103 #  define wbuf_argf "s*"
 104 #else
 105 #  define get_state(x) ((state_t *) PyModule_GetState(x))
 106 #  define cstr_argf "y"
 107 #  define rbuf_argf "y#"
 108 #  define wbuf_argf "y*"
 109 #endif // PY_MAJOR_VERSION >= 3
 110
 111
 112 static void *checked_calloc(size_t n, size_t size)
 113 {
 114     void *result = calloc(n, size);
 115     if (!result)
 116         PyErr_NoMemory();
 117     return result;
 118 }
 119
 120 #ifndef BUP_HAVE_BUILTIN_MUL_OVERFLOW
 121
 122 #define checked_malloc checked_calloc
 123
 124 #else // defined BUP_HAVE_BUILTIN_MUL_OVERFLOW
 125
 126 static void *checked_malloc(size_t n, size_t size)
 127 {
 128     size_t total;
 129     if (__builtin_mul_overflow(n, size, &total))
 130     {
 131         PyErr_Format(PyExc_OverflowError,
 132                      "request to allocate %zu items of size %zu is too large",
 133                      n, size);
 134         return NULL;
 135     }
 136     void *result = malloc(total);
 137     if (!result)
 138         return PyErr_NoMemory();
 139     return result;
 140 }
 141
 142 #endif // defined BUP_HAVE_BUILTIN_MUL_OVERFLOW
 143
 144
 145 #ifndef htonll
 146 // This function should technically be macro'd out if it's going to be used
 147 // more than ocasionally.  As of this writing, it'll actually never be called
 148 // in real world bup scenarios (because our packs are < MAX_INT bytes).
 149 static uint64_t htonll(uint64_t value)
 150 {
 151     static const int endian_test = 42;
 152
 153     if (*(char *)&endian_test == endian_test) // LSB-MSB
 154         return ((uint64_t)htonl(value & 0xFFFFFFFF) << 32) | htonl(value >> 32);
 155     return value; // already in network byte order MSB-LSB
 156 }
 157 #endif
 158
 159
 160 // Disabling sign-compare here should be fine since we're explicitly
 161 // checking for a sign mismatch, i.e. if the signs don't match, then
 162 // it doesn't matter what the value comparison says.
 163 // FIXME: ... so should we reverse the order?
 164 #define INTEGRAL_ASSIGNMENT_FITS(dest, src)                             \
 165     ({                                                                  \
 166         _Pragma("GCC diagnostic push");                                 \
 167         _Pragma("GCC diagnostic ignored \"-Wsign-compare\"");           \
 168         _Pragma("clang diagnostic push");                               \
 169         _Pragma("clang diagnostic ignored \"-Wshorten-64-to-32\"");     \
 170         *(dest) = (src);                                                \
 171         int result = *(dest) == (src) && (*(dest) < 1) == ((src) < 1);  \
 172         _Pragma("clang diagnostic pop");                                \
 173         _Pragma("GCC diagnostic pop");                                  \
 174         result;                                                         \
 175     })
 176
 177
 178 #define INTEGER_TO_PY(x)                                                \
 179     ({                                                                  \
 180         _Pragma("GCC diagnostic push");                                 \
 181         _Pragma("GCC diagnostic ignored \"-Wtype-limits\"");   \
 182         _Pragma("clang diagnostic push");                               \
 183         _Pragma("clang diagnostic ignored \"-Wtautological-compare\""); \
 184         PyObject *result = ((x) >= 0) ? PyLong_FromUnsignedLongLong(x) : PyLong_FromLongLong(x); \
 185         _Pragma("clang diagnostic pop");                                \
 186         _Pragma("GCC diagnostic pop");                                  \
 187         result;                                                         \
 188     })
 189
 190
 191 #if PY_MAJOR_VERSION < 3
 192 static int bup_ulong_from_pyint(unsigned long *x, PyObject *py,
 193                                 const char *name)
 194 {
 195     const long tmp = PyInt_AsLong(py);
 196     if (tmp == -1 && PyErr_Occurred())
 197     {
 198         if (PyErr_ExceptionMatches(PyExc_OverflowError))
 199             PyErr_Format(PyExc_OverflowError, "%s too big for unsigned long",
 200                          name);
 201         return 0;
 202     }
 203     if (tmp < 0)
 204     {
 205         PyErr_Format(PyExc_OverflowError,
 206                      "negative %s cannot be converted to unsigned long", name);
 207         return 0;
 208     }
 209     *x = tmp;
 210     return 1;
 211 }
 212 #endif
 213
 214
 215 static int bup_ulong_from_py(unsigned long *x, PyObject *py, const char *name)
 216 {
 217 #if PY_MAJOR_VERSION < 3
 218     if (PyInt_Check(py))
 219         return bup_ulong_from_pyint(x, py, name);
 220 #endif
 221
 222     if (!PyLong_Check(py))
 223     {
 224         PyErr_Format(PyExc_TypeError, "expected integer %s", name);
 225         return 0;
 226     }
 227
 228     const unsigned long tmp = PyLong_AsUnsignedLong(py);
 229     if (PyErr_Occurred())
 230     {
 231         if (PyErr_ExceptionMatches(PyExc_OverflowError))
 232             PyErr_Format(PyExc_OverflowError, "%s too big for unsigned long",
 233                          name);
 234         return 0;
 235     }
 236     *x = tmp;
 237     return 1;
 238 }
 239
 240
 241 static int bup_uint_from_py(unsigned int *x, PyObject *py, const char *name)
 242 {
 243     unsigned long tmp;
 244     if (!bup_ulong_from_py(&tmp, py, name))
 245         return 0;
 246
 247     if (tmp > UINT_MAX)
 248     {
 249         PyErr_Format(PyExc_OverflowError, "%s too big for unsigned int", name);
 250         return 0;
 251     }
 252     *x = (unsigned int) tmp;
 253     return 1;
 254 }
 255
 256 static int bup_ullong_from_py(unsigned PY_LONG_LONG *x, PyObject *py,
 257                               const char *name)
 258 {
 259 #if PY_MAJOR_VERSION < 3
 260     if (PyInt_Check(py))
 261     {
 262         unsigned long tmp;
 263         if (bup_ulong_from_pyint(&tmp, py, name))
 264         {
 265             *x = tmp;
 266             return 1;
 267         }
 268         return 0;
 269     }
 270 #endif
 271
 272     if (!PyLong_Check(py))
 273     {
 274         PyErr_Format(PyExc_TypeError, "integer argument expected for %s", name);
 275         return 0;
 276     }
 277
 278     const unsigned PY_LONG_LONG tmp = PyLong_AsUnsignedLongLong(py);
 279     if (tmp == (unsigned long long) -1 && PyErr_Occurred())
 280     {
 281         if (PyErr_ExceptionMatches(PyExc_OverflowError))
 282             PyErr_Format(PyExc_OverflowError,
 283                          "%s too big for unsigned long long", name);
 284         return 0;
 285     }
 286     *x = tmp;
 287     return 1;
 288 }
 289
 290
 291 static PyObject *bup_bytescmp(PyObject *self, PyObject *args)
 292 {
 293     PyObject *py_s1, *py_s2;  // This is really a PyBytes/PyString
 294     if (!PyArg_ParseTuple(args, "SS", &py_s1, &py_s2))
 295         return NULL;
 296     char *s1, *s2;
 297     Py_ssize_t s1_len, s2_len;
 298     if (PyBytes_AsStringAndSize(py_s1, &s1, &s1_len) == -1)
 299         return NULL;
 300     if (PyBytes_AsStringAndSize(py_s2, &s2, &s2_len) == -1)
 301         return NULL;
 302     const Py_ssize_t n = (s1_len < s2_len) ? s1_len : s2_len;
 303     const int cmp = memcmp(s1, s2, n);
 304     if (cmp != 0)
 305         return PyLong_FromLong(cmp);
 306     if (s1_len == s2_len)
 307         return PyLong_FromLong(0);;
 308     return PyLong_FromLong((s1_len < s2_len) ? -1 : 1);
 309 }
 310
 311
 312 static PyObject *bup_cat_bytes(PyObject *self, PyObject *args)
 313 {
 314     unsigned char *bufx = NULL, *bufy = NULL;
 315     Py_ssize_t bufx_len, bufx_ofs, bufx_n;
 316     Py_ssize_t bufy_len, bufy_ofs, bufy_n;
 317     if (!PyArg_ParseTuple(args,
 318                           rbuf_argf "nn"
 319                           rbuf_argf "nn",
 320                           &bufx, &bufx_len, &bufx_ofs, &bufx_n,
 321                           &bufy, &bufy_len, &bufy_ofs, &bufy_n))
 322         return NULL;
 323     if (bufx_ofs < 0)
 324         return PyErr_Format(PyExc_ValueError, "negative x offset");
 325     if (bufx_n < 0)
 326         return PyErr_Format(PyExc_ValueError, "negative x extent");
 327     if (bufx_ofs > bufx_len)
 328         return PyErr_Format(PyExc_ValueError, "x offset greater than length");
 329     if (bufx_n > bufx_len - bufx_ofs)
 330         return PyErr_Format(PyExc_ValueError, "x extent past end of buffer");
 331
 332     if (bufy_ofs < 0)
 333         return PyErr_Format(PyExc_ValueError, "negative y offset");
 334     if (bufy_n < 0)
 335         return PyErr_Format(PyExc_ValueError, "negative y extent");
 336     if (bufy_ofs > bufy_len)
 337         return PyErr_Format(PyExc_ValueError, "y offset greater than length");
 338     if (bufy_n > bufy_len - bufy_ofs)
 339         return PyErr_Format(PyExc_ValueError, "y extent past end of buffer");
 340
 341     if (bufy_n > PY_SSIZE_T_MAX - bufx_n)
 342         return PyErr_Format(PyExc_OverflowError, "result length too long");
 343
 344     PyObject *result = PyBytes_FromStringAndSize(NULL, bufx_n + bufy_n);
 345     if (!result)
 346         return PyErr_NoMemory();
 347     char *buf = PyBytes_AS_STRING(result);
 348     memcpy(buf, bufx + bufx_ofs, bufx_n);
 349     memcpy(buf + bufx_n, bufy + bufy_ofs, bufy_n);
 350     return result;
 351 }
 352
 353
 354
 355 // Probably we should use autoconf or something and set HAVE_PY_GETARGCARGV...
 356 #if __WIN32__ || __CYGWIN__
 357
 358 // There's no 'ps' on win32 anyway, and Py_GetArgcArgv() isn't available.
 359 static void unpythonize_argv(void) { }
 360
 361 #else // not __WIN32__
 362
 363 // For some reason this isn't declared in Python.h
 364 extern void Py_GetArgcArgv(int *argc, char ***argv);
 365
 366 static void unpythonize_argv(void)
 367 {
 368     int argc, i;
 369     char **argv, *arge;
 370
 371     Py_GetArgcArgv(&argc, &argv);
 372
 373     for (i = 0; i < argc-1; i++)
 374     {
 375         if (argv[i] + strlen(argv[i]) + 1 != argv[i+1])
 376         {
 377             // The argv block doesn't work the way we expected; it's unsafe
 378             // to mess with it.
 379             return;
 380         }
 381     }
 382
 383     arge = argv[argc-1] + strlen(argv[argc-1]) + 1;
 384
 385     if (strstr(argv[0], "python") && argv[1] == argv[0] + strlen(argv[0]) + 1)
 386     {
 387         char *p;
 388         size_t len, diff;
 389         p = strrchr(argv[1], '/');
 390         if (p)
 391         {
 392             p++;
 393             diff = p - argv[0];
 394             len = arge - p;
 395             memmove(argv[0], p, len);
 396             memset(arge - diff, 0, diff);
 397             for (i = 0; i < argc; i++)
 398                 argv[i] = argv[i+1] ? argv[i+1]-diff : NULL;
 399         }
 400     }
 401 }
 402
 403 #endif // not __WIN32__ or __CYGWIN__
 404
 405
 406 static int write_all(int fd, const void *buf, const size_t count)
 407 {
 408     size_t written = 0;
 409     while (written < count)
 410     {
 411         const ssize_t rc = write(fd, buf + written, count - written);
 412         if (rc == -1)
 413             return -1;
 414         written += rc;
 415     }
 416     return 0;
 417 }
 418
 419
 420 static int uadd(unsigned long long *dest,
 421                 const unsigned long long x,
 422                 const unsigned long long y)
 423 {
 424     const unsigned long long result = x + y;
 425     if (result < x || result < y)
 426         return 0;
 427     *dest = result;
 428     return 1;
 429 }
 430
 431
 432 static PyObject *append_sparse_region(const int fd, unsigned long long n)
 433 {
 434     while (n)
 435     {
 436         off_t new_off;
 437         if (!INTEGRAL_ASSIGNMENT_FITS(&new_off, n))
 438             new_off = INT_MAX;
 439         const off_t off = lseek(fd, new_off, SEEK_CUR);
 440         if (off == (off_t) -1)
 441             return PyErr_SetFromErrno(PyExc_IOError);
 442         n -= new_off;
 443     }
 444     return NULL;
 445 }
 446
 447
 448 static PyObject *record_sparse_zeros(unsigned long long *new_pending,
 449                                      const int fd,
 450                                      unsigned long long prev_pending,
 451                                      const unsigned long long count)
 452 {
 453     // Add count additional sparse zeros to prev_pending and store the
 454     // result in new_pending, or if the total won't fit in
 455     // new_pending, write some of the zeros to fd sparsely, and store
 456     // the remaining sum in new_pending.
 457     if (!uadd(new_pending, prev_pending, count))
 458     {
 459         PyObject *err = append_sparse_region(fd, prev_pending);
 460         if (err != NULL)
 461             return err;
 462         *new_pending = count;
 463     }
 464     return NULL;
 465 }
 466
 467
 468 static byte* find_not_zero(const byte * const start, const byte * const end)
 469 {
 470     // Return a pointer to first non-zero byte between start and end,
 471     // or end if there isn't one.
 472     assert(start <= end);
 473     const unsigned char *cur = start;
 474     while (cur < end && *cur == 0)
 475         cur++;
 476     return (byte *) cur;
 477 }
 478
 479
 480 static byte* find_trailing_zeros(const byte * const start,
 481                                  const byte * const end)
 482 {
 483     // Return a pointer to the start of any trailing run of zeros, or
 484     // end if there isn't one.
 485     assert(start <= end);
 486     if (start == end)
 487         return (byte *) end;
 488     const byte * cur = end;
 489     while (cur > start && *--cur == 0) {}
 490     if (*cur == 0)
 491         return (byte *) cur;
 492     else
 493         return (byte *) (cur + 1);
 494 }
 495
 496
 497 static byte *find_non_sparse_end(const byte * const start,
 498                                  const byte * const end,
 499                                  const ptrdiff_t min_len)
 500 {
 501     // Return the first pointer to a min_len sparse block in [start,
 502     // end) if there is one, otherwise a pointer to the start of any
 503     // trailing run of zeros.  If there are no trailing zeros, return
 504     // end.
 505     if (start == end)
 506         return (byte *) end;
 507     assert(start < end);
 508     assert(min_len);
 509     // Probe in min_len jumps, searching backward from the jump
 510     // destination for a non-zero byte.  If such a byte is found, move
 511     // just past it and try again.
 512     const byte *candidate = start;
 513     // End of any run of zeros, starting at candidate, that we've already seen
 514     const byte *end_of_known_zeros = candidate;
 515     while (end - candidate >= min_len) // Handle all min_len candidate blocks
 516     {
 517         const byte * const probe_end = candidate + min_len;
 518         const byte * const trailing_zeros =
 519             find_trailing_zeros(end_of_known_zeros, probe_end);
 520         if (trailing_zeros == probe_end)
 521             end_of_known_zeros = candidate = probe_end;
 522         else if (trailing_zeros == end_of_known_zeros)
 523         {
 524             assert(candidate >= start);
 525             assert(candidate <= end);
 526             assert(*candidate == 0);
 527             return (byte *) candidate;
 528         }
 529         else
 530         {
 531             candidate = trailing_zeros;
 532             end_of_known_zeros = probe_end;
 533         }
 534     }
 535
 536     if (candidate == end)
 537         return (byte *) end;
 538
 539     // No min_len sparse run found, search backward from end
 540     const byte * const trailing_zeros = find_trailing_zeros(end_of_known_zeros,
 541                                                             end);
 542
 543     if (trailing_zeros == end_of_known_zeros)
 544     {
 545         assert(candidate >= start);
 546         assert(candidate < end);
 547         assert(*candidate == 0);
 548         assert(end - candidate < min_len);
 549         return (byte *) candidate;
 550     }
 551
 552     if (trailing_zeros == end)
 553     {
 554         assert(*(end - 1) != 0);
 555         return (byte *) end;
 556     }
 557
 558     assert(end - trailing_zeros < min_len);
 559     assert(trailing_zeros >= start);
 560     assert(trailing_zeros < end);
 561     assert(*trailing_zeros == 0);
 562     return (byte *) trailing_zeros;
 563 }
 564
 565
 566 static PyObject *bup_write_sparsely(PyObject *self, PyObject *args)
 567 {
 568     int fd;
 569     unsigned char *buf = NULL;
 570     Py_ssize_t sbuf_len;
 571     PyObject *py_min_sparse_len, *py_prev_sparse_len;
 572     if (!PyArg_ParseTuple(args, "i" rbuf_argf "OO",
 573                           &fd, &buf, &sbuf_len,
 574                           &py_min_sparse_len, &py_prev_sparse_len))
 575         return NULL;
 576     ptrdiff_t min_sparse_len;
 577     unsigned long long prev_sparse_len, buf_len, ul_min_sparse_len;
 578     if (!bup_ullong_from_py(&ul_min_sparse_len, py_min_sparse_len, "min_sparse_len"))
 579         return NULL;
 580     if (!INTEGRAL_ASSIGNMENT_FITS(&min_sparse_len, ul_min_sparse_len))
 581         return PyErr_Format(PyExc_OverflowError, "min_sparse_len too large");
 582     if (!bup_ullong_from_py(&prev_sparse_len, py_prev_sparse_len, "prev_sparse_len"))
 583         return NULL;
 584     if (sbuf_len < 0)
 585         return PyErr_Format(PyExc_ValueError, "negative bufer length");
 586     if (!INTEGRAL_ASSIGNMENT_FITS(&buf_len, sbuf_len))
 587         return PyErr_Format(PyExc_OverflowError, "buffer length too large");
 588
 589     const byte * block = buf; // Start of pending block
 590     const byte * const end = buf + buf_len;
 591     unsigned long long zeros = prev_sparse_len;
 592     while (1)
 593     {
 594         assert(block <= end);
 595         if (block == end)
 596             return PyLong_FromUnsignedLongLong(zeros);
 597
 598         if (*block != 0)
 599         {
 600             // Look for the end of block, i.e. the next sparse run of
 601             // at least min_sparse_len zeros, or the end of the
 602             // buffer.
 603             const byte * const probe = find_non_sparse_end(block + 1, end,
 604                                                            min_sparse_len);
 605             // Either at end of block, or end of non-sparse; write pending data
 606             PyObject *err = append_sparse_region(fd, zeros);
 607             if (err != NULL)
 608                 return err;
 609             int rc = write_all(fd, block, probe - block);
 610             if (rc)
 611                 return PyErr_SetFromErrno(PyExc_IOError);
 612
 613             if (end - probe < min_sparse_len)
 614                 zeros = end - probe;
 615             else
 616                 zeros = min_sparse_len;
 617             block = probe + zeros;
 618         }
 619         else // *block == 0
 620         {
 621             // Should be in the first loop iteration, a sparse run of
 622             // zeros, or nearly at the end of the block (within
 623             // min_sparse_len).
 624             const byte * const zeros_end = find_not_zero(block, end);
 625             PyObject *err = record_sparse_zeros(&zeros, fd,
 626                                                 zeros, zeros_end - block);
 627             if (err != NULL)
 628                 return err;
 629             assert(block <= zeros_end);
 630             block = zeros_end;
 631         }
 632     }
 633 }
 634
 635
 636 static PyObject *selftest(PyObject *self, PyObject *args)
 637 {
 638     if (!PyArg_ParseTuple(args, ""))
 639         return NULL;
 640
 641     return Py_BuildValue("i", !bupsplit_selftest());
 642 }
 643
 644
 645 static PyObject *blobbits(PyObject *self, PyObject *args)
 646 {
 647     if (!PyArg_ParseTuple(args, ""))
 648         return NULL;
 649     return Py_BuildValue("i", BUP_BLOBBITS);
 650 }
 651
 652
 653 static PyObject *splitbuf(PyObject *self, PyObject *args)
 654 {
 655     // We stick to buffers in python 2 because they appear to be
 656     // substantially smaller than memoryviews, and because
 657     // zlib.compress() in python 2 can't accept a memoryview
 658     // (cf. hashsplit.py).
 659     int out = 0, bits = -1;
 660     if (PY_MAJOR_VERSION > 2)
 661     {
 662         Py_buffer buf;
 663         if (!PyArg_ParseTuple(args, "y*", &buf))
 664             return NULL;
 665         assert(buf.len <= INT_MAX);
 666         out = bupsplit_find_ofs(buf.buf, buf.len, &bits);
 667         PyBuffer_Release(&buf);
 668     }
 669     else
 670     {
 671         unsigned char *buf = NULL;
 672         Py_ssize_t len = 0;
 673         if (!PyArg_ParseTuple(args, "t#", &buf, &len))
 674             return NULL;
 675         assert(len <= INT_MAX);
 676         out = bupsplit_find_ofs(buf, (int) len, &bits);
 677     }
 678     if (out) assert(bits >= BUP_BLOBBITS);
 679     return Py_BuildValue("ii", out, bits);
 680 }
 681
 682
 683 static PyObject *bitmatch(PyObject *self, PyObject *args)
 684 {
 685     unsigned char *buf1 = NULL, *buf2 = NULL;
 686     Py_ssize_t len1 = 0, len2 = 0;
 687     Py_ssize_t byte;
 688     int bit;
 689
 690     if (!PyArg_ParseTuple(args, rbuf_argf rbuf_argf, &buf1, &len1, &buf2, &len2))
 691         return NULL;
 692
 693     bit = 0;
 694     for (byte = 0; byte < len1 && byte < len2; byte++)
 695     {
 696         int b1 = buf1[byte], b2 = buf2[byte];
 697         if (b1 != b2)
 698         {
 699             for (bit = 0; bit < 8; bit++)
 700                 if ( (b1 & (0x80 >> bit)) != (b2 & (0x80 >> bit)) )
 701                     break;
 702             break;
 703         }
 704     }
 705
 706     assert(byte <= (INT_MAX >> 3));
 707     return Py_BuildValue("i", byte*8 + bit);
 708 }
 709
 710
 711 static PyObject *firstword(PyObject *self, PyObject *args)
 712 {
 713     unsigned char *buf = NULL;
 714     Py_ssize_t len = 0;
 715     uint32_t v;
 716
 717     if (!PyArg_ParseTuple(args, rbuf_argf, &buf, &len))
 718         return NULL;
 719
 720     if (len < 4)
 721         return NULL;
 722
 723     v = ntohl(*(uint32_t *)buf);
 724     return PyLong_FromUnsignedLong(v);
 725 }
 726
 727
 728 #define BLOOM2_HEADERLEN 16
 729
 730 static void to_bloom_address_bitmask4(const unsigned char *buf,
 731         const int nbits, uint64_t *v, unsigned char *bitmask)
 732 {
 733     int bit;
 734     uint32_t high;
 735     uint64_t raw, mask;
 736
 737     memcpy(&high, buf, 4);
 738     mask = (1<<nbits) - 1;
 739     raw = (((uint64_t)ntohl(high) << 8) | buf[4]);
 740     bit = (raw >> (37-nbits)) & 0x7;
 741     *v = (raw >> (40-nbits)) & mask;
 742     *bitmask = 1 << bit;
 743 }
 744
 745 static void to_bloom_address_bitmask5(const unsigned char *buf,
 746         const int nbits, uint32_t *v, unsigned char *bitmask)
 747 {
 748     int bit;
 749     uint32_t high;
 750     uint32_t raw, mask;
 751
 752     memcpy(&high, buf, 4);
 753     mask = (1<<nbits) - 1;
 754     raw = ntohl(high);
 755     bit = (raw >> (29-nbits)) & 0x7;
 756     *v = (raw >> (32-nbits)) & mask;
 757     *bitmask = 1 << bit;
 758 }
 759
 760 #define BLOOM_SET_BIT(name, address, otype) \
 761 static void name(unsigned char *bloom, const unsigned char *buf, const int nbits)\
 762 {\
 763     unsigned char bitmask;\
 764     otype v;\
 765     address(buf, nbits, &v, &bitmask);\
 766     bloom[BLOOM2_HEADERLEN+v] |= bitmask;\
 767 }
 768 BLOOM_SET_BIT(bloom_set_bit4, to_bloom_address_bitmask4, uint64_t)
 769 BLOOM_SET_BIT(bloom_set_bit5, to_bloom_address_bitmask5, uint32_t)
 770
 771
 772 #define BLOOM_GET_BIT(name, address, otype) \
 773 static int name(const unsigned char *bloom, const unsigned char *buf, const int nbits)\
 774 {\
 775     unsigned char bitmask;\
 776     otype v;\
 777     address(buf, nbits, &v, &bitmask);\
 778     return bloom[BLOOM2_HEADERLEN+v] & bitmask;\
 779 }
 780 BLOOM_GET_BIT(bloom_get_bit4, to_bloom_address_bitmask4, uint64_t)
 781 BLOOM_GET_BIT(bloom_get_bit5, to_bloom_address_bitmask5, uint32_t)
 782
 783
 784 static PyObject *bloom_add(PyObject *self, PyObject *args)
 785 {
 786     Py_buffer bloom, sha;
 787     int nbits = 0, k = 0;
 788     if (!PyArg_ParseTuple(args, wbuf_argf wbuf_argf "ii",
 789                           &bloom, &sha, &nbits, &k))
 790         return NULL;
 791
 792     PyObject *result = NULL;
 793
 794     if (bloom.len < 16+(1<<nbits) || sha.len % 20 != 0)
 795         goto clean_and_return;
 796
 797     if (k == 5)
 798     {
 799         if (nbits > 29)
 800             goto clean_and_return;
 801         unsigned char *cur = sha.buf;
 802         unsigned char *end;
 803         for (end = cur + sha.len; cur < end; cur += 20/k)
 804             bloom_set_bit5(bloom.buf, cur, nbits);
 805     }
 806     else if (k == 4)
 807     {
 808         if (nbits > 37)
 809             goto clean_and_return;
 810         unsigned char *cur = sha.buf;
 811         unsigned char *end = cur + sha.len;
 812         for (; cur < end; cur += 20/k)
 813             bloom_set_bit4(bloom.buf, cur, nbits);
 814     }
 815     else
 816         goto clean_and_return;
 817
 818     result = Py_BuildValue("n", sha.len / 20);
 819
 820  clean_and_return:
 821     PyBuffer_Release(&bloom);
 822     PyBuffer_Release(&sha);
 823     return result;
 824 }
 825
 826 static PyObject *bloom_contains(PyObject *self, PyObject *args)
 827 {
 828     Py_buffer bloom;
 829     unsigned char *sha = NULL;
 830     Py_ssize_t len = 0;
 831     int nbits = 0, k = 0;
 832     if (!PyArg_ParseTuple(args, wbuf_argf rbuf_argf "ii",
 833                           &bloom, &sha, &len, &nbits, &k))
 834         return NULL;
 835
 836     PyObject *result = NULL;
 837
 838     if (len != 20)
 839         goto clean_and_return;
 840
 841     if (k == 5)
 842     {
 843         if (nbits > 29)
 844             goto clean_and_return;
 845         int steps;
 846         unsigned char *end;
 847         for (steps = 1, end = sha + 20; sha < end; sha += 20/k, steps++)
 848             if (!bloom_get_bit5(bloom.buf, sha, nbits))
 849             {
 850                 result = Py_BuildValue("Oi", Py_None, steps);
 851                 goto clean_and_return;
 852             }
 853     }
 854     else if (k == 4)
 855     {
 856         if (nbits > 37)
 857             goto clean_and_return;
 858         int steps;
 859         unsigned char *end;
 860         for (steps = 1, end = sha + 20; sha < end; sha += 20/k, steps++)
 861             if (!bloom_get_bit4(bloom.buf, sha, nbits))
 862             {
 863                 result = Py_BuildValue("Oi", Py_None, steps);
 864                 goto clean_and_return;
 865             }
 866     }
 867     else
 868         goto clean_and_return;
 869
 870     result = Py_BuildValue("ii", 1, k);
 871
 872  clean_and_return:
 873     PyBuffer_Release(&bloom);
 874     return result;
 875 }
 876
 877
 878 static uint32_t _extract_bits(unsigned char *buf, int nbits)
 879 {
 880     uint32_t v, mask;
 881
 882     mask = (1<<nbits) - 1;
 883     v = ntohl(*(uint32_t *)buf);
 884     v = (v >> (32-nbits)) & mask;
 885     return v;
 886 }
 887
 888
 889 static PyObject *extract_bits(PyObject *self, PyObject *args)
 890 {
 891     unsigned char *buf = NULL;
 892     Py_ssize_t len = 0;
 893     int nbits = 0;
 894
 895     if (!PyArg_ParseTuple(args, rbuf_argf "i", &buf, &len, &nbits))
 896         return NULL;
 897
 898     if (len < 4)
 899         return NULL;
 900
 901     return PyLong_FromUnsignedLong(_extract_bits(buf, nbits));
 902 }
 903
 904
 905 struct sha {
 906     unsigned char bytes[20];
 907 };
 908
 909 static inline int _cmp_sha(const struct sha *sha1, const struct sha *sha2)
 910 {
 911     return memcmp(sha1->bytes, sha2->bytes, sizeof(sha1->bytes));
 912 }
 913
 914
 915 struct idx {
 916     unsigned char *map;
 917     struct sha *cur;
 918     struct sha *end;
 919     uint32_t *cur_name;
 920     Py_ssize_t bytes;
 921     int name_base;
 922 };
 923
 924 static void _fix_idx_order(struct idx **idxs, Py_ssize_t *last_i)
 925 {
 926     struct idx *idx;
 927     Py_ssize_t low, mid, high;
 928     int c = 0;
 929
 930     idx = idxs[*last_i];
 931     if (idxs[*last_i]->cur >= idxs[*last_i]->end)
 932     {
 933         idxs[*last_i] = NULL;
 934         PyMem_Free(idx);
 935         --*last_i;
 936         return;
 937     }
 938     if (*last_i == 0)
 939         return;
 940
 941     low = *last_i-1;
 942     mid = *last_i;
 943     high = 0;
 944     while (low >= high)
 945     {
 946         mid = (low + high) / 2;
 947         c = _cmp_sha(idx->cur, idxs[mid]->cur);
 948         if (c < 0)
 949             high = mid + 1;
 950         else if (c > 0)
 951             low = mid - 1;
 952         else
 953             break;
 954     }
 955     if (c < 0)
 956         ++mid;
 957     if (mid == *last_i)
 958         return;
 959     memmove(&idxs[mid+1], &idxs[mid], (*last_i-mid)*sizeof(struct idx *));
 960     idxs[mid] = idx;
 961 }
 962
 963
 964 static uint32_t _get_idx_i(struct idx *idx)
 965 {
 966     if (idx->cur_name == NULL)
 967         return idx->name_base;
 968     return ntohl(*idx->cur_name) + idx->name_base;
 969 }
 970
 971 #define MIDX4_HEADERLEN 12
 972
 973 static PyObject *merge_into(PyObject *self, PyObject *args)
 974 {
 975     struct sha *sha_ptr, *sha_start = NULL;
 976     uint32_t *table_ptr, *name_ptr, *name_start;
 977     int i;
 978     unsigned int total;
 979     uint32_t count, prefix;
 980
 981
 982     Py_buffer fmap;
 983     int bits;;
 984     PyObject *py_total, *ilist = NULL;
 985     if (!PyArg_ParseTuple(args, wbuf_argf "iOO",
 986                           &fmap, &bits, &py_total, &ilist))
 987         return NULL;
 988
 989     PyObject *result = NULL;
 990     struct idx **idxs = NULL;
 991     Py_ssize_t num_i = 0;
 992     int *idx_buf_init = NULL;
 993     Py_buffer *idx_buf = NULL;
 994
 995     if (!bup_uint_from_py(&total, py_total, "total"))
 996         goto clean_and_return;
 997
 998     num_i = PyList_Size(ilist);
 999
1000     if (!(idxs = checked_malloc(num_i, sizeof(struct idx *))))
1001         goto clean_and_return;
1002     if (!(idx_buf_init = checked_calloc(num_i, sizeof(int))))
1003         goto clean_and_return;
1004     if (!(idx_buf = checked_malloc(num_i, sizeof(Py_buffer))))
1005         goto clean_and_return;
1006
1007     for (i = 0; i < num_i; i++)
1008     {
1009         long len, sha_ofs, name_map_ofs;
1010         if (!(idxs[i] = checked_malloc(1, sizeof(struct idx))))
1011             goto clean_and_return;
1012         PyObject *itup = PyList_GetItem(ilist, i);
1013         if (!PyArg_ParseTuple(itup, wbuf_argf "llli",
1014                               &(idx_buf[i]), &len, &sha_ofs, &name_map_ofs,
1015                               &idxs[i]->name_base))
1016             return NULL;
1017         idx_buf_init[i] = 1;
1018         idxs[i]->map = idx_buf[i].buf;
1019         idxs[i]->bytes = idx_buf[i].len;
1020         idxs[i]->cur = (struct sha *)&idxs[i]->map[sha_ofs];
1021         idxs[i]->end = &idxs[i]->cur[len];
1022         if (name_map_ofs)
1023             idxs[i]->cur_name = (uint32_t *)&idxs[i]->map[name_map_ofs];
1024         else
1025             idxs[i]->cur_name = NULL;
1026     }
1027     table_ptr = (uint32_t *) &((unsigned char *) fmap.buf)[MIDX4_HEADERLEN];
1028     sha_start = sha_ptr = (struct sha *)&table_ptr[1<<bits];
1029     name_start = name_ptr = (uint32_t *)&sha_ptr[total];
1030
1031     Py_ssize_t last_i = num_i - 1;
1032     count = 0;
1033     prefix = 0;
1034     while (last_i >= 0)
1035     {
1036         struct idx *idx;
1037         uint32_t new_prefix;
1038         if (count % 102424 == 0 && get_state(self)->istty2)
1039             fprintf(stderr, "midx: writing %.2f%% (%d/%d)\r",
1040                     count*100.0/total, count, total);
1041         idx = idxs[last_i];
1042         new_prefix = _extract_bits((unsigned char *)idx->cur, bits);
1043         while (prefix < new_prefix)
1044             table_ptr[prefix++] = htonl(count);
1045         memcpy(sha_ptr++, idx->cur, sizeof(struct sha));
1046         *name_ptr++ = htonl(_get_idx_i(idx));
1047         ++idx->cur;
1048         if (idx->cur_name != NULL)
1049             ++idx->cur_name;
1050         _fix_idx_order(idxs, &last_i);
1051         ++count;
1052     }
1053     while (prefix < ((uint32_t) 1 << bits))
1054         table_ptr[prefix++] = htonl(count);
1055     assert(count == total);
1056     assert(prefix == ((uint32_t) 1 << bits));
1057     assert(sha_ptr == sha_start+count);
1058     assert(name_ptr == name_start+count);
1059
1060     result = PyLong_FromUnsignedLong(count);
1061
1062  clean_and_return:
1063     if (idx_buf_init)
1064     {
1065         for (i = 0; i < num_i; i++)
1066             if (idx_buf_init[i])
1067                 PyBuffer_Release(&(idx_buf[i]));
1068         free(idx_buf_init);
1069         free(idx_buf);
1070     }
1071     if (idxs)
1072     {
1073         for (i = 0; i < num_i; i++)
1074             free(idxs[i]);
1075         free(idxs);
1076     }
1077     PyBuffer_Release(&fmap);
1078     return result;
1079 }
1080
1081 #define FAN_ENTRIES 256
1082
1083 static PyObject *write_idx(PyObject *self, PyObject *args)
1084 {
1085     char *filename = NULL;
1086     PyObject *py_total, *idx = NULL;
1087     PyObject *part;
1088     unsigned int total = 0;
1089     uint32_t count;
1090     int i, j, ofs64_count;
1091     uint32_t *fan_ptr, *crc_ptr, *ofs_ptr;
1092     uint64_t *ofs64_ptr;
1093     struct sha *sha_ptr;
1094
1095     Py_buffer fmap;
1096     if (!PyArg_ParseTuple(args, cstr_argf wbuf_argf "OO",
1097                           &filename, &fmap, &idx, &py_total))
1098         return NULL;
1099
1100     PyObject *result = NULL;
1101
1102     if (!bup_uint_from_py(&total, py_total, "total"))
1103         goto clean_and_return;
1104
1105     if (PyList_Size (idx) != FAN_ENTRIES) // Check for list of the right length.
1106     {
1107         result = PyErr_Format (PyExc_TypeError, "idx must contain %d entries",
1108                                FAN_ENTRIES);
1109         goto clean_and_return;
1110     }
1111
1112     const char idx_header[] = "\377tOc\0\0\0\002";
1113     memcpy (fmap.buf, idx_header, sizeof(idx_header) - 1);
1114
1115     fan_ptr = (uint32_t *)&((unsigned char *)fmap.buf)[sizeof(idx_header) - 1];
1116     sha_ptr = (struct sha *)&fan_ptr[FAN_ENTRIES];
1117     crc_ptr = (uint32_t *)&sha_ptr[total];
1118     ofs_ptr = (uint32_t *)&crc_ptr[total];
1119     ofs64_ptr = (uint64_t *)&ofs_ptr[total];
1120
1121     count = 0;
1122     ofs64_count = 0;
1123     for (i = 0; i < FAN_ENTRIES; ++i)
1124     {
1125         Py_ssize_t plen;
1126         part = PyList_GET_ITEM(idx, i);
1127         PyList_Sort(part);
1128         plen = PyList_GET_SIZE(part);
1129         if (plen > UINT32_MAX || UINT32_MAX - count < plen) {
1130             PyErr_Format(PyExc_OverflowError, "too many objects in index part");
1131             goto clean_and_return;
1132         }
1133         count += (uint32_t) plen;
1134         *fan_ptr++ = htonl(count);
1135         for (j = 0; j < plen; ++j)
1136         {
1137             unsigned char *sha = NULL;
1138             Py_ssize_t sha_len = 0;
1139             PyObject *crc_py, *ofs_py;
1140             unsigned int crc;
1141             unsigned PY_LONG_LONG ofs_ull;
1142             uint64_t ofs;
1143             if (!PyArg_ParseTuple(PyList_GET_ITEM(part, j), rbuf_argf "OO",
1144                                   &sha, &sha_len, &crc_py, &ofs_py))
1145                 goto clean_and_return;
1146             if(!bup_uint_from_py(&crc, crc_py, "crc"))
1147                 goto clean_and_return;
1148             if(!bup_ullong_from_py(&ofs_ull, ofs_py, "ofs"))
1149                 goto clean_and_return;
1150             assert(crc <= UINT32_MAX);
1151             assert(ofs_ull <= UINT64_MAX);
1152             ofs = ofs_ull;
1153             if (sha_len != sizeof(struct sha))
1154                 goto clean_and_return;
1155             memcpy(sha_ptr++, sha, sizeof(struct sha));
1156             *crc_ptr++ = htonl(crc);
1157             if (ofs > 0x7fffffff)
1158             {
1159                 *ofs64_ptr++ = htonll(ofs);
1160                 ofs = 0x80000000 | ofs64_count++;
1161             }
1162             *ofs_ptr++ = htonl((uint32_t)ofs);
1163         }
1164     }
1165
1166     int rc = msync(fmap.buf, fmap.len, MS_ASYNC);
1167     if (rc != 0)
1168     {
1169         result = PyErr_SetFromErrnoWithFilename(PyExc_IOError, filename);
1170         goto clean_and_return;
1171     }
1172
1173     result = PyLong_FromUnsignedLong(count);
1174
1175  clean_and_return:
1176     PyBuffer_Release(&fmap);
1177     return result;
1178 }
1179
1180
1181 // I would have made this a lower-level function that just fills in a buffer
1182 // with random values, and then written those values from python.  But that's
1183 // about 20% slower in my tests, and since we typically generate random
1184 // numbers for benchmarking other parts of bup, any slowness in generating
1185 // random bytes will make our benchmarks inaccurate.  Plus nobody wants
1186 // pseudorandom bytes much except for this anyway.
1187 static PyObject *write_random(PyObject *self, PyObject *args)
1188 {
1189     uint32_t buf[1024/4];
1190     int fd = -1, seed = 0, verbose = 0;
1191     ssize_t ret;
1192     long long len = 0, kbytes = 0, written = 0;
1193
1194     if (!PyArg_ParseTuple(args, "iLii", &fd, &len, &seed, &verbose))
1195         return NULL;
1196
1197     srandom(seed);
1198
1199     for (kbytes = 0; kbytes < len/1024; kbytes++)
1200     {
1201         unsigned i;
1202         for (i = 0; i < sizeof(buf)/sizeof(buf[0]); i++)
1203             buf[i] = (uint32_t) random();
1204         ret = write(fd, buf, sizeof(buf));
1205         if (ret < 0)
1206             ret = 0;
1207         written += ret;
1208         if (ret < (int)sizeof(buf))
1209             break;
1210         if (verbose && kbytes/1024 > 0 && !(kbytes%1024))
1211             fprintf(stderr, "Random: %lld Mbytes\r", kbytes/1024);
1212     }
1213
1214     // handle non-multiples of 1024
1215     if (len % 1024)
1216     {
1217         unsigned i;
1218         for (i = 0; i < sizeof(buf)/sizeof(buf[0]); i++)
1219             buf[i] = (uint32_t) random();
1220         ret = write(fd, buf, len % 1024);
1221         if (ret < 0)
1222             ret = 0;
1223         written += ret;
1224     }
1225
1226     if (kbytes/1024 > 0)
1227         fprintf(stderr, "Random: %lld Mbytes, done.\n", kbytes/1024);
1228     return Py_BuildValue("L", written);
1229 }
1230
1231
1232 static PyObject *random_sha(PyObject *self, PyObject *args)
1233 {
1234     static int seeded = 0;
1235     uint32_t shabuf[20/4];
1236     int i;
1237
1238     if (!seeded)
1239     {
1240         assert(sizeof(shabuf) == 20);
1241         srandom((unsigned int) time(NULL));
1242         seeded = 1;
1243     }
1244
1245     if (!PyArg_ParseTuple(args, ""))
1246         return NULL;
1247
1248     memset(shabuf, 0, sizeof(shabuf));
1249     for (i=0; i < 20/4; i++)
1250         shabuf[i] = (uint32_t) random();
1251     return Py_BuildValue(rbuf_argf, shabuf, 20);
1252 }
1253
1254
1255 static int _open_noatime(const char *filename, int attrs)
1256 {
1257     int attrs_noatime, fd;
1258     attrs |= O_RDONLY;
1259 #ifdef O_NOFOLLOW
1260     attrs |= O_NOFOLLOW;
1261 #endif
1262 #ifdef O_LARGEFILE
1263     attrs |= O_LARGEFILE;
1264 #endif
1265     attrs_noatime = attrs;
1266 #ifdef O_NOATIME
1267     attrs_noatime |= O_NOATIME;
1268 #endif
1269     fd = open(filename, attrs_noatime);
1270     if (fd < 0 && errno == EPERM)
1271     {
1272         // older Linux kernels would return EPERM if you used O_NOATIME
1273         // and weren't the file's owner.  This pointless restriction was
1274         // relaxed eventually, but we have to handle it anyway.
1275         // (VERY old kernels didn't recognized O_NOATIME, but they would
1276         // just harmlessly ignore it, so this branch won't trigger)
1277         fd = open(filename, attrs);
1278     }
1279     return fd;
1280 }
1281
1282
1283 static PyObject *open_noatime(PyObject *self, PyObject *args)
1284 {
1285     char *filename = NULL;
1286     int fd;
1287     if (!PyArg_ParseTuple(args, cstr_argf, &filename))
1288         return NULL;
1289     fd = _open_noatime(filename, 0);
1290     if (fd < 0)
1291         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, filename);
1292     return Py_BuildValue("i", fd);
1293 }
1294
1295
1296 static PyObject *fadvise_done(PyObject *self, PyObject *args)
1297 {
1298     int fd = -1;
1299     long long llofs, lllen = 0;
1300     if (!PyArg_ParseTuple(args, "iLL", &fd, &llofs, &lllen))
1301         return NULL;
1302     off_t ofs, len;
1303     if (!INTEGRAL_ASSIGNMENT_FITS(&ofs, llofs))
1304         return PyErr_Format(PyExc_OverflowError,
1305                             "fadvise offset overflows off_t");
1306     if (!INTEGRAL_ASSIGNMENT_FITS(&len, lllen))
1307         return PyErr_Format(PyExc_OverflowError,
1308                             "fadvise length overflows off_t");
1309 #ifdef POSIX_FADV_DONTNEED
1310     posix_fadvise(fd, ofs, len, POSIX_FADV_DONTNEED);
1311 #endif
1312     return Py_BuildValue("");
1313 }
1314
1315
1316 // Currently the Linux kernel and FUSE disagree over the type for
1317 // FS_IOC_GETFLAGS and FS_IOC_SETFLAGS.  The kernel actually uses int,
1318 // but FUSE chose long (matching the declaration in linux/fs.h).  So
1319 // if you use int, and then traverse a FUSE filesystem, you may
1320 // corrupt the stack.  But if you use long, then you may get invalid
1321 // results on big-endian systems.
1322 //
1323 // For now, we just use long, and then disable Linux attrs entirely
1324 // (with a warning) in helpers.py on systems that are affected.
1325
1326 #ifdef BUP_HAVE_FILE_ATTRS
1327 static PyObject *bup_get_linux_file_attr(PyObject *self, PyObject *args)
1328 {
1329     int rc;
1330     unsigned long attr;
1331     char *path;
1332     int fd;
1333
1334     if (!PyArg_ParseTuple(args, cstr_argf, &path))
1335         return NULL;
1336
1337     fd = _open_noatime(path, O_NONBLOCK);
1338     if (fd == -1)
1339         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
1340
1341     attr = 0;  // Handle int/long mismatch (see above)
1342     rc = ioctl(fd, FS_IOC_GETFLAGS, &attr);
1343     if (rc == -1)
1344     {
1345         close(fd);
1346         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
1347     }
1348     close(fd);
1349     assert(attr <= UINT_MAX);  // Kernel type is actually int
1350     return PyLong_FromUnsignedLong(attr);
1351 }
1352 #endif /* def BUP_HAVE_FILE_ATTRS */
1353
1354
1355
1356 #ifdef BUP_HAVE_FILE_ATTRS
1357 static PyObject *bup_set_linux_file_attr(PyObject *self, PyObject *args)
1358 {
1359     int rc;
1360     unsigned long orig_attr;
1361     unsigned int attr;
1362     char *path;
1363     PyObject *py_attr;
1364     int fd;
1365
1366     if (!PyArg_ParseTuple(args, cstr_argf "O", &path, &py_attr))
1367         return NULL;
1368
1369     if (!bup_uint_from_py(&attr, py_attr, "attr"))
1370         return NULL;
1371
1372     fd = open(path, O_RDONLY | O_NONBLOCK | O_LARGEFILE | O_NOFOLLOW);
1373     if (fd == -1)
1374         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
1375
1376     // Restrict attr to modifiable flags acdeijstuADST -- see
1377     // chattr(1) and the e2fsprogs source.  Letter to flag mapping is
1378     // in pf.c flags_array[].
1379     attr &= FS_APPEND_FL | FS_COMPR_FL | FS_NODUMP_FL | FS_EXTENT_FL
1380     | FS_IMMUTABLE_FL | FS_JOURNAL_DATA_FL | FS_SECRM_FL | FS_NOTAIL_FL
1381     | FS_UNRM_FL | FS_NOATIME_FL | FS_DIRSYNC_FL | FS_SYNC_FL
1382     | FS_TOPDIR_FL | FS_NOCOW_FL;
1383
1384     // The extents flag can't be removed, so don't (see chattr(1) and chattr.c).
1385     orig_attr = 0; // Handle int/long mismatch (see above)
1386     rc = ioctl(fd, FS_IOC_GETFLAGS, &orig_attr);
1387     if (rc == -1)
1388     {
1389         close(fd);
1390         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
1391     }
1392     assert(orig_attr <= UINT_MAX);  // Kernel type is actually int
1393     attr |= ((unsigned int) orig_attr) & FS_EXTENT_FL;
1394
1395     rc = ioctl(fd, FS_IOC_SETFLAGS, &attr);
1396     if (rc == -1)
1397     {
1398         close(fd);
1399         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
1400     }
1401
1402     close(fd);
1403     return Py_BuildValue("O", Py_None);
1404 }
1405 #endif /* def BUP_HAVE_FILE_ATTRS */
1406
1407
1408 #ifndef HAVE_UTIMENSAT
1409 #ifndef HAVE_UTIMES
1410 #error "cannot find utimensat or utimes()"
1411 #endif
1412 #ifndef HAVE_LUTIMES
1413 #error "cannot find utimensat or lutimes()"
1414 #endif
1415 #endif
1416
1417 #define ASSIGN_PYLONG_TO_INTEGRAL(dest, pylong, overflow) \
1418     ({                                                     \
1419         int result = 0;                                                 \
1420         *(overflow) = 0;                                                \
1421         const long long lltmp = PyLong_AsLongLong(pylong);              \
1422         if (lltmp == -1 && PyErr_Occurred())                            \
1423         {                                                               \
1424             if (PyErr_ExceptionMatches(PyExc_OverflowError))            \
1425             {                                                           \
1426                 const unsigned long long ulltmp = PyLong_AsUnsignedLongLong(pylong); \
1427                 if (ulltmp == (unsigned long long) -1 && PyErr_Occurred()) \
1428                 {                                                       \
1429                     if (PyErr_ExceptionMatches(PyExc_OverflowError))    \
1430                     {                                                   \
1431                         PyErr_Clear();                                  \
1432                         *(overflow) = 1;                                \
1433                     }                                                   \
1434                 }                                                       \
1435                 if (INTEGRAL_ASSIGNMENT_FITS((dest), ulltmp))           \
1436                     result = 1;                                         \
1437                 else                                                    \
1438                     *(overflow) = 1;                                    \
1439             }                                                           \
1440         }                                                               \
1441         else                                                            \
1442         {                                                               \
1443             if (INTEGRAL_ASSIGNMENT_FITS((dest), lltmp))                \
1444                 result = 1;                                             \
1445             else                                                        \
1446                 *(overflow) = 1;                                        \
1447         }                                                               \
1448         result;                                                         \
1449         })
1450
1451
1452 #ifdef HAVE_UTIMENSAT
1453
1454 static PyObject *bup_utimensat(PyObject *self, PyObject *args)
1455 {
1456     int rc;
1457     int fd, flag;
1458     char *path;
1459     PyObject *access_py, *modification_py;
1460     struct timespec ts[2];
1461
1462     if (!PyArg_ParseTuple(args, "i" cstr_argf "((Ol)(Ol))i",
1463                           &fd,
1464                           &path,
1465                           &access_py, &(ts[0].tv_nsec),
1466                           &modification_py, &(ts[1].tv_nsec),
1467                           &flag))
1468         return NULL;
1469
1470     int overflow;
1471     if (!ASSIGN_PYLONG_TO_INTEGRAL(&(ts[0].tv_sec), access_py, &overflow))
1472     {
1473         if (overflow)
1474             PyErr_SetString(PyExc_ValueError,
1475                             "unable to convert access time seconds for utimensat");
1476         return NULL;
1477     }
1478     if (!ASSIGN_PYLONG_TO_INTEGRAL(&(ts[1].tv_sec), modification_py, &overflow))
1479     {
1480         if (overflow)
1481             PyErr_SetString(PyExc_ValueError,
1482                             "unable to convert modification time seconds for utimensat");
1483         return NULL;
1484     }
1485     rc = utimensat(fd, path, ts, flag);
1486     if (rc != 0)
1487         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
1488
1489     return Py_BuildValue("O", Py_None);
1490 }
1491
1492 #endif /* def HAVE_UTIMENSAT */
1493
1494
1495 #if defined(HAVE_UTIMES) || defined(HAVE_LUTIMES)
1496
1497 static int bup_parse_xutimes_args(char **path,
1498                                   struct timeval tv[2],
1499                                   PyObject *args)
1500 {
1501     PyObject *access_py, *modification_py;
1502     long long access_us, modification_us; // POSIX guarantees tv_usec is signed.
1503
1504     if (!PyArg_ParseTuple(args, cstr_argf "((OL)(OL))",
1505                           path,
1506                           &access_py, &access_us,
1507                           &modification_py, &modification_us))
1508         return 0;
1509
1510     int overflow;
1511     if (!ASSIGN_PYLONG_TO_INTEGRAL(&(tv[0].tv_sec), access_py, &overflow))
1512     {
1513         if (overflow)
1514             PyErr_SetString(PyExc_ValueError, "unable to convert access time seconds to timeval");
1515         return 0;
1516     }
1517     if (!INTEGRAL_ASSIGNMENT_FITS(&(tv[0].tv_usec), access_us))
1518     {
1519         PyErr_SetString(PyExc_ValueError, "unable to convert access time nanoseconds to timeval");
1520         return 0;
1521     }
1522     if (!ASSIGN_PYLONG_TO_INTEGRAL(&(tv[1].tv_sec), modification_py, &overflow))
1523     {
1524         if (overflow)
1525             PyErr_SetString(PyExc_ValueError, "unable to convert modification time seconds to timeval");
1526         return 0;
1527     }
1528     if (!INTEGRAL_ASSIGNMENT_FITS(&(tv[1].tv_usec), modification_us))
1529     {
1530         PyErr_SetString(PyExc_ValueError, "unable to convert modification time nanoseconds to timeval");
1531         return 0;
1532     }
1533     return 1;
1534 }
1535
1536 #endif /* defined(HAVE_UTIMES) || defined(HAVE_LUTIMES) */
1537
1538
1539 #ifdef HAVE_UTIMES
1540 static PyObject *bup_utimes(PyObject *self, PyObject *args)
1541 {
1542     char *path;
1543     struct timeval tv[2];
1544     if (!bup_parse_xutimes_args(&path, tv, args))
1545         return NULL;
1546     int rc = utimes(path, tv);
1547     if (rc != 0)
1548         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
1549     return Py_BuildValue("O", Py_None);
1550 }
1551 #endif /* def HAVE_UTIMES */
1552
1553
1554 #ifdef HAVE_LUTIMES
1555 static PyObject *bup_lutimes(PyObject *self, PyObject *args)
1556 {
1557     char *path;
1558     struct timeval tv[2];
1559     if (!bup_parse_xutimes_args(&path, tv, args))
1560         return NULL;
1561     int rc = lutimes(path, tv);
1562     if (rc != 0)
1563         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
1564
1565     return Py_BuildValue("O", Py_None);
1566 }
1567 #endif /* def HAVE_LUTIMES */
1568
1569
1570 #ifdef HAVE_STAT_ST_ATIM
1571 # define BUP_STAT_ATIME_NS(st) (st)->st_atim.tv_nsec
1572 # define BUP_STAT_MTIME_NS(st) (st)->st_mtim.tv_nsec
1573 # define BUP_STAT_CTIME_NS(st) (st)->st_ctim.tv_nsec
1574 #elif defined HAVE_STAT_ST_ATIMENSEC
1575 # define BUP_STAT_ATIME_NS(st) (st)->st_atimespec.tv_nsec
1576 # define BUP_STAT_MTIME_NS(st) (st)->st_mtimespec.tv_nsec
1577 # define BUP_STAT_CTIME_NS(st) (st)->st_ctimespec.tv_nsec
1578 #else
1579 # define BUP_STAT_ATIME_NS(st) 0
1580 # define BUP_STAT_MTIME_NS(st) 0
1581 # define BUP_STAT_CTIME_NS(st) 0
1582 #endif
1583
1584
1585 static PyObject *stat_struct_to_py(const struct stat *st,
1586                                    const char *filename,
1587                                    int fd)
1588 {
1589     // We can check the known (via POSIX) signed and unsigned types at
1590     // compile time, but not (easily) the unspecified types, so handle
1591     // those via INTEGER_TO_PY().  Assumes ns values will fit in a
1592     // long.
1593     return Py_BuildValue("NKNNNNNL(Nl)(Nl)(Nl)",
1594                          INTEGER_TO_PY(st->st_mode),
1595                          (unsigned PY_LONG_LONG) st->st_ino,
1596                          INTEGER_TO_PY(st->st_dev),
1597                          INTEGER_TO_PY(st->st_nlink),
1598                          INTEGER_TO_PY(st->st_uid),
1599                          INTEGER_TO_PY(st->st_gid),
1600                          INTEGER_TO_PY(st->st_rdev),
1601                          (PY_LONG_LONG) st->st_size,
1602                          INTEGER_TO_PY(st->st_atime),
1603                          (long) BUP_STAT_ATIME_NS(st),
1604                          INTEGER_TO_PY(st->st_mtime),
1605                          (long) BUP_STAT_MTIME_NS(st),
1606                          INTEGER_TO_PY(st->st_ctime),
1607                          (long) BUP_STAT_CTIME_NS(st));
1608 }
1609
1610
1611 static PyObject *bup_stat(PyObject *self, PyObject *args)
1612 {
1613     int rc;
1614     char *filename;
1615
1616     if (!PyArg_ParseTuple(args, cstr_argf, &filename))
1617         return NULL;
1618
1619     struct stat st;
1620     rc = stat(filename, &st);
1621     if (rc != 0)
1622         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, filename);
1623     return stat_struct_to_py(&st, filename, 0);
1624 }
1625
1626
1627 static PyObject *bup_lstat(PyObject *self, PyObject *args)
1628 {
1629     int rc;
1630     char *filename;
1631
1632     if (!PyArg_ParseTuple(args, cstr_argf, &filename))
1633         return NULL;
1634
1635     struct stat st;
1636     rc = lstat(filename, &st);
1637     if (rc != 0)
1638         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, filename);
1639     return stat_struct_to_py(&st, filename, 0);
1640 }
1641
1642
1643 static PyObject *bup_fstat(PyObject *self, PyObject *args)
1644 {
1645     int rc, fd;
1646
1647     if (!PyArg_ParseTuple(args, "i", &fd))
1648         return NULL;
1649
1650     struct stat st;
1651     rc = fstat(fd, &st);
1652     if (rc != 0)
1653         return PyErr_SetFromErrno(PyExc_OSError);
1654     return stat_struct_to_py(&st, NULL, fd);
1655 }
1656
1657
1658 #ifdef HAVE_TM_TM_GMTOFF
1659 static PyObject *bup_localtime(PyObject *self, PyObject *args)
1660 {
1661     long long lltime;
1662     time_t ttime;
1663     if (!PyArg_ParseTuple(args, "L", &lltime))
1664         return NULL;
1665     if (!INTEGRAL_ASSIGNMENT_FITS(&ttime, lltime))
1666         return PyErr_Format(PyExc_OverflowError, "time value too large");
1667
1668     struct tm tm;
1669     tzset();
1670     if(localtime_r(&ttime, &tm) == NULL)
1671         return PyErr_SetFromErrno(PyExc_OSError);
1672
1673     // Match the Python struct_time values.
1674     return Py_BuildValue("[i,i,i,i,i,i,i,i,i,i,s]",
1675                          1900 + tm.tm_year, tm.tm_mon + 1, tm.tm_mday,
1676                          tm.tm_hour, tm.tm_min, tm.tm_sec,
1677                          tm.tm_wday, tm.tm_yday + 1,
1678                          tm.tm_isdst, tm.tm_gmtoff, tm.tm_zone);
1679 }
1680 #endif /* def HAVE_TM_TM_GMTOFF */
1681
1682
1683 #ifdef BUP_MINCORE_BUF_TYPE
1684 static PyObject *bup_mincore(PyObject *self, PyObject *args)
1685 {
1686     Py_buffer src, dest;
1687     PyObject *py_src_n, *py_src_off, *py_dest_off;
1688
1689     if (!PyArg_ParseTuple(args, cstr_argf "*OOw*O",
1690                           &src, &py_src_n, &py_src_off,
1691                           &dest, &py_dest_off))
1692         return NULL;
1693
1694     PyObject *result = NULL;
1695
1696     unsigned long long src_n, src_off, dest_off;
1697     if (!(bup_ullong_from_py(&src_n, py_src_n, "src_n")
1698           && bup_ullong_from_py(&src_off, py_src_off, "src_off")
1699           && bup_ullong_from_py(&dest_off, py_dest_off, "dest_off")))
1700         goto clean_and_return;
1701
1702     unsigned long long src_region_end;
1703     if (!uadd(&src_region_end, src_off, src_n)) {
1704         result = PyErr_Format(PyExc_OverflowError, "(src_off + src_n) too large");
1705         goto clean_and_return;
1706     }
1707     assert(src.len >= 0);
1708     if (src_region_end > (unsigned long long) src.len) {
1709         result = PyErr_Format(PyExc_OverflowError, "region runs off end of src");
1710         goto clean_and_return;
1711     }
1712
1713     unsigned long long dest_size;
1714     if (!INTEGRAL_ASSIGNMENT_FITS(&dest_size, dest.len)) {
1715         result = PyErr_Format(PyExc_OverflowError, "invalid dest size");
1716         goto clean_and_return;
1717     }
1718     if (dest_off > dest_size) {
1719         result = PyErr_Format(PyExc_OverflowError, "region runs off end of dest");
1720         goto clean_and_return;
1721     }
1722
1723     size_t length;
1724     if (!INTEGRAL_ASSIGNMENT_FITS(&length, src_n)) {
1725         result = PyErr_Format(PyExc_OverflowError, "src_n overflows size_t");
1726         goto clean_and_return;
1727     }
1728     int rc = mincore((void *)(src.buf + src_off), length,
1729                      (BUP_MINCORE_BUF_TYPE *) (dest.buf + dest_off));
1730     if (rc != 0) {
1731         result = PyErr_SetFromErrno(PyExc_OSError);
1732         goto clean_and_return;
1733     }
1734     result = Py_BuildValue("O", Py_None);
1735
1736  clean_and_return:
1737     PyBuffer_Release(&src);
1738     PyBuffer_Release(&dest);
1739     return result;
1740 }
1741 #endif /* def BUP_MINCORE_BUF_TYPE */
1742
1743
1744 static PyObject *tuple_from_cstrs(char **cstrs)
1745 {
1746     // Assumes list is null terminated
1747     size_t n = 0;
1748     while(cstrs[n] != NULL)
1749         n++;
1750
1751     Py_ssize_t sn;
1752     if (!INTEGRAL_ASSIGNMENT_FITS(&sn, n))
1753         return PyErr_Format(PyExc_OverflowError, "string array too large");
1754
1755     PyObject *result = PyTuple_New(sn);
1756     Py_ssize_t i = 0;
1757     for (i = 0; i < sn; i++)
1758     {
1759         PyObject *gname = Py_BuildValue(cstr_argf, cstrs[i]);
1760         if (gname == NULL)
1761         {
1762             Py_DECREF(result);
1763             return NULL;
1764         }
1765         PyTuple_SET_ITEM(result, i, gname);
1766     }
1767     return result;
1768 }
1769
1770 static PyObject *appropriate_errno_ex(void)
1771 {
1772     switch (errno) {
1773     case ENOMEM:
1774         return PyErr_NoMemory();
1775     case EIO:
1776     case EMFILE:
1777     case ENFILE:
1778         // In 3.3 IOError was merged into OSError.
1779         return PyErr_SetFromErrno(PyExc_IOError);
1780     default:
1781         return PyErr_SetFromErrno(PyExc_OSError);
1782     }
1783 }
1784
1785
1786 static PyObject *pwd_struct_to_py(const struct passwd *pwd)
1787 {
1788     // We can check the known (via POSIX) signed and unsigned types at
1789     // compile time, but not (easily) the unspecified types, so handle
1790     // those via INTEGER_TO_PY().
1791     if (pwd == NULL)
1792         Py_RETURN_NONE;
1793     return Py_BuildValue(cstr_argf cstr_argf "OO"
1794                          cstr_argf cstr_argf cstr_argf,
1795                          pwd->pw_name,
1796                          pwd->pw_passwd,
1797                          INTEGER_TO_PY(pwd->pw_uid),
1798                          INTEGER_TO_PY(pwd->pw_gid),
1799                          pwd->pw_gecos,
1800                          pwd->pw_dir,
1801                          pwd->pw_shell);
1802 }
1803
1804 static PyObject *bup_getpwuid(PyObject *self, PyObject *args)
1805 {
1806     unsigned long long py_uid;
1807     if (!PyArg_ParseTuple(args, "K", &py_uid))
1808         return NULL;
1809     uid_t uid;
1810     if (!INTEGRAL_ASSIGNMENT_FITS(&uid, py_uid))
1811         return PyErr_Format(PyExc_OverflowError, "uid too large for uid_t");
1812
1813     errno = 0;
1814     struct passwd *pwd = getpwuid(uid);
1815     if (!pwd && errno)
1816         return appropriate_errno_ex();
1817     return pwd_struct_to_py(pwd);
1818 }
1819
1820 static PyObject *bup_getpwnam(PyObject *self, PyObject *args)
1821 {
1822     PyObject *py_name;
1823     if (!PyArg_ParseTuple(args, "S", &py_name))
1824         return NULL;
1825
1826     char *name = PyBytes_AS_STRING(py_name);
1827     errno = 0;
1828     struct passwd *pwd = getpwnam(name);
1829     if (!pwd && errno)
1830         return appropriate_errno_ex();
1831     return pwd_struct_to_py(pwd);
1832 }
1833
1834 static PyObject *grp_struct_to_py(const struct group *grp)
1835 {
1836     // We can check the known (via POSIX) signed and unsigned types at
1837     // compile time, but not (easily) the unspecified types, so handle
1838     // those via INTEGER_TO_PY().
1839     if (grp == NULL)
1840         Py_RETURN_NONE;
1841
1842     PyObject *members = tuple_from_cstrs(grp->gr_mem);
1843     if (members == NULL)
1844         return NULL;
1845     return Py_BuildValue(cstr_argf cstr_argf "OO",
1846                          grp->gr_name,
1847                          grp->gr_passwd,
1848                          INTEGER_TO_PY(grp->gr_gid),
1849                          members);
1850 }
1851
1852 static PyObject *bup_getgrgid(PyObject *self, PyObject *args)
1853 {
1854     unsigned long long py_gid;
1855     if (!PyArg_ParseTuple(args, "K", &py_gid))
1856         return NULL;
1857     gid_t gid;
1858     if (!INTEGRAL_ASSIGNMENT_FITS(&gid, py_gid))
1859         return PyErr_Format(PyExc_OverflowError, "gid too large for gid_t");
1860
1861     errno = 0;
1862     struct group *grp = getgrgid(gid);
1863     if (!grp && errno)
1864         return appropriate_errno_ex();
1865     return grp_struct_to_py(grp);
1866 }
1867
1868 static PyObject *bup_getgrnam(PyObject *self, PyObject *args)
1869 {
1870     PyObject *py_name;
1871     if (!PyArg_ParseTuple(args, "S", &py_name))
1872         return NULL;
1873
1874     char *name = PyBytes_AS_STRING(py_name);
1875     errno = 0;
1876     struct group *grp = getgrnam(name);
1877     if (!grp && errno)
1878         return appropriate_errno_ex();
1879     return grp_struct_to_py(grp);
1880 }
1881
1882
1883 static PyObject *bup_gethostname(PyObject *mod, PyObject *ignore)
1884 {
1885 #ifdef HOST_NAME_MAX
1886     char buf[HOST_NAME_MAX + 1] = {};
1887 #else
1888     /* 'SUSv2 guarantees that "Host names are limited to 255 bytes".' */
1889     char buf[256] = {};
1890 #endif
1891
1892     if (gethostname(buf, sizeof(buf) - 1))
1893         return PyErr_SetFromErrno(PyExc_IOError);
1894     return PyBytes_FromString(buf);
1895 }
1896
1897
1898 #ifdef BUP_HAVE_READLINE
1899
1900 static char *cstr_from_bytes(PyObject *bytes)
1901 {
1902     char *buf;
1903     Py_ssize_t length;
1904     int rc = PyBytes_AsStringAndSize(bytes, &buf, &length);
1905     if (rc == -1)
1906         return NULL;
1907     char *result = checked_malloc(length, sizeof(char));
1908     if (!result)
1909         return NULL;
1910     memcpy(result, buf, length);
1911     return result;
1912 }
1913
1914 static char **cstrs_from_seq(PyObject *seq)
1915 {
1916     char **result = NULL;
1917     seq = PySequence_Fast(seq, "Cannot convert sequence items to C strings");
1918     if (!seq)
1919         return NULL;
1920
1921     const Py_ssize_t len = PySequence_Fast_GET_SIZE(seq);
1922     if (len > PY_SSIZE_T_MAX - 1) {
1923         PyErr_Format(PyExc_OverflowError,
1924                      "Sequence length %zd too large for conversion to C array",
1925                      len);
1926         goto finish;
1927     }
1928     result = checked_malloc(len + 1, sizeof(char *));
1929     if (!result)
1930         goto finish;
1931     Py_ssize_t i = 0;
1932     for (i = 0; i < len; i++)
1933     {
1934         PyObject *item = PySequence_Fast_GET_ITEM(seq, i);
1935         if (!item)
1936             goto abandon_result;
1937         result[i] = cstr_from_bytes(item);
1938         if (!result[i]) {
1939             i--;
1940             goto abandon_result;
1941         }
1942     }
1943     result[len] = NULL;
1944     goto finish;
1945
1946  abandon_result:
1947     if (result) {
1948         for (; i > 0; i--)
1949             free(result[i]);
1950         free(result);
1951         result = NULL;
1952     }
1953  finish:
1954     Py_DECREF(seq);
1955     return result;
1956 }
1957
1958 static char* our_word_break_chars = NULL;
1959
1960 static PyObject *
1961 bup_set_completer_word_break_characters(PyObject *self, PyObject *args)
1962 {
1963     char *bytes;
1964     if (!PyArg_ParseTuple(args, cstr_argf, &bytes))
1965         return NULL;
1966     char *prev = our_word_break_chars;
1967     char *next = strdup(bytes);
1968     if (!next)
1969         return PyErr_NoMemory();
1970     our_word_break_chars = next;
1971     rl_completer_word_break_characters = next;
1972     if (prev)
1973         free(prev);
1974     Py_RETURN_NONE;
1975 }
1976
1977 static PyObject *
1978 bup_get_completer_word_break_characters(PyObject *self, PyObject *args)
1979 {
1980     if (!PyArg_ParseTuple(args, ""))
1981         return NULL;
1982     return PyBytes_FromString(rl_completer_word_break_characters);
1983 }
1984
1985 static PyObject *bup_get_line_buffer(PyObject *self, PyObject *args)
1986 {
1987     if (!PyArg_ParseTuple(args, ""))
1988         return NULL;
1989     return PyBytes_FromString(rl_line_buffer);
1990 }
1991
1992 static PyObject *
1993 bup_parse_and_bind(PyObject *self, PyObject *args)
1994 {
1995     char *bytes;
1996     if (!PyArg_ParseTuple(args, cstr_argf ":parse_and_bind", &bytes))
1997         return NULL;
1998     char *tmp = strdup(bytes); // Because it may modify the arg
1999     if (!tmp)
2000         return PyErr_NoMemory();
2001     int rc = rl_parse_and_bind(tmp);
2002     free(tmp);
2003     if (rc != 0)
2004         return PyErr_Format(PyExc_OSError,
2005                             "system rl_parse_and_bind failed (%d)", rc);
2006     Py_RETURN_NONE;
2007 }
2008
2009
2010 static PyObject *py_on_attempted_completion;
2011 static char **prev_completions;
2012
2013 static char **on_attempted_completion(const char *text, int start, int end)
2014 {
2015     if (!py_on_attempted_completion)
2016         return NULL;
2017
2018     char **result = NULL;
2019     PyObject *py_result = PyObject_CallFunction(py_on_attempted_completion,
2020                                                 cstr_argf "ii",
2021                                                 text, start, end);
2022     if (!py_result)
2023         return NULL;
2024     if (py_result != Py_None) {
2025         result = cstrs_from_seq(py_result);
2026         free(prev_completions);
2027         prev_completions = result;
2028     }
2029     Py_DECREF(py_result);
2030     return result;
2031 }
2032
2033 static PyObject *
2034 bup_set_attempted_completion_function(PyObject *self, PyObject *args)
2035 {
2036     PyObject *completer;
2037     if (!PyArg_ParseTuple(args, "O", &completer))
2038         return NULL;
2039
2040     PyObject *prev = py_on_attempted_completion;
2041     if (completer == Py_None)
2042     {
2043         py_on_attempted_completion = NULL;
2044         rl_attempted_completion_function = NULL;
2045     } else {
2046         py_on_attempted_completion = completer;
2047         rl_attempted_completion_function = on_attempted_completion;
2048         Py_INCREF(completer);
2049     }
2050     Py_XDECREF(prev);
2051     Py_RETURN_NONE;
2052 }
2053
2054
2055 static PyObject *py_on_completion_entry;
2056
2057 static char *on_completion_entry(const char *text, int state)
2058 {
2059     if (!py_on_completion_entry)
2060         return NULL;
2061
2062     PyObject *py_result = PyObject_CallFunction(py_on_completion_entry,
2063                                                 cstr_argf "i", text, state);
2064     if (!py_result)
2065         return NULL;
2066     char *result = (py_result == Py_None) ? NULL : cstr_from_bytes(py_result);
2067     Py_DECREF(py_result);
2068     return result;
2069 }
2070
2071 static PyObject *
2072 bup_set_completion_entry_function(PyObject *self, PyObject *args)
2073 {
2074     PyObject *completer;
2075     if (!PyArg_ParseTuple(args, "O", &completer))
2076         return NULL;
2077
2078     PyObject *prev = py_on_completion_entry;
2079     if (completer == Py_None) {
2080         py_on_completion_entry = NULL;
2081         rl_completion_entry_function = NULL;
2082     } else {
2083         py_on_completion_entry = completer;
2084         rl_completion_entry_function = on_completion_entry;
2085         Py_INCREF(completer);
2086     }
2087     Py_XDECREF(prev);
2088     Py_RETURN_NONE;
2089 }
2090
2091 static PyObject *
2092 bup_readline(PyObject *self, PyObject *args)
2093 {
2094     char *prompt;
2095     if (!PyArg_ParseTuple(args, cstr_argf, &prompt))
2096         return NULL;
2097     char *line = readline(prompt);
2098     if (!line)
2099         return PyErr_Format(PyExc_EOFError, "readline EOF");
2100     PyObject *result = PyBytes_FromString(line);
2101     free(line);
2102     return result;
2103 }
2104
2105 #endif // defined BUP_HAVE_READLINE
2106
2107 #if defined(HAVE_SYS_ACL_H) && \
2108     defined(HAVE_ACL_LIBACL_H) && \
2109     defined(HAVE_ACL_EXTENDED_FILE) && \
2110     defined(HAVE_ACL_GET_FILE) && \
2111     defined(HAVE_ACL_TO_ANY_TEXT) && \
2112     defined(HAVE_ACL_FROM_TEXT) && \
2113     defined(HAVE_ACL_SET_FILE)
2114 #define ACL_SUPPORT 1
2115 #include <sys/acl.h>
2116 #include <acl/libacl.h>
2117
2118 // Returns
2119 //   0 for success
2120 //  -1 for errors, with python exception set
2121 //  -2 for ignored errors (not supported)
2122 static int bup_read_acl_to_text(const char *name, acl_type_t type,
2123                                 char **txt, char **num)
2124 {
2125     acl_t acl;
2126
2127     acl = acl_get_file(name, type);
2128     if (!acl) {
2129         if (errno == EOPNOTSUPP || errno == ENOSYS)
2130             return -2;
2131         PyErr_SetFromErrno(PyExc_IOError);
2132         return -1;
2133     }
2134
2135     *num = NULL;
2136     *txt = acl_to_any_text(acl, "", '\n', TEXT_ABBREVIATE);
2137     if (*txt)
2138         *num = acl_to_any_text(acl, "", '\n', TEXT_ABBREVIATE | TEXT_NUMERIC_IDS);
2139
2140     if (*txt && *num)
2141         return 0;
2142
2143     if (errno == ENOMEM)
2144         PyErr_NoMemory();
2145     else
2146         PyErr_SetFromErrno(PyExc_IOError);
2147
2148     if (*txt)
2149         acl_free((acl_t)*txt);
2150     if (*num)
2151         acl_free((acl_t)*num);
2152
2153     return -1;
2154 }
2155
2156 static PyObject *bup_read_acl(PyObject *self, PyObject *args)
2157 {
2158     char *name;
2159     int isdir, rv;
2160     PyObject *ret = NULL;
2161     char *acl_txt = NULL, *acl_num = NULL;
2162
2163     if (!PyArg_ParseTuple(args, cstr_argf "i", &name, &isdir))
2164         return NULL;
2165
2166     if (!acl_extended_file(name))
2167         Py_RETURN_NONE;
2168
2169     rv = bup_read_acl_to_text(name, ACL_TYPE_ACCESS, &acl_txt, &acl_num);
2170     if (rv)
2171         goto out;
2172
2173     if (isdir) {
2174         char *def_txt = NULL, *def_num = NULL;
2175
2176         rv = bup_read_acl_to_text(name, ACL_TYPE_DEFAULT, &def_txt, &def_num);
2177         if (rv)
2178             goto out;
2179
2180         ret = Py_BuildValue("[" cstr_argf cstr_argf cstr_argf cstr_argf "]",
2181                             acl_txt, acl_num, def_txt, def_num);
2182
2183         if (def_txt)
2184             acl_free((acl_t)def_txt);
2185         if (def_num)
2186             acl_free((acl_t)def_num);
2187     } else {
2188         ret = Py_BuildValue("[" cstr_argf cstr_argf "]",
2189                             acl_txt, acl_num);
2190     }
2191
2192 out:
2193     if (acl_txt)
2194         acl_free((acl_t)acl_txt);
2195     if (acl_num)
2196         acl_free((acl_t)acl_num);
2197     if (rv == -2)
2198         Py_RETURN_NONE;
2199     return ret;
2200 }
2201
2202 static int bup_apply_acl_string(const char *name, const char *s)
2203 {
2204     acl_t acl = acl_from_text(s);
2205     int ret = 0;
2206
2207     if (!acl) {
2208         PyErr_SetFromErrno(PyExc_IOError);
2209         return -1;
2210     }
2211
2212     if (acl_set_file(name, ACL_TYPE_ACCESS, acl)) {
2213         PyErr_SetFromErrno(PyExc_IOError);
2214         ret = -1;
2215     }
2216
2217     acl_free(acl);
2218
2219     return ret;
2220 }
2221
2222 static PyObject *bup_apply_acl(PyObject *self, PyObject *args)
2223 {
2224     char *name, *acl, *def = NULL;
2225
2226     if (!PyArg_ParseTuple(args, cstr_argf cstr_argf "|" cstr_argf, &name, &acl, &def))
2227         return NULL;
2228
2229     if (bup_apply_acl_string(name, acl))
2230         return NULL;
2231
2232     if (def && bup_apply_acl_string(name, def))
2233         return NULL;
2234
2235     Py_RETURN_NONE;
2236 }
2237 #endif
2238
2239 static PyMethodDef helper_methods[] = {
2240     { "write_sparsely", bup_write_sparsely, METH_VARARGS,
2241       "Write buf excepting zeros at the end. Return trailing zero count." },
2242     { "selftest", selftest, METH_VARARGS,
2243         "Check that the rolling checksum rolls correctly (for unit tests)." },
2244     { "blobbits", blobbits, METH_VARARGS,
2245         "Return the number of bits in the rolling checksum." },
2246     { "splitbuf", splitbuf, METH_VARARGS,
2247         "Split a list of strings based on a rolling checksum." },
2248     { "bitmatch", bitmatch, METH_VARARGS,
2249         "Count the number of matching prefix bits between two strings." },
2250     { "firstword", firstword, METH_VARARGS,
2251         "Return an int corresponding to the first 32 bits of buf." },
2252     { "bloom_contains", bloom_contains, METH_VARARGS,
2253         "Check if a bloom filter of 2^nbits bytes contains an object" },
2254     { "bloom_add", bloom_add, METH_VARARGS,
2255         "Add an object to a bloom filter of 2^nbits bytes" },
2256     { "extract_bits", extract_bits, METH_VARARGS,
2257         "Take the first 'nbits' bits from 'buf' and return them as an int." },
2258     { "merge_into", merge_into, METH_VARARGS,
2259         "Merges a bunch of idx and midx files into a single midx." },
2260     { "write_idx", write_idx, METH_VARARGS,
2261         "Write a PackIdxV2 file from an idx list of lists of tuples" },
2262     { "write_random", write_random, METH_VARARGS,
2263         "Write random bytes to the given file descriptor" },
2264     { "random_sha", random_sha, METH_VARARGS,
2265         "Return a random 20-byte string" },
2266     { "open_noatime", open_noatime, METH_VARARGS,
2267         "open() the given filename for read with O_NOATIME if possible" },
2268     { "fadvise_done", fadvise_done, METH_VARARGS,
2269         "Inform the kernel that we're finished with earlier parts of a file" },
2270 #ifdef BUP_HAVE_FILE_ATTRS
2271     { "get_linux_file_attr", bup_get_linux_file_attr, METH_VARARGS,
2272       "Return the Linux attributes for the given file." },
2273 #endif
2274 #ifdef BUP_HAVE_FILE_ATTRS
2275     { "set_linux_file_attr", bup_set_linux_file_attr, METH_VARARGS,
2276       "Set the Linux attributes for the given file." },
2277 #endif
2278 #ifdef HAVE_UTIMENSAT
2279     { "bup_utimensat", bup_utimensat, METH_VARARGS,
2280       "Change path timestamps with nanosecond precision (POSIX)." },
2281 #endif
2282 #ifdef HAVE_UTIMES
2283     { "bup_utimes", bup_utimes, METH_VARARGS,
2284       "Change path timestamps with microsecond precision." },
2285 #endif
2286 #ifdef HAVE_LUTIMES
2287     { "bup_lutimes", bup_lutimes, METH_VARARGS,
2288       "Change path timestamps with microsecond precision;"
2289       " don't follow symlinks." },
2290 #endif
2291     { "stat", bup_stat, METH_VARARGS,
2292       "Extended version of stat." },
2293     { "lstat", bup_lstat, METH_VARARGS,
2294       "Extended version of lstat." },
2295     { "fstat", bup_fstat, METH_VARARGS,
2296       "Extended version of fstat." },
2297 #ifdef HAVE_TM_TM_GMTOFF
2298     { "localtime", bup_localtime, METH_VARARGS,
2299       "Return struct_time elements plus the timezone offset and name." },
2300 #endif
2301     { "bytescmp", bup_bytescmp, METH_VARARGS,
2302       "Return a negative value if x < y, zero if equal, positive otherwise."},
2303     { "cat_bytes", bup_cat_bytes, METH_VARARGS,
2304       "For (x_bytes, x_ofs, x_n, y_bytes, y_ofs, y_n) arguments, return their concatenation."},
2305 #ifdef BUP_MINCORE_BUF_TYPE
2306     { "mincore", bup_mincore, METH_VARARGS,
2307       "For mincore(src, src_n, src_off, dest, dest_off)"
2308       " call the system mincore(src + src_off, src_n, &dest[dest_off])." },
2309 #endif
2310     { "getpwuid", bup_getpwuid, METH_VARARGS,
2311       "Return the password database entry for the given numeric user id,"
2312       " as a tuple with all C strings as bytes(), or None if the user does"
2313       " not exist." },
2314     { "getpwnam", bup_getpwnam, METH_VARARGS,
2315       "Return the password database entry for the given user name,"
2316       " as a tuple with all C strings as bytes(), or None if the user does"
2317       " not exist." },
2318     { "getgrgid", bup_getgrgid, METH_VARARGS,
2319       "Return the group database entry for the given numeric group id,"
2320       " as a tuple with all C strings as bytes(), or None if the group does"
2321       " not exist." },
2322     { "getgrnam", bup_getgrnam, METH_VARARGS,
2323       "Return the group database entry for the given group name,"
2324       " as a tuple with all C strings as bytes(), or None if the group does"
2325       " not exist." },
2326     { "gethostname", bup_gethostname, METH_NOARGS,
2327       "Return the current hostname (as bytes)" },
2328 #ifdef BUP_HAVE_READLINE
2329     { "set_completion_entry_function", bup_set_completion_entry_function, METH_VARARGS,
2330       "Set rl_completion_entry_function.  Called as f(text, state)." },
2331     { "set_attempted_completion_function", bup_set_attempted_completion_function, METH_VARARGS,
2332       "Set rl_attempted_completion_function.  Called as f(text, start, end)." },
2333     { "parse_and_bind", bup_parse_and_bind, METH_VARARGS,
2334       "Call rl_parse_and_bind." },
2335     { "get_line_buffer", bup_get_line_buffer, METH_NOARGS,
2336       "Return rl_line_buffer." },
2337     { "get_completer_word_break_characters", bup_get_completer_word_break_characters, METH_NOARGS,
2338       "Return rl_completer_word_break_characters." },
2339     { "set_completer_word_break_characters", bup_set_completer_word_break_characters, METH_VARARGS,
2340       "Set rl_completer_word_break_characters." },
2341     { "readline", bup_readline, METH_VARARGS,
2342       "Call readline(prompt)." },
2343 #endif // defined BUP_HAVE_READLINE
2344 #ifdef ACL_SUPPORT
2345     { "read_acl", bup_read_acl, METH_VARARGS,
2346       "read_acl(name, isdir)\n\n"
2347       "Read ACLs for the given file/dirname and return the correctly encoded"
2348       " list [txt, num, def_tx, def_num] (the def_* being empty bytestrings"
2349       " unless the second argument 'isdir' is True)." },
2350     { "apply_acl", bup_apply_acl, METH_VARARGS,
2351       "apply_acl(name, acl, def=None)\n\n"
2352       "Given a file/dirname (bytes) and the ACLs to restore, do that." },
2353 #endif /* HAVE_ACLS */
2354     { NULL, NULL, 0, NULL },  // sentinel
2355 };
2356
2357 static void test_integral_assignment_fits(void)
2358 {
2359     assert(sizeof(signed short) == sizeof(unsigned short));
2360     assert(sizeof(signed short) < sizeof(signed long long));
2361     assert(sizeof(signed short) < sizeof(unsigned long long));
2362     assert(sizeof(unsigned short) < sizeof(signed long long));
2363     assert(sizeof(unsigned short) < sizeof(unsigned long long));
2364     assert(sizeof(Py_ssize_t) <= sizeof(size_t));
2365     {
2366         signed short ss, ssmin = SHRT_MIN, ssmax = SHRT_MAX;
2367         unsigned short us, usmax = USHRT_MAX;
2368         signed long long sllmin = LLONG_MIN, sllmax = LLONG_MAX;
2369         unsigned long long ullmax = ULLONG_MAX;
2370
2371         assert(INTEGRAL_ASSIGNMENT_FITS(&ss, ssmax));
2372         assert(INTEGRAL_ASSIGNMENT_FITS(&ss, ssmin));
2373         assert(!INTEGRAL_ASSIGNMENT_FITS(&ss, usmax));
2374         assert(!INTEGRAL_ASSIGNMENT_FITS(&ss, sllmin));
2375         assert(!INTEGRAL_ASSIGNMENT_FITS(&ss, sllmax));
2376         assert(!INTEGRAL_ASSIGNMENT_FITS(&ss, ullmax));
2377
2378         assert(INTEGRAL_ASSIGNMENT_FITS(&us, usmax));
2379         assert(!INTEGRAL_ASSIGNMENT_FITS(&us, ssmin));
2380         assert(!INTEGRAL_ASSIGNMENT_FITS(&us, sllmin));
2381         assert(!INTEGRAL_ASSIGNMENT_FITS(&us, sllmax));
2382         assert(!INTEGRAL_ASSIGNMENT_FITS(&us, ullmax));
2383     }
2384 }
2385
2386 static int setup_module(PyObject *m)
2387 {
2388     // FIXME: migrate these tests to configure, or at least don't
2389     // possibly crash the whole application.  Check against the type
2390     // we're going to use when passing to python.  Other stat types
2391     // are tested at runtime.
2392     assert(sizeof(ino_t) <= sizeof(unsigned PY_LONG_LONG));
2393     assert(sizeof(off_t) <= sizeof(PY_LONG_LONG));
2394     assert(sizeof(blksize_t) <= sizeof(PY_LONG_LONG));
2395     assert(sizeof(blkcnt_t) <= sizeof(PY_LONG_LONG));
2396     // Just be sure (relevant when passing timestamps back to Python above).
2397     assert(sizeof(PY_LONG_LONG) <= sizeof(long long));
2398     assert(sizeof(unsigned PY_LONG_LONG) <= sizeof(unsigned long long));
2399
2400     test_integral_assignment_fits();
2401
2402     // Originally required by append_sparse_region()
2403     {
2404         off_t probe;
2405         if (!INTEGRAL_ASSIGNMENT_FITS(&probe, INT_MAX))
2406         {
2407             fprintf(stderr, "off_t can't hold INT_MAX; please report.\n");
2408             exit(1);
2409         }
2410     }
2411
2412     char *e;
2413     {
2414         PyObject *value;
2415         value = INTEGER_TO_PY(INT_MAX);
2416         PyObject_SetAttrString(m, "INT_MAX", value);
2417         Py_DECREF(value);
2418         value = INTEGER_TO_PY(UINT_MAX);
2419         PyObject_SetAttrString(m, "UINT_MAX", value);
2420         Py_DECREF(value);
2421     }
2422 #ifdef HAVE_UTIMENSAT
2423     {
2424         PyObject *value;
2425         value = INTEGER_TO_PY(AT_FDCWD);
2426         PyObject_SetAttrString(m, "AT_FDCWD", value);
2427         Py_DECREF(value);
2428         value = INTEGER_TO_PY(AT_SYMLINK_NOFOLLOW);
2429         PyObject_SetAttrString(m, "AT_SYMLINK_NOFOLLOW", value);
2430         Py_DECREF(value);
2431         value = INTEGER_TO_PY(UTIME_NOW);
2432         PyObject_SetAttrString(m, "UTIME_NOW", value);
2433         Py_DECREF(value);
2434     }
2435 #endif
2436 #ifdef BUP_HAVE_MINCORE_INCORE
2437     {
2438         PyObject *value;
2439         value = INTEGER_TO_PY(MINCORE_INCORE);
2440         PyObject_SetAttrString(m, "MINCORE_INCORE", value);
2441         Py_DECREF(value);
2442     }
2443 #endif
2444
2445     e = getenv("BUP_FORCE_TTY");
2446     get_state(m)->istty2 = isatty(2) || (atoi(e ? e : "0") & 2);
2447     unpythonize_argv();
2448     return 1;
2449 }
2450
2451
2452 #if PY_MAJOR_VERSION < 3
2453
2454 PyMODINIT_FUNC init_helpers(void)
2455 {
2456     PyObject *m = Py_InitModule("_helpers", helper_methods);
2457     if (m == NULL)
2458         return;
2459
2460     if (!setup_module(m))
2461     {
2462         Py_DECREF(m);
2463         return;
2464     }
2465 }
2466
2467 # else // PY_MAJOR_VERSION >= 3
2468
2469 static struct PyModuleDef helpers_def = {
2470     PyModuleDef_HEAD_INIT,
2471     "_helpers",
2472     NULL,
2473     sizeof(state_t),
2474     helper_methods,
2475     NULL,
2476     NULL, // helpers_traverse,
2477     NULL, // helpers_clear,
2478     NULL
2479 };
2480
2481 PyMODINIT_FUNC PyInit__helpers(void)
2482 {
2483     PyObject *module = PyModule_Create(&helpers_def);
2484     if (module == NULL)
2485         return NULL;
2486     if (!setup_module(module))
2487     {
2488         Py_DECREF(module);
2489         return NULL;
2490     }
2491     return module;
2492 }
2493
2494 #endif // PY_MAJOR_VERSION >= 3