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) 2011, 2012, 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 #include "../include/obd_class.h"
46 #include "../include/lustre/lustre_idl.h"
47 
obdo_set_parent_fid(struct obdo * dst,const struct lu_fid * parent)48 void obdo_set_parent_fid(struct obdo *dst, const struct lu_fid *parent)
49 {
50 	dst->o_parent_oid = fid_oid(parent);
51 	dst->o_parent_seq = fid_seq(parent);
52 	dst->o_parent_ver = fid_ver(parent);
53 	dst->o_valid |= OBD_MD_FLGENER | OBD_MD_FLFID;
54 }
55 EXPORT_SYMBOL(obdo_set_parent_fid);
56 
57 /* WARNING: the file systems must take care not to tinker with
58    attributes they don't manage (such as blocks). */
obdo_from_inode(struct obdo * dst,struct inode * src,u32 valid)59 void obdo_from_inode(struct obdo *dst, struct inode *src, u32 valid)
60 {
61 	u32 newvalid = 0;
62 
63 	if (valid & (OBD_MD_FLCTIME | OBD_MD_FLMTIME))
64 		CDEBUG(D_INODE, "valid %x, new time %lu/%lu\n",
65 		       valid, LTIME_S(src->i_mtime),
66 		       LTIME_S(src->i_ctime));
67 
68 	if (valid & OBD_MD_FLATIME) {
69 		dst->o_atime = LTIME_S(src->i_atime);
70 		newvalid |= OBD_MD_FLATIME;
71 	}
72 	if (valid & OBD_MD_FLMTIME) {
73 		dst->o_mtime = LTIME_S(src->i_mtime);
74 		newvalid |= OBD_MD_FLMTIME;
75 	}
76 	if (valid & OBD_MD_FLCTIME) {
77 		dst->o_ctime = LTIME_S(src->i_ctime);
78 		newvalid |= OBD_MD_FLCTIME;
79 	}
80 	if (valid & OBD_MD_FLSIZE) {
81 		dst->o_size = i_size_read(src);
82 		newvalid |= OBD_MD_FLSIZE;
83 	}
84 	if (valid & OBD_MD_FLBLOCKS) {  /* allocation of space (x512 bytes) */
85 		dst->o_blocks = src->i_blocks;
86 		newvalid |= OBD_MD_FLBLOCKS;
87 	}
88 	if (valid & OBD_MD_FLBLKSZ) {   /* optimal block size */
89 		dst->o_blksize = 1 << src->i_blkbits;
90 		newvalid |= OBD_MD_FLBLKSZ;
91 	}
92 	if (valid & OBD_MD_FLTYPE) {
93 		dst->o_mode = (dst->o_mode & S_IALLUGO) |
94 			      (src->i_mode & S_IFMT);
95 		newvalid |= OBD_MD_FLTYPE;
96 	}
97 	if (valid & OBD_MD_FLMODE) {
98 		dst->o_mode = (dst->o_mode & S_IFMT) |
99 			      (src->i_mode & S_IALLUGO);
100 		newvalid |= OBD_MD_FLMODE;
101 	}
102 	if (valid & OBD_MD_FLUID) {
103 		dst->o_uid = from_kuid(&init_user_ns, src->i_uid);
104 		newvalid |= OBD_MD_FLUID;
105 	}
106 	if (valid & OBD_MD_FLGID) {
107 		dst->o_gid = from_kgid(&init_user_ns, src->i_gid);
108 		newvalid |= OBD_MD_FLGID;
109 	}
110 	if (valid & OBD_MD_FLFLAGS) {
111 		dst->o_flags = src->i_flags;
112 		newvalid |= OBD_MD_FLFLAGS;
113 	}
114 	dst->o_valid |= newvalid;
115 }
116 EXPORT_SYMBOL(obdo_from_inode);
117 
obdo_cpy_md(struct obdo * dst,struct obdo * src,u32 valid)118 void obdo_cpy_md(struct obdo *dst, struct obdo *src, u32 valid)
119 {
120 	CDEBUG(D_INODE, "src obdo "DOSTID" valid %#llx, dst obdo "DOSTID"\n",
121 	       POSTID(&src->o_oi), src->o_valid, POSTID(&dst->o_oi));
122 	if (valid & OBD_MD_FLATIME)
123 		dst->o_atime = src->o_atime;
124 	if (valid & OBD_MD_FLMTIME)
125 		dst->o_mtime = src->o_mtime;
126 	if (valid & OBD_MD_FLCTIME)
127 		dst->o_ctime = src->o_ctime;
128 	if (valid & OBD_MD_FLSIZE)
129 		dst->o_size = src->o_size;
130 	if (valid & OBD_MD_FLBLOCKS) /* allocation of space */
131 		dst->o_blocks = src->o_blocks;
132 	if (valid & OBD_MD_FLBLKSZ)
133 		dst->o_blksize = src->o_blksize;
134 	if (valid & OBD_MD_FLTYPE)
135 		dst->o_mode = (dst->o_mode & ~S_IFMT) | (src->o_mode & S_IFMT);
136 	if (valid & OBD_MD_FLMODE)
137 		dst->o_mode = (dst->o_mode & S_IFMT) | (src->o_mode & ~S_IFMT);
138 	if (valid & OBD_MD_FLUID)
139 		dst->o_uid = src->o_uid;
140 	if (valid & OBD_MD_FLGID)
141 		dst->o_gid = src->o_gid;
142 	if (valid & OBD_MD_FLFLAGS)
143 		dst->o_flags = src->o_flags;
144 	if (valid & OBD_MD_FLFID) {
145 		dst->o_parent_seq = src->o_parent_seq;
146 		dst->o_parent_ver = src->o_parent_ver;
147 	}
148 	if (valid & OBD_MD_FLGENER)
149 		dst->o_parent_oid = src->o_parent_oid;
150 	if (valid & OBD_MD_FLHANDLE)
151 		dst->o_handle = src->o_handle;
152 	if (valid & OBD_MD_FLCOOKIE)
153 		dst->o_lcookie = src->o_lcookie;
154 
155 	dst->o_valid |= valid;
156 }
157 EXPORT_SYMBOL(obdo_cpy_md);
158 
159 /* returns FALSE if comparison (by flags) is same, TRUE if changed */
obdo_cmp_md(struct obdo * dst,struct obdo * src,u32 compare)160 int obdo_cmp_md(struct obdo *dst, struct obdo *src, u32 compare)
161 {
162 	int res = 0;
163 
164 	if (compare & OBD_MD_FLATIME)
165 		res |= dst->o_atime != src->o_atime;
166 	if (compare & OBD_MD_FLMTIME)
167 		res |= dst->o_mtime != src->o_mtime;
168 	if (compare & OBD_MD_FLCTIME)
169 		res |= dst->o_ctime != src->o_ctime;
170 	if (compare & OBD_MD_FLSIZE)
171 		res |= dst->o_size != src->o_size;
172 	if (compare & OBD_MD_FLBLOCKS) /* allocation of space */
173 		res |= dst->o_blocks != src->o_blocks;
174 	if (compare & OBD_MD_FLBLKSZ)
175 		res |= dst->o_blksize != src->o_blksize;
176 	if (compare & OBD_MD_FLTYPE)
177 		res |= ((dst->o_mode ^ src->o_mode) & S_IFMT) != 0;
178 	if (compare & OBD_MD_FLMODE)
179 		res |= ((dst->o_mode ^ src->o_mode) & ~S_IFMT) != 0;
180 	if (compare & OBD_MD_FLUID)
181 		res |= dst->o_uid != src->o_uid;
182 	if (compare & OBD_MD_FLGID)
183 		res |= dst->o_gid != src->o_gid;
184 	if (compare & OBD_MD_FLFLAGS)
185 		res |= dst->o_flags != src->o_flags;
186 	if (compare & OBD_MD_FLNLINK)
187 		res |= dst->o_nlink != src->o_nlink;
188 	if (compare & OBD_MD_FLFID) {
189 		res |= dst->o_parent_seq != src->o_parent_seq;
190 		res |= dst->o_parent_ver != src->o_parent_ver;
191 	}
192 	if (compare & OBD_MD_FLGENER)
193 		res |= dst->o_parent_oid != src->o_parent_oid;
194 	/* XXX Don't know if these should be included here - wasn't previously
195 	if ( compare & OBD_MD_FLINLINE )
196 		res |= memcmp(dst->o_inline, src->o_inline);
197 	*/
198 	return res;
199 }
200 EXPORT_SYMBOL(obdo_cmp_md);
201 
obdo_to_ioobj(struct obdo * oa,struct obd_ioobj * ioobj)202 void obdo_to_ioobj(struct obdo *oa, struct obd_ioobj *ioobj)
203 {
204 	ioobj->ioo_oid = oa->o_oi;
205 	if (unlikely(!(oa->o_valid & OBD_MD_FLGROUP)))
206 		ostid_set_seq_mdt0(&ioobj->ioo_oid);
207 
208 	/* Since 2.4 this does not contain o_mode in the low 16 bits.
209 	 * Instead, it holds (bd_md_max_brw - 1) for multi-bulk BRW RPCs */
210 	ioobj->ioo_max_brw = 0;
211 }
212 EXPORT_SYMBOL(obdo_to_ioobj);
213 
obdo_from_iattr(struct obdo * oa,struct iattr * attr,unsigned int ia_valid)214 void obdo_from_iattr(struct obdo *oa, struct iattr *attr, unsigned int ia_valid)
215 {
216 	if (ia_valid & ATTR_ATIME) {
217 		oa->o_atime = LTIME_S(attr->ia_atime);
218 		oa->o_valid |= OBD_MD_FLATIME;
219 	}
220 	if (ia_valid & ATTR_MTIME) {
221 		oa->o_mtime = LTIME_S(attr->ia_mtime);
222 		oa->o_valid |= OBD_MD_FLMTIME;
223 	}
224 	if (ia_valid & ATTR_CTIME) {
225 		oa->o_ctime = LTIME_S(attr->ia_ctime);
226 		oa->o_valid |= OBD_MD_FLCTIME;
227 	}
228 	if (ia_valid & ATTR_SIZE) {
229 		oa->o_size = attr->ia_size;
230 		oa->o_valid |= OBD_MD_FLSIZE;
231 	}
232 	if (ia_valid & ATTR_MODE) {
233 		oa->o_mode = attr->ia_mode;
234 		oa->o_valid |= OBD_MD_FLTYPE | OBD_MD_FLMODE;
235 		if (!in_group_p(make_kgid(&init_user_ns, oa->o_gid)) &&
236 		    !capable(CFS_CAP_FSETID))
237 			oa->o_mode &= ~S_ISGID;
238 	}
239 	if (ia_valid & ATTR_UID) {
240 		oa->o_uid = from_kuid(&init_user_ns, attr->ia_uid);
241 		oa->o_valid |= OBD_MD_FLUID;
242 	}
243 	if (ia_valid & ATTR_GID) {
244 		oa->o_gid = from_kgid(&init_user_ns, attr->ia_gid);
245 		oa->o_valid |= OBD_MD_FLGID;
246 	}
247 }
248 EXPORT_SYMBOL(obdo_from_iattr);
249 
iattr_from_obdo(struct iattr * attr,struct obdo * oa,u32 valid)250 void iattr_from_obdo(struct iattr *attr, struct obdo *oa, u32 valid)
251 {
252 	valid &= oa->o_valid;
253 
254 	if (valid & (OBD_MD_FLCTIME | OBD_MD_FLMTIME))
255 		CDEBUG(D_INODE, "valid %#llx, new time %llu/%llu\n",
256 		       oa->o_valid, oa->o_mtime, oa->o_ctime);
257 
258 	attr->ia_valid = 0;
259 	if (valid & OBD_MD_FLATIME) {
260 		LTIME_S(attr->ia_atime) = oa->o_atime;
261 		attr->ia_valid |= ATTR_ATIME;
262 	}
263 	if (valid & OBD_MD_FLMTIME) {
264 		LTIME_S(attr->ia_mtime) = oa->o_mtime;
265 		attr->ia_valid |= ATTR_MTIME;
266 	}
267 	if (valid & OBD_MD_FLCTIME) {
268 		LTIME_S(attr->ia_ctime) = oa->o_ctime;
269 		attr->ia_valid |= ATTR_CTIME;
270 	}
271 	if (valid & OBD_MD_FLSIZE) {
272 		attr->ia_size = oa->o_size;
273 		attr->ia_valid |= ATTR_SIZE;
274 	}
275 #if 0   /* you shouldn't be able to change a file's type with setattr */
276 	if (valid & OBD_MD_FLTYPE) {
277 		attr->ia_mode = (attr->ia_mode & ~S_IFMT)|(oa->o_mode & S_IFMT);
278 		attr->ia_valid |= ATTR_MODE;
279 	}
280 #endif
281 	if (valid & OBD_MD_FLMODE) {
282 		attr->ia_mode = (attr->ia_mode & S_IFMT)|(oa->o_mode & ~S_IFMT);
283 		attr->ia_valid |= ATTR_MODE;
284 		if (!in_group_p(make_kgid(&init_user_ns, oa->o_gid)) &&
285 		    !capable(CFS_CAP_FSETID))
286 			attr->ia_mode &= ~S_ISGID;
287 	}
288 	if (valid & OBD_MD_FLUID) {
289 		attr->ia_uid = make_kuid(&init_user_ns, oa->o_uid);
290 		attr->ia_valid |= ATTR_UID;
291 	}
292 	if (valid & OBD_MD_FLGID) {
293 		attr->ia_gid = make_kgid(&init_user_ns, oa->o_gid);
294 		attr->ia_valid |= ATTR_GID;
295 	}
296 }
297 EXPORT_SYMBOL(iattr_from_obdo);
298 
md_from_obdo(struct md_op_data * op_data,struct obdo * oa,u32 valid)299 void md_from_obdo(struct md_op_data *op_data, struct obdo *oa, u32 valid)
300 {
301 	iattr_from_obdo(&op_data->op_attr, oa, valid);
302 	if (valid & OBD_MD_FLBLOCKS) {
303 		op_data->op_attr_blocks = oa->o_blocks;
304 		op_data->op_attr.ia_valid |= ATTR_BLOCKS;
305 	}
306 	if (valid & OBD_MD_FLFLAGS) {
307 		((struct ll_iattr *)&op_data->op_attr)->ia_attr_flags =
308 			oa->o_flags;
309 		op_data->op_attr.ia_valid |= ATTR_ATTR_FLAG;
310 	}
311 }
312 EXPORT_SYMBOL(md_from_obdo);
313 
obdo_from_md(struct obdo * oa,struct md_op_data * op_data,unsigned int valid)314 void obdo_from_md(struct obdo *oa, struct md_op_data *op_data,
315 		  unsigned int valid)
316 {
317 	obdo_from_iattr(oa, &op_data->op_attr, valid);
318 	if (valid & ATTR_BLOCKS) {
319 		oa->o_blocks = op_data->op_attr_blocks;
320 		oa->o_valid |= OBD_MD_FLBLOCKS;
321 	}
322 	if (valid & ATTR_ATTR_FLAG) {
323 		oa->o_flags =
324 			((struct ll_iattr *)&op_data->op_attr)->ia_attr_flags;
325 		oa->o_valid |= OBD_MD_FLFLAGS;
326 	}
327 }
328 EXPORT_SYMBOL(obdo_from_md);
329 
obdo_cpu_to_le(struct obdo * dobdo,struct obdo * sobdo)330 void obdo_cpu_to_le(struct obdo *dobdo, struct obdo *sobdo)
331 {
332 	dobdo->o_size = cpu_to_le64(sobdo->o_size);
333 	dobdo->o_mtime = cpu_to_le64(sobdo->o_mtime);
334 	dobdo->o_atime = cpu_to_le64(sobdo->o_atime);
335 	dobdo->o_ctime = cpu_to_le64(sobdo->o_ctime);
336 	dobdo->o_blocks = cpu_to_le64(sobdo->o_blocks);
337 	dobdo->o_mode = cpu_to_le32(sobdo->o_mode);
338 	dobdo->o_uid = cpu_to_le32(sobdo->o_uid);
339 	dobdo->o_gid = cpu_to_le32(sobdo->o_gid);
340 	dobdo->o_flags = cpu_to_le32(sobdo->o_flags);
341 	dobdo->o_nlink = cpu_to_le32(sobdo->o_nlink);
342 	dobdo->o_blksize = cpu_to_le32(sobdo->o_blksize);
343 	dobdo->o_valid = cpu_to_le64(sobdo->o_valid);
344 }
345 EXPORT_SYMBOL(obdo_cpu_to_le);
346 
obdo_le_to_cpu(struct obdo * dobdo,struct obdo * sobdo)347 void obdo_le_to_cpu(struct obdo *dobdo, struct obdo *sobdo)
348 {
349 	dobdo->o_size = le64_to_cpu(sobdo->o_size);
350 	dobdo->o_mtime = le64_to_cpu(sobdo->o_mtime);
351 	dobdo->o_atime = le64_to_cpu(sobdo->o_atime);
352 	dobdo->o_ctime = le64_to_cpu(sobdo->o_ctime);
353 	dobdo->o_blocks = le64_to_cpu(sobdo->o_blocks);
354 	dobdo->o_mode = le32_to_cpu(sobdo->o_mode);
355 	dobdo->o_uid = le32_to_cpu(sobdo->o_uid);
356 	dobdo->o_gid = le32_to_cpu(sobdo->o_gid);
357 	dobdo->o_flags = le32_to_cpu(sobdo->o_flags);
358 	dobdo->o_nlink = le32_to_cpu(sobdo->o_nlink);
359 	dobdo->o_blksize = le32_to_cpu(sobdo->o_blksize);
360 	dobdo->o_valid = le64_to_cpu(sobdo->o_valid);
361 }
362 EXPORT_SYMBOL(obdo_le_to_cpu);
363