thrift_src/standard.thrift

/* Copyright 2013-present Barefoot Networks, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * Antonin Bas (antonin@barefootnetworks.com)
 *
 */

namespace cpp bm_runtime.standard
namespace py bm_runtime.standard

typedef i32 BmEntryHandle
typedef list<binary> BmActionData

typedef i32 BmMemberHandle
typedef i32 BmGroupHandle

typedef i32 BmLearningListId
typedef i64 BmLearningBufferId
typedef i32 BmLearningSampleId

enum BmMatchParamType {
  EXACT = 0,
  LPM = 1,
  TERNARY = 2,
  VALID = 3,
  RANGE = 4
}

struct BmMatchParamExact {
  1:binary key
}

struct BmMatchParamLPM {
  1:binary key,
  2:i32 prefix_length
}

struct BmMatchParamTernary {
  1:binary key,
  2:binary mask
}

struct BmMatchParamValid {
  1:bool key
}

# end is a keyword in Thrift
struct BmMatchParamRange {
  1:binary start,
  2:binary end_
}

# Thrift union sucks in C++, the following is much better
struct BmMatchParam {
  1:BmMatchParamType type,
  2:optional BmMatchParamExact exact,
  3:optional BmMatchParamLPM lpm,
  4:optional BmMatchParamTernary ternary,
  5:optional BmMatchParamValid valid,
  6:optional BmMatchParamRange range
}

typedef list<BmMatchParam> BmMatchParams

struct BmAddEntryOptions {
  1:optional i32 priority
}

struct BmCounterValue {
  1:i64 bytes;
  2:i64 packets;
}

struct BmMeterRateConfig {
  1:double units_per_micros;
  2:i32 burst_size;
}

enum TableOperationErrorCode {
  TABLE_FULL = 1,
  INVALID_HANDLE = 2,
  EXPIRED_HANDLE = 3,
  COUNTERS_DISABLED = 4,
  METERS_DISABLED = 5,
  AGEING_DISABLED = 6,
  INVALID_TABLE_NAME = 7,
  INVALID_ACTION_NAME = 8,
  WRONG_TABLE_TYPE = 9,
  INVALID_MBR_HANDLE = 10,
  MBR_STILL_USED = 11,
  MBR_ALREADY_IN_GRP = 12,
  MBR_NOT_IN_GRP = 13,
  INVALID_GRP_HANDLE = 14,
  GRP_STILL_USED = 15,
  EMPTY_GRP = 16,
  DUPLICATE_ENTRY = 17,
  BAD_MATCH_KEY = 18,
  INVALID_METER_OPERATION = 19,
  DEFAULT_ACTION_IS_CONST = 20,
  DEFAULT_ENTRY_IS_CONST = 21,
  NO_DEFAULT_ENTRY = 22,
  INVALID_ACTION_PROFILE_NAME = 23,
  NO_ACTION_PROFILE_SELECTION = 24,
  IMMUTABLE_TABLE_ENTRIES = 25,
  BAD_ACTION_DATA = 26,
  NO_TABLE_KEY = 27,
  ERROR = 100,
}

exception InvalidTableOperation {
  1:TableOperationErrorCode code
}

enum CounterOperationErrorCode {
  INVALID_COUNTER_NAME = 1,
  INVALID_INDEX = 2,
  ERROR = 3,
}

exception InvalidCounterOperation {
  1:CounterOperationErrorCode code
}

enum SwapOperationErrorCode {
  CONFIG_SWAP_DISABLED = 1,
  ONGOING_SWAP = 2,
  NO_ONGOING_SWAP = 3
}

exception InvalidSwapOperation {
  1:SwapOperationErrorCode code
}

enum MeterOperationErrorCode {
  INVALID_METER_NAME = 1,
  INVALID_INDEX = 2,
  BAD_RATES_LIST = 3,
  INVALID_INFO_RATE_VALUE = 4,
  INVALID_BURST_SIZE_VALUE = 5,
  ERROR = 6
}

exception InvalidMeterOperation {
 1:MeterOperationErrorCode code
}

