*
* Floating point read/write functions.
*
- * Copyright (c) 2010 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
*
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
+ * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
- * This library 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
- * Lesser General Public License for more details.
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*
* Reference: ISO C99 standard 5.2.4
*/
#include <glib.h>
#include <float.h> /* C99 floating point definitions */
#include <limits.h> /* C99 limits */
-#include <endian.h>
+#include <babeltrace/endian.h>
+#include <pthread.h>
/*
* This library is limited to binary representation of floating point values.
- * Sign-extension of the exponents is assumed to keep the NaN, +inf, -inf
- * values, but this should be double-checked (TODO).
+ * We use hardware support for conversion between 32 and 64-bit floating
+ * point values.
*/
/*
* Aliasing float/double and unsigned long is not strictly permitted by strict
- * aliasing, but in practice type prunning is well supported, and this permits
+ * aliasing, but in practice declaration prunning is well supported, and this permits
* us to use per-word read/writes rather than per-byte.
*/
#endif
union doubleIEEE754 {
- double v;
+ double vd;
+ float vf;
#ifdef HAS_TYPE_PRUNING
unsigned long bits[(sizeof(double) + sizeof(unsigned long) - 1) / sizeof(unsigned long)];
#else
#endif
};
-union ldoubleIEEE754 {
- long double v;
-#ifdef HAS_TYPE_PRUNING
- unsigned long bits[(sizeof(long double) + sizeof(unsigned long) - 1) / sizeof(unsigned long)];
-#else
- unsigned char bits[sizeof(long double)];
-#endif
-};
+/*
+ * This mutex protects the static temporary float and double
+ * declarations (static_float_declaration and static_double_declaration).
+ */
+static pthread_mutex_t float_mutex = PTHREAD_MUTEX_INITIALIZER;
+
+static struct declaration_float *static_float_declaration,
+ *static_double_declaration;
struct pos_len {
- size_t sign_start, exp_start, mantissa_start, len;
+ size_t len;
};
-/* TODO */
+static void float_lock(void)
+{
+ int ret;
+
+ ret = pthread_mutex_lock(&float_mutex);
+ assert(!ret);
+}
+
+static void float_unlock(void)
+{
+ int ret;
+
+ ret = pthread_mutex_unlock(&float_mutex);
+ assert(!ret);
+}
-void ctf_float_copy(unsigned char *destp, const struct type_class_float *dest,
- const unsigned char *src, const struct type_class_float *src)
+int _ctf_float_copy(struct stream_pos *destp,
+ struct definition_float *dest_definition,
+ struct stream_pos *srcp,
+ const struct definition_float *src_definition)
{
- struct pos_len destpos, srcpos;
- union {
- unsigned long long u;
- long long s;
- } tmp;
-
- destpos.len = dest->exp_len + dest->mantissa_len;
- if (dest->byte_order == LITTLE_ENDIAN) {
- destpos.sign_start = destpos.len - 1;
- destpos.exp_start = destpos.sign_start - dest->exp_len;
- destpos.mantissa_start = 0;
+ int ret;
+
+ /* We only support copy of same-size floats for now */
+ assert(src_definition->declaration->sign->len ==
+ dest_definition->declaration->sign->len);
+ assert(src_definition->declaration->exp->len ==
+ dest_definition->declaration->exp->len);
+ assert(src_definition->declaration->mantissa->len ==
+ dest_definition->declaration->mantissa->len);
+ /* Read */
+ if (src_definition->declaration->byte_order == LITTLE_ENDIAN) {
+ ret = ctf_integer_read(srcp, &src_definition->mantissa->p);
+ if (ret)
+ return ret;
+ ret = ctf_integer_read(srcp, &src_definition->exp->p);
+ if (ret)
+ return ret;
+ ret = ctf_integer_read(srcp, &src_definition->sign->p);
+ if (ret)
+ return ret;
} else {
- destpos.sign_start = 0;
- destpos.exp_start = 1;
- destpos.mantissa_start = destpos.exp_start + dest->exp_len;
+ ret = ctf_integer_read(srcp, &src_definition->sign->p);
+ if (ret)
+ return ret;
+ ret = ctf_integer_read(srcp, &src_definition->exp->p);
+ if (ret)
+ return ret;
+ ret = ctf_integer_read(srcp, &src_definition->mantissa->p);
+ if (ret)
+ return ret;
}
- srcpos.len = src->exp_len + src->mantissa_len;
- if (src->byte_order == LITTLE_ENDIAN) {
- srcpos.sign_start = srcpos.len - 1;
- srcpos.exp_start = srcpos.sign_start - src->exp_len;
- srcpos.mantissa_start = 0;
+ dest_definition->mantissa->value._unsigned =
+ src_definition->mantissa->value._unsigned;
+ dest_definition->exp->value._signed =
+ src_definition->exp->value._signed;
+ dest_definition->sign->value._unsigned =
+ src_definition->sign->value._unsigned;
+
+ /* Write */
+ if (dest_definition->declaration->byte_order == LITTLE_ENDIAN) {
+ ret = ctf_integer_write(destp, &dest_definition->mantissa->p);
+ if (ret)
+ return ret;
+ ret = ctf_integer_write(destp, &dest_definition->exp->p);
+ if (ret)
+ return ret;
+ ret = ctf_integer_write(destp, &dest_definition->sign->p);
+ if (ret)
+ return ret;
} else {
- srcpos.sign_start = 0;
- srcpos.exp_start = 1;
- srcpos.mantissa_start = srcpos.exp_start + src->exp_len;
+ ret = ctf_integer_write(destp, &dest_definition->sign->p);
+ if (ret)
+ return ret;
+ ret = ctf_integer_write(destp, &dest_definition->exp->p);
+ if (ret)
+ return ret;
+ ret = ctf_integer_write(destp, &dest_definition->mantissa->p);
+ if (ret)
+ return ret;
}
-
- /* sign */
- tmp.u = ctf_bitfield_unsigned_read(ptr, srcpos.sign_start, 1,
- src->byte_order);
- ctf_bitfield_unsigned_write(&u.bits, destpos.sign_start, 1,
- dest->byte_order, tmp.u);
-
- /* mantissa (without leading 1). No sign extend. */
- tmp.u = ctf_bitfield_unsigned_read(ptr, srcpos.mantissa_start,
- src->mantissa_len - 1,
- src->byte_order);
- ctf_bitfield_unsigned_write(&u.bits, destpos.mantissa_start,
- dest->mantissa_len - 1, dest->byte_order,
- tmp.u);
-
- /* exponent, with sign-extend. */
- tmp.s = ctf_bitfield_signed_read(ptr, srcpos.exp_start, src->exp_len,
- src->byte_order);
- ctf_bitfield_signed_write(&u.bits, destpos.exp_start, dest->exp_len,
- dest->byte_order, tmp.s);
+ return 0;
}
-double ctf_double_read(const unsigned char *ptr, const struct type_class_float *src)
+int ctf_float_read(struct stream_pos *ppos, struct definition *definition)
{
+ struct definition_float *float_definition =
+ container_of(definition, struct definition_float, p);
+ const struct declaration_float *float_declaration =
+ float_definition->declaration;
+ struct ctf_stream_pos *pos = ctf_pos(ppos);
union doubleIEEE754 u;
- struct ctf_float dest = {
- .exp_len = sizeof(double) * CHAR_BIT - DBL_MANT_DIG,
- .mantissa_len = DBL_MANT_DIG,
- .byte_order = BYTE_ORDER,
- };
-
- ctf_float_copy(&u.bits, &dest, ptr, src);
- return u.v;
+ struct definition *tmpdef;
+ struct definition_float *tmpfloat;
+ struct ctf_stream_pos destp;
+ struct mmap_align mma;
+ int ret;
+
+ float_lock();
+ switch (float_declaration->mantissa->len + 1) {
+ case FLT_MANT_DIG:
+ tmpdef = static_float_declaration->p.definition_new(
+ &static_float_declaration->p,
+ NULL, 0, 0, "__tmpfloat");
+ break;
+ case DBL_MANT_DIG:
+ tmpdef = static_double_declaration->p.definition_new(
+ &static_double_declaration->p,
+ NULL, 0, 0, "__tmpfloat");
+ break;
+ default:
+ ret = -EINVAL;
+ goto end;
+ }
+ tmpfloat = container_of(tmpdef, struct definition_float, p);
+ memset(&destp, 0, sizeof(destp));
+ ctf_init_pos(&destp, -1, O_RDWR);
+ mmap_align_set_addr(&mma, (char *) u.bits);
+ destp.base_mma = &mma;
+ destp.packet_size = sizeof(u) * CHAR_BIT;
+ ctf_align_pos(pos, float_declaration->p.alignment);
+ ret = _ctf_float_copy(&destp.parent, tmpfloat, ppos, float_definition);
+ switch (float_declaration->mantissa->len + 1) {
+ case FLT_MANT_DIG:
+ float_definition->value = u.vf;
+ break;
+ case DBL_MANT_DIG:
+ float_definition->value = u.vd;
+ break;
+ default:
+ ret = -EINVAL;
+ goto end_unref;
+ }
+
+end_unref:
+ definition_unref(tmpdef);
+end:
+ float_unlock();
+ return ret;
}
-size_t ctf_double_write(unsigned char *ptr, const struct type_class_float *dest,
- double v)
+int ctf_float_write(struct stream_pos *ppos, struct definition *definition)
{
+ struct definition_float *float_definition =
+ container_of(definition, struct definition_float, p);
+ const struct declaration_float *float_declaration =
+ float_definition->declaration;
+ struct ctf_stream_pos *pos = ctf_pos(ppos);
union doubleIEEE754 u;
- struct ctf_float src = {
- .exp_len = sizeof(double) * CHAR_BIT - DBL_MANT_DIG,
- .mantissa_len = DBL_MANT_DIG,
- .byte_order = BYTE_ORDER,
- };
+ struct definition *tmpdef;
+ struct definition_float *tmpfloat;
+ struct ctf_stream_pos srcp;
+ struct mmap_align mma;
+ int ret;
- if (!ptr)
+ float_lock();
+ switch (float_declaration->mantissa->len + 1) {
+ case FLT_MANT_DIG:
+ tmpdef = static_float_declaration->p.definition_new(
+ &static_float_declaration->p,
+ NULL, 0, 0, "__tmpfloat");
+ break;
+ case DBL_MANT_DIG:
+ tmpdef = static_double_declaration->p.definition_new(
+ &static_double_declaration->p,
+ NULL, 0, 0, "__tmpfloat");
+ break;
+ default:
+ ret = -EINVAL;
goto end;
- u.v = v;
- ctf_float_copy(ptr, dest, &u.bits, &src);
+ }
+ tmpfloat = container_of(tmpdef, struct definition_float, p);
+ ctf_init_pos(&srcp, -1, O_RDONLY);
+ mmap_align_set_addr(&mma, (char *) u.bits);
+ srcp.base_mma = &mma;
+ srcp.packet_size = sizeof(u) * CHAR_BIT;
+ switch (float_declaration->mantissa->len + 1) {
+ case FLT_MANT_DIG:
+ u.vf = float_definition->value;
+ break;
+ case DBL_MANT_DIG:
+ u.vd = float_definition->value;
+ break;
+ default:
+ ret = -EINVAL;
+ goto end_unref;
+ }
+ ctf_align_pos(pos, float_declaration->p.alignment);
+ ret = _ctf_float_copy(ppos, float_definition, &srcp.parent, tmpfloat);
+
+end_unref:
+ definition_unref(tmpdef);
end:
- return len;
+ float_unlock();
+ return ret;
}
-long double ctf_ldouble_read(const unsigned char *ptr,
- const struct type_class_float *src)
+void __attribute__((constructor)) ctf_float_init(void)
{
- union ldoubleIEEE754 u;
- struct ctf_float dest = {
- .exp_len = sizeof(double) * CHAR_BIT - LDBL_MANT_DIG,
- .mantissa_len = LDBL_MANT_DIG,
- .byte_order = BYTE_ORDER,
- };
-
- ctf_float_copy(&u.bits, &dest, ptr, src);
- return u.v;
+ static_float_declaration =
+ float_declaration_new(FLT_MANT_DIG,
+ sizeof(float) * CHAR_BIT - FLT_MANT_DIG,
+ BYTE_ORDER,
+ __alignof__(float));
+ static_double_declaration =
+ float_declaration_new(DBL_MANT_DIG,
+ sizeof(double) * CHAR_BIT - DBL_MANT_DIG,
+ BYTE_ORDER,
+ __alignof__(double));
}
-size_t ctf_ldouble_write(unsigned char *ptr, const struct type_class_float *dest,
- long double v)
+void __attribute__((destructor)) ctf_float_fini(void)
{
- union ldoubleIEEE754 u;
- struct ctf_float src = {
- .exp_len = sizeof(double) * CHAR_BIT - LDBL_MANT_DIG,
- .mantissa_len = LDBL_MANT_DIG,
- .byte_order = BYTE_ORDER,
- };
-
- if (!ptr)
- goto end;
- u.v = v;
- ctf_float_copy(ptr, dest, &u.bits, &src);
-end:
- return len;
+ declaration_unref(&static_float_declaration->p);
+ declaration_unref(&static_double_declaration->p);
}