labcomm_private.h 14.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/*
  labcomm_private.h -- semi private declarations for handling encoding and 
                       decoding of labcomm samples.

  Copyright 2006-2013 Anders Blomdell <anders.blomdell@control.lth.se>

  This file is part of LabComm.

  LabComm is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  LabComm 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 for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

Anders Nilsson's avatar
Anders Nilsson committed
23
24
25
#ifndef _LABCOMM_PRIVATE_H_
#define _LABCOMM_PRIVATE_H_

26
27
#ifdef LABCOMM_COMPAT
  #include LABCOMM_COMPAT
Oscar Olsson's avatar
Oscar Olsson committed
28
29
30
31
32
#else
  #include <endian.h>
  #include <stdio.h>
#endif

33
#include <stdint.h>
34
//#include <stdlib.h>
Anders Nilsson's avatar
Anders Nilsson committed
35
#include <string.h>
36
#include <unistd.h>
Anders Nilsson's avatar
Anders Nilsson committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
#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
 */
62
#define LABCOMM_USER     0x40
Anders Nilsson's avatar
Anders Nilsson committed
63

64
65
66
67
/*
 *
 */
#define LABCOMM_DECLARE_SIGNATURE(name) \
68
  struct labcomm_signature __attribute__((section("labcomm"),aligned(1))) name 
69

70
71
72
73
74
75
76
77
78
/*
 * Semi private dynamic memory declarations
 */

struct labcomm_memory {
  void *(*alloc)(struct labcomm_memory *m, int lifetime, size_t size);
  void *(*realloc)(struct labcomm_memory *m, int lifetime, 
		   void *ptr, size_t size);
  void (*free)(struct labcomm_memory *m, int lifetime, void *ptr);
79
  void *context;
80
81
};

Anders Nilsson's avatar
Anders Nilsson committed
82
83
84
/*
 * Semi private decoder declarations
 */
85
typedef void (*labcomm_handler_function)(void *value, void *context);
Anders Nilsson's avatar
Anders Nilsson committed
86

87
typedef void (*labcomm_decoder_function)(
88
  struct labcomm_reader *r,
89
90
  labcomm_handler_function handler,
  void *context);
Anders Nilsson's avatar
Anders Nilsson committed
91

92
93
struct labcomm_reader_action_context;

94
struct labcomm_reader_action {
95
96
97
98
99
100
101
102
103
  /* 'alloc' is called at the first invocation of 'labcomm_decoder_decode_one' 
     on the decoder containing the reader. If 'labcomm_version' != NULL
     and non-empty the transport layer may use it to ensure that
     compatible versions are used.

     Returned value:
       >  0    Number of bytes allocated for buffering
       <= 0    Error
  */
104
105
  int (*alloc)(struct labcomm_reader *r, 
	       struct labcomm_reader_action_context *action_context, 
Anders Blomdell's avatar
Anders Blomdell committed
106
	       char *labcomm_version);
107
108
109
110
111
112
113
  /* 'free' returns the resources claimed by 'alloc' and might have other
     reader specific side-effects as well.

     Returned value:
       == 0    Success
       != 0    Error
  */
114
115
  int (*free)(struct labcomm_reader *r, 
	      struct labcomm_reader_action_context *action_context);
116
117
118
  /* 'start' is called right after a sample has arrived. In the case of 
     a sample or typedef, 'value' == NULL.
   */
119
  int (*start)(struct labcomm_reader *r, 
120
	       struct labcomm_reader_action_context *action_context,
Anders Blomdell's avatar
Anders Blomdell committed
121
122
	       int local_index, int remote_index,
	       struct labcomm_signature *signature,
123
	       void *value);
124
125
126
127
128
129
  int (*end)(struct labcomm_reader *r, 
	     struct labcomm_reader_action_context *action_context);
  int (*fill)(struct labcomm_reader *r, 
	      struct labcomm_reader_action_context *action_context);
  int (*ioctl)(struct labcomm_reader *r, 
	       struct labcomm_reader_action_context *action_context,
130
	       int index, struct labcomm_signature *signature, 
131
	       uint32_t ioctl_action, va_list args);
132
133
};

134
135
struct labcomm_reader_action_context {
  struct labcomm_reader_action_context *next;
136
  const struct labcomm_reader_action *action;
137
138
139
140
141
  void *context;  
};

struct labcomm_reader {
  struct labcomm_reader_action_context *action_context;
142
143
144
  struct labcomm_memory *memory;
  /* The following fields are initialized by labcomm_decoder_new */
  struct labcomm_decoder *decoder;
145
146
147
148
149
150
151
  unsigned char *data;
  int data_size;
  int count;
  int pos;
  int error;
};

152
153
154
155
156
157
int labcomm_reader_alloc(struct labcomm_reader *r, 
			 struct labcomm_reader_action_context *action_context, 
			 char *labcomm_version);
