xref: /onnv-gate/usr/src/lib/libntfs/common/include/ntfs/support.h (revision 9663:ace9a2ac3683)
1*9663SMark.Logan@Sun.COM /*
2*9663SMark.Logan@Sun.COM  * support.h - Various useful things. Part of the Linux-NTFS project.
3*9663SMark.Logan@Sun.COM  *
4*9663SMark.Logan@Sun.COM  * Copyright (c) 2000-2004 Anton Altaparmakov
5*9663SMark.Logan@Sun.COM  * Copyright (c)      2006 Szabolcs Szakacsits
6*9663SMark.Logan@Sun.COM  * Copyright (c)      2006 Yura Pakhuchiy
7*9663SMark.Logan@Sun.COM  *
8*9663SMark.Logan@Sun.COM  * This program/include file is free software; you can redistribute it and/or
9*9663SMark.Logan@Sun.COM  * modify it under the terms of the GNU General Public License as published
10*9663SMark.Logan@Sun.COM  * by the Free Software Foundation; either version 2 of the License, or
11*9663SMark.Logan@Sun.COM  * (at your option) any later version.
12*9663SMark.Logan@Sun.COM  *
13*9663SMark.Logan@Sun.COM  * This program/include file is distributed in the hope that it will be
14*9663SMark.Logan@Sun.COM  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
15*9663SMark.Logan@Sun.COM  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16*9663SMark.Logan@Sun.COM  * GNU General Public License for more details.
17*9663SMark.Logan@Sun.COM  *
18*9663SMark.Logan@Sun.COM  * You should have received a copy of the GNU General Public License
19*9663SMark.Logan@Sun.COM  * along with this program (in the main directory of the Linux-NTFS
20*9663SMark.Logan@Sun.COM  * distribution in the file COPYING); if not, write to the Free Software
21*9663SMark.Logan@Sun.COM  * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22*9663SMark.Logan@Sun.COM  */
23*9663SMark.Logan@Sun.COM 
24*9663SMark.Logan@Sun.COM #ifndef _NTFS_SUPPORT_H
25*9663SMark.Logan@Sun.COM #define _NTFS_SUPPORT_H
26*9663SMark.Logan@Sun.COM 
27*9663SMark.Logan@Sun.COM #ifdef HAVE_CONFIG_H
28*9663SMark.Logan@Sun.COM #include "config.h"
29*9663SMark.Logan@Sun.COM #endif
30*9663SMark.Logan@Sun.COM 
31*9663SMark.Logan@Sun.COM #ifdef HAVE_STDDEF_H
32*9663SMark.Logan@Sun.COM #include <stddef.h>
33*9663SMark.Logan@Sun.COM #endif
34*9663SMark.Logan@Sun.COM 
35*9663SMark.Logan@Sun.COM #ifdef HAVE_STDLIB_H
36*9663SMark.Logan@Sun.COM #include <stdlib.h>
37*9663SMark.Logan@Sun.COM #endif
38*9663SMark.Logan@Sun.COM 
39*9663SMark.Logan@Sun.COM #include "logging.h"
40*9663SMark.Logan@Sun.COM 
41*9663SMark.Logan@Sun.COM /*
42*9663SMark.Logan@Sun.COM  * Our mailing list. Use this define to prevent typos in email address.
43*9663SMark.Logan@Sun.COM  */
44*9663SMark.Logan@Sun.COM #define NTFS_DEV_LIST	"linux-ntfs-dev@lists.sf.net"
45*9663SMark.Logan@Sun.COM 
46*9663SMark.Logan@Sun.COM /*
47*9663SMark.Logan@Sun.COM  * Generic macro to convert pointers to values for comparison purposes.
48*9663SMark.Logan@Sun.COM  */
49*9663SMark.Logan@Sun.COM #ifndef p2n
50*9663SMark.Logan@Sun.COM #define p2n(p)		((ptrdiff_t)((ptrdiff_t*)(p)))
51*9663SMark.Logan@Sun.COM #endif
52*9663SMark.Logan@Sun.COM 
53*9663SMark.Logan@Sun.COM /*
54*9663SMark.Logan@Sun.COM  * The classic min and max macros.
55*9663SMark.Logan@Sun.COM  */
56*9663SMark.Logan@Sun.COM #ifndef min
57*9663SMark.Logan@Sun.COM #define min(a,b)	((a) <= (b) ? (a) : (b))
58*9663SMark.Logan@Sun.COM #endif
59*9663SMark.Logan@Sun.COM 
60*9663SMark.Logan@Sun.COM #ifndef max
61*9663SMark.Logan@Sun.COM #define max(a,b)	((a) >= (b) ? (a) : (b))
62*9663SMark.Logan@Sun.COM #endif
63*9663SMark.Logan@Sun.COM 
64*9663SMark.Logan@Sun.COM /*
65*9663SMark.Logan@Sun.COM  * Useful macro for determining the offset of a struct member.
66*9663SMark.Logan@Sun.COM  */
67*9663SMark.Logan@Sun.COM #ifndef offsetof
68*9663SMark.Logan@Sun.COM #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
69*9663SMark.Logan@Sun.COM #endif
70*9663SMark.Logan@Sun.COM 
71*9663SMark.Logan@Sun.COM /*
72*9663SMark.Logan@Sun.COM  * Round up and down @num to 2 in power of @order.
73*9663SMark.Logan@Sun.COM  */
74*9663SMark.Logan@Sun.COM #define ROUND_UP(num,order)	(((num) + ((1 << (order)) - 1)) & \
75*9663SMark.Logan@Sun.COM 				~((1 << (order)) - 1))
76*9663SMark.Logan@Sun.COM #define ROUND_DOWN(num,order)	((num) & ~((1 << (order)) - 1))
77*9663SMark.Logan@Sun.COM 
78*9663SMark.Logan@Sun.COM /*
79*9663SMark.Logan@Sun.COM  * Simple bit operation macros. NOTE: These are NOT atomic.
80*9663SMark.Logan@Sun.COM  */
81*9663SMark.Logan@Sun.COM #define test_bit(bit, var)	      ((var) & (1 << (bit)))
82*9663SMark.Logan@Sun.COM #define set_bit(bit, var)	      (var) |= 1 << (bit)
83*9663SMark.Logan@Sun.COM #define clear_bit(bit, var)	      (var) &= ~(1 << (bit))
84*9663SMark.Logan@Sun.COM 
85*9663SMark.Logan@Sun.COM #ifdef __sun
86*9663SMark.Logan@Sun.COM #define test_and_set_bit(bit, var)	_test_and_set_bit(bit, &var)
_test_and_set_bit(unsigned long bit,unsigned long * var)87*9663SMark.Logan@Sun.COM static __inline__ BOOL _test_and_set_bit(unsigned long bit, unsigned long *var)
88*9663SMark.Logan@Sun.COM {
89*9663SMark.Logan@Sun.COM 	const BOOL old_state = test_bit(bit, *var);
90*9663SMark.Logan@Sun.COM 	set_bit(bit, *var);
91*9663SMark.Logan@Sun.COM 	return old_state;
92*9663SMark.Logan@Sun.COM }
93*9663SMark.Logan@Sun.COM 
94*9663SMark.Logan@Sun.COM #define test_and_clear_bit(bit, var)	_test_and_clear_bit(bit, &var)
_test_and_clear_bit(unsigned long bit,unsigned long * var)95*9663SMark.Logan@Sun.COM static __inline__ BOOL _test_and_clear_bit(unsigned long bit, unsigned long *var)
96*9663SMark.Logan@Sun.COM {
97*9663SMark.Logan@Sun.COM 	const BOOL old_state = test_bit(bit, *var);
98*9663SMark.Logan@Sun.COM 	clear_bit(bit, *var);
99*9663SMark.Logan@Sun.COM 	return old_state;
100*9663SMark.Logan@Sun.COM }
101*9663SMark.Logan@Sun.COM #else /* !__sun */
102*9663SMark.Logan@Sun.COM #define test_and_set_bit(bit, var)			\
103*9663SMark.Logan@Sun.COM ({							\
104*9663SMark.Logan@Sun.COM 	const BOOL old_state = test_bit(bit, var);	\
105*9663SMark.Logan@Sun.COM 	set_bit(bit, var);				\
106*9663SMark.Logan@Sun.COM 	old_state;					\
107*9663SMark.Logan@Sun.COM })
108*9663SMark.Logan@Sun.COM 
109*9663SMark.Logan@Sun.COM #define test_and_clear_bit(bit, var)			\
110*9663SMark.Logan@Sun.COM ({							\
111*9663SMark.Logan@Sun.COM 	const BOOL old_state = test_bit(bit, var);	\
112*9663SMark.Logan@Sun.COM 	clear_bit(bit, var);				\
113*9663SMark.Logan@Sun.COM 	old_state;					\
114*9663SMark.Logan@Sun.COM })
115*9663SMark.Logan@Sun.COM #endif /* __sun */
116*9663SMark.Logan@Sun.COM 
117*9663SMark.Logan@Sun.COM /* Memory allocation with logging. */
118*9663SMark.Logan@Sun.COM extern void *ntfs_calloc(size_t size);
119*9663SMark.Logan@Sun.COM extern void *ntfs_malloc(size_t size);
120*9663SMark.Logan@Sun.COM 
121*9663SMark.Logan@Sun.COM #endif /* defined _NTFS_SUPPORT_H */
122