labcomm_private.h 15.2 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
 * Macro to automagically call constructors in modules compiled 
 * with the labcomm compiler. If __attribute__((constructor)) is
 * not supported, these calls has to be done first in main program.
68
 */
69
70
#ifndef LABCOMM_CONSTRUCTOR
#define LABCOMM_CONSTRUCTOR __attribute__((constructor))
71
#endif
72

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

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

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

95
96
struct labcomm_reader_action_context;

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

     Returned value:
       == 0    Success
       != 0    Error
  */
117
118
  int (*free)(struct labcomm_reader *r, 
	      struct labcomm_reader_action_context *action_context);
119
120
121
122
123
124
125
  /* '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)
126
   */
127
  int (*start)(struct labcomm_reader *r, 
128
	       struct labcomm_reader_action_context *action_context,
Anders Blomdell's avatar
Anders Blomdell committed
129
130
	       int local_index, int remote_index,
	       struct labcomm_signature *signature,
131
	       void *value);
132
133
134
135
136
137
  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,
138
139
	       int local_index, int remote_index,
	       struct labcomm_signature *signature, 
140
	       uint32_t ioctl_action, va_list args);
141
142
};

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

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

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

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

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

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

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

#else

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

242
static inline unsigned int labcomm_read_packed32(struct labcomm_reader *r)
243
244
245
246
247
248
249
{
  unsigned int result = 0;
  
  while (1) {
    unsigned char tmp;

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

/*
 * Semi private encoder declarations
 */
Anders Blomdell's avatar
Anders Blomdell committed
291
292
typedef int (*labcomm_encoder_function)(struct labcomm_writer *,
					void *value);
293
struct labcomm_writer_action_context;
294
295

struct labcomm_writer_action {
296
297
  int (*alloc)(struct labcomm_writer *w, 
	       struct labcomm_writer_action_context *action_context, 
Anders Blomdell's avatar
Anders Blomdell committed
298
	       char *labcomm_version);
299
300
  int (*free)(struct labcomm_writer *w, 
	      struct labcomm_writer_action_context *action_context);
301
302
303
304
305
306
307
308
309
  /* '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
   */
310
311
  int (*start)(struct labcomm_writer *w, 
	       struct labcomm_writer_action_context *action_context,
312
313
	       int index, struct labcomm_signature *signature,
	       void *value);
314
315
316
317
318
319
  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, 
320
	       int index, struct labcomm_signature *signature, 
321
	       uint32_t ioctl_action, va_list args);
322
323
};

324
325
struct labcomm_writer_action_context {
  struct labcomm_writer_action_context *next;
326
  const struct labcomm_writer_action *action;
327
328
329
330
331
  void *context;  
};

struct labcomm_writer {
  struct labcomm_writer_action_context *action_context;
332
333
334
  struct labcomm_memory *memory;
  /* The following fields are initialized by labcomm_encoder_new */
  struct labcomm_encoder *encoder;
335
336
337
338
339
340
341
  unsigned char *data;
  int data_size;
  int count;
  int pos;
  int error;
};

342
343
int labcomm_writer_alloc(struct labcomm_writer *w, 
			 struct labcomm_writer_action_context *action_context, 
Anders Blomdell's avatar
Anders Blomdell committed
344
			 char *labcomm_version);
345
346
347
348
349
350
351
352
353
354
355
356
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, 
357
			 int index, struct labcomm_signature *signature, 
358
359
			 uint32_t ioctl_action, va_list args);

360
int labcomm_internal_encoder_register(
361
362
  struct labcomm_encoder *encoder, 
  struct labcomm_signature *signature, 
363
  labcomm_encoder_function encode);
Anders Nilsson's avatar
Anders Nilsson committed
364

365
int labcomm_internal_encode(
366
367
  struct labcomm_encoder *encoder, 
  struct labcomm_signature *signature, 
368
  labcomm_encoder_function encode,
Anders Nilsson's avatar
Anders Nilsson committed
369
370
  void *value);

371
int labcomm_internal_encoder_ioctl(struct labcomm_encoder *encoder, 
372
				   struct labcomm_signature *signature,
373
				   uint32_t ioctl_action, va_list args);
374

Anders Nilsson's avatar
Anders Nilsson committed
375
376
377
#if __BYTE_ORDER == __LITTLE_ENDIAN

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

#else

#define LABCOMM_ENCODE(name, type)					\
395
  static inline int labcomm_write_##name(struct labcomm_writer *w, type data) { \
Anders Nilsson's avatar
Anders Nilsson committed
396
397
398
    int i;								\
    for (i = 0 ; i < sizeof(type) ; i++) {				\
      if (w->pos >= w->count) {						\
399
        int err;							\
400
	err = labcomm_writer_flush(w, w->action_context);		\
401
	if (err != 0) { return err; }					\
Anders Nilsson's avatar
Anders Nilsson committed
402
403
404
405
      }									\
      w->data[w->pos] = ((unsigned char*)(&data))[i];			\
      w->pos++;								\
    }									\
406
    return 0;								\
Anders Nilsson's avatar
Anders Nilsson committed
407
408
409
410
411
412
413
414
415
416
417
  }

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

419
static inline int labcomm_write_packed32(struct labcomm_writer *w, 
420
421
422
423
424
425
426
427
428
429
430
					 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;
431
      err = labcomm_writer_flush(w, w->action_context);	
432
433
434
435
436
437
438
      if (err != 0) { return err; }
    }
    w->data[w->pos++] = tmp[i] | (i?0x80:0x00);
  }
  return 0;
}

439
static inline int labcomm_write_string(struct labcomm_writer *w, char *s)
Anders Nilsson's avatar
Anders Nilsson committed
440
{
441
  int length, i, err; 
Anders Nilsson's avatar
Anders Nilsson committed
442
443

  length = strlen((char*)s);
444
445
  err = labcomm_write_packed32(w, length);
  if (err != 0) { return err; }
Anders Nilsson's avatar
Anders Nilsson committed
446
447
  for (i = 0 ; i < length ; i++) {
    if (w->pos >= w->count) {	
448
      int err;
449
      err = labcomm_writer_flush(w, w->action_context);	
450
      if (err != 0) { return err; }
Anders Nilsson's avatar
Anders Nilsson committed
451
452
453
454
    }
    w->data[w->pos] = s[i];
    w->pos++;
  }
455
  return 0;
Anders Nilsson's avatar
Anders Nilsson committed
456
457
}

458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
/*
 * 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 */

476
477
#define LABCOMM_SIGNATURE_ARRAY_FREE(memory, name, kind)	\
  if (name.data) { labcomm_memory_free(memory, 0, name.data); }	\
478
479
  name.data = (kind *)NULL; /* typechecking */

480
481
482
483
484
485
486
487
488
489
490
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)		\
491
  (name.data = (kind *)name.data, /* typechecking no-op */		\
492
493
   (kind *)(labcomm_signature_array_ref(memory,				\
					&name.first, &name.last,	\
494
495
496
					(void **)&name.data,		\
					sizeof(kind), index)))

497
498
499
#define LABCOMM_SIGNATURE_ARRAY_FOREACH(name, kind, var)		\
  for (name.data = (kind *)name.data, /* typechecking no-op */		\
       var = name.first ; var < name.last ; var++)
500

501
502
503
504
505
506
/* Give signature a free local index, this may not be used concurrently */
void labcomm_set_local_index(struct labcomm_signature *signature);

/* Get the local index for a signature */
int labcomm_get_local_index(struct labcomm_signature *s);

Anders Nilsson's avatar
Anders Nilsson committed
507
#endif