apricot.proto

/*
 * === This file is part of ALICE O² ===
 *
 * Copyright 2020-2021 CERN and copyright holders of ALICE O².
 * Author: Teo Mrnjavac <teo.mrnjavac@cern.ch>
 *
 * This program 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.
 *
 * This program 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/>.
 *
 * In applying this license CERN does not waive the privileges and
 * immunities granted to it by virtue of its status as an
 * Intergovernmental Organization or submit itself to any jurisdiction.
 */

syntax = "proto3";

package apricot;
option java_package = "ch.cern.alice.o2.apricot.rpcserver";
option go_package = "github.com/AliceO2Group/Control/apricot/protos;apricotpb";

service Apricot {
    rpc NewRunNumber(Empty) returns (RunNumberResponse) {}
    rpc GetDefaults(Empty) returns (StringMap) {}
    rpc GetVars(Empty) returns (StringMap) {}
    rpc RawGetRecursive(RawGetRecursiveRequest) returns (ComponentResponse) {}

    // Detectors and host inventories
    rpc ListDetectors(DetectorsRequest) returns (DetectorsResponse) {}
    rpc GetHostInventory(HostGetRequest) returns (HostEntriesResponse) {}
    rpc GetDetectorsInventory(Empty) returns (DetectorEntriesResponse) {}
    rpc GetDetectorForHost(HostRequest) returns (DetectorResponse) {}
    rpc GetDetectorsForHosts(HostsRequest) returns (DetectorsResponse) {}
    rpc GetCRUCardsForHost(HostRequest) returns (CRUCardsResponse) {}
    rpc GetEndpointsForCRUCard(CardRequest) returns (CRUCardEndpointResponse) {}
    rpc GetLinkIDsForCRUEndpoint(LinkIDsRequest) returns (LinkIDsResponse) {}
    rpc GetAliasedLinkIDsForDetector(AliasedLinkIDsRequest) returns (AliasedLinkIDsResponse) {}

    // Runtime KV calls
    rpc GetRuntimeEntry(GetRuntimeEntryRequest) returns (ComponentResponse) {}
    rpc SetRuntimeEntry(SetRuntimeEntryRequest) returns (Empty) {}
    rpc GetRuntimeEntries(GetRuntimeEntriesRequest) returns (StringMap) {}
    rpc ListRuntimeEntries(ListRuntimeEntriesRequest) returns (ComponentEntriesResponse) {}

    // Component configuration calls
    rpc ListComponents(Empty) returns (ComponentEntriesResponse) {}
    rpc ListComponentEntries(ListComponentEntriesRequest) returns (ComponentEntriesResponse) {}
    rpc GetComponentConfiguration(ComponentRequest) returns (ComponentResponse) {}
    rpc GetComponentConfigurationWithLastIndex(ComponentRequest) returns (ComponentResponseWithLastIndex) {}
    rpc ResolveComponentQuery(ComponentQuery) returns (ComponentQuery) {}
    rpc ImportComponentConfiguration(ImportComponentConfigurationRequest) returns (ImportComponentConfigurationResponse) {}
    rpc InvalidateComponentTemplateCache(Empty) returns (Empty) {}
}

// NOTE: make sure the enum values include and match those in RunType in dcs.pb.go and runtype.go
// NOTE: this run type list is replicated in AliceO2 repo in
// https://github.com/AliceO2Group/AliceO2/blob/dev/DataFormats/Parameters/include/DataFormatsParameters/ECSDataAdapters.h
// Inform Ruben when the list is updated.

enum RunType {
    NULL                     =   0;
    PHYSICS                  =   1;
    TECHNICAL                =   2;
    PEDESTAL                 =   3;
    PULSER                   =   4;
    LASER                    =   5;
    CALIBRATION_ITHR_TUNING  =   6;
    CALIBRATION_VCASN_TUNING =   7;
    CALIBRATION_THR_SCAN     =   8;
    CALIBRATION_DIGITAL_SCAN =   9;
    CALIBRATION_ANALOG_SCAN  =  10;
    CALIBRATION_FHR          =  11;
    CALIBRATION_ALPIDE_SCAN  =  12;
    CALIBRATION              =  13;
    COSMICS                  =  14;
    SYNTHETIC                =  15;
    NOISE                    =  16;
    CALIBRATION_PULSE_LENGTH =  17;
    CALIBRATION_VRESETD      =  18;
    reserved 19 to 299;

    ANY                      = 300;
}

message Empty {}

message ComponentQuery {
    string component = 1;
    RunType runType = 2;
    string machineRole = 3;
    string entry = 4;
}

message ComponentRequest {
    oneof queryPath {
        string path = 1;
        ComponentQuery query = 2;
    }
    bool processTemplate = 3;
    map<string, string> varStack = 4;
}

message ComponentResponse {
    string payload = 1;
}

message ComponentResponseWithLastIndex {
    string payload = 1;
    uint64 lastIndex = 2;
}

message HostRequest {
    string hostname = 1;
}

message HostsRequest {
    repeated string hosts = 1;
}

message DetectorResponse {
    string payload = 1;
}

message DetectorInventoryResponse {
    repeated string flps = 1;
}

message DetectorEntriesResponse {
    map<string, DetectorInventoryResponse> detectorEntries = 1;
}

message RunNumberResponse {
    uint32 runNumber = 1;
}

message StringMap {
    map<string, string> stringMap = 1;
}

message RawGetRecursiveRequest {
    string rawPath = 1;
}

message GetRuntimeEntryRequest {
    string component = 1;
    string key = 2;
}

message SetRuntimeEntryRequest {
    string component = 1;
    string key = 2;
    string value = 3;
}
message GetEntryRequest {
    string key = 1;
}

message GetRuntimeEntriesRequest {
    string component = 1;
}

message ListRuntimeEntriesRequest {
    string component = 1;
}

message ComponentEntriesQuery {
    string component = 1;
    RunType runType = 2;
    string machineRole = 3;
}

message ListComponentEntriesRequest {
    oneof queryPath {
        string path = 1;
        ComponentEntriesQuery query = 2;
    }
}

message ComponentEntriesResponse {
    repeated string payload = 1;
}

message DetectorsRequest {
    bool getAll = 1; // if false(default) restricts "private" detectors (e.g. TRG)
}

message DetectorsResponse {
    repeated string detectors = 1;
}

message HostGetRequest {
    string detector = 1;
}

message HostEntriesResponse {
    repeated string hosts = 1;
}

message ImportComponentConfigurationRequest {
    ComponentQuery query = 1;
    string payload = 2;
    bool newComponent = 3;
}

message ImportComponentConfigurationResponse {
    bool existingComponentUpdated = 1;
    bool existingEntryUpdated = 2;
}

message CRUCardsResponse {
    string cards = 1;
}

message CardRequest {
    string hostname = 1;
    string cardSerial = 2;
}

message CRUCardEndpointResponse {
    string endpoints = 1;
}

message LinkIDsRequest {
    string hostname = 1;
    string cardSerial = 2;
    string endpoint = 3;
    bool onlyEnabled = 4;
}

message LinkIDsResponse {
    repeated string linkIDs = 1;
}

message AliasedLinkIDsRequest {
    string detector = 1;
    bool onlyEnabled = 2;
}

message AliasedLinkIDsResponse {
    repeated string aliasedLinkIDs = 1;
}