1 /* help detect directory cycles efficiently
3 Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; see the file COPYING.
17 If not, write to the Free Software Foundation,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
20 /* Written by Jim Meyering */
26 #include <sys/types.h>
34 #include "cycle-check.h"
36 #define CC_MAGIC 9827862
38 /* Return true if I is a power of 2, or is zero. */
41 is_zero_or_power_of_two (uintmax_t i)
43 return (i & (i - 1)) == 0;
47 cycle_check_init (struct cycle_check_state *state)
49 state->chdir_counter = 0;
50 state->magic = CC_MAGIC;
53 /* In traversing a directory hierarchy, call this function once for each
54 descending chdir call, with SB corresponding to the chdir operand.
55 If SB corresponds to a directory that has already been seen,
56 return true to indicate that there is a directory cycle.
57 Note that this is done `lazily', which means that some of
58 the directories in the cycle may be processed twice before
59 the cycle is detected. */
62 cycle_check (struct cycle_check_state *state, struct stat const *sb)
64 assert (state->magic == CC_MAGIC);
66 /* If the current directory ever happens to be the same
67 as the one we last recorded for the cycle detection,
68 then it's obviously part of a cycle. */
69 if (state->chdir_counter && SAME_INODE (*sb, state->dev_ino))
72 /* If the number of `descending' chdir calls is a power of two,
73 record the dev/ino of the current directory. */
74 if (is_zero_or_power_of_two (++(state->chdir_counter)))
76 /* On all architectures that we know about, if the counter
77 overflows then there is a directory cycle here somewhere,
78 even if we haven't detected it yet. Typically this happens
79 only after the counter is incremented 2**64 times, so it's a
80 fairly theoretical point. */
81 if (state->chdir_counter == 0)
84 state->dev_ino.st_dev = sb->st_dev;
85 state->dev_ino.st_ino = sb->st_ino;