[deliverable/linux.git] / drivers / staging / lustre / lustre / obdclass / md_attrs.c

/*
 * GPL HEADER START
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License version 2 for more details (a copy is included
 * in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 021110-1307, USA
 *
 * GPL HEADER END
 */
/*
 * Copyright (c) 2012, Intel Corporation.
 * Use is subject to license terms.
 *
 * Author: Johann Lombardi <johann.lombardi@intel.com>
 */

#include <lustre/lustre_idl.h>
#include <obd.h>
#include <md_object.h>

/**
 * Initialize new \a lma. Only fid is stored.
 *
 * \param lma - is the new LMA structure to be initialized
 * \param fid - is the FID of the object this LMA belongs to
 * \param incompat - features that MDS must understand to access object
 */
void lustre_lma_init(struct lustre_mdt_attrs *lma, const struct lu_fid *fid,
		     __u32 incompat)
{
	lma->lma_compat   = 0;
	lma->lma_incompat = incompat;
	lma->lma_self_fid = *fid;

	/* If a field is added in struct lustre_mdt_attrs, zero it explicitly
	 * and change the test below. */
	LASSERT(sizeof(*lma) ==
		(offsetof(struct lustre_mdt_attrs, lma_self_fid) +
		 sizeof(lma->lma_self_fid)));
};
EXPORT_SYMBOL(lustre_lma_init);

/**
 * Swab, if needed, LMA structure which is stored on-disk in little-endian order.
 *
 * \param lma - is a pointer to the LMA structure to be swabbed.
 */
void lustre_lma_swab(struct lustre_mdt_attrs *lma)
{
	/* Use LUSTRE_MSG_MAGIC to detect local endianess. */
	if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
		__swab32s(&lma->lma_compat);
		__swab32s(&lma->lma_incompat);
		lustre_swab_lu_fid(&lma->lma_self_fid);
	}
};
EXPORT_SYMBOL(lustre_lma_swab);

/**
 * Swab, if needed, SOM structure which is stored on-disk in little-endian
 * order.
 *
 * \param attrs - is a pointer to the SOM structure to be swabbed.
 */
void lustre_som_swab(struct som_attrs *attrs)
{
	/* Use LUSTRE_MSG_MAGIC to detect local endianess. */
	if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
		__swab32s(&attrs->som_compat);
		__swab32s(&attrs->som_incompat);
		__swab64s(&attrs->som_ioepoch);
		__swab64s(&attrs->som_size);
		__swab64s(&attrs->som_blocks);
		__swab64s(&attrs->som_mountid);
	}
};
EXPORT_SYMBOL(lustre_som_swab);

/*
 * Swab and extract SOM attributes from on-disk xattr.
 *
 * \param buf - is a buffer containing the on-disk SOM extended attribute.
 * \param rc  - is the SOM xattr stored in \a buf
 * \param msd - is the md_som_data structure where to extract SOM attributes.
 */
int lustre_buf2som(void *buf, int rc, struct md_som_data *msd)
{
	struct som_attrs *attrs = (struct som_attrs *)buf;
	ENTRY;

	if (rc == 0 ||  rc == -ENODATA)
		/* no SOM attributes */
		RETURN(-ENODATA);

	if (rc < 0)
		/* error hit while fetching xattr */
		RETURN(rc);

	/* check SOM compatibility */
	if (attrs->som_incompat & ~cpu_to_le32(SOM_INCOMPAT_SUPP))
		RETURN(-ENODATA);

	/* unpack SOM attributes */
	lustre_som_swab(attrs);

	/* fill in-memory msd structure */
	msd->msd_compat   = attrs->som_compat;
	msd->msd_incompat = attrs->som_incompat;
	msd->msd_ioepoch  = attrs->som_ioepoch;
	msd->msd_size     = attrs->som_size;
	msd->msd_blocks   = attrs->som_blocks;
	msd->msd_mountid  = attrs->som_mountid;

	RETURN(0);
}
EXPORT_SYMBOL(lustre_buf2som);

/**
 * Swab, if needed, HSM structure which is stored on-disk in little-endian
 * order.
 *
 * \param attrs - is a pointer to the HSM structure to be swabbed.
 */
void lustre_hsm_swab(struct hsm_attrs *attrs)
{
	/* Use LUSTRE_MSG_MAGIC to detect local endianess. */
	if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
		__swab32s(&attrs->hsm_compat);
		__swab32s(&attrs->hsm_flags);
		__swab64s(&attrs->hsm_arch_id);
		__swab64s(&attrs->hsm_arch_ver);
	}
};
EXPORT_SYMBOL(lustre_hsm_swab);

