labcomm_private.h 10.1 KB
Newer Older
Anders Nilsson's avatar
Anders Nilsson committed
1
2
3
#ifndef _LABCOMM_PRIVATE_H_
#define _LABCOMM_PRIVATE_H_

4
5
#ifdef LABCOMM_COMPAT
  #include LABCOMM_COMPAT
Oscar Olsson's avatar
Oscar Olsson committed
6
7
8
9
10
#else
  #include <endian.h>
  #include <stdio.h>
#endif

11
#include <stdint.h>
Anders Nilsson's avatar
Anders Nilsson committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#include <stdlib.h>
#include <string.h>
#include "labcomm.h"

/*
 * Predeclared aggregate type indices
 */
#define LABCOMM_TYPEDEF  0x01
#define LABCOMM_SAMPLE   0x02
#define LABCOMM_ARRAY    0x10
#define LABCOMM_STRUCT   0x11

/*
 * Predeclared primitive type indices
 */
#define LABCOMM_BOOLEAN  0x20 
#define LABCOMM_BYTE     0x21
#define LABCOMM_SHORT    0x22
#define LABCOMM_INT      0x23
#define LABCOMM_LONG     0x24
#define LABCOMM_FLOAT    0x25
#define LABCOMM_DOUBLE   0x26
#define LABCOMM_STRING   0x27

/*
 * Start index for user defined types
 */
39
#define LABCOMM_USER     0x40
Anders Nilsson's avatar
Anders Nilsson committed
40

41
42
43
44
45
46
/*
 *
 */
#define LABCOMM_DECLARE_SIGNATURE(name) \
  labcomm_signature_t name __attribute__((section("labcomm")))

Anders Nilsson's avatar
Anders Nilsson committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
 * Semi private decoder declarations
 */
typedef void (*labcomm_handler_typecast_t)(void *, void *);

typedef void (*labcomm_decoder_typecast_t)(
  struct labcomm_decoder *,
  labcomm_handler_typecast_t,
  void *);

typedef struct labcomm_decoder {
  void *context;
  labcomm_reader_t reader;
  void (*do_register)(struct labcomm_decoder *, 
		      labcomm_signature_t *, 
		      labcomm_decoder_typecast_t,
		      labcomm_handler_typecast_t,
		      void *context);
  int (*do_decode_one)(struct labcomm_decoder *decoder);
Oscar Olsson's avatar
Oscar Olsson committed
66
67
  labcomm_error_handler_callback on_error;
  labcomm_handle_new_datatype_callback on_new_datatype;
Anders Nilsson's avatar
Anders Nilsson committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
} labcomm_decoder_t;

/*
 * Non typesafe registration function to be called from
 * generated labcomm_decoder_register_* functions.
 */
void labcomm_internal_decoder_register(
  labcomm_decoder_t *, 
  labcomm_signature_t *, 
  labcomm_decoder_typecast_t,
  labcomm_handler_typecast_t,
  void *context);

#if __BYTE_ORDER == __LITTLE_ENDIAN

#define LABCOMM_DECODE(name, type)					\
  static inline type labcomm_read_##name(labcomm_reader_t *r) {		\
    type result; int i;							\
    for (i = sizeof(type) - 1 ; i >= 0 ; i--) {				\
      if (r->pos >= r->count) {						\
	r->read(r, labcomm_reader_continue);				\
      }									\
      ((unsigned char*)(&result))[i] = r->data[r->pos];			\
      r->pos++;								\
    }									\
    return result;							\
  }									\
  static inline type labcomm_decode_##name(labcomm_decoder_t *d) {	\
    return labcomm_read_##name(&d->reader);				\
  }

#else

#define LABCOMM_DECODE(name, type)					\
  static inline type labcomm_read_##name(labcomm_reader_t *r) {		\
    type result; int i;							\
    for (i = 0 ; i < sizeof(type) ; i++) {				\
      if (r->pos >= r->count) {						\
	r->read(r, labcomm_reader_continue);				\
      }									\
      ((unsigned char*)(&result))[i] = r->data[r->pos];			\
      r->pos++;								\
    }									\
    return result;							\
  }									\
  static inline type labcomm_decode_##name(labcomm_decoder_t *d) {	\
    return labcomm_read_##name(&d->reader);				\
  }

