Whamcloud - gitweb
LU-3030 build: Update Master Copyrights pre 2.4 split
[fs/lustre-release.git] / lustre / obdclass / obdo.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2012, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/obdclass/obdo.c
37  *
38  * Object Devices Class Driver
39  * These are the only exported functions, they provide some generic
40  * infrastructure for managing object devices
41  */
42
43 #define DEBUG_SUBSYSTEM S_CLASS
44
45 #ifndef __KERNEL__
46 #include "../liblustre/llite_lib.h"
47 #else
48 #include <obd_class.h>
49 #include <lustre/lustre_idl.h>
50 #endif
51
52 void obdo_set_parent_fid(struct obdo *dst, const struct lu_fid *parent)
53 {
54         dst->o_parent_oid = fid_oid(parent);
55         dst->o_parent_seq = fid_seq(parent);
56         dst->o_parent_ver = fid_ver(parent);
57         dst->o_valid |= OBD_MD_FLGENER | OBD_MD_FLFID;
58 }
59 EXPORT_SYMBOL(obdo_set_parent_fid);
60
61 /* WARNING: the file systems must take care not to tinker with
62    attributes they don't manage (such as blocks). */
63 void obdo_from_inode(struct obdo *dst, struct inode *src, obd_flag valid)
64 {
65         obd_flag newvalid = 0;
66
67         if (valid & (OBD_MD_FLCTIME | OBD_MD_FLMTIME))
68                 CDEBUG(D_INODE, "valid %x, new time %lu/%lu\n",
69                        valid, LTIME_S(src->i_mtime),
70                        LTIME_S(src->i_ctime));
71
72         if (valid & OBD_MD_FLATIME) {
73                 dst->o_atime = LTIME_S(src->i_atime);
74                 newvalid |= OBD_MD_FLATIME;
75         }
76         if (valid & OBD_MD_FLMTIME) {
77                 dst->o_mtime = LTIME_S(src->i_mtime);
78                 newvalid |= OBD_MD_FLMTIME;
79         }
80         if (valid & OBD_MD_FLCTIME) {
81                 dst->o_ctime = LTIME_S(src->i_ctime);
82                 newvalid |= OBD_MD_FLCTIME;
83         }
84         if (valid & OBD_MD_FLSIZE) {
85                 dst->o_size = i_size_read(src);
86                 newvalid |= OBD_MD_FLSIZE;
87         }
88         if (valid & OBD_MD_FLBLOCKS) {  /* allocation of space (x512 bytes) */
89                 dst->o_blocks = src->i_blocks;
90                 newvalid |= OBD_MD_FLBLOCKS;
91         }
92         if (valid & OBD_MD_FLBLKSZ) {   /* optimal block size */
93                 dst->o_blksize = ll_inode_blksize(src);
94                 newvalid |= OBD_MD_FLBLKSZ;
95         }
96         if (valid & OBD_MD_FLTYPE) {
97                 dst->o_mode = (dst->o_mode & S_IALLUGO) |
98                               (src->i_mode & S_IFMT);
99                 newvalid |= OBD_MD_FLTYPE;
100         }
101         if (valid & OBD_MD_FLMODE) {
102                 dst->o_mode = (dst->o_mode & S_IFMT) |
103                               (src->i_mode & S_IALLUGO);
104                 newvalid |= OBD_MD_FLMODE;
105         }
106         if (valid & OBD_MD_FLUID) {
107                 dst->o_uid = src->i_uid;
108                 newvalid |= OBD_MD_FLUID;
109         }
110         if (valid & OBD_MD_FLGID) {
111                 dst->o_gid = src->i_gid;
112                 newvalid |= OBD_MD_FLGID;
113         }
114         if (valid & OBD_MD_FLFLAGS) {
115                 dst->o_flags = ll_inode_flags(src);
116                 newvalid |= OBD_MD_FLFLAGS;
117         }
118         dst->o_valid |= newvalid;
119 }
120 EXPORT_SYMBOL(obdo_from_inode);
121
122 void obdo_cpy_md(struct obdo *dst, struct obdo *src, obd_flag valid)
123 {
124 #ifdef __KERNEL__
125         CDEBUG(D_INODE, "src obdo "DOSTID" valid "LPX64", dst obdo "DOSTID"\n",
126                POSTID(&src->o_oi), src->o_valid, POSTID(&dst->o_oi));
127 #endif
128         if (valid & OBD_MD_FLATIME)
129                 dst->o_atime = src->o_atime;
130         if (valid & OBD_MD_FLMTIME)
131                 dst->o_mtime = src->o_mtime;
132         if (valid & OBD_MD_FLCTIME)
133                 dst->o_ctime = src->o_ctime;
134         if (valid & OBD_MD_FLSIZE)
135                 dst->o_size = src->o_size;
136         if (valid & OBD_MD_FLBLOCKS) /* allocation of space */
137                 dst->o_blocks = src->o_blocks;
138         if (valid & OBD_MD_FLBLKSZ)
139                 dst->o_blksize = src->o_blksize;
140         if (valid & OBD_MD_FLTYPE)
141                 dst->o_mode = (dst->o_mode & ~S_IFMT) | (src->o_mode & S_IFMT);
142         if (valid & OBD_MD_FLMODE)
143                 dst->o_mode = (dst->o_mode & S_IFMT) | (src->o_mode & ~S_IFMT);
144         if (valid & OBD_MD_FLUID)
145                 dst->o_uid = src->o_uid;
146         if (valid & OBD_MD_FLGID)
147                 dst->o_gid = src->o_gid;
148         if (valid & OBD_MD_FLFLAGS)
149                 dst->o_flags = src->o_flags;
150         if (valid & OBD_MD_FLFID) {
151                 dst->o_parent_seq = src->o_parent_seq;
152                 dst->o_parent_ver = src->o_parent_ver;
153         }
154         if (valid & OBD_MD_FLGENER)
155                 dst->o_parent_oid = src->o_parent_oid;
156         if (valid & OBD_MD_FLHANDLE)
157                 dst->o_handle = src->o_handle;
158         if (valid & OBD_MD_FLCOOKIE)
159                 dst->o_lcookie = src->o_lcookie;
160
161         dst->o_valid |= valid;
162 }
163 EXPORT_SYMBOL(obdo_cpy_md);
164
165 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
166 int obdo_cmp_md(struct obdo *dst, struct obdo *src, obd_flag compare)
167 {
168         int res = 0;
169
170         if ( compare & OBD_MD_FLATIME )
171                 res = (res || (dst->o_atime != src->o_atime));
172         if ( compare & OBD_MD_FLMTIME )
173                 res = (res || (dst->o_mtime != src->o_mtime));
174         if ( compare & OBD_MD_FLCTIME )
175                 res = (res || (dst->o_ctime != src->o_ctime));
176         if ( compare & OBD_MD_FLSIZE )
177                 res = (res || (dst->o_size != src->o_size));
178         if ( compare & OBD_MD_FLBLOCKS ) /* allocation of space */
179                 res = (res || (dst->o_blocks != src->o_blocks));
180         if ( compare & OBD_MD_FLBLKSZ )
181                 res = (res || (dst->o_blksize != src->o_blksize));
182         if ( compare & OBD_MD_FLTYPE )
183                 res = (res || (((dst->o_mode ^ src->o_mode) & S_IFMT) != 0));
184         if ( compare & OBD_MD_FLMODE )
185                 res = (res || (((dst->o_mode ^ src->o_mode) & ~S_IFMT) != 0));
186         if ( compare & OBD_MD_FLUID )
187                 res = (res || (dst->o_uid != src->o_uid));
188         if ( compare & OBD_MD_FLGID )
189                 res = (res || (dst->o_gid != src->o_gid));
190         if ( compare & OBD_MD_FLFLAGS )
191                 res = (res || (dst->o_flags != src->o_flags));
192         if ( compare & OBD_MD_FLNLINK )
193                 res = (res || (dst->o_nlink != src->o_nlink));
194         if ( compare & OBD_MD_FLFID ) {
195                 res = (res || (dst->o_parent_seq != src->o_parent_seq));
196                 res = (res || (dst->o_parent_ver != src->o_parent_ver));
197         }
198         if ( compare & OBD_MD_FLGENER )
199                 res = (res || (dst->o_parent_oid != src->o_parent_oid));
200         /* XXX Don't know if thses should be included here - wasn't previously
201         if ( compare & OBD_MD_FLINLINE )
202                 res = (res || memcmp(dst->o_inline, src->o_inline));
203         */
204         return res;
205 }
206 EXPORT_SYMBOL(obdo_cmp_md);
207
208 void obdo_to_ioobj(struct obdo *oa, struct obd_ioobj *ioobj)
209 {
210         ioobj->ioo_oid = oa->o_oi;
211         if (unlikely(!(oa->o_valid & OBD_MD_FLGROUP)))
212                 ostid_set_seq_mdt0(&ioobj->ioo_oid);
213
214         /* Since 2.4 this does not contain o_mode in the low 16 bits.
215          * Instead, it holds (bd_md_max_brw - 1) for multi-bulk BRW RPCs */
216         ioobj->ioo_max_brw = 0;
217 }
218 EXPORT_SYMBOL(obdo_to_ioobj);
219
220 void obdo_from_iattr(struct obdo *oa, struct iattr *attr, unsigned int ia_valid)
221 {
222         if (ia_valid & ATTR_ATIME) {
223                 oa->o_atime = LTIME_S(attr->ia_atime);
224                 oa->o_valid |= OBD_MD_FLATIME;
225         }
226         if (ia_valid & ATTR_MTIME) {
227                 oa->o_mtime = LTIME_S(attr->ia_mtime);
228                 oa->o_valid |= OBD_MD_FLMTIME;
229         }
230         if (ia_valid & ATTR_CTIME) {
231                 oa->o_ctime = LTIME_S(attr->ia_ctime);
232                 oa->o_valid |= OBD_MD_FLCTIME;
233         }
234         if (ia_valid & ATTR_SIZE) {
235                 oa->o_size = attr->ia_size;
236                 oa->o_valid |= OBD_MD_FLSIZE;
237         }
238         if (ia_valid & ATTR_MODE) {
239                 oa->o_mode = attr->ia_mode;
240                 oa->o_valid |= OBD_MD_FLTYPE | OBD_MD_FLMODE;
241                 if (!cfs_curproc_is_in_groups(oa->o_gid) &&
242                     !cfs_capable(CFS_CAP_FSETID))
243                         oa->o_mode &= ~S_ISGID;
244         }
245         if (ia_valid & ATTR_UID) {
246                 oa->o_uid = attr->ia_uid;
247                 oa->o_valid |= OBD_MD_FLUID;
248         }
249         if (ia_valid & ATTR_GID) {
250                 oa->o_gid = attr->ia_gid;
251                 oa->o_valid |= OBD_MD_FLGID;
252         }
253 }
254 EXPORT_SYMBOL(obdo_from_iattr);
255
256 void iattr_from_obdo(struct iattr *attr, struct obdo *oa, obd_flag valid)
257 {
258         valid &= oa->o_valid;
259
260         if (valid & (OBD_MD_FLCTIME | OBD_MD_FLMTIME))
261                 CDEBUG(D_INODE, "valid "LPX64", new time "LPU64"/"LPU64"\n",
262                        oa->o_valid, oa->o_mtime, oa->o_ctime);
263
264         attr->ia_valid = 0;
265         if (valid & OBD_MD_FLATIME) {
266                 LTIME_S(attr->ia_atime) = oa->o_atime;
267                 attr->ia_valid |= ATTR_ATIME;
268         }
269         if (valid & OBD_MD_FLMTIME) {
270                 LTIME_S(attr->ia_mtime) = oa->o_mtime;
271                 attr->ia_valid |= ATTR_MTIME;
272         }
273         if (valid & OBD_MD_FLCTIME) {
274                 LTIME_S(attr->ia_ctime) = oa->o_ctime;
275                 attr->ia_valid |= ATTR_CTIME;
276         }
277         if (valid & OBD_MD_FLSIZE) {
278                 attr->ia_size = oa->o_size;
279                 attr->ia_valid |= ATTR_SIZE;
280         }
281 #if 0   /* you shouldn't be able to change a file's type with setattr */
282         if (valid & OBD_MD_FLTYPE) {
283                 attr->ia_mode = (attr->ia_mode & ~S_IFMT)|(oa->o_mode & S_IFMT);
284                 attr->ia_valid |= ATTR_MODE;
285         }
286 #endif
287         if (valid & OBD_MD_FLMODE) {
288                 attr->ia_mode = (attr->ia_mode & S_IFMT)|(oa->o_mode & ~S_IFMT);
289                 attr->ia_valid |= ATTR_MODE;
290                 if (!cfs_curproc_is_in_groups(oa->o_gid) &&
291                     !cfs_capable(CFS_CAP_FSETID))
292                         attr->ia_mode &= ~S_ISGID;
293         }
294         if (valid & OBD_MD_FLUID) {
295                 attr->ia_uid = oa->o_uid;
296                 attr->ia_valid |= ATTR_UID;
297         }
298         if (valid & OBD_MD_FLGID) {
299                 attr->ia_gid = oa->o_gid;
300                 attr->ia_valid |= ATTR_GID;
301         }
302 }
303 EXPORT_SYMBOL(iattr_from_obdo);
304
305 void md_from_obdo(struct md_op_data *op_data, struct obdo *oa, obd_flag valid)
306 {
307         iattr_from_obdo(&op_data->op_attr, oa, valid);
308         if (valid & OBD_MD_FLBLOCKS) {
309                 op_data->op_attr_blocks = oa->o_blocks;
310                 op_data->op_attr.ia_valid |= ATTR_BLOCKS;
311         }
312         if (valid & OBD_MD_FLFLAGS) {
313                 ((struct ll_iattr *)&op_data->op_attr)->ia_attr_flags =
314                         oa->o_flags;
315                 op_data->op_attr.ia_valid |= ATTR_ATTR_FLAG;
316         }
317 }
318 EXPORT_SYMBOL(md_from_obdo);
319
320 void obdo_from_md(struct obdo *oa, struct md_op_data *op_data,
321                   unsigned int valid)
322 {
323         obdo_from_iattr(oa, &op_data->op_attr, valid);
324         if (valid & ATTR_BLOCKS) {
325                 oa->o_blocks = op_data->op_attr_blocks;
326                 oa->o_valid |= OBD_MD_FLBLOCKS;
327         }
328         if (valid & ATTR_ATTR_FLAG) {
329                 oa->o_flags = 
330                         ((struct ll_iattr *)&op_data->op_attr)->ia_attr_flags;
331                 oa->o_valid |= OBD_MD_FLFLAGS;
332         }
333 }
334 EXPORT_SYMBOL(obdo_from_md);
335
336 void obdo_cpu_to_le(struct obdo *dobdo, struct obdo *sobdo)
337 {
338         dobdo->o_size = cpu_to_le64(sobdo->o_size);
339         dobdo->o_mtime = cpu_to_le64(sobdo->o_mtime);
340         dobdo->o_atime = cpu_to_le64(sobdo->o_atime);
341         dobdo->o_ctime = cpu_to_le64(sobdo->o_ctime);
342         dobdo->o_blocks = cpu_to_le64(sobdo->o_blocks);
343         dobdo->o_mode = cpu_to_le32(sobdo->o_mode);
344         dobdo->o_uid = cpu_to_le32(sobdo->o_uid);
345         dobdo->o_gid = cpu_to_le32(sobdo->o_gid);
346         dobdo->o_flags = cpu_to_le32(sobdo->o_flags);
347         dobdo->o_nlink = cpu_to_le32(sobdo->o_nlink);
348         dobdo->o_blksize = cpu_to_le32(sobdo->o_blksize);
349         dobdo->o_valid = cpu_to_le64(sobdo->o_valid);
350 }
351 EXPORT_SYMBOL(obdo_cpu_to_le);
352
353 void obdo_le_to_cpu(struct obdo *dobdo, struct obdo *sobdo)
354 {
355         dobdo->o_size = le64_to_cpu(sobdo->o_size);
356         dobdo->o_mtime = le64_to_cpu(sobdo->o_mtime);
357         dobdo->o_atime = le64_to_cpu(sobdo->o_atime);
358         dobdo->o_ctime = le64_to_cpu(sobdo->o_ctime);
359         dobdo->o_blocks = le64_to_cpu(sobdo->o_blocks);
360         dobdo->o_mode = le32_to_cpu(sobdo->o_mode);
361         dobdo->o_uid = le32_to_cpu(sobdo->o_uid);
362         dobdo->o_gid = le32_to_cpu(sobdo->o_gid);
363         dobdo->o_flags = le32_to_cpu(sobdo->o_flags);
364         dobdo->o_nlink = le32_to_cpu(sobdo->o_nlink);
365         dobdo->o_blksize = le32_to_cpu(sobdo->o_blksize);
366         dobdo->o_valid = le64_to_cpu(sobdo->o_valid);
367 }
368 EXPORT_SYMBOL(obdo_le_to_cpu);
369