/*
 * Swab and extract HSM attributes from on-disk xattr.
 *
 * \param buf - is a buffer containing the on-disk HSM extended attribute.
 * \param rc  - is the HSM xattr stored in \a buf
 * \param mh  - is the md_hsm structure where to extract HSM attributes.
 */
int lustre_buf2hsm(void *buf, int rc, struct md_hsm *mh)
{
	struct hsm_attrs *attrs = (struct hsm_attrs *)buf;
	ENTRY;

	if (rc == 0 ||  rc == -ENODATA)
		/* no HSM attributes */
		RETURN(-ENODATA);

	if (rc < 0)
		/* error hit while fetching xattr */
		RETURN(rc);

	/* unpack HSM attributes */
	lustre_hsm_swab(attrs);

	/* fill md_hsm structure */
	mh->mh_compat   = attrs->hsm_compat;
	mh->mh_flags    = attrs->hsm_flags;
	mh->mh_arch_id  = attrs->hsm_arch_id;
	mh->mh_arch_ver = attrs->hsm_arch_ver;

	RETURN(0);
}
EXPORT_SYMBOL(lustre_buf2hsm);

/*
 * Pack HSM attributes.
 *
 * \param buf - is the output buffer where to pack the on-disk HSM xattr.
 * \param mh  - is the md_hsm structure to pack.
 */