typedef i64 BmRegisterValue

enum RegisterOperationErrorCode {
  INVALID_REGISTER_NAME = 1,
  INVALID_INDEX = 2,
  ERROR = 3
}

exception InvalidRegisterOperation {
 1:RegisterOperationErrorCode code
}

typedef binary BmParseVSetValue

enum ParseVSetOperationErrorCode {
  INVALID_PARSE_VSET_NAME = 1,
  ERROR = 2
}

exception InvalidParseVSetOperation {
 1:ParseVSetOperationErrorCode code
}

enum LearnOperationErrorCode {
  INVALID_LIST_ID = 1,
  INVALID_LIST_NAME = 2,
  ERROR = 3
}

exception InvalidLearnOperation {
 1:LearnOperationErrorCode code
}

// TODO
enum DevMgrErrorCode {
  ERROR = 1
}

exception InvalidDevMgrOperation {
 1:DevMgrErrorCode code
}

struct DevMgrPortInfo {
  1:i32 port_num;
  2:string iface_name;
  3:bool is_up;
  4:map<string, string> extra;
}

struct BmCrc16Config {
  1:i16 polynomial;
  2:i16 initial_remainder;
  3:i16 final_xor_value;
  4:bool data_reflected;
  5:bool remainder_reflected;
}

struct BmCrc32Config {
  1:i32 polynomial;
  2:i32 initial_remainder;
  3:i32 final_xor_value;
  4:bool data_reflected;
  5:bool remainder_reflected;
}

enum CrcErrorCode {
  INVALID_CALCULATION_NAME = 1,
  WRONG_TYPE_CALCULATION = 2,
  INVALID_CONFIG = 3
}

exception InvalidCrcOperation {
 1:CrcErrorCode code
}

typedef binary BmToeplitzHashKey

enum ToeplitzHashErrorCode {
  INVALID_CALCULATION_NAME = 1,
  WRONG_TYPE_CALCULATION = 2,
  INVALID_KEY = 3
}

exception InvalidToeplitzHashOperation {
  1:ToeplitzHashErrorCode code
}

enum BmActionEntryType {
  NONE = 0,  // used when querying default entry, if none configured
  ACTION_DATA = 1,
  MBR_HANDLE = 2,
  GRP_HANDLE = 3
}

struct BmActionEntry {
 1:BmActionEntryType action_type,
 2:optional string action_name,
 3:optional BmActionData action_data,
 4:optional BmMemberHandle mbr_handle,
 5:optional BmGroupHandle grp_handle
}

struct BmMtEntryLife {
 1:i32 timeout_ms;
 2:i32 time_since_hit_ms;
}

struct BmMtEntry {
 1:BmMatchParams match_key,
 2:BmAddEntryOptions options,
 3:BmEntryHandle entry_handle,
 4:BmActionEntry action_entry,
 5:optional BmMtEntryLife life
}

struct BmMtActProfMember {
 1:BmMemberHandle mbr_handle,
 2:string action_name,
 3:BmActionData action_data
}

struct BmMtActProfGroup {
 1:BmGroupHandle grp_handle,
 2:list<BmMemberHandle> mbr_handles
}

struct BmConfig {
 1:i64 device_id,
 2:i32 thrift_port,
 3:optional string notifications_socket,
 4:optional string elogger_socket,
 5:optional string debugger_socket
}

enum BmResourceType {
  MATCH_TABLE = 0,
  ACTION_PROFILE = 1,
  COUNTER = 2,
  METER = 3,
  REGISTER = 4,
  LEARNING_LIST = 5
}

enum IdLookupErrorCode {
  INVALID_RESOURCE_TYPE = 0,
  INVALID_RESOURCE_NAME = 1
}

exception InvalidIdLookup {
 1:IdLookupErrorCode code
}

