dangling-comments-are-bad-20040504
[openafs.git] / src / afs / LINUX / osi_misc.c
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 support routines.
12  *
13  */
14 #include <afsconfig.h>
15 #include "afs/param.h"
16
17 RCSID
18     ("$Header$");
19
20 #include "afs/sysincludes.h"
21 #include "afsincludes.h"
22 #include "afs/afs_stats.h"
23 #if defined(AFS_LINUX24_ENV)
24 #include "h/smp_lock.h"
25 #endif
26 #if defined(AFS_LINUX26_ENV)
27 #include "h/namei.h"
28 #endif
29
30 #if defined(AFS_LINUX24_ENV)
31 /* Lookup name and return vnode for same. */
32 int
33 osi_lookupname(char *aname, uio_seg_t seg, int followlink,
34                         vnode_t ** dirvpp, struct dentry **dpp)
35 {
36     int code;
37     extern struct nameidata afs_cacheNd;
38     struct nameidata *nd = &afs_cacheNd;
39
40     code = ENOENT;
41     if (seg == AFS_UIOUSER) {
42         code =
43             followlink ? user_path_walk(aname,
44                                         nd) : user_path_walk_link(aname, nd);
45     } else {
46 #if defined(AFS_LINUX26_ENV)
47         code = path_lookup(aname, followlink ? LOOKUP_FOLLOW : 0, nd);
48 #else
49         if (path_init(aname, followlink ? LOOKUP_FOLLOW : 0, nd))
50             code = path_walk(aname, nd);
51 #endif
52     }
53
54     if (!code) {
55         if (nd->dentry->d_inode) {
56             *dpp = dget(nd->dentry);
57             code = 0;
58         } else {
59             code = ENOENT;
60             path_release(nd);
61         }
62     }
63     return code;
64 }
65 #else
66 int
67 osi_lookupname(char *aname, uio_seg_t seg, int followlink, vnode_t ** dirvpp,
68                struct dentry **dpp)
69 {
70     struct dentry *dp = NULL;
71     int code;
72
73     code = ENOENT;
74     if (seg == AFS_UIOUSER) {
75         dp = followlink ? namei(aname) : lnamei(aname);
76     } else {
77         dp = lookup_dentry(aname, NULL, followlink ? 1 : 0);
78     }
79
80     if (dp && !IS_ERR(dp)) {
81         if (dp->d_inode) {
82             *dpp = dp;
83             code = 0;
84         } else
85             dput(dp);
86     }
87
88     return code;
89 }
90 #endif
91
92 /* Intialize cache device info and fragment size for disk cache partition. */
93 int
94 osi_InitCacheInfo(char *aname)
95 {
96     int code;
97     struct dentry *dp;
98     extern ino_t cacheInode;
99     extern struct osi_dev cacheDev;
100     extern afs_int32 afs_fsfragsize;
101     extern struct super_block *afs_cacheSBp;
102     code = osi_lookupname(aname, AFS_UIOSYS, 1, NULL, &dp);
103     if (code)
104         return ENOENT;
105
106     cacheInode = dp->d_inode->i_ino;
107     cacheDev.dev = dp->d_inode->i_sb->s_dev;
108     afs_fsfragsize = dp->d_inode->i_sb->s_blocksize - 1;
109     afs_cacheSBp = dp->d_inode->i_sb;
110
111     dput(dp);
112
113     return 0;
114 }
115
116
117 #define FOP_READ(F, B, C) (F)->f_op->read(F, B, (size_t)(C), &(F)->f_pos)
118 #define FOP_WRITE(F, B, C) (F)->f_op->write(F, B, (size_t)(C), &(F)->f_pos)
119
120 /* osi_rdwr
121  * Seek, then read or write to an open inode. addrp points to data in
122  * kernel space.
123  */
124 int
125 osi_rdwr(int rw, struct osi_file *file, caddr_t addrp, size_t asize,
126          size_t * resid)
127 {
128     int code = 0;
129     KERNEL_SPACE_DECL;
130     struct file *filp = &file->file;
131     off_t offset = file->offset;
132     unsigned long savelim;
133
134     /* Seek to the desired position. Return -1 on error. */
135     if (filp->f_op->llseek) {
136         if (filp->f_op->llseek(filp, (loff_t) offset, 0) != offset)
137             return -1;
138     } else
139         filp->f_pos = offset;
140
141     savelim = current->rlim[RLIMIT_FSIZE].rlim_cur;
142     current->rlim[RLIMIT_FSIZE].rlim_cur = RLIM_INFINITY;
143
144     /* Read/Write the data. */
145     TO_USER_SPACE();
146     if (rw == UIO_READ)
147         code = FOP_READ(filp, addrp, asize);
148     else if (rw == UIO_WRITE)
149         code = FOP_WRITE(filp, addrp, asize);
150     else                        /* all is well? */
151         code = asize;
152     TO_KERNEL_SPACE();
153
154     current->rlim[RLIMIT_FSIZE].rlim_cur = savelim;
155
156     if (code >= 0) {
157         *resid = asize - code;
158         return 0;
159     } else
160         return -1;
161 }
162
163 /* This variant is called from AFS read/write routines and takes a uio
164  * struct and, if successful, returns 0.
165  */
166 int
167 osi_file_uio_rdwr(struct osi_file *osifile, uio_t * uiop, int rw)
168 {
169     struct file *filp = &osifile->file;
170     struct inode *ip = FILE_INODE(&osifile->file);
171     KERNEL_SPACE_DECL;
172     int code = 0;
173     struct iovec *iov;
174     int count;
175     unsigned long savelim;
176
177     savelim = current->rlim[RLIMIT_FSIZE].rlim_cur;
178     current->rlim[RLIMIT_FSIZE].rlim_cur = RLIM_INFINITY;
179
180     if (uiop->uio_seg == AFS_UIOSYS)
181         TO_USER_SPACE();
182
183     filp->f_pos = uiop->uio_offset;
184     while (code == 0 && uiop->uio_resid > 0 && uiop->uio_iovcnt > 0) {
185         iov = uiop->uio_iov;
186         count = iov->iov_len;
187         if (count == 0) {
188             uiop->uio_iov++;
189             uiop->uio_iovcnt--;
190             continue;
191         }
192
193         if (rw == UIO_READ)
194             code = FOP_READ(filp, iov->iov_base, count);
195         else
196             code = FOP_WRITE(filp, iov->iov_base, count);
197
198         if (code < 0) {
199             code = -code;
200             break;
201         } else if (code == 0) {
202             /*
203              * This is bad -- we can't read any more data from the
204              * file, but we have no good way of signaling a partial
205              * read either.
206              */
207             code = EIO;
208             break;
209         }
210
211         iov->iov_base += code;
212         iov->iov_len -= code;
213         uiop->uio_resid -= code;
214         uiop->uio_offset += code;
215         code = 0;
216     }
217
218     if (uiop->uio_seg == AFS_UIOSYS)
219         TO_KERNEL_SPACE();
220
221     current->rlim[RLIMIT_FSIZE].rlim_cur = savelim;
222
223     return code;
224 }
225
226 /* setup_uio 
227  * Setup a uio struct.
228  */
229 void
230 setup_uio(uio_t * uiop, struct iovec *iovecp, char *buf, afs_offs_t pos,
231           int count, uio_flag_t flag, uio_seg_t seg)
232 {
233     iovecp->iov_base = buf;
234     iovecp->iov_len = count;
235     uiop->uio_iov = iovecp;
236     uiop->uio_iovcnt = 1;
237     uiop->uio_offset = pos;
238     uiop->uio_seg = seg;
239     uiop->uio_resid = count;
240     uiop->uio_flag = flag;
241 }
242
243
244 /* uiomove
245  * UIO_READ : dp -> uio
246  * UIO_WRITE : uio -> dp
247  */
248 int
249 uiomove(char *dp, int length, uio_flag_t rw, uio_t * uiop)
250 {
251     int count, n;
252     struct iovec *iov;
253     int code;
254
255     while (length > 0 && uiop->uio_resid > 0 && uiop->uio_iovcnt > 0) {
256         iov = uiop->uio_iov;
257         count = iov->iov_len;
258
259         if (!count) {
260             uiop->uio_iov++;
261             uiop->uio_iovcnt--;
262             continue;
263         }
264
265         if (count > length)
266             count = length;
267
268         switch (uiop->uio_seg) {
269         case AFS_UIOSYS:
270             switch (rw) {
271             case UIO_READ:
272                 memcpy(iov->iov_base, dp, count);
273                 break;
274             case UIO_WRITE:
275                 memcpy(dp, iov->iov_base, count);
276                 break;
277             default:
278                 printf("uiomove: Bad rw = %d\n", rw);
279                 return -EINVAL;
280             }
281             break;
282         case AFS_UIOUSER:
283             switch (rw) {
284             case UIO_READ:
285                 AFS_COPYOUT(dp, iov->iov_base, count, code);
286                 break;
287             case UIO_WRITE:
288                 AFS_COPYIN(iov->iov_base, dp, count, code);
289                 break;
290             default:
291                 printf("uiomove: Bad rw = %d\n", rw);
292                 return -EINVAL;
293             }
294             break;
295         default:
296             printf("uiomove: Bad seg = %d\n", uiop->uio_seg);
297             return -EINVAL;
298         }
299
300         dp += count;
301         length -= count;
302         iov->iov_base += count;
303         iov->iov_len -= count;
304         uiop->uio_offset += count;
305         uiop->uio_resid -= count;
306     }
307     return 0;
308 }
309
310 void
311 afs_osi_SetTime(osi_timeval_t * tvp)
312 {
313     extern int (*sys_settimeofdayp) (struct timeval * tv,
314                                      struct timezone * tz);
315 #ifdef AFS_LINUX_64BIT_KERNEL
316     struct timeval tv;
317     AFS_STATCNT(osi_SetTime);
318     tv.tv_sec = tvp->tv_sec;
319     tv.tv_usec = tvp->tv_usec;
320     (void)(*sys_settimeofdayp) (&tv, NULL);
321 #else
322     KERNEL_SPACE_DECL;
323
324     AFS_STATCNT(osi_SetTime);
325
326     TO_USER_SPACE();
327     (void)(*sys_settimeofdayp) (tvp, NULL);
328     TO_KERNEL_SPACE();
329 #endif
330 }
331
332 /* Free all the pages on any of the vnodes in the vlru. Must be done before
333  * freeing all memory.
334  */
335 void
336 osi_linux_free_inode_pages(void)
337 {
338     int i;
339     struct vcache *tvc;
340     struct inode *ip;
341     extern struct vcache *afs_vhashT[VCSIZE];
342
343     for (i = 0; i < VCSIZE; i++) {
344         for (tvc = afs_vhashT[i]; tvc; tvc = tvc->hnext) {
345             ip = AFSTOI(tvc);
346 #if defined(AFS_LINUX24_ENV)
347             if (ip->i_data.nrpages) {
348 #else
349             if (ip->i_nrpages) {
350 #endif
351 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,4,0)
352                 truncate_inode_pages(&ip->i_data, 0);
353 #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2,2,15)
354                 truncate_inode_pages(ip, 0);
355 #else
356                 invalidate_inode_pages(ip);
357 #endif
358 #if defined(AFS_LINUX24_ENV)
359                 if (ip->i_data.nrpages) {
360 #else
361                 if (ip->i_nrpages) {
362 #endif
363                     printf("Failed to invalidate all pages on inode 0x%x\n",
364                            ip);
365                 }
366             }
367         }
368     }
369 }
370
371 void
372 osi_clear_inode(struct inode *ip)
373 {
374     cred_t *credp = crref();
375     struct vcache *vcp = ITOAFS(ip);
376
377 #if defined(AFS_LINUX24_ENV)
378     if (atomic_read(&ip->i_count) > 1)
379 #else
380     if (ip->i_count > 1)
381 #endif
382         printf("afs_put_inode: ino %d (0x%x) has count %d\n", ip->i_ino, ip,
383                ip->i_count);
384
385     afs_InactiveVCache(vcp, credp);
386     ObtainWriteLock(&vcp->lock, 504);
387     ip->i_nlink = 0;            /* iput checks this after calling this routine. */
388     ip->i_state = I_CLEAR;
389     ReleaseWriteLock(&vcp->lock);
390     crfree(credp);
391 }
392
393 #if !defined(AFS_LINUX26_ENV)
394 /* iput an inode. Since we still have a separate inode pool, we don't want
395  * to call iput on AFS inodes, since they would then end up on Linux's
396  * inode_unsed list.
397  */
398 void
399 osi_iput(struct inode *ip)
400 {
401     extern struct vfs *afs_globalVFS;
402
403     AFS_GLOCK();
404
405     if (afs_globalVFS && ip->i_sb != afs_globalVFS)
406         osi_Panic("IPUT Not an afs inode\n");
407
408 #if defined(AFS_LINUX24_ENV)
409     if (atomic_read(&ip->i_count) == 0)
410 #else
411     if (ip->i_count == 0)
412 #endif
413         osi_Panic("IPUT Bad refCount %d on inode 0x%x\n",
414 #if defined(AFS_LINUX24_ENV)
415                   atomic_read(&ip->i_count),
416 #else
417                   ip->i_count,
418 #endif
419                                 ip);
420
421 #if defined(AFS_LINUX24_ENV)
422     if (atomic_dec_and_test(&ip->i_count))
423 #else
424     if (!--ip->i_count)
425 #endif
426                                            {
427         osi_clear_inode(ip);
428         ip->i_state = 0;
429     }
430     AFS_GUNLOCK();
431 }
432 #endif
433
434 /* check_bad_parent() : Checks if this dentry's vcache is a root vcache
435  * that has its mvid (parent dir's fid) pointer set to the wrong directory
436  * due to being mounted in multiple points at once. If so, check_bad_parent()
437  * calls afs_lookup() to correct the vcache's mvid, as well as the volume's
438  * dotdotfid and mtpoint fid members.
439  * Parameters:
440  *  dp - dentry to be checked.
441  * Return Values:
442  *  None.
443  * Sideeffects:
444  *   This dentry's vcache's mvid will be set to the correct parent directory's
445  *   fid.
446  *   This root vnode's volume will have its dotdotfid and mtpoint fids set
447  *    to the correct parent and mountpoint fids.
448  */
449
450 void
451 check_bad_parent(struct dentry *dp)
452 {
453     cred_t *credp;
454     struct vcache *vcp = ITOAFS(dp->d_inode), *avc = NULL;
455     struct vcache *pvc = ITOAFS(dp->d_parent->d_inode);
456
457     if (vcp->mvid->Fid.Volume != pvc->fid.Fid.Volume) { /* bad parent */
458         credp = crref();
459
460
461         /* force a lookup, so vcp->mvid is fixed up */
462         afs_lookup(pvc, dp->d_name.name, &avc, credp);
463         if (!avc || vcp != avc) {       /* bad, very bad.. */
464             afs_Trace4(afs_iclSetp, CM_TRACE_TMP_1S3L, ICL_TYPE_STRING,
465                        "check_bad_parent: bad pointer returned from afs_lookup origvc newvc dentry",
466                        ICL_TYPE_POINTER, vcp, ICL_TYPE_POINTER, avc,
467                        ICL_TYPE_POINTER, dp);
468         }
469         if (avc)
470             AFS_RELE(avc);
471         crfree(credp);
472     }
473     /* if bad parent */
474     return;
475 }
476
477 struct task_struct *rxk_ListenerTask;
478
479 void
480 osi_linux_mask(void)
481 {
482     SIG_LOCK(current);
483     sigfillset(&current->blocked);
484     RECALC_SIGPENDING(current);
485     SIG_UNLOCK(current);
486 }
487
488 void
489 osi_linux_rxkreg(void)
490 {
491     rxk_ListenerTask = current;
492 }