int labcomm_reader_free(struct labcomm_reader *r, 
			struct labcomm_reader_action_context *action_context);
int labcomm_reader_start(struct labcomm_reader *r, 
158
			 struct labcomm_reader_action_context *action_context,
Anders Blomdell's avatar
Anders Blomdell committed
159
160
			 int local_index, int remote_index,
			 struct labcomm_signature *signature,
161
			 void *value);
162
163
164
165
166
167
int labcomm_reader_end(struct labcomm_reader *r, 
		       struct labcomm_reader_action_context *action_context);
int labcomm_reader_fill(struct labcomm_reader *r, 
			struct labcomm_reader_action_context *action_context);
int labcomm_reader_ioctl(struct labcomm_reader *r, 
			 struct labcomm_reader_action_context *action_context,
168
			 int index, struct labcomm_signature *signature, 
169
			 uint32_t ioctl_action, va_list args);
170

Anders Nilsson's avatar
Anders Nilsson committed
171
172
173
174
/*
 * Non typesafe registration function to be called from
 * generated labcomm_decoder_register_* functions.
 */
175
int labcomm_internal_decoder_register(
176
177
178
179
  struct labcomm_decoder *d, 
  struct labcomm_signature *s, 
  labcomm_decoder_function decoder,
  labcomm_handler_function handler,
Anders Nilsson's avatar
Anders Nilsson committed
180
181
  void *context);

182
int labcomm_internal_decoder_ioctl(struct labcomm_decoder *decoder, 
183
				   struct labcomm_signature *signature,
184
				   uint32_t ioctl_action, va_list args);
185

Anders Nilsson's avatar
Anders Nilsson committed
186
187
188
#if __BYTE_ORDER == __LITTLE_ENDIAN

#define LABCOMM_DECODE(name, type)					\
189
  static inline type labcomm_read_##name(struct labcomm_reader *r) {	\
Anders Nilsson's avatar
Anders Nilsson committed
190
191
192
    type result; int i;							\
    for (i = sizeof(type) - 1 ; i >= 0 ; i--) {				\
      if (r->pos >= r->count) {						\
193
	labcomm_reader_fill(r, r->action_context);			\
Anders Nilsson's avatar
Anders Nilsson committed
194
195
196
197
198
199
200
201
202
203
      }									\
      ((unsigned char*)(&result))[i] = r->data[r->pos];			\
      r->pos++;								\
    }									\
    return result;							\
  }

#else

#define LABCOMM_DECODE(name, type)					\
204
  static inline type labcomm_read_##name(struct labcomm_reader *r) {	\
Anders Nilsson's avatar
Anders Nilsson committed
205
206
207
    type result; int i;							\
    for (i = 0 ; i < sizeof(type) ; i++) {				\
      if (r->pos >= r->count) {						\
208
	labcomm_reader_fille(r, r->action_context);			\
Anders Nilsson's avatar
Anders Nilsson committed
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
      }									\
      ((unsigned char*)(&result))[i] = r->data[r->pos];			\
      r->pos++;								\
    }									\
    return result;							\
  }

#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)
225

226
static inline unsigned int labcomm_read_packed32(struct labcomm_reader *r)
227
228
229
230
231
232
233
{
  unsigned int result = 0;
  
  while (1) {
    unsigned char tmp;

    if (r->pos >= r->count) {	
234
      labcomm_reader_fill(r, r->action_context);
Anders Blomdell's avatar
Anders Blomdell committed
235
236
237
      if (r->error != 0) {
	goto out;
      }
238
239
240
241
242
243
244
245
    }
    tmp = r->data[r->pos];
    r->pos++;
    result = (result << 7) | (tmp & 0x7f);
    if ((tmp & 0x80) == 0) { 
      break; 
    }
  }
Anders Blomdell's avatar
Anders Blomdell committed
246
out:
247
248
249
  return result;
}
 
250
static inline char *labcomm_read_string(struct labcomm_reader *r)
Anders Nilsson's avatar
Anders Nilsson committed
251
252
253
254
{
  char *result;
  int length, i; 
  
255
  length = labcomm_read_packed32(r);
256
  result = labcomm_memory_alloc(r->memory, 1, length + 1);
Anders Nilsson's avatar
Anders Nilsson committed
257
258
  for (i = 0 ; i < length ; i++) {
    if (r->pos >= r->count) {	
259
      labcomm_reader_fill(r, r->action_context);
Anders Nilsson's avatar
Anders Nilsson committed
260
261
262
263
264
265
266
267
268
269
270
    }
    result[i] = r->data[r->pos];
    r->pos++;
  }
  result[length] = 0;
  return result;
}

/*
 * Semi private encoder declarations
 */
