Move GLOCK initialisation to platform directories
[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 #include <linux/version.h>
19 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,4)
20 #define AFS_LINUX26_ONEGROUP_ENV 1
21 #endif
22
23 /* Only needed for xdr.h in glibc 2.1.x */
24 #ifndef quad_t
25 #define quad_t __quad_t
26 #define u_quad_t __u_quad_t
27 #endif
28
29 #undef getuerror
30
31 #ifdef STRUCT_TASK_STRUCT_HAS_TGID
32 #define getpid() current->tgid
33 #ifdef STRUCT_TASK_STRUCT_HAS_REAL_PARENT
34 #define getppid() current->real_parent->tgid
35 #elif defined(STRUCT_TASK_STRUCT_HAS_PARENT)
36 #define getppid() current->parent->tgid
37 #else
38 #define getppid() current->p_opptr->tgid
39 #endif
40 #else /* !STRUCT_TASK_STRUCT_HAS_TGID */
41 #define getpid() current->pid
42 #ifdef STRUCT_TASK_STRUCT_HAS_REAL_PARENT
43 #define getppid() current->real_parent->pid
44 #elif defined(STRUCT_TASK_STRUCT_HAS_PARENT)
45 #define getppid() current->parent->pid
46 #else
47 #define getppid() current->p_opptr->pid
48 #endif
49 #endif /* STRUCT_TASK_STRUCT_HAS_TGID */
50
51 #ifdef RECALC_SIGPENDING_TAKES_VOID
52 #define RECALC_SIGPENDING(X) recalc_sigpending()
53 #else
54 #define RECALC_SIGPENDING(X) recalc_sigpending(X)
55 #endif
56
57 #if defined (STRUCT_TASK_STRUCT_HAS_SIGMASK_LOCK)
58 #define SIG_LOCK(X) spin_lock_irq(&X->sigmask_lock)
59 #define SIG_UNLOCK(X) spin_unlock_irq(&X->sigmask_lock)
60 #elif defined (STRUCT_TASK_STRUCT_HAS_SIGHAND)
61 #define SIG_LOCK(X) spin_lock_irq(&X->sighand->siglock)
62 #define SIG_UNLOCK(X) spin_unlock_irq(&X->sighand->siglock)
63 #else
64 #define SIG_LOCK(X) spin_lock_irq(&X->sig->siglock)
65 #define SIG_UNLOCK(X) spin_unlock_irq(&X->sig->siglock)
66 #endif
67
68 #if defined (STRUCT_TASK_STRUCT_HAS_RLIM)
69 #define TASK_STRUCT_RLIM rlim
70 #elif defined (STRUCT_TASK_STRUCT_HAS_SIGNAL_RLIM)
71 #define TASK_STRUCT_RLIM signal->rlim
72 #else
73 #error Not sure what to do about rlim (should be in the Linux task struct somewhere....)
74 #endif
75
76
77 #define afs_hz HZ
78 #include "h/sched.h"
79 #if defined(HAVE_CURRENT_KERNEL_TIME)
80 static inline time_t osi_Time(void) { 
81     struct timespec xtime;
82     xtime = current_kernel_time();
83     return xtime.tv_sec;
84 }
85 #else
86 #define osi_Time() (xtime.tv_sec)
87 #endif
88
89
90
91 #ifdef AFS_LINUX_64BIT_KERNEL
92 #define osi_GetTime(V)                                 \
93     do {                                               \
94        struct timeval __afs_tv;                              \
95        do_gettimeofday(&__afs_tv);                           \
96        (V)->tv_sec = (afs_int32)__afs_tv.tv_sec;             \
97        (V)->tv_usec = (afs_int32)__afs_tv.tv_usec;           \
98     } while (0)
99 #else
100 #define osi_GetTime(V) do_gettimeofday((V))
101 #endif
102
103 #undef gop_lookupname
104 #define gop_lookupname osi_lookupname
105
106 #undef gop_lookupname_user
107 #define gop_lookupname_user osi_lookupname
108
109 #define osi_vnhold(V, N) do { VN_HOLD(AFSTOV(V)); } while (0)
110 #define VN_HOLD(V) osi_Assert(igrab((V)) == (V))
111 #define VN_RELE(V) iput((V))
112
113 #define afs_suser(x) capable(CAP_SYS_ADMIN)
114 #define wakeup afs_osi_Wakeup
115
116 #define vType(V) ((AFSTOV((V)))->i_mode & S_IFMT)
117 #define vSetType(V, type) AFSTOV((V))->i_mode = ((type) | (AFSTOV((V))->i_mode & ~S_IFMT))      /* preserve mode */
118 #define vSetVfsp(V, vfsp)                               /* unused */
119 #define IsAfsVnode(V) ((V)->i_sb == afs_globalVFS)      /* test superblock instead */
120 #define SetAfsVnode(V)                                  /* unnecessary */
121
122 /* We often need to pretend we're in user space to get memory transfers
123  * right for the kernel calls we use.
124  */
125 #include <asm/uaccess.h>
126
127 #ifdef KERNEL_SPACE_DECL
128 #undef KERNEL_SPACE_DECL
129 #undef TO_USER_SPACE
130 #undef TO_KERNEL_SPACE
131 #endif
132 #define KERNEL_SPACE_DECL mm_segment_t _fs_space_decl={0}
133 #define TO_USER_SPACE() { _fs_space_decl = get_fs(); set_fs(get_ds()); }
134 #define TO_KERNEL_SPACE() set_fs(_fs_space_decl)
135
136 #define copyin(F, T, C)  (copy_from_user ((char*)(T), (char*)(F), (C)) > 0 ? EFAULT : 0)
137 static inline long copyinstr(char *from, char *to, int count, int *length) {
138     long tmp;
139     tmp = strncpy_from_user(to, from, count);
140     if (tmp < 0)
141             return EFAULT;
142     *length = tmp;
143     return 0;
144 }
145 #define copyout(F, T, C) (copy_to_user ((char*)(T), (char*)(F), (C)) > 0 ? EFAULT : 0)
146
147 /* kernel print statements */
148 #define printf printk
149 #define uprintf printk
150
151
152 #ifndef NGROUPS
153 #define NGROUPS NGROUPS_SMALL
154 #endif
155
156 typedef struct task_struct afs_proc_t;
157
158 /* Credentials.  For newer kernels we use the kernel structure directly. */
159 #if defined(STRUCT_TASK_HAS_CRED)
160
161 typedef struct cred afs_ucred_t;
162 typedef struct cred cred_t;
163
164 #define afs_cr_uid(cred) ((cred)->fsuid)
165 #define afs_cr_gid(cred) ((cred)->fsgid)
166 #define afs_cr_ruid(cred) ((cred)->uid)
167 #define afs_cr_rgid(cred) ((cred)->gid)
168 #define afs_cr_group_info(cred) ((cred)->group_info)
169 #define crhold(c) (get_cred(c))
170 static inline void
171 afs_set_cr_uid(cred_t *cred, uid_t uid) {
172     cred->fsuid = uid;
173 }
174 static inline void
175 afs_set_cr_gid(cred_t *cred, gid_t gid) {
176     cred->fsgid = gid;
177 }
178 static inline void
179 afs_set_cr_ruid(cred_t *cred, uid_t uid) {
180     cred->uid = uid;
181 }
182 static inline void
183 afs_set_cr_rgid(cred_t *cred, gid_t gid) {
184     cred->gid = gid;
185 }
186 static inline void
187 afs_set_cr_group_info(cred_t *cred, struct group_info *group_info) {
188     cred->group_info = group_info;
189 }
190
191 #define current_group_info() (current->cred->group_info)
192 #define task_gid(task) (task->cred->gid)
193 #define task_user(task) (task->cred->user)
194 #define task_session_keyring(task) (task->cred->tgcred->session_keyring)
195 #define current_session_keyring() (current->cred->tgcred->session_keyring)
196
197 #else
198
199 typedef struct afs_cred {
200     atomic_t cr_ref;
201     uid_t cr_uid;
202     uid_t cr_ruid;
203     gid_t cr_gid;
204     gid_t cr_rgid;
205     struct group_info *cr_group_info;
206 } cred_t;
207
208 typedef struct afs_cred afs_ucred_t;
209 #define afs_cr_group_info(cred) ((cred)->cr_group_info)
210 static inline void
211 afs_set_cr_group_info(cred_t *cred, struct group_info *group_info) {
212     cred->cr_group_info = group_info;
213 }
214
215 #define current_group_info() (current->group_info)
216 #if !defined(task_gid)
217 #define task_gid(task) (task->gid)
218 #endif
219 #if !defined(task_uid)
220 #define task_uid(task) (task->uid)
221 #endif
222 #define task_user(task) (task->user)
223 #define task_session_keyring(task) (task->signal->session_keyring)
224 #define current_session_keyring() (current->signal->session_keyring)
225 #define crhold(c) atomic_inc(&(c)->cr_ref)
226
227 #endif /* defined(STRUCT_TASK_HAS_CRED) */
228
229 #if !defined(current_cred)
230 #define current_gid() (current->gid)
231 #define current_uid() (current->uid)
232 #define current_fsgid() (current->fsgid)
233 #define current_fsuid() (current->fsuid)
234 #endif
235
236 /* UIO manipulation */
237 typedef enum { AFS_UIOSYS, AFS_UIOUSER } uio_seg_t;
238 typedef enum { UIO_READ, UIO_WRITE } uio_flag_t;
239 typedef struct uio {
240     struct iovec *uio_iov;
241     int uio_iovcnt;
242     afs_offs_t uio_offset;
243     uio_seg_t uio_seg;
244     int uio_resid;
245     uio_flag_t uio_flag;
246 } uio_t;
247 #define afsio_iov       uio_iov
248 #define afsio_iovcnt    uio_iovcnt
249 #define afsio_offset    uio_offset
250 #define afsio_seg       uio_segflg
251 #define afsio_fmode     uio_fmode
252 #define afsio_resid     uio_resid
253
254 /* Get/set the inode in the osifile struct. */
255 #define FILE_INODE(F) (F)->f_dentry->d_inode
256
257 #define OSIFILE_INODE(a) FILE_INODE((a)->filp)
258
259 #if defined(AFS_LINUX_64BIT_KERNEL) && !defined(AFS_ALPHA_LINUX20_ENV) && !defined(AFS_IA64_LINUX20_ENV)
260 #define NEED_IOCTL32
261 #endif
262
263 #if defined(__KERNEL__)
264 #include <linux/version.h>
265 #include <linux/sched.h>
266 #include <linux/wait.h>
267
268 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,16)
269 extern struct mutex afs_global_lock;
270 #else
271 extern struct semaphore afs_global_lock;
272 #define mutex_lock(lock) down(lock)
273 #define mutex_unlock(lock) up(lock)
274 #endif
275 extern int afs_global_owner;
276
277 #define AFS_GLOCK() \
278 do { \
279          mutex_lock(&afs_global_lock); \
280          if (afs_global_owner) \
281              osi_Panic("afs_global_lock already held by pid %d", \
282                        afs_global_owner); \
283          afs_global_owner = current->pid; \
284 } while (0)
285
286 #define ISAFS_GLOCK() (afs_global_owner == current->pid)
287
288 #define AFS_GUNLOCK() \
289 do { \
290     if (!ISAFS_GLOCK()) \
291         osi_Panic("afs global lock not held at %s:%d", __FILE__, __LINE__); \
292     afs_global_owner = 0; \
293     mutex_unlock(&afs_global_lock); \
294 } while (0)
295
296 #define osi_InitGlock()
297
298 #else
299 #define AFS_GLOCK()
300 #define AFS_GUNLOCK()
301 #define ISAFS_GLOCK() 1
302 #define AFS_ASSERT_GLOCK()
303 #endif
304
305 #ifdef AFS_AMD64_LINUX20_ENV
306 /* RHEL5 beta's kernel doesn't define these. They aren't gonna change, so... */
307
308 #ifndef __NR_ia32_afs_syscall
309 #define __NR_ia32_afs_syscall 137
310 #endif
311 #ifndef __NR_ia32_setgroups
312 #define __NR_ia32_setgroups 81
313 #endif
314 #ifndef __NR_ia32_setgroups32
315 #define __NR_ia32_setgroups32 206
316 #endif
317 #ifndef __NR_ia32_close
318 #define __NR_ia32_close 6
319 #endif
320 #ifndef __NR_ia32_chdir
321 #define __NR_ia32_chdir 12
322 #endif
323 #ifndef __NR_ia32_break
324 #define __NR_ia32_break 17
325 #endif
326 #ifndef __NR_ia32_stty
327 #define __NR_ia32_stty 31
328 #endif
329 #ifndef __NR_ia32_gtty
330 #define __NR_ia32_gtty 32
331 #endif
332 #ifndef __NR_ia32_ftime
333 #define __NR_ia32_ftime 35
334 #endif
335 #ifndef __NR_ia32_prof
336 #define __NR_ia32_prof 44
337 #endif
338 #ifndef __NR_ia32_lock
339 #define __NR_ia32_lock 53
340 #endif
341 #ifndef __NR_ia32_mpx
342 #define __NR_ia32_mpx 56
343 #endif
344 #ifndef __NR_ia32_exit
345 #define __NR_ia32_exit 1
346 #endif
347 #ifndef __NR_ia32_mount
348 #define __NR_ia32_mount 21
349 #endif
350 #ifndef __NR_ia32_read
351 #define __NR_ia32_read 3
352 #endif
353 #ifndef __NR_ia32_write
354 #define __NR_ia32_write 4
355 #endif
356 #ifndef __NR_ia32_open
357 #define __NR_ia32_open 5
358 #endif
359 #ifndef __NR_ia32_close
360 #define __NR_ia32_close 6
361 #endif
362 #ifndef __NR_ia32_unlink
363 #define __NR_ia32_unlink 10
364 #endif
365 #endif
366
367 #endif /* OSI_MACHDEP_H_ */