labcomm_private.h 14.7 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
#ifndef LABCOMM_DECLARE_SIGNATURE
68
#define LABCOMM_DECLARE_SIGNATURE(name) \
69
  struct labcomm_signature __attribute__((section("labcomm"),aligned(1))) name 
70
#endif
71

72
73
74
75
76
77
78
79
80
/*
 * 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);
81
  void *context;
82
83
};

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

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

94
95
struct labcomm_reader_action_context;

96
struct labcomm_reader_action {
97
98
99
100
101
102
103
104
105
  /* '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
  */
106
107
  int (*alloc)(struct labcomm_reader *r, 
	       struct labcomm_reader_action_context *action_context, 
Anders Blomdell's avatar
Anders Blomdell committed
108
	       char *labcomm_version);
109
110
111
112
113
114
115
  /* 'free' returns the resources claimed by 'alloc' and might have other
     reader specific side-effects as well.

     Returned value:
       == 0    Success
       != 0    Error
  */
116
117
  int (*free)(struct labcomm_reader *r, 
	      struct labcomm_reader_action_context *action_context);
118
119
120
121
122
123
124
  /* 'start' is called at the following instances:
     1. When a sample is registered 
          (local_index != 0, remote_index == 0, value == NULL)
     2. When a sample definition is received 
          (local_index != 0, remote_index != 0, value == NULL)
     3. When a sample is received
          (local_index != 0, remote_index != 0, value != NULL)
125
   */
126
  int (*start)(struct labcomm_reader *r, 
127
	       struct labcomm_reader_action_context *action_context,
Anders Blomdell's avatar
Anders Blomdell committed
128
129
	       int local_index, int remote_index,
	       struct labcomm_signature *signature,
130
	       void *value);
131
132
133
134
135
136
  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,
137
138
	       int local_index, int remote_index,
	       struct labcomm_signature *signature, 
139
	       uint32_t ioctl_action, va_list args);
140
141
};

142
143
struct labcomm_reader_action_context {
  struct labcomm_reader_action_context *next;
144
  const struct labcomm_reader_action *action;
145
146
147
148
149
  void *context;  
};

struct labcomm_reader {
  struct labcomm_reader_action_context *action_context;
150
151
152
  struct labcomm_memory *memory;
  /* The following fields are initialized by labcomm_decoder_new */
  struct labcomm_decoder *decoder;
153
154
155
156
157
158
159
  unsigned char *data;
  int data_size;
  int count;
  int pos;
  int error;
};

160
161
162
163
164
165
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, 
166
			 struct labcomm_reader_action_context *action_context,
Anders Blomdell's avatar
Anders Blomdell committed
167
168
			 int local_index, int remote_index,
			 struct labcomm_signature *signature,
169
			 void *value);
170
171
172
173
174
175
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,
176
177
			 int local_index, int remote_index,
			 struct labcomm_signature *signature, 
178
			 uint32_t ioctl_action, va_list args);
179

Anders Nilsson's avatar
Anders Nilsson committed
180
181
182
183
/*
 * Non typesafe registration function to be called from
 * generated labcomm_decoder_register_* functions.
 */
184
int labcomm_internal_decoder_register(
185
186
187
188
  struct labcomm_decoder *d, 
  struct labcomm_signature *s, 
  labcomm_decoder_function decoder,
  labcomm_handler_function handler,
Anders Nilsson's avatar
Anders Nilsson committed
189
190
  void *context);

191
int labcomm_internal_decoder_ioctl(struct labcomm_decoder *decoder, 
192
				   struct labcomm_signature *signature,
193
				   uint32_t ioctl_action, va_list args);
194

Anders Nilsson's avatar
Anders Nilsson committed
195
196
197
#if __BYTE_ORDER == __LITTLE_ENDIAN

#define LABCOMM_DECODE(name, type)					\
198
  static inline type labcomm_read_##name(struct labcomm_reader *r) {	\