Anders Blomdell's avatar
Anders Blomdell committed
271
272
typedef int (*labcomm_encoder_function)(struct labcomm_writer *,
					void *value);
273
struct labcomm_writer_action_context;
274
275

struct labcomm_writer_action {
276
277
  int (*alloc)(struct labcomm_writer *w, 
	       struct labcomm_writer_action_context *action_context, 
Anders Blomdell's avatar
Anders Blomdell committed
278
	       char *labcomm_version);
279
280
  int (*free)(struct labcomm_writer *w, 
	      struct labcomm_writer_action_context *action_context);
281
282
283
284
285
286
287
288
289
  /* 'start' is called right before a sample is to be sent. In the 
     case of a sample or typedef, 'value' == NULL.

     Returned value:
       == 0          Success -> continue sending the sample
       == -EALREADY  Success -> silently skip sending the sample,
                                'end' will not be called
       < 0           Error
   */
290
291
  int (*start)(struct labcomm_writer *w, 
	       struct labcomm_writer_action_context *action_context,
292
293
	       int index, struct labcomm_signature *signature,
	       void *value);
294
295
296
297
298
299
  int (*end)(struct labcomm_writer *w, 
	     struct labcomm_writer_action_context *action_context);
  int (*flush)(struct labcomm_writer *w, 
	       struct labcomm_writer_action_context *action_context); 
  int (*ioctl)(struct labcomm_writer *w, 
	       struct labcomm_writer_action_context *action_context, 
300
	       int index, struct labcomm_signature *signature, 
301
	       uint32_t ioctl_action, va_list args);
302
303
};

304
305
struct labcomm_writer_action_context {
  struct labcomm_writer_action_context *next;
306
  const struct labcomm_writer_action *action;
307
308
309
310
311
  void *context;  
};

struct labcomm_writer {
  struct labcomm_writer_action_context *action_context;
312
313
314
  struct labcomm_memory *memory;
  /* The following fields are initialized by labcomm_encoder_new */
  struct labcomm_encoder *encoder;
315
316
317
318
319
320
321
  unsigned char *data;
  int data_size;
  int count;
  int pos;
  int error;
};

322
323
int labcomm_writer_alloc(struct labcomm_writer *w, 
			 struct labcomm_writer_action_context *action_context, 
Anders Blomdell's avatar
Anders Blomdell committed
324
			 char *labcomm_version);
325
326
327
328
329
330
331
332
333
334
335
336
int labcomm_writer_free(struct labcomm_writer *w, 
			struct labcomm_writer_action_context *action_context);
int labcomm_writer_start(struct labcomm_writer *w, 
			 struct labcomm_writer_action_context *action_context,
			 int index, struct labcomm_signature *signature,
			 void *value);
int labcomm_writer_end(struct labcomm_writer *w, 
		       struct labcomm_writer_action_context *action_context);
int labcomm_writer_flush(struct labcomm_writer *w, 
			 struct labcomm_writer_action_context *action_context); 
int labcomm_writer_ioctl(struct labcomm_writer *w, 
			 struct labcomm_writer_action_context *action_context, 
337
			 int index, struct labcomm_signature *signature, 
338
339
			 uint32_t ioctl_action, va_list args);

340
int labcomm_internal_encoder_register(
341
342
  struct labcomm_encoder *encoder, 
  struct labcomm_signature *signature, 
343
  labcomm_encoder_function encode);
Anders Nilsson's avatar
Anders Nilsson committed
344

345
int labcomm_internal_encode(
346
347
  struct labcomm_encoder *encoder, 
  struct labcomm_signature *signature, 
348
  labcomm_encoder_function encode,
Anders Nilsson's avatar
Anders Nilsson committed
349
350
  void *value);

351
int labcomm_internal_encoder_ioctl(struct labcomm_encoder *encoder, 
352
				   struct labcomm_signature *signature,
353
				   uint32_t ioctl_action, va_list args);
354

Anders Nilsson's avatar
Anders Nilsson committed
355
356
357
#if __BYTE_ORDER == __LITTLE_ENDIAN

#define LABCOMM_ENCODE(name, type)					\
358
  static inline int labcomm_write_##name(struct labcomm_writer *w, type data) { \
Anders Nilsson's avatar
Anders Nilsson committed
359
360
    int i;								\
    for (i = sizeof(type) - 1 ; i >= 0 ; i--) {				\
Oscar Olsson's avatar
Oscar Olsson committed
361
      if (w->pos >= w->count) { /*buffer is full*/			\
362
        int err;							\
363
	err = labcomm_writer_flush(w, w->action_context);		\
364
	if (err != 0) { return err; }					\
Anders Nilsson's avatar
Anders Nilsson committed
365
366
367
368
      }									\
      w->data[w->pos] = ((unsigned char*)(&data))[i];			\
      w->pos++;								\
    }									\
369
    return 0;								\
