client.h

Go to the documentation of this file.

/*------------------------------------------------------------------------------
Copyright 2024 Munich Quantum Software Stack Project
 
Licensed under the Apache License, Version 2.0 with LLVM Exceptions (the
"License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 
https://github.com/Munich-Quantum-Software-Stack/QDMI/blob/develop/LICENSE
 
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.
 
SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
------------------------------------------------------------------------------*/
 
#pragma once
 
#include "qdmi/constants.h" // IWYU pragma: export
#include "qdmi/types.h"     // IWYU pragma: export
 
#ifdef __cplusplus
#include <cstddef>
 
extern "C" {
#else
#include <stddef.h>
#endif
 
// The following clang-tidy warning cannot be addressed because this header is
// used from both C and C++ code.
// NOLINTBEGIN(performance-enum-size, modernize-use-using)
 
typedef struct QDMI_Device_impl_d *QDMI_Device;
 
typedef struct QDMI_Session_impl_d *QDMI_Session;
 
int QDMI_session_alloc(QDMI_Session *session);
 
enum QDMI_SESSION_PARAMETER_T {
  QDMI_SESSION_PARAMETER_TOKEN = 0,
  QDMI_SESSION_PARAMETER_USERNAME = 1,
  QDMI_SESSION_PARAMETER_PROJECTID = 2,
  QDMI_SESSION_PARAMETER_MAX = 3,
  QDMI_SESSION_PARAMETER_CUSTOM1 = 999999995,
  QDMI_SESSION_PARAMETER_CUSTOM2 = 999999996,
  QDMI_SESSION_PARAMETER_CUSTOM3 = 999999997,
  QDMI_SESSION_PARAMETER_CUSTOM4 = 999999998,
  QDMI_SESSION_PARAMETER_CUSTOM5 = 999999999
};
 
typedef enum QDMI_SESSION_PARAMETER_T QDMI_Session_Parameter;
 
int QDMI_session_set_parameter(QDMI_Session session,
                               QDMI_Session_Parameter param, size_t size,
                               const void *value);
 
int QDMI_session_init(QDMI_Session session);
 
enum QDMI_SESSION_PROPERTY_T {
  QDMI_SESSION_PROPERTY_DEVICES = 0,
  QDMI_SESSION_PROPERTY_MAX = 1,
  QDMI_SESSION_PROPERTY_CUSTOM1 = 999999995,
  QDMI_SESSION_PROPERTY_CUSTOM2 = 999999996,
  QDMI_SESSION_PROPERTY_CUSTOM3 = 999999997,
  QDMI_SESSION_PROPERTY_CUSTOM4 = 999999998,
  QDMI_SESSION_PROPERTY_CUSTOM5 = 999999999
};
 
typedef enum QDMI_SESSION_PROPERTY_T QDMI_Session_Property;
 
int QDMI_session_query_session_property(QDMI_Session session,
                                        QDMI_Session_Property prop, size_t size,
                                        void *value, size_t *size_ret);
 
void QDMI_session_free(QDMI_Session session);
 
 // end of client_session_interface
 
int QDMI_device_query_device_property(QDMI_Device device,
                                      QDMI_Device_Property prop, size_t size,
                                      void *value, size_t *size_ret);
 
int QDMI_device_query_site_property(QDMI_Device device, QDMI_Site site,
                                    QDMI_Site_Property prop, size_t size,
                                    void *value, size_t *size_ret);
 
int QDMI_device_query_operation_property(
    QDMI_Device device, QDMI_Operation operation, size_t num_sites,
    const QDMI_Site *sites, size_t num_params, const double *params,
    QDMI_Operation_Property prop, size_t size, void *value, size_t *size_ret);
 
 // end of client_query_interface
 
typedef struct QDMI_Job_impl_d *QDMI_Job;
 
int QDMI_device_create_job(QDMI_Device device, QDMI_Job *job);
 
enum QDMI_JOB_PARAMETER_T {
  QDMI_JOB_PARAMETER_PROGRAMFORMAT = 0,
  QDMI_JOB_PARAMETER_PROGRAM = 1,
  QDMI_JOB_PARAMETER_SHOTSNUM = 2,
  QDMI_JOB_PARAMETER_MAX = 3,
  QDMI_JOB_PARAMETER_CUSTOM1 = 999999995,
  QDMI_JOB_PARAMETER_CUSTOM2 = 999999996,
  QDMI_JOB_PARAMETER_CUSTOM3 = 999999997,
  QDMI_JOB_PARAMETER_CUSTOM4 = 999999998,
  QDMI_JOB_PARAMETER_CUSTOM5 = 999999999
};
 
typedef enum QDMI_JOB_PARAMETER_T QDMI_Job_Parameter;
 
int QDMI_job_set_parameter(QDMI_Job job, QDMI_Job_Parameter param, size_t size,
                           const void *value);
 
int QDMI_job_submit(QDMI_Job job);
 
int QDMI_job_cancel(QDMI_Job job);
 
int QDMI_job_check(QDMI_Job job, QDMI_Job_Status *status);
 
int QDMI_job_wait(QDMI_Job job);
 
int QDMI_job_get_results(QDMI_Job job, QDMI_Job_Result result, size_t size,
                         void *data, size_t *size_ret);
 
void QDMI_job_free(QDMI_Job job);
 
 // end of client_job_interface
 
 // end of client_interface
 
// NOLINTEND(performance-enum-size, modernize-use-using)
 
#ifdef __cplusplus
} // extern "C"
#endif