#endif

LABCOMM_DECODE(boolean, unsigned char)
LABCOMM_DECODE(byte, unsigned char)
LABCOMM_DECODE(short, short)
LABCOMM_DECODE(int, int)
LABCOMM_DECODE(long, long long)
LABCOMM_DECODE(float, float)
LABCOMM_DECODE(double, double)
126

127
128
129
130
131
132
133
134
135
136
137
138
/* 
 * Unpack a 32 bit unsigned number from a sequence bytes, where the 
 * first byte is prefixed with a variable length bit pattern that
 * indicates the number of bytes used for encoding. The encoding
 * is inspired by the UTF-8 encoding.
 *
 * 0b0     - 1 byte  (0x00000000 - 0x0000007f)
 * 0b10    - 2 bytes (0x00000080 - 0x00003fff)
 * 0b110   - 3 bytes (0x00004000 - 0x001fffff)
 * 0b1110  - 4 bytes (0x00200000 - 0x0fffffff)
 * 0b11110 - 5 bytes (0x10000000 - 0xffffffff) [4 bits unused]
 */
139
140
static inline unsigned int labcomm_unpack32(labcomm_reader_t *r)
{
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
  unsigned int result = 0;
  int n, i;
  unsigned char tag;

  if (r->pos >= r->count) {	
    r->read(r, labcomm_reader_continue);
  }
  tag = r->data[r->pos];
  r->pos++;
  if (tag < 0x80) {
    n = 1;
    result = tag;
  } else if (tag < 0xc0) {
    n = 2;
    result = tag & 0x3f;
  } else if (tag < 0xe0) {
    n = 3;
    result = tag & 0x1f;
  } else if (tag < 0xf0) {
    n = 4;
    result = tag & 0x0f;
  } else {
    n = 5;
  }
  for (i = 1 ; i < n ; i++) {
166
167
168
    if (r->pos >= r->count) {	
      r->read(r, labcomm_reader_continue);
    }
169
    result = (result << 8) | r->data[r->pos];
170
    r->pos++;
171
172
  }
  return result;
173
174
175
176
177
178
179
}

static inline unsigned int labcomm_decode_packed32(labcomm_decoder_t *d) 
{
    return labcomm_unpack32(&d->reader);
}

Anders Nilsson's avatar
Anders Nilsson committed
180
181
182
183
184
static inline char *labcomm_read_string(labcomm_reader_t *r)
{
  char *result;
  int length, i; 
  
185
  length = labcomm_unpack32(r);
Anders Nilsson's avatar
Anders Nilsson committed
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
  result = malloc(length + 1);
  for (i = 0 ; i < length ; i++) {
    if (r->pos >= r->count) {	
      r->read(r, labcomm_reader_continue);
    }
    result[i] = r->data[r->pos];
    r->pos++;
  }
  result[length] = 0;
  return result;
}

static inline char *labcomm_decode_string(labcomm_decoder_t *d)
{
  return labcomm_read_string(&d->reader);
}

/*
 * Semi private encoder declarations
 */
206
typedef int (*labcomm_encoder_function)(
Anders Nilsson's avatar
Anders Nilsson committed
207
208
209
210
211
212
213
214
  struct labcomm_encoder *,
  void *value);

typedef struct labcomm_encoder {
  void *context;
  labcomm_writer_t writer;
  void (*do_register)(struct labcomm_encoder *encoder, 
		      labcomm_signature_t *signature,
215
216
		      labcomm_encoder_function encode);
  int (*do_encode)(struct labcomm_encoder *encoder, 
Anders Nilsson's avatar
Anders Nilsson committed
217
		    labcomm_signature_t *signature, 
218
		    labcomm_encoder_function encode,
Anders Nilsson's avatar
Anders Nilsson committed
219
		    void *value);
Oscar Olsson's avatar
Oscar Olsson committed
220
  labcomm_error_handler_callback on_error;
Anders Nilsson's avatar
Anders Nilsson committed
221
222
223
224
225
} labcomm_encoder_t;