Anders Nilsson's avatar
Anders Nilsson committed
370
371
372
373
374
  }

#else

#define LABCOMM_ENCODE(name, type)					\
375
  static inline int labcomm_write_##name(struct labcomm_writer *w, type data) { \
Anders Nilsson's avatar
Anders Nilsson committed
376
377
378
    int i;								\
    for (i = 0 ; i < sizeof(type) ; i++) {				\
      if (w->pos >= w->count) {						\
379
        int err;							\
380
	err = labcomm_writer_flush(w, w->action_context);		\
381
	if (err != 0) { return err; }					\
Anders Nilsson's avatar
Anders Nilsson committed
382
383
384
385
      }									\
      w->data[w->pos] = ((unsigned char*)(&data))[i];			\
      w->pos++;								\
    }									\
386
    return 0;								\
Anders Nilsson's avatar
Anders Nilsson committed
387
388
389
390
391
392
393
394
395
396
397
  }

#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)
398

399
static inline int labcomm_write_packed32(struct labcomm_writer *w, 
400
401
402
403
404
405
406
407
408
409
410
					 unsigned int data)
{
  unsigned char tmp[5];
  int i;
  
  for (i = 0 ; i == 0 || data ; i++, data = (data >> 7)) {
    tmp[i] = data & 0x7f;
  }
  for (i = i - 1 ; i >= 0 ; i--) {
    if (w->pos >= w->count) {					
      int err;
411
      err = labcomm_writer_flush(w, w->action_context);	
412
413
414
415
416
417
418
      if (err != 0) { return err; }
    }
    w->data[w->pos++] = tmp[i] | (i?0x80:0x00);
  }
  return 0;
}

419
static inline int labcomm_write_string(struct labcomm_writer *w, char *s)
Anders Nilsson's avatar
Anders Nilsson committed
420
{
421
  int length, i, err; 
Anders Nilsson's avatar
Anders Nilsson committed
422
423

  length = strlen((char*)s);
424
425
  err = labcomm_write_packed32(w, length);
  if (err != 0) { return err; }
Anders Nilsson's avatar
Anders Nilsson committed
426
427
  for (i = 0 ; i < length ; i++) {
    if (w->pos >= w->count) {	
428
      int err;
429
      err = labcomm_writer_flush(w, w->action_context);	
430
      if (err != 0) { return err; }
Anders Nilsson's avatar
Anders Nilsson committed
431
432
433
434
    }
    w->data[w->pos] = s[i];
    w->pos++;
  }
435
  return 0;
Anders Nilsson's avatar
Anders Nilsson committed
436
437
}

438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
/*
 * Macros for handling arrays indexed by signature index
 */

#define LABCOMM_SIGNATURE_ARRAY_DEF(name, kind)	\
  struct {					\
    int first;					\
    int last;					\
    kind *data;					\
  } name

#define LABCOMM_SIGNATURE_ARRAY_DEF_INIT(name, kind)		\
  LABCOMM_SIGNATURE_ARRAY_DEF(name, kind) = { 0, 0, NULL }

#define LABCOMM_SIGNATURE_ARRAY_INIT(name, kind)		\
  name.first = 0; name.last = 0; name.data = NULL;		\
  name.data = (kind *)name.data; /* typechecking no-op */

456
457
#define LABCOMM_SIGNATURE_ARRAY_FREE(memory, name, kind)	\
  if (name.data) { labcomm_memory_free(memory, 0, name.data); }	\
458
459
  name.data = (kind *)NULL; /* typechecking */

460
461
462
463
464
465
466
467
468
469
470
void *labcomm_signature_array_ref(struct labcomm_memory * memory,
				  int *first, int *last, void **data,
				  int size, int index);
/*
 * NB: the pointer returned by LABCOMM_SIGNATURE_ARRAY_REF might be
 *     rendered invalid by a subsequent call to LABCOMM_SIGNATURE_ARRAY_REF
 *     on the same SIGNATURE_ARRAY, so make sure not to use the result if 
 *     any other code might have made a call to LABCOMM_SIGNATURE_ARRAY_REF
 *     on the same SIGNATURE_ARRAY.
 */
#define LABCOMM_SIGNATURE_ARRAY_REF(memory, name, kind, index)		\
471
  (name.data = (kind *)name.data, /* typechecking no-op */		\
472
473
   (kind *)(labcomm_signature_array_ref(memory,				\
					&name.first, &name.last,	\
474
475
476
					(void **)&name.data,		\
					sizeof(kind), index)))

477
478
479
#define LABCOMM_SIGNATURE_ARRAY_FOREACH(name, kind, var)		\
  for (name.data = (kind *)name.data, /* typechecking no-op */		\
       var = name.first ; var < name.last ; var++)
480

Anders Nilsson's avatar
Anders Nilsson committed
481
#endif