[deliverable/linux.git] / include / linux / ceph / decode.h

#ifndef __CEPH_DECODE_H
#define __CEPH_DECODE_H

#include <linux/err.h>
#include <linux/bug.h>
#include <linux/time.h>
#include <asm/unaligned.h>

#include <linux/ceph/types.h>

/*
 * in all cases,
 *   void **p     pointer to position pointer
 *   void *end    pointer to end of buffer (last byte + 1)
 */

static inline u64 ceph_decode_64(void **p)
{
	u64 v = get_unaligned_le64(*p);
	*p += sizeof(u64);
	return v;
}
static inline u32 ceph_decode_32(void **p)
{
	u32 v = get_unaligned_le32(*p);
	*p += sizeof(u32);
	return v;
}
static inline u16 ceph_decode_16(void **p)
{
	u16 v = get_unaligned_le16(*p);
	*p += sizeof(u16);
	return v;
}
static inline u8 ceph_decode_8(void **p)
{
	u8 v = *(u8 *)*p;
	(*p)++;
	return v;
}
static inline void ceph_decode_copy(void **p, void *pv, size_t n)
{
	memcpy(pv, *p, n);
	*p += n;
}

/*
 * bounds check input.
 */
static inline bool ceph_has_room(void **p, void *end, size_t n)
{
	return end >= *p && n <= end - *p;
}

#define ceph_decode_need(p, end, n, bad)			\
	do {							\
		if (!likely(ceph_has_room(p, end, n)))		\
			goto bad;				\
	} while (0)

#define ceph_decode_64_safe(p, end, v, bad)			\
	do {							\
		ceph_decode_need(p, end, sizeof(u64), bad);	\
		v = ceph_decode_64(p);				\
	} while (0)
#define ceph_decode_32_safe(p, end, v, bad)			\
	do {							\
		ceph_decode_need(p, end, sizeof(u32), bad);	\
		v = ceph_decode_32(p);				\
	} while (0)
#define ceph_decode_16_safe(p, end, v, bad)			\
	do {							\
		ceph_decode_need(p, end, sizeof(u16), bad);	\
		v = ceph_decode_16(p);				\
	} while (0)
#define ceph_decode_8_safe(p, end, v, bad)			\
	do {							\
		ceph_decode_need(p, end, sizeof(u8), bad);	\
		v = ceph_decode_8(p);				\
	} while (0)

#define ceph_decode_copy_safe(p, end, pv, n, bad)		\
	do {							\
		ceph_decode_need(p, end, n, bad);		\
		ceph_decode_copy(p, pv, n);			\
	} while (0)

/*
 * Allocate a buffer big enough to hold the wire-encoded string, and
 * decode the string into it.  The resulting string will always be
 * terminated with '\0'.  If successful, *p will be advanced
 * past the decoded data.  Also, if lenp is not a null pointer, the
 * length (not including the terminating '\0') will be recorded in
 * *lenp.  Note that a zero-length string is a valid return value.
 *
 * Returns a pointer to the newly-allocated string buffer, or a
 * pointer-coded errno if an error occurs.  Neither *p nor *lenp
 * will have been updated if an error is returned.
 *
 * There are two possible failures:
 *   - converting the string would require accessing memory at or
 *     beyond the "end" pointer provided (-ERANGE)
 *   - memory could not be allocated for the result (-ENOMEM)
 */
static inline char *ceph_extract_encoded_string(void **p, void *end,
						size_t *lenp, gfp_t gfp)
{
	u32 len;
	void *sp = *p;
	char *buf;

	ceph_decode_32_safe(&sp, end, len, bad);
	if (!ceph_has_room(&sp, end, len))
		goto bad;

	buf = kmalloc(len + 1, gfp);
	if (!buf)
		return ERR_PTR(-ENOMEM);

	if (len)
		memcpy(buf, sp, len);
	buf[len] = '\0';

	*p = (char *) *p + sizeof (u32) + len;
	if (lenp)
		*lenp = (size_t) len;

	return buf;

bad:
	return ERR_PTR(-ERANGE);
}

/*
 * struct ceph_timespec <-> struct timespec
 */
static inline void ceph_decode_timespec(struct timespec *ts,
					const struct ceph_timespec *tv)
{
	ts->tv_sec = (__kernel_time_t)le32_to_cpu(tv->tv_sec);
	ts->tv_nsec = (long)le32_to_cpu(tv->tv_nsec);
}
static inline void ceph_encode_timespec(struct ceph_timespec *tv,
					const struct timespec *ts)
{
	tv->tv_sec = cpu_to_le32((u32)ts->tv_sec);
	tv->tv_nsec = cpu_to_le32((u32)ts->tv_nsec);
}

/*
 * sockaddr_storage <-> ceph_sockaddr
 */
