csl.h

Go to the documentation of this file.

 
#ifndef _TEAMPLAY_CSL_H
#define _TEAMPLAY_CSL_H
 
//
// Utility Annotations
//
 
void __csl_security_set_secret( unsigned long long *var );
 
 
//
// Capture Annotations
//
 
/*
  We use 'TeamPlay variable' to refer to a C variable that is passed to at least one of the capture
  annotations defined herein.
 
  We require/assume that all TeamPlay variables are <em>unique<em>; i.e. the same TeamPlay variable must not be passed to two capture annotations. For clarity, this includes two occurrences of the
  same capture annotation.
 
  In addition to the Non-Functional Properties (NFP) file, the programmer may provide an
  <em>expert file<em> (name not final). The expert file is a CSV file with four columns:
 
  -# TeamPlay variable name (string),
  -# architecture (unsigned int),
  -# value (unsigned long long), and
  -# confidence level (bool).
 
  The TeamPlay variable is used to relate an entry (row) in the expert file with a
  capture annotation in the CSL-annotated source. The architecture value refers to the unique
  numerical ID for a supported architecture as defined in <tt>teamplay_arch.h</tt>. The value is a
  user-provided default value to be assigned to the given TeamPlay variable. Finally, the
  confidence value determines whether the default value should always be used (see
  <tt>teamplay_reel.h</tt>). The behaviour for pairing entires in the expert file and capture
  annotations in the CSL-annotated source code when there exists multiple entries in the expert
  file for the same TeamPlay variable and architecture pair is as yet undefined.
*/
 
void __csl_time_worst( unsigned long long *var );
 
void __csl_average_time( unsigned long long *var );
 
 
void __csl_energy( unsigned long long *var );
 
void __csl_security_crypto( unsigned long long *var );
 
void __csl_security_sca_time_worst( unsigned long long *var );
 
void __csl_security_sca_time_average( unsigned long long *var );
 
void __csl_security_sca_time_ratio( unsigned long long *var );
 
void __csl_security_sca_energy_worst( unsigned long long *var );
 
void __csl_security_sca_energy_average( unsigned long long *var );
 
void __csl_security_sca_energy_ratio( unsigned long long *var );
 
void __csl_security_sca_power_worst( unsigned long long *var );
 
void __csl_security_sca_power_average( unsigned long long *var );
 
void __csl_security_sca_power_ratio( unsigned long long *var );
 
//
// Assertion Annotations
//
 
void __csl_assert( _Bool expr );
 
 
struct __csl_nonground_int {
  unsigned long long minimum;
  unsigned long long maximum;
};
 
void __csl_assert_nonground( struct __csl_nonground_int *ngvar, _Bool expr );
 
//
// Component Annotations
//
 
#define __csl_component_application(x) void dummy_csl_fn_ ## x()
 
#define __csl_component(x) void dummy_csl_fn_ ## x()
 
void __csl_component_deadline(unsigned long long deadline);
 
void __csl_component_period(unsigned long long period);
 
void __csl_component_energy_available(unsigned long long energy);
 
void __csl_component_type_alias(char alias[], char type[], void *dValue);
 
void __csl_component_input(char label[], unsigned long long consume, char alias[]);
 
void __csl_component_output(char label[] , unsigned long long produce, char alias[], char edges[]);
 
void __csl_component_version( char label[] );
 
void __csl_component_security( unsigned long long secLevel);
 
void __csl_component_arch( char arch_label[]);
 
void __csl_component_wcet( unsigned long long wcet );
 
void __csl_component_wcec( unsigned long long wcec );
 
#endif