linux-crref-held-longer-20050320
[openafs.git] / src / afs / LINUX / osi_machdep.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 /*
11  * Linux implementation.
12  *
13  */
14
15 #ifndef OSI_MACHDEP_H_
16 #define OSI_MACHDEP_H_
17
18 /* Only needed for xdr.h in glibc 2.1.x */
19 #ifndef quad_t
20 #define quad_t __quad_t
21 #define u_quad_t __u_quad_t
22 #endif
23
24 #undef getuerror
25
26 #define getpid() current->pid
27 #ifdef STRUCT_TASK_STRUCT_HAS_REAL_PARENT
28 #define getppid() current->real_parent->pid
29 #else
30 #define getppid() current->p_opptr->pid
31 #endif
32
33 #ifdef RECALC_SIGPENDING_TAKES_VOID
34 #define RECALC_SIGPENDING(X) recalc_sigpending()
35 #else
36 #define RECALC_SIGPENDING(X) recalc_sigpending(X)
37 #endif
38
39 #if defined (STRUCT_TASK_STRUCT_HAS_SIGMASK_LOCK)
40 #define SIG_LOCK(X) spin_lock_irq(&X->sigmask_lock)
41 #define SIG_UNLOCK(X) spin_unlock_irq(&X->sigmask_lock)
42 #elif defined (STRUCT_TASK_STRUCT_HAS_SIGHAND)
43 #define SIG_LOCK(X) spin_lock_irq(&X->sighand->siglock)
44 #define SIG_UNLOCK(X) spin_unlock_irq(&X->sighand->siglock)
45 #else
46 #define SIG_LOCK(X) spin_lock_irq(&X->sig->siglock)
47 #define SIG_UNLOCK(X) spin_unlock_irq(&X->sig->siglock)
48 #endif
49
50 #if defined (STRUCT_TASK_STRUCT_HAS_RLIM)
51 #define TASK_STRUCT_RLIM rlim
52 #elif defined (STRUCT_TASK_STRUCT_HAS_SIGNAL_RLIM)
53 #define TASK_STRUCT_RLIM signal->rlim
54 #else
55 #error Not sure what to do about rlim (should be in the Linux task struct somewhere....)
56 #endif
57
58
59 #define afs_hz HZ
60 #include "h/sched.h"
61 #define osi_Time() (xtime.tv_sec)
62 #ifdef AFS_LINUX_64BIT_KERNEL
63 #define osi_GetTime(V)                                 \
64     do {                                               \
65        struct timeval __afs_tv;                              \
66        do_gettimeofday(&__afs_tv);                           \
67        (V)->tv_sec = (afs_int32)__afs_tv.tv_sec;             \
68        (V)->tv_usec = (afs_int32)__afs_tv.tv_usec;           \
69     } while (0)
70 #else
71 #define osi_GetTime(V) do_gettimeofday((V))
72 #endif
73
74 #undef gop_lookupname
75 #define gop_lookupname osi_lookupname
76
77 #define osi_vnhold(v, n) do { VN_HOLD(AFSTOV(v)); } while (0)
78
79 #if defined(AFS_LINUX24_ENV)
80 #define VN_HOLD(V) atomic_inc(&((vnode_t *) V)->i_count)
81 #else
82 #define VN_HOLD(V) ((vnode_t *) V)->i_count++
83 #endif
84
85 #if defined(AFS_LINUX26_ENV)
86 #define VN_RELE(V) iput((struct inode *) V)
87 #else
88 #define VN_RELE(V) osi_iput((struct inode *) V)
89 #endif
90
91 #define osi_AllocSmall afs_osi_Alloc
92 #define osi_FreeSmall afs_osi_Free
93
94 #define afs_suser(x) capable(CAP_SYS_ADMIN)
95 #define wakeup afs_osi_Wakeup
96
97 #undef vType
98 #define vType(V) ((( vnode_t *)V)->v_type & S_IFMT)
99
100 /* IsAfsVnode relies on the fast that there is only one vnodeop table for AFS.
101  * Use the same type of test as other OS's for compatibility.
102  */
103 #undef IsAfsVnode
104 extern struct vnodeops afs_file_iops, afs_dir_iops, afs_symlink_iops;
105 #define IsAfsVnode(v) (((v)->v_op == &afs_file_iops) ? 1 : \
106                         ((v)->v_op == &afs_dir_iops) ? 1 : \
107                         ((v)->v_op == &afs_symlink_iops))
108 #undef SetAfsVnode
109 #define SetAfsVnode(v)
110
111 /* We often need to pretend we're in user space to get memory transfers
112  * right for the kernel calls we use.
113  */
114 #ifdef KERNEL_SPACE_DECL
115 #undef KERNEL_SPACE_DECL
116 #undef TO_USER_SPACE
117 #undef TO_KERNEL_SPACE
118 #endif
119 #define KERNEL_SPACE_DECL mm_segment_t _fs_space_decl
120 #define TO_USER_SPACE() { _fs_space_decl = get_fs(); set_fs(get_ds()); }
121 #define TO_KERNEL_SPACE() set_fs(_fs_space_decl)
122
123 /* Backwards compatibilty macros - copyin/copyout are redone because macro
124  * inside parentheses is not evalutated.
125  */
126 #define memcpy_fromfs copy_from_user
127 #define memcpy_tofs copy_to_user
128 #define copyin(F, T, C)  (copy_from_user ((char*)(T), (char*)(F), (C)), 0)
129 #define copyinstr(F, T, C, L) (copyin(F, T, C), *(L)=strlen(T), 0)
130 #define copyout(F, T, C) (copy_to_user ((char*)(T), (char*)(F), (C)), 0)
131
132 /* kernel print statements */
133 #define printf printk
134 #define uprintf printk
135
136
137 #define PAGESIZE PAGE_SIZE
138 #ifndef NGROUPS
139 #define NGROUPS NGROUPS_SMALL
140 #endif
141
142 /* cred struct */
143 typedef struct cred {           /* maps to task field: */
144     int cr_ref;
145     uid_t cr_uid;               /* euid */
146     uid_t cr_ruid;              /* uid */
147     gid_t cr_gid;               /* egid */
148     gid_t cr_rgid;              /* gid */
149 #if defined(AFS_LINUX26_ENV)
150     struct group_info *cr_group_info;
151 #else
152     gid_t cr_groups[NGROUPS];   /* 32 groups - empty set to NOGROUP */
153     int cr_ngroups;
154 #endif
155     struct cred *cr_next;
156 } cred_t;
157 #define AFS_UCRED cred
158 #define AFS_PROC struct task_struct
159 #define crhold(c) (c)->cr_ref++
160
161 /* UIO manipulation */
162 typedef enum { AFS_UIOSYS, AFS_UIOUSER } uio_seg_t;
163 typedef enum { UIO_READ, UIO_WRITE } uio_flag_t;
164 typedef struct uio {
165     struct iovec *uio_iov;
166     int uio_iovcnt;
167     afs_offs_t uio_offset;
168     uio_seg_t uio_seg;
169     int uio_resid;
170     uio_flag_t uio_flag;
171 } uio_t;
172 #define afsio_iov       uio_iov
173 #define afsio_iovcnt    uio_iovcnt
174 #define afsio_offset    uio_offset
175 #define afsio_seg       uio_segflg
176 #define afsio_fmode     uio_fmode
177 #define afsio_resid     uio_resid
178
179 /* Get/set the inode in the osifile struct. */
180 #define FILE_INODE(F) (F)->f_dentry->d_inode
181
182
183 /* page offset is obtained and stored here during module initialization 
184  * We need a variable to do this because, the PAGE_OFFSET macro defined in
185  * include/asm/page.h can change from kernel to kernel and we cannot use
186  * the hardcoded version.
187  */
188 extern unsigned long afs_linux_page_offset;
189
190 /* function to help with the page offset stuff */
191 #define afs_linux_page_address(page) (afs_linux_page_offset + PAGE_SIZE * (page - mem_map))
192
193 #if defined(__KERNEL__) && defined(CONFIG_SMP)
194 #include "../h/sched.h"
195 #include "linux/wait.h"
196
197 extern struct semaphore afs_global_lock;
198 extern int afs_global_owner;
199
200 #define AFS_GLOCK() \
201 do { \
202          down(&afs_global_lock); \
203          if (afs_global_owner) \
204              osi_Panic("afs_global_lock already held by pid %d", \
205                        afs_global_owner); \
206          afs_global_owner = current->pid; \
207 } while (0)
208
209 #define ISAFS_GLOCK() (afs_global_owner == current->pid)
210
211 #define AFS_GUNLOCK() \
212 do { \
213     if (!ISAFS_GLOCK()) \
214         osi_Panic("afs global lock not held at %s:%d", __FILE__, __LINE__); \
215     afs_global_owner = 0; \
216     up(&afs_global_lock); \
217 } while (0)
218
219
220 #else
221 #define AFS_GLOCK()
222 #define AFS_GUNLOCK()
223 #define ISAFS_GLOCK() 1
224 #define AFS_ASSERT_GLOCK()
225 #define AFS_ASSERT_RXGLOCK()
226 #endif
227
228 #define AFS_RXGLOCK()
229 #define AFS_RXGUNLOCK()
230 #define ISAFS_RXGLOCK() 1
231 #endif /* OSI_MACHDEP_H_ */