void lustre_hsm2buf(void *buf, struct md_hsm *mh)
{
	struct hsm_attrs *attrs = (struct hsm_attrs *)buf;
	ENTRY;

	/* copy HSM attributes */
	attrs->hsm_compat   = mh->mh_compat;
	attrs->hsm_flags    = mh->mh_flags;
	attrs->hsm_arch_id  = mh->mh_arch_id;
	attrs->hsm_arch_ver = mh->mh_arch_ver;

	/* pack xattr */
	lustre_hsm_swab(attrs);
}
EXPORT_SYMBOL(lustre_hsm2buf);
Commit	Line	Data
d7e09d03 PT	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, write to the
	18	* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	19	* Boston, MA 021110-1307, USA
	20	*
	21	* GPL HEADER END
	22	*/
	23	/*
	24	* Copyright (c) 2012, Intel Corporation.
	25	* Use is subject to license terms.
	26	*
	27	* Author: Johann Lombardi <johann.lombardi@intel.com>
	28	*/
	29
	30	#include <lustre/lustre_idl.h>
	31	#include <obd.h>
	32	#include <md_object.h>
	33
	34	/**
	35	* Initialize new \a lma. Only fid is stored.
	36	*
	37	* \param lma - is the new LMA structure to be initialized
	38	* \param fid - is the FID of the object this LMA belongs to
	39	* \param incompat - features that MDS must understand to access object
	40	*/
	41	void lustre_lma_init(struct lustre_mdt_attrs lma, const struct lu_fid fid,
	42	__u32 incompat)
	43	{
	44	lma->lma_compat = 0;
	45	lma->lma_incompat = incompat;
	46	lma->lma_self_fid = *fid;
	47
	48	/* If a field is added in struct lustre_mdt_attrs, zero it explicitly
	49	* and change the test below. */
	50	LASSERT(sizeof(*lma) ==
	51	(offsetof(struct lustre_mdt_attrs, lma_self_fid) +
	52	sizeof(lma->lma_self_fid)));
	53	};
	54	EXPORT_SYMBOL(lustre_lma_init);
	55
	56	/**
	57	* Swab, if needed, LMA structure which is stored on-disk in little-endian order.
	58	*
	59	* \param lma - is a pointer to the LMA structure to be swabbed.
	60	*/
	61	void lustre_lma_swab(struct lustre_mdt_attrs *lma)
	62	{
	63	/* Use LUSTRE_MSG_MAGIC to detect local endianess. */
	64	if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
65	__swab32s(&lma->lma_compat);
66	__swab32s(&lma->lma_incompat);
67	lustre_swab_lu_fid(&lma->lma_self_fid);
68	}
69	};
70	EXPORT_SYMBOL(lustre_lma_swab);
71
72	/**
73	* Swab, if needed, SOM structure which is stored on-disk in little-endian
74	* order.
75	*
76	* \param attrs - is a pointer to the SOM structure to be swabbed.
77	*/
78	void lustre_som_swab(struct som_attrs *attrs)
79	{
80	/* Use LUSTRE_MSG_MAGIC to detect local endianess. */
81	if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
82	__swab32s(&attrs->som_compat);
83	__swab32s(&attrs->som_incompat);
84	__swab64s(&attrs->som_ioepoch);
85	__swab64s(&attrs->som_size);
86	__swab64s(&attrs->som_blocks);
87	__swab64s(&attrs->som_mountid);
88	}
89	};
90	EXPORT_SYMBOL(lustre_som_swab);
91
92	/*
93	* Swab and extract SOM attributes from on-disk xattr.
94	*
95	* \param buf - is a buffer containing the on-disk SOM extended attribute.
96	* \param rc - is the SOM xattr stored in \a buf
97	* \param msd - is the md_som_data structure where to extract SOM attributes.
98	*/
99	int lustre_buf2som(void buf, int rc, struct md_som_data msd)
100	{
101	struct som_attrs attrs = (struct som_attrs )buf;
102	ENTRY;
103
104	if (rc == 0 \|\| rc == -ENODATA)
105	/* no SOM attributes */
106	RETURN(-ENODATA);
107
108	if (rc < 0)
109	/* error hit while fetching xattr */
110	RETURN(rc);
111
112	/* check SOM compatibility */
113	if (attrs->som_incompat & ~cpu_to_le32(SOM_INCOMPAT_SUPP))
114	RETURN(-ENODATA);
115
116	/* unpack SOM attributes */
117	lustre_som_swab(attrs);
118
119	/* fill in-memory msd structure */
120	msd->msd_compat = attrs->som_compat;
121	msd->msd_incompat = attrs->som_incompat;
122	msd->msd_ioepoch = attrs->som_ioepoch;
123	msd->msd_size = attrs->som_size;
124	msd->msd_blocks = attrs->som_blocks;
125	msd->msd_mountid = attrs->som_mountid;
126
127	RETURN(0);
128	}
129	EXPORT_SYMBOL(lustre_buf2som);
130
131	/**
132	* Swab, if needed, HSM structure which is stored on-disk in little-endian
133	* order.
134	*
135	* \param attrs - is a pointer to the HSM structure to be swabbed.
136	*/
137	void lustre_hsm_swab(struct hsm_attrs *attrs)
138	{
139	/* Use LUSTRE_MSG_MAGIC to detect local endianess. */
140	if (LUSTRE_MSG_MAGIC != cpu_to_le32(LUSTRE_MSG_MAGIC)) {
141	__swab32s(&attrs->hsm_compat);
142	__swab32s(&attrs->hsm_flags);
143	__swab64s(&attrs->hsm_arch_id);
144	__swab64s(&attrs->hsm_arch_ver);
145	}
146	};
147	EXPORT_SYMBOL(lustre_hsm_swab);
148
149	/*
150	* Swab and extract HSM attributes from on-disk xattr.
151	*
152	* \param buf - is a buffer containing the on-disk HSM extended attribute.
153	* \param rc - is the HSM xattr stored in \a buf
154	* \param mh - is the md_hsm structure where to extract HSM attributes.
155	*/
156	int lustre_buf2hsm(void buf, int rc, struct md_hsm mh)
157	{
158	struct hsm_attrs attrs = (struct hsm_attrs )buf;
159	ENTRY;
160
161	if (rc == 0 \|\| rc == -ENODATA)
162	/* no HSM attributes */
163	RETURN(-ENODATA);
164
165	if (rc < 0)
166	/* error hit while fetching xattr */
167	RETURN(rc);
168
169	/* unpack HSM attributes */
170	lustre_hsm_swab(attrs);
171
172	/* fill md_hsm structure */
173	mh->mh_compat = attrs->hsm_compat;
174	mh->mh_flags = attrs->hsm_flags;
175	mh->mh_arch_id = attrs->hsm_arch_id;
176	mh->mh_arch_ver = attrs->hsm_arch_ver;
177
178	RETURN(0);
179	}
180	EXPORT_SYMBOL(lustre_buf2hsm);
181
182	/*
183	* Pack HSM attributes.
184	*
185	* \param buf - is the output buffer where to pack the on-disk HSM xattr.
186	* \param mh - is the md_hsm structure to pack.
187	*/
188	void lustre_hsm2buf(void buf, struct md_hsm mh)
189	{
190	struct hsm_attrs attrs = (struct hsm_attrs )buf;
191	ENTRY;
192
193	/* copy HSM attributes */
194	attrs->hsm_compat = mh->mh_compat;
195	attrs->hsm_flags = mh->mh_flags;
196	attrs->hsm_arch_id = mh->mh_arch_id;
197	attrs->hsm_arch_ver = mh->mh_arch_ver;
198
199	/* pack xattr */
200	lustre_hsm_swab(attrs);
201	}
202	EXPORT_SYMBOL(lustre_hsm2buf);