void labcomm_internal_encoder_register(
  labcomm_encoder_t *encoder, 
  labcomm_signature_t *signature, 
226
  labcomm_encoder_function encode);
Anders Nilsson's avatar
Anders Nilsson committed
227

228
int labcomm_internal_encode(
Anders Nilsson's avatar
Anders Nilsson committed
229
230
  labcomm_encoder_t *encoder, 
  labcomm_signature_t *signature, 
231
  labcomm_encoder_function encode,
Anders Nilsson's avatar
Anders Nilsson committed
232
233
234
235
236
  void *value);

#if __BYTE_ORDER == __LITTLE_ENDIAN

#define LABCOMM_ENCODE(name, type)					\
237
  static inline int labcomm_write_##name(labcomm_writer_t *w, type data) { \
Anders Nilsson's avatar
Anders Nilsson committed
238
239
    int i;								\
    for (i = sizeof(type) - 1 ; i >= 0 ; i--) {				\
Oscar Olsson's avatar
Oscar Olsson committed
240
      if (w->pos >= w->count) { /*buffer is full*/			\
241
242
243
        int err;							\
	err = w->write(w, labcomm_writer_continue);			\
	if (err != 0) { return err; }					\
Anders Nilsson's avatar
Anders Nilsson committed
244
245
246
247
      }									\
      w->data[w->pos] = ((unsigned char*)(&data))[i];			\
      w->pos++;								\
    }									\
248
    return 0;								\
Anders Nilsson's avatar
Anders Nilsson committed
249
  }									\
250
251
  static inline int labcomm_encode_##name(labcomm_encoder_t *e, type data) { \
    return labcomm_write_##name(&e->writer, data);				\
Anders Nilsson's avatar
Anders Nilsson committed
252
253
254
255
256
  }

#else

#define LABCOMM_ENCODE(name, type)					\
257
  static inline int labcomm_write_##name(labcomm_writer_t *w, type data) { \
Anders Nilsson's avatar
Anders Nilsson committed
258
259
260
    int i;								\
    for (i = 0 ; i < sizeof(type) ; i++) {				\
      if (w->pos >= w->count) {						\
261
262
263
        int err;							\
	err = w->write(w, labcomm_writer_continue);			\
	if (err != 0) { return err; }					\
Anders Nilsson's avatar
Anders Nilsson committed
264
265
266
267
      }									\
      w->data[w->pos] = ((unsigned char*)(&data))[i];			\
      w->pos++;								\
    }									\
268
    return 0;								\
Anders Nilsson's avatar
Anders Nilsson committed
269
  }									\
270
271
  static inline int labcomm_encode_##name(labcomm_encoder_t *e, type data) { \
    return labcomm_write_##name(&e->writer, data);				\
Anders Nilsson's avatar
Anders Nilsson committed
272
273
274
275
276
277
278
279
280
281
282
  }

#endif

LABCOMM_ENCODE(boolean, unsigned char)
LABCOMM_ENCODE(byte, unsigned char)
LABCOMM_ENCODE(short, short)
LABCOMM_ENCODE(int, int)
LABCOMM_ENCODE(long, long long)
LABCOMM_ENCODE(float, float)
LABCOMM_ENCODE(double, double)
283

284
/* 
285
286
287
288
 * Pack the 32 bit unsigned number data as a sequence bytes, where the 
 * first byte is prefixed with a variable length bit pattern that
 * indicates the number of bytes used for encoding. The encoding
 * is inspired by the UTF-8 encoding.
289
 *
290
291
292
293
294
295
 * 0b0     - 1 byte  (0x00000000 - 0x0000007f)
 * 0b10    - 2 bytes (0x00000080 - 0x00003fff)
 * 0b110   - 3 bytes (0x00004000 - 0x001fffff)
 * 0b1110  - 4 bytes (0x00200000 - 0x0fffffff)
 * 0b11110 - 5 bytes (0x10000000 - 0xffffffff) [4 bits unused]
 */