service Standard {
	
  // table operations

  // works for direct and indirect tables
  i64 bm_mt_get_num_entries(
    1:i32 cxt_id,
    2:string table_name
  ) throws (1:InvalidTableOperation ouch),

  // works for direct and indirect tables
  void bm_mt_clear_entries(
    1:i32 cxt_id,
    2:string table_name,
    3:bool reset_default_entry
  ) throws (1:InvalidTableOperation ouch),

  // direct tables

  BmEntryHandle bm_mt_add_entry(
    1:i32 cxt_id,
    2:string table_name,
    3:BmMatchParams match_key,
    4:string action_name,
    5:BmActionData action_data,
    6:BmAddEntryOptions options
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_set_default_action(
    1:i32 cxt_id,
    2:string table_name,
    3:string action_name,
    4:BmActionData action_data
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_reset_default_entry(
    1:i32 cxt_id,
    2:string table_name
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_delete_entry(
    1:i32 cxt_id,
    2:string table_name,
    3:BmEntryHandle entry_handle
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_modify_entry(
    1:i32 cxt_id,
    2:string table_name,
    3:BmEntryHandle entry_handle,
    4:string action_name,
    5:BmActionData action_data
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_set_entry_ttl(
    1:i32 cxt_id,
    2:string table_name
    3:BmEntryHandle entry_handle,
    4:i32 timeout_ms
  ) throws (1:InvalidTableOperation ouch),

  // action profiles

  BmMemberHandle bm_mt_act_prof_add_member(
    1:i32 cxt_id,
    2:string act_prof_name,
    3:string action_name,
    4:BmActionData action_data
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_act_prof_delete_member(
    1:i32 cxt_id,
    2:string act_prof_name,
    3:BmMemberHandle mbr_handle
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_act_prof_modify_member(
    1:i32 cxt_id,
    2:string act_prof_name,
    3:BmMemberHandle mbr_handle,
    4:string action_name,
    5:BmActionData action_data
  ) throws (1:InvalidTableOperation ouch),

  BmGroupHandle bm_mt_act_prof_create_group(
    1:i32 cxt_id,
    2:string act_prof_name
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_act_prof_delete_group(
    1:i32 cxt_id,
    2:string act_prof_name,
    3:BmGroupHandle grp_handle
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_act_prof_add_member_to_group(
    1:i32 cxt_id,
    2:string act_prof_name,
    3:BmMemberHandle mbr_handle,
    4:BmGroupHandle grp_handle
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_act_prof_remove_member_from_group(
    1:i32 cxt_id,
    2:string act_prof_name,
    3:BmMemberHandle mbr_handle,
    4:BmGroupHandle grp_handle
  ) throws (1:InvalidTableOperation ouch),

  list<BmMtActProfMember> bm_mt_act_prof_get_members(
    1:i32 cxt_id,
    2:string act_prof_name
  ) throws (1:InvalidTableOperation ouch),

  BmMtActProfMember bm_mt_act_prof_get_member(
    1:i32 cxt_id,
    2:string act_prof_name,
    3:BmMemberHandle mbr_handle
  ) throws (1:InvalidTableOperation ouch),

  list<BmMtActProfGroup> bm_mt_act_prof_get_groups(
    1:i32 cxt_id,
    2:string act_prof_name
  ) throws (1:InvalidTableOperation ouch),

  BmMtActProfGroup bm_mt_act_prof_get_group(
    1:i32 cxt_id,
    2:string act_prof_name,
    3:BmGroupHandle grp_handle
  ) throws (1:InvalidTableOperation ouch),

  // indirect tables

  BmEntryHandle bm_mt_indirect_add_entry(
    1:i32 cxt_id,
    2:string table_name,
    3:BmMatchParams match_key,
    4:BmMemberHandle mbr_handle,
    5:BmAddEntryOptions options
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_indirect_modify_entry(
    1:i32 cxt_id,
    2:string table_name,
    3:BmEntryHandle entry_handle,
    4:BmMemberHandle mbr_handle
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_indirect_delete_entry(
    1:i32 cxt_id,
    2:string table_name,
    3:BmEntryHandle entry_handle
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_indirect_set_entry_ttl(
    1:i32 cxt_id,
    2:string table_name
    3:BmEntryHandle entry_handle,
    4:i32 timeout_ms
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_indirect_set_default_member(
    1:i32 cxt_id,
    2:string table_name,
    3:BmMemberHandle mbr_handle
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_indirect_reset_default_entry(
    1:i32 cxt_id,
    2:string table_name
  ) throws (1:InvalidTableOperation ouch),

  // indirect tables with selector

  BmEntryHandle bm_mt_indirect_ws_add_entry(
    1:i32 cxt_id,
    2:string table_name,
    3:BmMatchParams match_key,
    4:BmGroupHandle grp_handle
    5:BmAddEntryOptions options
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_indirect_ws_modify_entry(
    1:i32 cxt_id,
    2:string table_name,
    3:BmEntryHandle entry_handle,
    4:BmGroupHandle grp_handle
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_indirect_ws_set_default_group(
    1:i32 cxt_id,
    2:string table_name,
    3:BmGroupHandle grp_handle
  ) throws (1:InvalidTableOperation ouch),

  BmCounterValue bm_mt_read_counter(
    1:i32 cxt_id,
    2:string table_name,
    3:BmEntryHandle entry_handle
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_reset_counters(
    1:i32 cxt_id,
    2:string table_name
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_write_counter(
    1:i32 cxt_id,
    2:string table_name,
    3:BmEntryHandle entry_handle,
    4:BmCounterValue value
  ) throws (1:InvalidTableOperation ouch),

  void bm_mt_set_meter_rates(
    1:i32 cxt_id,
    2:string table_name,
    3:BmEntryHandle entry_handle,
    4:list<BmMeterRateConfig> rates
  ) throws (1:InvalidTableOperation ouch),

  list<BmMeterRateConfig> bm_mt_get_meter_rates(
    1:i32 cxt_id,
    2:string table_name,
    3:BmEntryHandle entry_handle
  ) throws (1:InvalidTableOperation ouch),

  list<BmMtEntry> bm_mt_get_entries(
    1:i32 cxt_id,
    2:string table_name
  ) throws (1:InvalidTableOperation ouch),

  BmMtEntry bm_mt_get_entry(
    1:i32 cxt_id,
    2:string table_name,
    3:BmEntryHandle entry_handle
  ) throws (1:InvalidTableOperation ouch),

  BmActionEntry bm_mt_get_default_entry(
    1:i32 cxt_id,
    2:string table_name
  ) throws (1:InvalidTableOperation ouch),

  // if match_key is empty, returns default entry
  BmMtEntry bm_mt_get_entry_from_key(
    1:i32 cxt_id,
    2:string table_name,
    3:BmMatchParams match_key,
    4:BmAddEntryOptions options
  ) throws (1:InvalidTableOperation ouch),

  // indirect counters

  BmCounterValue bm_counter_read(
    1:i32 cxt_id,
    2:string counter_name,
    3:i32 index
  ) throws (1:InvalidCounterOperation ouch),

  void bm_counter_reset_all(
    1:i32 cxt_id,
    2:string counter_name
  ) throws (1:InvalidCounterOperation ouch),

  void bm_counter_write(
    1:i32 cxt_id,
    2:string counter_name,
    3:i32 index,
    4:BmCounterValue value
  ) throws (1:InvalidCounterOperation ouch),

  // learning acks

  void bm_learning_ack(
    1:i32 cxt_id,
    2:BmLearningListId list_id,
    3:BmLearningBufferId buffer_id,
    4:list<BmLearningSampleId> sample_ids
  ) throws (1:InvalidLearnOperation ouch),

  void bm_learning_ack_buffer(
    1:i32 cxt_id,
    2:BmLearningListId list_id,
    3:BmLearningBufferId buffer_id
  ) throws (1:InvalidLearnOperation ouch),

  void bm_learning_set_timeout(
    1:i32 cxt_id,
    2:BmLearningListId list_id,
    3:i32 timeout_ms
  ) throws (1:InvalidLearnOperation ouch),

  void bm_learning_set_buffer_size(
    1:i32 cxt_id,
    2:BmLearningListId list_id,
    3:i32 nb_samples
  ) throws (1:InvalidLearnOperation ouch),

  // swap configs

  void bm_load_new_config(
    1:string config_str
  ) throws (1:InvalidSwapOperation ouch),

  void bm_swap_configs() throws (1:InvalidSwapOperation ouch),
  
  // meters

  void bm_meter_array_set_rates(
    1:i32 cxt_id,
    2:string meter_array_name,
    3:list<BmMeterRateConfig> rates
  ) throws (1:InvalidMeterOperation ouch)

  void bm_meter_set_rates(
    1:i32 cxt_id,
    2:string meter_array_name,
    3:i32 index,
    4:list<BmMeterRateConfig> rates
  ) throws (1:InvalidMeterOperation ouch)

  list<BmMeterRateConfig> bm_meter_get_rates(
    1:i32 cxt_id,
    2:string meter_array_name,
    3:i32 index
  ) throws (1:InvalidMeterOperation ouch)


  // registers

  BmRegisterValue bm_register_read(
    1:i32 cxt_id,
    2:string register_array_name,
    3:i32 idx
  ) throws (1:InvalidRegisterOperation ouch)

  list<BmRegisterValue> bm_register_read_all(
    1:i32 cxt_id,
    2:string register_array_name
  ) throws (1:InvalidRegisterOperation ouch)

  void bm_register_write(
    1:i32 cxt_id,
    2:string register_array_name,
    3:i32 index,
    4:BmRegisterValue value
  ) throws (1:InvalidRegisterOperation ouch)

  void bm_register_write_range(
    1:i32 cxt_id,
    2:string register_array_name,
    3:i32 start_index,
    4:i32 end_index,
    5:BmRegisterValue value
  ) throws (1:InvalidRegisterOperation ouch)

  void bm_register_reset(
    1:i32 cxt_id,
    2:string register_array_name
  ) throws (1:InvalidRegisterOperation ouch)

  // parse value sets

  void bm_parse_vset_add(
    1:i32 cxt_id,
    2:string parse_vset_name,
    3:BmParseVSetValue value
  ) throws (1:InvalidParseVSetOperation ouch)

  void bm_parse_vset_remove(
    1:i32 cxt_id,
    2:string parse_vset_name,
    3:BmParseVSetValue value
  ) throws (1:InvalidParseVSetOperation ouch)

  list<BmParseVSetValue> bm_parse_vset_get(
    1:i32 cxt_id,
    2:string parse_vset_name
  ) throws (1:InvalidParseVSetOperation ouch)

  void bm_parse_vset_clear(
    1:i32 cxt_id,
    2:string parse_vset_name
  ) throws (1:InvalidParseVSetOperation ouch)


  // device manager

  void bm_dev_mgr_add_port(
    1:string iface_name,
    2:i32 port_num,
    3:string pcap_path // optional
  ) throws (1:InvalidDevMgrOperation ouch)

  void bm_dev_mgr_remove_port(
    1:i32 port_num
  ) throws (1:InvalidDevMgrOperation ouch)

  list<DevMgrPortInfo> bm_dev_mgr_show_ports(
  ) throws (1:InvalidDevMgrOperation ouch)

  // bmv2 management functions

  BmConfig bm_mgmt_get_info()

  void bm_set_crc16_custom_parameters(
    1:i32 cxt_id,
    2:string calc_name,
    3:BmCrc16Config crc16_config
  ) throws (1:InvalidCrcOperation ouch)

  void bm_set_crc32_custom_parameters(
    1:i32 cxt_id,
    2:string calc_name,
    3:BmCrc32Config crc32_config
  ) throws (1:InvalidCrcOperation ouch)

  void bm_set_toeplitz_hash_key(
    1:i32 cxt_id,
    2:string calc_name,
    3:BmToeplitzHashKey key
  ) throws (1:InvalidToeplitzHashOperation ouch)

  void bm_reset_state()

  string bm_get_config()
  binary bm_get_config_md5()

  i32 bm_get_id_from_name(
    1:i32 cxt_id,
    2:BmResourceType resource_type,
    3:string resource_name
  ) throws (1:InvalidIdLookup ouch)

  string bm_serialize_state()
}