Anders Nilsson's avatar
Anders Nilsson committed
199
200
201
    type result; int i;							\
    for (i = sizeof(type) - 1 ; i >= 0 ; i--) {				\
      if (r->pos >= r->count) {						\
202
	labcomm_reader_fill(r, r->action_context);			\
Anders Nilsson's avatar
Anders Nilsson committed
203
204
205
206
207
208
209
210
211
212
      }									\
      ((unsigned char*)(&result))[i] = r->data[r->pos];			\
      r->pos++;								\
    }									\
    return result;							\
  }

#else

#define LABCOMM_DECODE(name, type)					\
213
  static inline type labcomm_read_##name(struct labcomm_reader *r) {	\
Anders Nilsson's avatar
Anders Nilsson committed
214
215
216
    type result; int i;							\
    for (i = 0 ; i < sizeof(type) ; i++) {				\
      if (r->pos >= r->count) {						\
217
	labcomm_reader_fille(r, r->action_context);			\
Anders Nilsson's avatar
Anders Nilsson committed
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
      }									\
      ((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)
234

235
static inline unsigned int labcomm_read_packed32(struct labcomm_reader *r)
236
237
238
239
240
241
242
{
  unsigned int result = 0;
  
  while (1) {
    unsigned char tmp;

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

/*
 * Semi private encoder declarations
 */
Anders Blomdell's avatar
Anders Blomdell committed
280
281
typedef int (*labcomm_encoder_function)(struct labcomm_writer *,
					void *value);
282
struct labcomm_writer_action_context;
283
284

struct labcomm_writer_action {
285
286
  int (*alloc)(struct labcomm_writer *w, 
	       struct labcomm_writer_action_context *action_context, 
Anders Blomdell's avatar
Anders Blomdell committed
287
	       char *labcomm_version);
288
289
  int (*free)(struct labcomm_writer *w, 
	      struct labcomm_writer_action_context *action_context);
290
291
292
293
294
295
296
297
298
  /* '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
   */
299
300
  int (*start)(struct labcomm_writer *w, 
	       struct labcomm_writer_action_context *action_context,
301
302
	       int index, struct labcomm_signature *signature,
	       void *value);
303
304
305
306
307
308
  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, 
309
	       int index, struct labcomm_signature *signature, 
310
	       uint32_t ioctl_action, va_list args);
311
312
};

313
314
struct labcomm_writer_action_context {
  struct labcomm_writer_action_context *next;
315
  const struct labcomm_writer_action *action;
316
317
318
319
320
  void *context;  
};

struct labcomm_writer {
  struct labcomm_writer_action_context *action_context;
321
322
323
  struct labcomm_memory *memory;
  /* The following fields are initialized by labcomm_encoder_new */
  struct labcomm_encoder *encoder;
324
325
326
327
328
329
330
  unsigned char *data;
  int data_size;
  int count;
  int pos;
  int error;
};

331
332
int labcomm_writer_alloc(struct labcomm_writer *w, 
			 struct labcomm_writer_action_context *action_context, 
Anders Blomdell's avatar
Anders Blomdell committed
333
			 char *labcomm_version);
334
335
336
337
338
339
340
341
342
343
344
345
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, 
346
			 int index, struct labcomm_signature *signature, 
347
348
			 uint32_t ioctl_action, va_list args);

349
int labcomm_internal_encoder_register(
350
351
  struct labcomm_encoder *encoder, 
  struct labcomm_signature *signature, 
352
  labcomm_encoder_function encode);
Anders Nilsson's avatar
Anders Nilsson committed
353

354
int labcomm_internal_encode(
355
356
  struct labcomm_encoder *encoder, 
  struct labcomm_signature *signature, 
357
  labcomm_encoder_function encode,
Anders Nilsson's avatar
Anders Nilsson committed
358
359
  void *value);

360
int labcomm_internal_encoder_ioctl(struct labcomm_encoder *encoder, 
361
				   struct labcomm_signature *signature,
362
				   uint32_t ioctl_action, va_list args);
363

Anders Nilsson's avatar
Anders Nilsson committed
364
365
366
#if __BYTE_ORDER == __LITTLE_ENDIAN

#define LABCOMM_ENCODE(name, type)					\
367
  static inline int labcomm_write_##name(struct labcomm_writer *w, type data) { \
Anders Nilsson's avatar
Anders Nilsson committed
368
369
    int i;								\
    for (i = sizeof(type) - 1 ; i >= 0 ; i--) {				\
Oscar Olsson's avatar
Oscar Olsson committed
370
      if (w->pos >= w->count) { /*buffer is full*/			\
371
        int err;							\
372
	err = labcomm_writer_flush(w, w->action_context);		\
373
	if (err != 0) { return err; }					\
Anders Nilsson's avatar
Anders Nilsson committed
374
375
376
377
      }									\
      w->data[w->pos] = ((unsigned char*)(&data))[i];			\
      w->pos++;								\
    }									\
378
    return 0;								\
Anders Nilsson's avatar
Anders Nilsson committed
379
380
381
382
383
  }

#else

#define LABCOMM_ENCODE(name, type)					\
384
  static inline int labcomm_write_##name(struct labcomm_writer *w, type data) { \
Anders Nilsson's avatar
Anders Nilsson committed
385
386
387
    int i;								\
    for (i = 0 ; i < sizeof(type) ; i++) {				\
      if (w->pos >= w->count) {						\
388
        int err;							\
389
	err = labcomm_writer_flush(w, w->action_context);		\
390
	if (err != 0) { return err; }					\
Anders Nilsson's avatar
Anders Nilsson committed
391
392
393
394
      }									\
      w->data[w->pos] = ((unsigned char*)(&data))[i];			\
      w->pos++;								\
    }									\
395
    return 0;								\
Anders Nilsson's avatar
Anders Nilsson committed
396
397
398
399
400
401
402
403
404
405
406
  }

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