296
297
static inline int labcomm_write_packed32(labcomm_writer_t *w, 
					  unsigned int data)
298
{
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
  int n;
  unsigned char tag;
  unsigned char tmp[4] = { (data >> 24) & 0xff, 
			   (data >> 16) & 0xff, 
			   (data >>  8) & 0xff, 
			   (data      ) & 0xff }; 
  if (data < 0x80) {
    n = 1;
    tag = 0x00;
  } else if (data < 0x4000) { 
    n = 2;
    tag = 0x80;
  } else if (data < 0x200000) { 
    n = 3;
    tag = 0xc0;
  } else if (data < 0x10000000) { 
    n = 4;
    tag = 0xe0;
  } else  {
    n = 5;
    tag = 0xf0;
  }
321
322
  /* TODO: maybe?
    if (w->pos + n - 1 >= w->count) {	
323
    w->write(w, labcomm_writer_continue, n);
324
325
    }
  */
326
  switch (n) {
327
    case 5: { 
328
329
330
331
      if (w->pos >= w->count) {	
	int err;
	err = w->write(w, labcomm_writer_continue);
	if (err != 0) { return err; }
332
333
334
335
336
      }
      w->data[w->pos++] = tag; tag = 0;
    }
    case 4: { 
      if (w->pos >= w->count) {					
337
338
339
	int err;
	err = w->write(w, labcomm_writer_continue);
	if (err != 0) { return err; }
340
341
342
343
344
      }
      w->data[w->pos++] = tmp[0] | tag; tag = 0;
    }
    case 3: { 
      if (w->pos >= w->count) {					
345
346
347
	int err;
	err = w->write(w, labcomm_writer_continue);
	if (err != 0) { return err; }
348
349
350
351
352
      }
      w->data[w->pos++] = tmp[1] | tag; tag = 0;
    }
    case 2: { 
      if (w->pos >= w->count) {					
353
354
355
	int err;
	err = w->write(w, labcomm_writer_continue);
	if (err != 0) { return err; }
356
357
358
359
360
      }
      w->data[w->pos++] = tmp[2] | tag; tag = 0;
    }
    case 1: { 
      if (w->pos >= w->count) {					
361
362
363
	int err;
	err = w->write(w, labcomm_writer_continue);
	if (err != 0) { return err; }
364
365
366
      }
      w->data[w->pos++] = tmp[3] | tag;
    }
367
  }
368
  return 0;
369
370
}

371
372
static inline int labcomm_encode_packed32(labcomm_encoder_t *e, 
					   unsigned int data) 
373
{ 
374
  return labcomm_write_packed32(&e->writer, data);				
375
376
}

377

378
static inline int labcomm_write_string(labcomm_writer_t *w, char *s)
Anders Nilsson's avatar
Anders Nilsson committed
379
{
380
  int length, i, err; 
Anders Nilsson's avatar
Anders Nilsson committed
381
382

  length = strlen((char*)s);
383
384
  err = labcomm_write_packed32(w, length);
  if (err != 0) { return err; }
Anders Nilsson's avatar
Anders Nilsson committed
385
386
  for (i = 0 ; i < length ; i++) {
    if (w->pos >= w->count) {	
387
388
389
      int err;
      err = w->write(w, labcomm_writer_continue);
      if (err != 0) { return err; }
Anders Nilsson's avatar
Anders Nilsson committed
390
391
392
393
    }
    w->data[w->pos] = s[i];
    w->pos++;
  }
394
  return 0;
Anders Nilsson's avatar
Anders Nilsson committed
395
396
}

397
static inline int labcomm_encode_string(labcomm_encoder_t *e, 
Anders Nilsson's avatar
Anders Nilsson committed
398
399
					 char *s)
{
400
  return labcomm_write_string(&e->writer, s);
Anders Nilsson's avatar
Anders Nilsson committed
401
402
403
}

#endif