static inline void ceph_encode_addr(struct ceph_entity_addr *a)
{
	__be16 ss_family = htons(a->in_addr.ss_family);
	a->in_addr.ss_family = *(__u16 *)&ss_family;
}
static inline void ceph_decode_addr(struct ceph_entity_addr *a)
{
	__be16 ss_family = *(__be16 *)&a->in_addr.ss_family;
	a->in_addr.ss_family = ntohs(ss_family);
	WARN_ON(a->in_addr.ss_family == 512);
}

/*
 * encoders
 */
static inline void ceph_encode_64(void **p, u64 v)
{
	put_unaligned_le64(v, (__le64 *)*p);
	*p += sizeof(u64);
}
static inline void ceph_encode_32(void **p, u32 v)
{
	put_unaligned_le32(v, (__le32 *)*p);
	*p += sizeof(u32);
}
static inline void ceph_encode_16(void **p, u16 v)
{
	put_unaligned_le16(v, (__le16 *)*p);
	*p += sizeof(u16);
}
static inline void ceph_encode_8(void **p, u8 v)
{
	*(u8 *)*p = v;
	(*p)++;
}
static inline void ceph_encode_copy(void **p, const void *s, int len)
{
	memcpy(*p, s, len);
	*p += len;
}

/*
 * filepath, string encoders
 */
static inline void ceph_encode_filepath(void **p, void *end,
					u64 ino, const char *path)
{
	u32 len = path ? strlen(path) : 0;
	BUG_ON(*p + 1 + sizeof(ino) + sizeof(len) + len > end);
	ceph_encode_8(p, 1);
	ceph_encode_64(p, ino);
	ceph_encode_32(p, len);
	if (len)
		memcpy(*p, path, len);
	*p += len;
}

static inline void ceph_encode_string(void **p, void *end,
				      const char *s, u32 len)
{
	BUG_ON(*p + sizeof(len) + len > end);
	ceph_encode_32(p, len);
	if (len)
		memcpy(*p, s, len);
	*p += len;
}

#define ceph_encode_need(p, end, n, bad)			\
	do {							\
		if (!likely(ceph_has_room(p, end, n)))		\
			goto bad;				\
	} while (0)

#define ceph_encode_64_safe(p, end, v, bad)			\
	do {							\
		ceph_encode_need(p, end, sizeof(u64), bad);	\
		ceph_encode_64(p, v);				\
	} while (0)
#define ceph_encode_32_safe(p, end, v, bad)			\
	do {							\
		ceph_encode_need(p, end, sizeof(u32), bad);	\
		ceph_encode_32(p, v);				\
	} while (0)
#define ceph_encode_16_safe(p, end, v, bad)			\
	do {							\
		ceph_encode_need(p, end, sizeof(u16), bad);	\
		ceph_encode_16(p, v);				\
	} while (0)
#define ceph_encode_8_safe(p, end, v, bad)			\
	do {							\
		ceph_encode_need(p, end, sizeof(u8), bad);	\
		ceph_encode_8(p, v);				\
	} while (0)

#define ceph_encode_copy_safe(p, end, pv, n, bad)		\
	do {							\
		ceph_encode_need(p, end, n, bad);		\
		ceph_encode_copy(p, pv, n);			\
	} while (0)
#define ceph_encode_string_safe(p, end, s, n, bad)		\
	do {							\
		ceph_encode_need(p, end, n, bad);		\
		ceph_encode_string(p, end, s, n);		\
	} while (0)


#endif
Commit	Line	Data
31b8006e SW	1	#ifndef __CEPH_DECODE_H
	2	#define __CEPH_DECODE_H
	3
f8c36c58	4	#include <linux/err.h>
187f1882	5	#include <linux/bug.h>
c7e337d6	6	#include <linux/time.h>
187f1882	7	#include <asm/unaligned.h>
31b8006e	8
a1ce3928	9	#include <linux/ceph/types.h>
c89136ea	10
31b8006e SW	11	/*
	12	* in all cases,
	13	* void **p pointer to position pointer
	14	* void *end pointer to end of buffer (last byte + 1)
	15	*/
	16
c89136ea SW	17	static inline u64 ceph_decode_64(void **p)
	18	{
	19	u64 v = get_unaligned_le64(*p);
	20	*p += sizeof(u64);
	21	return v;
	22	}
	23	static inline u32 ceph_decode_32(void **p)
	24	{
	25	u32 v = get_unaligned_le32(*p);
	26	*p += sizeof(u32);
	27	return v;
	28	}
	29	static inline u16 ceph_decode_16(void **p)
	30	{
	31	u16 v = get_unaligned_le16(*p);
	32	*p += sizeof(u16);
	33	return v;
	34	}
	35	static inline u8 ceph_decode_8(void **p)
	36	{
	37	u8 v = (u8 )*p;
	38	(*p)++;
	39	return v;
	40	}
	41	static inline void ceph_decode_copy(void *p, void pv, size_t n)
	42	{
	43	memcpy(pv, *p, n);
	44	*p += n;
	45	}
	46
