Home | History | Annotate | Download | only in 1.0 
      1 /*
      2  * Copyright (C) 2016 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package android.hardware.tests.msgq@1.0;
     18 
     19 interface IBenchmarkMsgQ {
     20     /**
     21      * This method requests the service to set up Synchronous read/write
     22      * wait-free FMQ with the client as reader.
     23      * @return ret Will be true if the setup was successful, false otherwise.
     24      * @return mqDescIn This structure describes the FMQ that was set up
     25      * by the service. Client can use it to set up the FMQ at its end.
     26      */
     27     configureClientInboxSyncReadWrite()
     28         generates(bool ret, fmq_sync<uint8_t> mqDescIn);
     29 
     30     /**
     31      * This method requests the service to set up Synchronous read/write
     32      * wait-free FMQ with the client as writer.
     33      * @return ret Will be true if the setup was successful, false otherwise.
     34      * @return mqDescOut This structure describes the FMQ that was set up
     35      * by the service. Client can use it to set up the FMQ at its end.
     36      */
     37     configureClientOutboxSyncReadWrite()
     38         generates(bool ret, fmq_sync<uint8_t> mqDescOut);
     39 
     40     /**
     41      * This method request the service to write into the FMQ.
     42      * @param count Number to messages to write.
     43      * @return ret Will be true if the write operation was successful,
     44      * false otherwise.
     45      */
     46     requestWrite(int32_t count) generates (bool ret);
     47 
     48     /**
     49      * This method request the service to read from the FMQ.
     50      * @param count Number to messages to read.
     51      * @ret Will be true if the read operation was successful, false otherwise.
     52      */
     53     requestRead(int32_t count) generates (bool ret);
     54 
     55     /**
     56      * This method kicks off a benchmarking experiment where
     57      * the client writes a message into its outbox FMQ,
     58      * the service reads it and writes it into the client's
     59      * inbox FMQ and the client reads the message.
     60      * The average time taken for the experiment is measured.
     61      * @param numIter The number of iterations to run the experiment.
     62      */
     63     benchmarkPingPong(uint32_t numIter);
     64 
     65     /**
     66      * This method kicks off a benchmarking experiment where
     67      * the service writes into an FMQ and the client reads the same.
     68      * @param numIter The number of iterations to run the experiment.
     69      */
     70     benchmarkServiceWriteClientRead(uint32_t numIter);
     71 
     72     /**
     73      * This method sends a vector of time duration(in ns).
     74      * @param timeData vector of time instants measured by client.
     75      * Each entry is the number of ns between the epoch and a
     76      * std::chrono::time_point.
     77      */
     78     sendTimeData(vec<int64_t> timeData);
     79 };
     80