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

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

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

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

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

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

Anders Nilsson's avatar
Anders Nilsson committed
193
194
195
#if __BYTE_ORDER == __LITTLE_ENDIAN

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

#else

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

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

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

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

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

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

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

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

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

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

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

Anders Nilsson's avatar
Anders Nilsson committed
362
363
364
#if __BYTE_ORDER == __LITTLE_ENDIAN

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

#else

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

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

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

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

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

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

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

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

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

Anders Nilsson's avatar
Anders Nilsson committed
488
#endif