/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/_readdir_pyx.pyx

  • Committer: John Arbash Meinel
  • Date: 2008-10-14 21:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3805.
  • Revision ID: john@arbash-meinel.com-20081014213527-4j9uc93aq1qmn43b
Add in a shortcut when we haven't cached much yet.

Document the current algorithm more completely, including the proper
justification for the various steps.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/_readdir_pyx.pyx
1
 
# Copyright (C) 2006, 2008, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Wrapper for readdir which returns files ordered by inode."""
18
18
 
25
25
    pass
26
26
 
27
27
 
 
28
# the opaque C library DIR type.
28
29
cdef extern from 'errno.h':
29
30
    int ENOENT
30
31
    int ENOTDIR
31
32
    int EAGAIN
32
 
    int EINTR
 
33
    int errno
33
34
    char *strerror(int errno)
34
 
    # not necessarily a real variable, but this should be close enough
35
 
    int errno
36
35
 
37
36
cdef extern from 'unistd.h':
38
37
    int chdir(char *path)
39
 
    int close(int fd)
40
 
    int fchdir(int fd)
41
38
    char *getcwd(char *, int size)
42
39
 
43
40
cdef extern from 'stdlib.h':
51
48
    ctypedef long time_t
52
49
    ctypedef unsigned long ino_t
53
50
    ctypedef unsigned long long off_t
54
 
    ctypedef int mode_t
55
51
 
56
52
 
57
53
cdef extern from 'sys/stat.h':
72
68
    int S_ISSOCK(int mode)
73
69
 
74
70
 
75
 
cdef extern from 'fcntl.h':
76
 
    int O_RDONLY
77
 
    int open(char *pathname, int flags, mode_t mode)
78
 
 
79
 
 
80
71
cdef extern from 'Python.h':
81
 
    int PyErr_CheckSignals() except -1
82
72
    char * PyString_AS_STRING(object)
83
73
    ctypedef int Py_ssize_t # Required for older pyrex versions
84
74
    ctypedef struct PyObject:
99
89
    ctypedef struct dirent:
100
90
        char d_name[256]
101
91
        ino_t d_ino
102
 
    # the opaque C library DIR type.
103
92
    ctypedef struct DIR
104
93
    # should be DIR *, pyrex barfs.
105
94
    DIR * opendir(char * name)
156
145
        (mode, ino, dev, nlink, uid, gid, size, None(atime), mtime, ctime)
157
146
        """
158
147
        return repr((self.st_mode, 0, 0, 0, 0, 0, self.st_size, None,
159
 
                     self.st_mtime, self.st_ctime))
 
148
                     self._mtime, self._ctime))
160
149
 
161
150
 
162
151
from bzrlib import osutils
272
261
        return result
273
262
 
274
263
 
275
 
cdef raise_os_error(int errnum, char *msg_prefix, path):
276
 
    if errnum == EINTR:
277
 
        PyErr_CheckSignals()
278
 
    raise OSError(errnum, msg_prefix + strerror(errnum), path)
279
 
 
280
 
 
281
264
cdef _read_dir(path):
282
265
    """Like os.listdir, this reads the contents of a directory.
283
266
 
294
277
    cdef char *name
295
278
    cdef int stat_result
296
279
    cdef _Stat statvalue
297
 
    global errno
298
 
    cdef int orig_dir_fd
299
 
 
300
 
    # Avoid chdir('') because it causes problems on Sun OS, and avoid this if
301
 
    # staying in .
302
 
    if path != "" and path != '.':
303
 
        # we change into the requested directory before reading, and back at the
304
 
        # end, because that turns out to make the stat calls measurably faster than
305
 
        # passing full paths every time.
306
 
        orig_dir_fd = open(".", O_RDONLY, 0)
307
 
        if orig_dir_fd == -1:
308
 
            raise_os_error(errno, "open: ", ".")
309
 
        if -1 == chdir(path):
310
 
            raise_os_error(errno, "chdir: ", path)
311
 
    else:
312
 
        orig_dir_fd = -1
313
 
 
 
280
    cdef char *cwd
 
281
 
 
282
    cwd = getcwd(NULL, 0)
 
283
    if -1 == chdir(path):
 
284
        raise OSError(errno, strerror(errno))
 
285
    the_dir = opendir(".")
 
286
    if NULL == the_dir:
 
287
        raise OSError(errno, strerror(errno))
 
288
    result = []
314
289
    try:
315
 
        the_dir = opendir(".")
316
 
        if NULL == the_dir:
317
 
            raise_os_error(errno, "opendir: ", path)
318
 
        try:
319
 
            result = []
320
 
            entry = &sentinel
321
 
            while entry != NULL:
322
 
                # Unlike most libc functions, readdir needs errno set to 0