408
static inline int labcomm_write_packed32(struct labcomm_writer *w, 
409
410
411
412
413
414
415
416
417
418
419
					 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;
420
      err = labcomm_writer_flush(w, w->action_context);	
421
422
423
424
425
426
427
      if (err != 0) { return err; }
    }
    w->data[w->pos++] = tmp[i] | (i?0x80:0x00);
  }
  return 0;
}

428
static inline int labcomm_write_string(struct labcomm_writer *w, char *s)
Anders Nilsson's avatar
Anders Nilsson committed
429
{
430
  int length, i, err; 
Anders Nilsson's avatar
Anders Nilsson committed
431
432

  length = strlen((char*)s);
433
434
  err = labcomm_write_packed32(w, length);
  if (err != 0) { return err; }
Anders Nilsson's avatar
Anders Nilsson committed
435
436
  for (i = 0 ; i < length ; i++) {
    if (w->pos >= w->count) {	
437
      int err;
438
      err = labcomm_writer_flush(w, w->action_context);	
439
      if (err != 0) { return err; }
Anders Nilsson's avatar
Anders Nilsson committed
440
441
442
443
    }
    w->data[w->pos] = s[i];
    w->pos++;
  }
444
  return 0;
Anders Nilsson's avatar
Anders Nilsson committed
445
446
}

447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
/*
 * 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 */

465
466
#define LABCOMM_SIGNATURE_ARRAY_FREE(memory, name, kind)	\
  if (name.data) { labcomm_memory_free(memory, 0, name.data); }	\
467
468
  name.data = (kind *)NULL; /* typechecking */

469
470
471
472
473
474
475
476
477
478
479
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)		\
480
  (name.data = (kind *)name.data, /* typechecking no-op */		\
481
482
   (kind *)(labcomm_signature_array_ref(memory,				\
					&name.first, &name.last,	\
483
484
485
					(void **)&name.data,		\
					sizeof(kind), index)))

486
487
488
#define LABCOMM_SIGNATURE_ARRAY_FOREACH(name, kind, var)		\
  for (name.data = (kind *)name.data, /* typechecking no-op */		\
       var = name.first ; var < name.last ; var++)
489

Anders Nilsson's avatar
Anders Nilsson committed
490
#endif