31b8006e SW	47	/*
	48	* bounds check input.
	49	*/
3b33f692	50	static inline bool ceph_has_room(void *p, void end, size_t n)
76aa542f XW	51	{
	52	return end >= p && n <= end - p;
	53	}
	54
dd5f049d AE	55	#define ceph_decode_need(p, end, n, bad) \
	56	do { \
	57	if (!likely(ceph_has_room(p, end, n))) \
	58	goto bad; \
31b8006e SW	59	} while (0)
31b8006e SW	60
31b8006e SW	61	#define ceph_decode_64_safe(p, end, v, bad) \
	62	do { \
	63	ceph_decode_need(p, end, sizeof(u64), bad); \
c89136ea	64	v = ceph_decode_64(p); \
31b8006e SW	65	} while (0)
	66	#define ceph_decode_32_safe(p, end, v, bad) \
	67	do { \
	68	ceph_decode_need(p, end, sizeof(u32), bad); \
c89136ea	69	v = ceph_decode_32(p); \
31b8006e SW	70	} while (0)
	71	#define ceph_decode_16_safe(p, end, v, bad) \
	72	do { \
	73	ceph_decode_need(p, end, sizeof(u16), bad); \
c89136ea	74	v = ceph_decode_16(p); \
31b8006e	75	} while (0)
c7e337d6 SW	76	#define ceph_decode_8_safe(p, end, v, bad) \
	77	do { \
	78	ceph_decode_need(p, end, sizeof(u8), bad); \
	79	v = ceph_decode_8(p); \
	80	} while (0)
31b8006e SW	81
	82	#define ceph_decode_copy_safe(p, end, pv, n, bad) \
	83	do { \
	84	ceph_decode_need(p, end, n, bad); \
	85	ceph_decode_copy(p, pv, n); \
	86	} while (0)
	87
f8c36c58 AE	88	/*
	89	* Allocate a buffer big enough to hold the wire-encoded string, and
	90	* decode the string into it. The resulting string will always be
	91	* terminated with '\0'. If successful, *p will be advanced
	92	* past the decoded data. Also, if lenp is not a null pointer, the
	93	* length (not including the terminating '\0') will be recorded in
	94	* *lenp. Note that a zero-length string is a valid return value.
	95	*
	96	* Returns a pointer to the newly-allocated string buffer, or a
	97	* pointer-coded errno if an error occurs. Neither p nor lenp
	98	* will have been updated if an error is returned.
	99	*
	100	* There are two possible failures:
	101	* - converting the string would require accessing memory at or
dd5f049d AE	102	* beyond the "end" pointer provided (-ERANGE)
dd5f049d AE	103	* - memory could not be allocated for the result (-ENOMEM)
f8c36c58 AE	104	*/
	105	static inline char ceph_extract_encoded_string(void p, void end,
	106	size_t *lenp, gfp_t gfp)
	107	{
	108	u32 len;
	109	void sp = p;
	110	char *buf;
	111
	112	ceph_decode_32_safe(&sp, end, len, bad);
	113	if (!ceph_has_room(&sp, end, len))
	114	goto bad;
	115
	116	buf = kmalloc(len + 1, gfp);
	117	if (!buf)
	118	return ERR_PTR(-ENOMEM);
	119
	120	if (len)
	121	memcpy(buf, sp, len);
	122	buf[len] = '\0';
	123
	124	p = (char ) *p + sizeof (u32) + len;
	125	if (lenp)
	126	*lenp = (size_t) len;
	127
	128	return buf;
	129
	130	bad:
	131	return ERR_PTR(-ERANGE);
	132	}
	133
31b8006e SW	134	/*
	135	* struct ceph_timespec <-> struct timespec
	136	*/
