client.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 - 2026 QDMI Maintainers
 * All rights reserved.
 *
 * Licensed under the Apache License v2.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://llvm.org/LICENSE.txt
 *
 * 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/client_version.h" // IWYU pragma: export
#include "qdmi/constants.h"      // IWYU pragma: export
#include "qdmi/export.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)



QDMI_DRIVER_EXPORT uint32_t QDMI_driver_get_client_abi_version(void);

typedef struct QDMI_Device_impl_d *QDMI_Device;


typedef struct QDMI_Session_impl_d *QDMI_Session;

QDMI_DRIVER_EXPORT int QDMI_session_alloc(QDMI_Session *session);

enum QDMI_SESSION_PARAMETER_T {
  QDMI_SESSION_PARAMETER_TOKEN = 0,
  QDMI_SESSION_PARAMETER_AUTHFILE = 1,
  QDMI_SESSION_PARAMETER_AUTHURL = 2,
  QDMI_SESSION_PARAMETER_USERNAME = 3,
  QDMI_SESSION_PARAMETER_PASSWORD = 4,
  QDMI_SESSION_PARAMETER_PROJECTID = 5,
  QDMI_SESSION_PARAMETER_MAX = 6,
  QDMI_SESSION_PARAMETER_CUSTOM1 = QDMI_CUSTOM_ENUM_VALUE_MIN,
  QDMI_SESSION_PARAMETER_CUSTOM2 = 999999996,
  QDMI_SESSION_PARAMETER_CUSTOM3 = 999999997,
  QDMI_SESSION_PARAMETER_CUSTOM4 = 999999998,
  QDMI_SESSION_PARAMETER_CUSTOM5 = 999999999,
  QDMI_SESSION_PARAMETER_CUSTOM_MAX = QDMI_CUSTOM_ENUM_VALUE_MAX
};

typedef enum QDMI_SESSION_PARAMETER_T QDMI_Session_Parameter;

QDMI_DRIVER_EXPORT int QDMI_session_set_parameter(QDMI_Session session,
                                                  QDMI_Session_Parameter param,
                                                  size_t size,
                                                  const void *value);

QDMI_DRIVER_EXPORT 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 = QDMI_CUSTOM_ENUM_VALUE_MIN,
  QDMI_SESSION_PROPERTY_CUSTOM2 = 999999996,
  QDMI_SESSION_PROPERTY_CUSTOM3 = 999999997,
  QDMI_SESSION_PROPERTY_CUSTOM4 = 999999998,
  QDMI_SESSION_PROPERTY_CUSTOM5 = 999999999,
  QDMI_SESSION_PROPERTY_CUSTOM_MAX = QDMI_CUSTOM_ENUM_VALUE_MAX
};

typedef enum QDMI_SESSION_PROPERTY_T QDMI_Session_Property;

QDMI_DRIVER_EXPORT int
QDMI_session_query_session_property(QDMI_Session session,
                                    QDMI_Session_Property prop, size_t size,
                                    void *value, size_t *size_ret);

QDMI_DRIVER_EXPORT void QDMI_session_free(QDMI_Session session);
 // end of client_session_interface


QDMI_DRIVER_EXPORT int
QDMI_device_query_device_property(QDMI_Device device, QDMI_Device_Property prop,
                                  size_t size, void *value, size_t *size_ret);

QDMI_DRIVER_EXPORT int QDMI_device_query_program_features(
    QDMI_Device device, const QDMI_Program_Format *format, size_t size,
    QDMI_Program_Feature *value, size_t *size_ret);

QDMI_DRIVER_EXPORT 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);

QDMI_DRIVER_EXPORT 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;

QDMI_DRIVER_EXPORT int QDMI_device_create_job(QDMI_Device device,
                                              QDMI_Job *job);

QDMI_DRIVER_EXPORT int QDMI_session_retrieve_job_by_id(QDMI_Device device,
                                                       const char *job_id,
                                                       QDMI_Job *job);

enum QDMI_JOB_PARAMETER_T {
  QDMI_JOB_PARAMETER_PROGRAMFORMAT = 0,
  QDMI_JOB_PARAMETER_SHOTSNUM = 1,
  QDMI_JOB_PARAMETER_MAX = 2,
  QDMI_JOB_PARAMETER_CUSTOM1 = QDMI_CUSTOM_ENUM_VALUE_MIN,
  QDMI_JOB_PARAMETER_CUSTOM2 = 999999996,
  QDMI_JOB_PARAMETER_CUSTOM3 = 999999997,
  QDMI_JOB_PARAMETER_CUSTOM4 = 999999998,
  QDMI_JOB_PARAMETER_CUSTOM5 = 999999999,
  QDMI_JOB_PARAMETER_CUSTOM_MAX = QDMI_CUSTOM_ENUM_VALUE_MAX
};

typedef enum QDMI_JOB_PARAMETER_T QDMI_Job_Parameter;

QDMI_DRIVER_EXPORT int QDMI_job_set_parameter(QDMI_Job job,
                                              QDMI_Job_Parameter param,
                                              size_t size, const void *value);

QDMI_DRIVER_EXPORT int QDMI_job_set_programs(QDMI_Job job,
                                             const QDMI_Program_Format *format,
                                             size_t count, const size_t *sizes,
                                             const void *const *programs);

enum QDMI_JOB_PROPERTY_T {
  QDMI_JOB_PROPERTY_ID = 0,
  QDMI_JOB_PROPERTY_PROGRAMFORMAT = 1,
  QDMI_JOB_PROPERTY_PROGRAM = 2,
  QDMI_JOB_PROPERTY_SHOTSNUM = 3,
  QDMI_JOB_PROPERTY_QUEUEPOSITION = 4,
  QDMI_JOB_PROPERTY_PROGRAMSNUM = 5,
  QDMI_JOB_PROPERTY_MAX = 6,
  QDMI_JOB_PROPERTY_CUSTOM1 = QDMI_CUSTOM_ENUM_VALUE_MIN,
  QDMI_JOB_PROPERTY_CUSTOM2 = 999999996,
  QDMI_JOB_PROPERTY_CUSTOM3 = 999999997,
  QDMI_JOB_PROPERTY_CUSTOM4 = 999999998,
  QDMI_JOB_PROPERTY_CUSTOM5 = 999999999,
  QDMI_JOB_PROPERTY_CUSTOM_MAX = QDMI_CUSTOM_ENUM_VALUE_MAX
};

typedef enum QDMI_JOB_PROPERTY_T QDMI_Job_Property;

QDMI_DRIVER_EXPORT int QDMI_job_query_property(QDMI_Job job,
                                               QDMI_Job_Property prop,
                                               size_t size, void *value,
                                               size_t *size_ret);

QDMI_DRIVER_EXPORT int QDMI_job_submit(QDMI_Job job);

QDMI_DRIVER_EXPORT int QDMI_job_cancel(QDMI_Job job);

QDMI_DRIVER_EXPORT int QDMI_job_check(QDMI_Job job, QDMI_Job_Status *status);

QDMI_DRIVER_EXPORT int QDMI_job_wait(QDMI_Job job, size_t timeout);

QDMI_DRIVER_EXPORT int QDMI_job_get_results(QDMI_Job job, size_t program_index,
                                            QDMI_Job_Result result, size_t size,
                                            void *data, size_t *size_ret);

QDMI_DRIVER_EXPORT 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