tesla.proto

Go to the documentation of this file.

/*
 * Copyright (c) 2012 Jonathan Anderson
 * All rights reserved.
 *
 * This software was developed by SRI International and the University of
 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
 * ("CTSRD"), as part of the DARPA CRASH research programme.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
package tesla;


message ManifestFile {
  repeated AutomatonDescription automaton = 1;

  repeated Usage root = 2;
}


message Usage {
  required Identifier identifier = 1;

  optional Expression beginning = 2;

  optional Expression end = 3;
}


message AutomatonDescription {
  required Identifier identifier = 1;

  enum Context { Global = 1; ThreadLocal = 2; };
  required Context context = 2;

  required Expression expression = 3;

  repeated Argument argument = 5;
}


message Identifier {
  optional string name = 1;

  optional Location location = 2;
}

message Location {
  required string filename = 1;
  required int32 line = 2;
  required int32 counter = 3;
}

message Expression {
  enum Type {
    BOOLEAN_EXPR = 1; SEQUENCE = 2; NULL_EXPR = 3;
    NOW = 4; FUNCTION = 5; FIELD_ASSIGN = 6;
    SUB_AUTOMATON = 7;
  };
  required Type type = 1;

  optional BooleanExpr booleanExpr = 2;
  optional Sequence sequence = 3;
  optional NowEvent now = 4;
  optional FunctionEvent function = 5;
  optional FieldAssignment fieldAssign = 6;
  optional Identifier subAutomaton = 7;
}

message BooleanExpr {
  enum Operation { BE_And = 1; BE_Or = 2; BE_Xor = 3; }

  required Operation operation = 1;
  repeated Expression expression = 2;
}

message Sequence {
  repeated Expression expression = 1;
}

message NowEvent {
  required Location location = 1;
}

message FunctionEvent {
  enum Direction { Entry = 1; Exit = 2; }
  enum CallContext { Caller = 1; Callee = 2; }
  enum CallKind { CCall = 1; ObjCInstanceMessage = 2; ObjCClassMessage = 3;
    ObjCSuperMessage = 4; }

  required FunctionRef function = 1;

  optional Direction direction = 2;

  optional CallContext context = 3;

  repeated Argument argument = 4;

  optional Argument expectedReturnValue = 5;

  optional bool strict = 6 [ default = true ];

  optional CallKind kind = 7 [ default = CCall ];

  optional Argument receiver = 8;
}

message FunctionRef {
  required string name = 1;
}

message FieldAssignment {
  enum AssignType { SimpleAssign = 1; PlusEqual = 2; MinusEqual = 3; };

  required StructField field = 8;

  required AssignType operation = 4;

  required Argument value = 5;

  optional bool strict = 7 [ default = true ];
}

message StructField {
  required string type = 1;

  required Argument base = 2;

  required string name = 3;

  required int32 index = 4;
}

message Argument {
  enum Type { Constant = 1; Variable = 2; Any = 3; Indirect = 4; Field = 5; }
  required Type type = 1;

  enum MatchType { Exact = 1; Flags = 2; Mask = 3; }

  optional int32 index = 2;

  optional string name = 3;

  optional int64 value = 5;

  optional MatchType constantMatch = 6 [ default = Exact ];

  optional Argument indirection = 7;

  optional StructField field = 8;
}