c89136ea	137	static inline void ceph_decode_timespec(struct timespec *ts,
63f2d211	138	const struct ceph_timespec *tv)
c89136ea	139	{
c3f56102 AE	140	ts->tv_sec = (__kernel_time_t)le32_to_cpu(tv->tv_sec);
c3f56102 AE	141	ts->tv_nsec = (long)le32_to_cpu(tv->tv_nsec);
c89136ea SW	142	}
c89136ea SW	143	static inline void ceph_encode_timespec(struct ceph_timespec *tv,
63f2d211	144	const struct timespec *ts)
c89136ea	145	{
c3f56102 AE	146	tv->tv_sec = cpu_to_le32((u32)ts->tv_sec);
c3f56102 AE	147	tv->tv_nsec = cpu_to_le32((u32)ts->tv_nsec);
c89136ea	148	}
31b8006e	149
63f2d211 SW	150	/*
	151	* sockaddr_storage <-> ceph_sockaddr
	152	*/
	153	static inline void ceph_encode_addr(struct ceph_entity_addr *a)
	154	{
cd84db6e YS	155	__be16 ss_family = htons(a->in_addr.ss_family);
cd84db6e YS	156	a->in_addr.ss_family = (__u16 )&ss_family;
63f2d211 SW	157	}
	158	static inline void ceph_decode_addr(struct ceph_entity_addr *a)
	159	{
cd84db6e YS	160	__be16 ss_family = (__be16 )&a->in_addr.ss_family;
cd84db6e YS	161	a->in_addr.ss_family = ntohs(ss_family);
4e7a5dcd	162	WARN_ON(a->in_addr.ss_family == 512);
63f2d211 SW	163	}
63f2d211 SW	164
31b8006e SW	165	/*
	166	* encoders
	167	*/
c89136ea SW	168	static inline void ceph_encode_64(void **p, u64 v)
	169	{
	170	put_unaligned_le64(v, (__le64 )p);
	171	*p += sizeof(u64);
	172	}
	173	static inline void ceph_encode_32(void **p, u32 v)
	174	{
	175	put_unaligned_le32(v, (__le32 )p);
	176	*p += sizeof(u32);
	177	}
	178	static inline void ceph_encode_16(void **p, u16 v)
	179	{
	180	put_unaligned_le16(v, (__le16 )p);
	181	*p += sizeof(u16);
	182	}
	183	static inline void ceph_encode_8(void **p, u8 v)
	184	{
	185	(u8 )*p = v;
	186	(*p)++;
	187	}
4e7a5dcd SW	188	static inline void ceph_encode_copy(void *p, const void s, int len)
	189	{
	190	memcpy(*p, s, len);
	191	*p += len;
	192	}
31b8006e SW	193
	194	/*
	195	* filepath, string encoders
	196	*/
	197	static inline void ceph_encode_filepath(void *p, void end,
	198	u64 ino, const char *path)
	199	{
	200	u32 len = path ? strlen(path) : 0;
c61a1abd	201	BUG_ON(*p + 1 + sizeof(ino) + sizeof(len) + len > end);
ac8839d7	202	ceph_encode_8(p, 1);
31b8006e SW	203	ceph_encode_64(p, ino);
	204	ceph_encode_32(p, len);
	205	if (len)
	206	memcpy(*p, path, len);
	207	*p += len;
	208	}
	209
	210	static inline void ceph_encode_string(void *p, void end,
	211	const char *s, u32 len)
	212	{
	213	BUG_ON(*p + sizeof(len) + len > end);
	214	ceph_encode_32(p, len);
	215	if (len)
	216	memcpy(*p, s, len);
	217	*p += len;
	218	}
	219
dd5f049d AE	220	#define ceph_encode_need(p, end, n, bad) \
	221	do { \
	222	if (!likely(ceph_has_room(p, end, n))) \
	223	goto bad; \
c7e337d6 SW	224	} while (0)
	225
	226	#define ceph_encode_64_safe(p, end, v, bad) \
	227	do { \
	228	ceph_encode_need(p, end, sizeof(u64), bad); \
	229	ceph_encode_64(p, v); \
	230	} while (0)
	231	#define ceph_encode_32_safe(p, end, v, bad) \
	232	do { \
	233	ceph_encode_need(p, end, sizeof(u32), bad); \
dd5f049d	234	ceph_encode_32(p, v); \
c7e337d6 SW	235	} while (0)
	236	#define ceph_encode_16_safe(p, end, v, bad) \
	237	do { \
	238	ceph_encode_need(p, end, sizeof(u16), bad); \
dd5f049d AE	239	ceph_encode_16(p, v); \
	240	} while (0)
	241	#define ceph_encode_8_safe(p, end, v, bad) \
	242	do { \
	243	ceph_encode_need(p, end, sizeof(u8), bad); \
	244	ceph_encode_8(p, v); \
c7e337d6 SW	245	} while (0)
	246
	247	#define ceph_encode_copy_safe(p, end, pv, n, bad) \
	248	do { \
	249	ceph_encode_need(p, end, n, bad); \
	250	ceph_encode_copy(p, pv, n); \
	251	} while (0)
ae1533b6 YS	252	#define ceph_encode_string_safe(p, end, s, n, bad) \
	253	do { \
	254	ceph_encode_need(p, end, n, bad); \
	255	ceph_encode_string(p, end, s, n); \
	256	} while (0)
c7e337d6	257
31b8006e SW	258
31b8006e SW	259	#endif