323
 
                # beforehand so that eof can be distinguished from errors.  See
324
 
                # <https://bugs.launchpad.net/bzr/+bug/279381>
325
 
                while True:
326
 
                    errno = 0
327
 
                    entry = readdir(the_dir)
328
 
                    if entry == NULL and (errno == EAGAIN or errno == EINTR):
329
 
                        if errno == EINTR:
330
 
                            PyErr_CheckSignals()
331
 
                        # try again
332
 
                        continue
333
 
                    else:
334
 
                        break
335
 
                if entry == NULL:
336
 
                    if errno == ENOTDIR or errno == 0:
337
 
                        # We see ENOTDIR at the end of a normal directory.
338
 
                        # As ENOTDIR for read_dir(file) is triggered on opendir,
339
 
                        # we consider ENOTDIR to be 'no error'.
340
 
                        continue
341
 
                    else:
342
 
                        raise_os_error(errno, "readdir: ", path)
343
 
                name = entry.d_name
344
 
                if not (name[0] == c"." and (
345
 
                    (name[1] == 0) or 
346
 
                    (name[1] == c"." and name[2] == 0))
347
 
                    ):
348
 
                    statvalue = _Stat()
349
 
                    stat_result = lstat(entry.d_name, &statvalue._st)
350
 
                    if stat_result != 0:
351
 
                        if errno != ENOENT:
352
 
                            raise_os_error(errno, "lstat: ",
353
 
                                path + "/" + entry.d_name)
354
 
                        else:
355
 
                            # the file seems to have disappeared after being
356
 
                            # seen by readdir - perhaps a transient temporary
357
 
                            # file.  there's no point returning it.
358
 
                            continue
359
 
                    # We append a 5-tuple that can be modified in-place by the C
360
 
                    # api:
361
 
                    # inode to sort on (to replace with top_path)
362
 
                    # name (to keep)
363
 
                    # kind (None, to set)
364
 
                    # statvalue (to keep)
365
 
                    # abspath (None, to set)
366
 
                    PyList_Append(result, (entry.d_ino, entry.d_name, None,
367
 
                        statvalue, None))
368
 
        finally:
369
 
            if -1 == closedir(the_dir):
370
 
                raise_os_error(errno, "closedir: ", path)
 
290
        entry = &sentinel
 
291
        while entry != NULL:
 
292
            entry = readdir(the_dir)
 
293
            if entry == NULL:
 
294
                if errno == EAGAIN:
 
295
                    # try again
 
296
                    continue
 
297
                elif errno != ENOTDIR and errno != ENOENT and errno != 0:
 
298
                    # We see ENOTDIR at the end of a normal directory.
 
299
                    # As ENOTDIR for read_dir(file) is triggered on opendir,
 
300
                    # we consider ENOTDIR to be 'no error'.
 
301
                    # ENOENT is listed as 'invalid position in the dir stream' for
 
302
                    # readdir. We swallow this for now and just keep reading.
 
303
                    raise OSError(errno, strerror(errno))
 
304
                else:
 
305
                    # done
 
306
                    continue
 
307
            name = entry.d_name
 
308
            if not (name[0] == c"." and (
 
309
                (name[1] == 0) or 
 
310
                (name[1] == c"." and name[2] == 0))
 
311
                ):
 
312
                statvalue = _Stat()
 
313
                stat_result = lstat(entry.d_name, &statvalue._st)
 
314
                if stat_result != 0:
 
315
                    if errno != ENOENT:
 
316
                        raise OSError(errno, strerror(errno))
 
317
                    else:
 
318
                        kind = _missing
 
319
                        statvalue = None
 
320
                # We append a 5-tuple that can be modified in-place by the C
 
321
                # api:
 
322
                # inode to sort on (to replace with top_path)
 
323
                # name (to keep)
 
324
                # kind (None, to set)
 
325
                # statvalue (to keep)
 
326
                # abspath (None, to set)
 
327
                PyList_Append(result, (entry.d_ino, entry.d_name, None,
 
328
                    statvalue, None))
371
329
    finally:
372
 
        if -1 != orig_dir_fd:
373
 
            failed = False
374
 
            if -1 == fchdir(orig_dir_fd):
375
 
                # try to close the original directory anyhow
376
 
                failed = True
377
 
            if -1 == close(orig_dir_fd) or failed:
378
 
                raise_os_error(errno, "return to orig_dir: ", "")
379
 
 
 
330
        if -1 == chdir(cwd):
 
331
            free(cwd)
 
332
            raise OSError(errno, strerror(errno))
 
333
        free(cwd)
 
334
        if -1 == closedir(the_dir):
 
335
            raise OSError(errno, strerror(errno))
380
336
    return result
381
337
 
382
338