fres/contract/fres_container_internal.h

   1 /**************************************************************************/
   2 /* ---------------------------------------------------------------------- */
   3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners:                 */
   4 /*                                                                        */
   5 /*   Universidad de Cantabria,              SPAIN                         */
   6 /*   University of York,                    UK                            */
   7 /*   Scuola Superiore Sant'Anna,            ITALY                         */
   8 /*   Kaiserslautern University,             GERMANY                       */
   9 /*   Univ. Politécnica  Valencia,           SPAIN                        */
  10 /*   Czech Technical University in Prague,  CZECH REPUBLIC                */
  11 /*   ENEA                                   SWEDEN                        */
  12 /*   Thales Communication S.A.              FRANCE                        */
  13 /*   Visual Tools S.A.                      SPAIN                         */
  14 /*   Rapita Systems Ltd                     UK                            */
  15 /*   Evidence                               ITALY                         */
  16 /*                                                                        */
  17 /*   See http://www.frescor.org for a link to partners' websites          */
  18 /*                                                                        */
  19 /*          FRESCOR project (FP6/2005/IST/5-034026) is funded             */
  20 /*       in part by the European Union Sixth Framework Programme          */
  21 /*       The European Union is not liable of any use that may be          */
  22 /*       made of this code.                                               */
  23 /*                                                                        */
  24 /*                                                                        */
  25 /*  This file is part of FRSH (FRescor ScHeduler)                         */
  26 /*                                                                        */
  27 /* FRSH is free software; you can redistribute it and/or modify it        */
  28 /* under terms of the GNU General Public License as published by the      */
  29 /* Free Software Foundation; either version 2, or (at your option) any    */
  30 /* later version.  FRSH is distributed in the hope that it will be        */
  31 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty    */
  32 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU    */
  33 /* General Public License for more details. You should have received a    */
  34 /* copy of the GNU General Public License along with FRSH; see file       */
  35 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,  */
  36 /* Cambridge, MA 02139, USA.                                              */
  37 /*                                                                        */
  38 /* As a special exception, including FRSH header files in a file,         */
  39 /* instantiating FRSH generics or templates, or linking other files       */
  40 /* with FRSH objects to produce an executable application, does not       */
  41 /* by itself cause the resulting executable application to be covered     */
  42 /* by the GNU General Public License. This exception does not             */
  43 /* however invalidate any other reasons why the executable file might be  */
  44 /* covered by the GNU Public License.                                     */
  45 /**************************************************************************/
  46
  47 /**
  48  * @file   fres_container_internal.h
  49  * @author Michal Sojka <sojkam1@fel.cvut.cz>
  50  *
  51  * @brief  Internal interface to fres_container.
  52  *
  53  * This header should only be included by files in frsh/fres library.
  54  *
  55  */
  56 #ifndef FRES_CONTAINER_INTERNAL_H
  57 #define FRES_CONTAINER_INTERNAL_H
  58
  59 #include <fres_contract_idl.h>
  60
  61 /** State of the block in container. */
  62 enum fres_block_state {
  63         /** There is no such block in the container. */
  64         FRES_BLOCK_EMPTY,
  65         /** The container contains the block in the deserialized
  66          * form. */
  67         FRES_BLOCK_DATA,
  68         /** The container contains the block in the serialized form
  69          * (sequence of octets).*/
  70         FRES_BLOCK_STREAM
  71 };
  72
  73 #define FRES_BLOCK_FLAG_ENDIAN_m 0x0001
  74 #define FRES_BLOCK_LITTLE_ENDIAN 0x0001
  75
  76 /** Unserialized (unknown) contracts blocks */
  77 typedef struct fres_block_stream {
  78         void *data; /**< Serialized data */
  79         CORBA_unsigned_short flags; /**< Flags: bit 1 - little endian */
  80         size_t length;              /**< Length of the stream */
  81 } fres_block_stream_t;
  82
  83 /**
  84  * Contract block.
  85  *
  86  */
  87 struct fres_block {
  88         enum fres_block_state state; /**< State of the block */
  89         union {
  90                 /** Pointer to data according to param_type
  91                  * (state == FRES_BLOCK_DATA) */
  92                 void *data;
  93
  94                 /** Unserialized (unknown) data
  95                  * (state == FRES_BLOCK_STREAM) */
  96                 fres_block_stream_t stream;
  97         } u;
  98 };
  99
 100 /**
 101  * Container for contract blocks.
 102  *
 103  * This is currently implemented as fixed size array of ::fres_block
 104  * structures, which means that the container cannot contain multiple
 105  * blocks of the same type.
 106  */
 107 struct fres_container {
 108         struct fres_block blocks[__FRES_NUM_BLOCKS];
 109 };
 110
 111 /** Checks wheder the @a type is valid number of the block */
 112 #define FRES_BLOCK_TYPE_VALID(type)     \
 113         ((type) < __FRES_NUM_BLOCKS &&  \
 114          (type) >= 0)
 115
 116 int
 117 fres_block_duplicate(struct fres_block *dest,
 118                      const struct fres_block *source,
 119                      enum fres_block_type type);
 120
 121 #endif