vtest/vtest_protocol.h - chromiumos/third_party/virglrenderer - Git at Google

 /**************************************************************************
  *
  * Copyright (C) 2015 Red Hat Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
  * to deal in the Software without restriction, including without limitation
  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  * and/or sell copies of the Software, and to permit persons to whom the
  * Software is furnished to do so, subject to the following conditions:
  *
  * The above copyright notice and this permission notice shall be included
  * in all copies or substantial portions of the Software.
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  * OTHER DEALINGS IN THE SOFTWARE.
  *
  **************************************************************************/

 #ifndef VTEST_PROTOCOL
 #define VTEST_PROTOCOL

 #define VTEST_DEFAULT_SOCKET_NAME "/tmp/.virgl_test"

 #ifdef VIRGL_RENDERER_UNSTABLE_APIS
 #define VTEST_PROTOCOL_VERSION 3
 #else
 #define VTEST_PROTOCOL_VERSION 2
 #endif

 /* 32-bit length field */
 /* 32-bit cmd field */
 #define VTEST_HDR_SIZE 2
 #define VTEST_CMD_LEN 0 /* length of data */
 #define VTEST_CMD_ID  1
 #define VTEST_CMD_DATA_START 2

 /* vtest cmds */
 #define VCMD_GET_CAPS 1

 #define VCMD_RESOURCE_CREATE 2
 #define VCMD_RESOURCE_UNREF 3

 #define VCMD_TRANSFER_GET 4
 #define VCMD_TRANSFER_PUT 5

 #define VCMD_SUBMIT_CMD 6

 #define VCMD_RESOURCE_BUSY_WAIT 7

 /* pass the process cmd line for debugging */
 #define VCMD_CREATE_RENDERER 8

 #define VCMD_GET_CAPS2 9
 /* get caps */
 /* 0 length cmd */
 /* resp VCMD_GET_CAPS + caps */

 #define VCMD_PING_PROTOCOL_VERSION 10

 #define VCMD_PROTOCOL_VERSION 11

 /* since protocol version 2 */
 #define VCMD_RESOURCE_CREATE2 12
 #define VCMD_TRANSFER_GET2 13
 #define VCMD_TRANSFER_PUT2 14

 #ifdef VIRGL_RENDERER_UNSTABLE_APIS
 /* since protocol version 3 */
 #define VCMD_GET_PARAM 15
 #define VCMD_GET_CAPSET 16
 #define VCMD_CONTEXT_INIT 17
 #define VCMD_RESOURCE_CREATE_BLOB 18
 #define VCMD_SYNC_CREATE 19
 #define VCMD_SYNC_UNREF 20
 #define VCMD_SYNC_READ 21
 #define VCMD_SYNC_WRITE 22
 #define VCMD_SYNC_WAIT 23
 #define VCMD_SUBMIT_CMD2 24
 #endif /* VIRGL_RENDERER_UNSTABLE_APIS */

 #define VCMD_RES_CREATE_SIZE 10
 #define VCMD_RES_CREATE_RES_HANDLE 0 /* must be 0 since protocol version 3 */
 #define VCMD_RES_CREATE_TARGET 1
 #define VCMD_RES_CREATE_FORMAT 2
 #define VCMD_RES_CREATE_BIND 3
 #define VCMD_RES_CREATE_WIDTH 4
 #define VCMD_RES_CREATE_HEIGHT 5
 #define VCMD_RES_CREATE_DEPTH 6
 #define VCMD_RES_CREATE_ARRAY_SIZE 7
 #define VCMD_RES_CREATE_LAST_LEVEL 8
 #define VCMD_RES_CREATE_NR_SAMPLES 9
 /* resp res_id since protocol version 3 */

 #define VCMD_RES_CREATE2_SIZE 11
 #define VCMD_RES_CREATE2_RES_HANDLE 0 /* must be 0 since protocol version 3 */
 #define VCMD_RES_CREATE2_TARGET 1
 #define VCMD_RES_CREATE2_FORMAT 2
 #define VCMD_RES_CREATE2_BIND 3
 #define VCMD_RES_CREATE2_WIDTH 4
 #define VCMD_RES_CREATE2_HEIGHT 5
 #define VCMD_RES_CREATE2_DEPTH 6
 #define VCMD_RES_CREATE2_ARRAY_SIZE 7
 #define VCMD_RES_CREATE2_LAST_LEVEL 8
 #define VCMD_RES_CREATE2_NR_SAMPLES 9
 #define VCMD_RES_CREATE2_DATA_SIZE 10
 /* resp res_id since protocol version 3, and fd if data_size >0 */

 #define VCMD_RES_UNREF_SIZE 1
 #define VCMD_RES_UNREF_RES_HANDLE 0

 #define VCMD_TRANSFER_HDR_SIZE 11
 #define VCMD_TRANSFER_RES_HANDLE 0
 #define VCMD_TRANSFER_LEVEL 1
 #define VCMD_TRANSFER_STRIDE 2
 #define VCMD_TRANSFER_LAYER_STRIDE 3
 #define VCMD_TRANSFER_X 4
 #define VCMD_TRANSFER_Y 5
 #define VCMD_TRANSFER_Z 6
 #define VCMD_TRANSFER_WIDTH 7
 #define VCMD_TRANSFER_HEIGHT 8
 #define VCMD_TRANSFER_DEPTH 9
 #define VCMD_TRANSFER_DATA_SIZE 10

 #define VCMD_TRANSFER2_HDR_SIZE 10
 #define VCMD_TRANSFER2_RES_HANDLE 0
 #define VCMD_TRANSFER2_LEVEL 1
 #define VCMD_TRANSFER2_X 2
 #define VCMD_TRANSFER2_Y 3
 #define VCMD_TRANSFER2_Z 4
 #define VCMD_TRANSFER2_WIDTH 5
 #define VCMD_TRANSFER2_HEIGHT 6
 #define VCMD_TRANSFER2_DEPTH 7
 #define VCMD_TRANSFER2_DATA_SIZE 8
 #define VCMD_TRANSFER2_OFFSET 9

 #define VCMD_BUSY_WAIT_FLAG_WAIT 1

 #define VCMD_BUSY_WAIT_SIZE 2
 #define VCMD_BUSY_WAIT_HANDLE 0
 #define VCMD_BUSY_WAIT_FLAGS 1

 #define VCMD_PING_PROTOCOL_VERSION_SIZE 0

 #define VCMD_PROTOCOL_VERSION_SIZE 1
 #define VCMD_PROTOCOL_VERSION_VERSION 0

 #ifdef VIRGL_RENDERER_UNSTABLE_APIS

 enum vcmd_param  {
    VCMD_PARAM_MAX_TIMELINE_COUNT = 1,
 };
 #define VCMD_GET_PARAM_SIZE 1
 #define VCMD_GET_PARAM_PARAM 0
 /* resp param validity and value */

 #define VCMD_GET_CAPSET_SIZE 2
 #define VCMD_GET_CAPSET_ID 0
 #define VCMD_GET_CAPSET_VERSION 1
 /* resp capset validity and contents */

 #define VCMD_CONTEXT_INIT_SIZE 1
 #define VCMD_CONTEXT_INIT_CAPSET_ID 0

 enum vcmd_blob_type {
    VCMD_BLOB_TYPE_GUEST        = 1,
    VCMD_BLOB_TYPE_HOST3D       = 2,
    VCMD_BLOB_TYPE_HOST3D_GUEST = 3,
 };

 enum vcmd_blob_flag {
    VCMD_BLOB_FLAG_MAPPABLE     = 1 << 0,
    VCMD_BLOB_FLAG_SHAREABLE    = 1 << 1,
    VCMD_BLOB_FLAG_CROSS_DEVICE = 1 << 2,
 };

 #define VCMD_RES_CREATE_BLOB_SIZE 6
 #define VCMD_RES_CREATE_BLOB_TYPE 0
 #define VCMD_RES_CREATE_BLOB_FLAGS 1
 #define VCMD_RES_CREATE_BLOB_SIZE_LO 2
 #define VCMD_RES_CREATE_BLOB_SIZE_HI 3
 #define VCMD_RES_CREATE_BLOB_ID_LO 4
 #define VCMD_RES_CREATE_BLOB_ID_HI 5
 /* resp res_id and mmap'able fd */

 #define VCMD_SYNC_CREATE_SIZE 2
 #define VCMD_SYNC_CREATE_VALUE_LO 0
 #define VCMD_SYNC_CREATE_VALUE_HI 1
 /* resp sync id */

 #define VCMD_SYNC_UNREF_SIZE 1
 #define VCMD_SYNC_UNREF_ID 0

 #define VCMD_SYNC_READ_SIZE 1
 #define VCMD_SYNC_READ_ID 0
 /* resp sync value */

 #define VCMD_SYNC_WRITE_SIZE 3
 #define VCMD_SYNC_WRITE_ID 0
 #define VCMD_SYNC_WRITE_VALUE_LO 1
 #define VCMD_SYNC_WRITE_VALUE_HI 2

 enum vcmd_sync_wait_flag {
    VCMD_SYNC_WAIT_FLAG_ANY = 1 << 0,
 };
 #define VCMD_SYNC_WAIT_SIZE(count) (2 + 3 * count)
 #define VCMD_SYNC_WAIT_FLAGS 0
 #define VCMD_SYNC_WAIT_TIMEOUT 1
 #define VCMD_SYNC_WAIT_ID(n)       (2 + 3 * (n) + 0)
 #define VCMD_SYNC_WAIT_VALUE_LO(n) (2 + 3 * (n) + 1)
 #define VCMD_SYNC_WAIT_VALUE_HI(n) (2 + 3 * (n) + 2)
 /* resp poll'able fd */

 enum vcmd_submit_cmd2_flag {
    VCMD_SUBMIT_CMD2_FLAG_RING_IDX = 1 << 0,
 };

 struct vcmd_submit_cmd2_batch {
    uint32_t flags;

    uint32_t cmd_offset;
    uint32_t cmd_size;

    /* sync_count pairs of (id, val) starting at sync_offset */
    uint32_t sync_offset;
    uint32_t sync_count;

    /* ignored unless VCMD_SUBMIT_CMD2_FLAG_RING_IDX is set */
    uint32_t ring_idx;
 };
 #define VCMD_SUBMIT_CMD2_BATCH_COUNT 0
 #define VCMD_SUBMIT_CMD2_BATCH_FLAGS(n)            (1 + 8 * (n) + 0)
 #define VCMD_SUBMIT_CMD2_BATCH_CMD_OFFSET(n)       (1 + 8 * (n) + 1)
 #define VCMD_SUBMIT_CMD2_BATCH_CMD_SIZE(n)         (1 + 8 * (n) + 2)
 #define VCMD_SUBMIT_CMD2_BATCH_SYNC_OFFSET(n)      (1 + 8 * (n) + 3)
 #define VCMD_SUBMIT_CMD2_BATCH_SYNC_COUNT(n)       (1 + 8 * (n) + 4)
 #define VCMD_SUBMIT_CMD2_BATCH_RING_IDX(n)         (1 + 8 * (n) + 5)

 #endif /* VIRGL_RENDERER_UNSTABLE_APIS */

 #endif /* VTEST_PROTOCOL */
	/**************************************************************************
	*
	* Copyright (C) 2015 Red Hat Inc.
	*
	* Permission is hereby granted, free of charge, to any person obtaining a
	* copy of this software and associated documentation files (the "Software"),
	* to deal in the Software without restriction, including without limitation
	* the rights to use, copy, modify, merge, publish, distribute, sublicense,
	* and/or sell copies of the Software, and to permit persons to whom the
	* Software is furnished to do so, subject to the following conditions:
	*
	* The above copyright notice and this permission notice shall be included
	* in all copies or substantial portions of the Software.
	*
	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
	* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
	* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
	* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	* OTHER DEALINGS IN THE SOFTWARE.
	*
	**************************************************************************/

	#ifndef VTEST_PROTOCOL
	#define VTEST_PROTOCOL

	#define VTEST_DEFAULT_SOCKET_NAME "/tmp/.virgl_test"

	#ifdef VIRGL_RENDERER_UNSTABLE_APIS
	#define VTEST_PROTOCOL_VERSION 3
	#else
	#define VTEST_PROTOCOL_VERSION 2
	#endif

	/* 32-bit length field */
	/* 32-bit cmd field */
	#define VTEST_HDR_SIZE 2
	#define VTEST_CMD_LEN 0 /* length of data */
	#define VTEST_CMD_ID 1
	#define VTEST_CMD_DATA_START 2

	/* vtest cmds */
	#define VCMD_GET_CAPS 1

	#define VCMD_RESOURCE_CREATE 2
	#define VCMD_RESOURCE_UNREF 3

	#define VCMD_TRANSFER_GET 4
	#define VCMD_TRANSFER_PUT 5

	#define VCMD_SUBMIT_CMD 6

	#define VCMD_RESOURCE_BUSY_WAIT 7

	/* pass the process cmd line for debugging */
	#define VCMD_CREATE_RENDERER 8

	#define VCMD_GET_CAPS2 9
	/* get caps */
	/* 0 length cmd */
	/* resp VCMD_GET_CAPS + caps */

	#define VCMD_PING_PROTOCOL_VERSION 10

	#define VCMD_PROTOCOL_VERSION 11

	/* since protocol version 2 */
	#define VCMD_RESOURCE_CREATE2 12
	#define VCMD_TRANSFER_GET2 13
	#define VCMD_TRANSFER_PUT2 14

	#ifdef VIRGL_RENDERER_UNSTABLE_APIS
	/* since protocol version 3 */
	#define VCMD_GET_PARAM 15
	#define VCMD_GET_CAPSET 16
	#define VCMD_CONTEXT_INIT 17
	#define VCMD_RESOURCE_CREATE_BLOB 18
	#define VCMD_SYNC_CREATE 19
	#define VCMD_SYNC_UNREF 20
	#define VCMD_SYNC_READ 21
	#define VCMD_SYNC_WRITE 22
	#define VCMD_SYNC_WAIT 23
	#define VCMD_SUBMIT_CMD2 24
	#endif /* VIRGL_RENDERER_UNSTABLE_APIS */

	#define VCMD_RES_CREATE_SIZE 10
	#define VCMD_RES_CREATE_RES_HANDLE 0 /* must be 0 since protocol version 3 */
	#define VCMD_RES_CREATE_TARGET 1
	#define VCMD_RES_CREATE_FORMAT 2
	#define VCMD_RES_CREATE_BIND 3
	#define VCMD_RES_CREATE_WIDTH 4
	#define VCMD_RES_CREATE_HEIGHT 5
	#define VCMD_RES_CREATE_DEPTH 6
	#define VCMD_RES_CREATE_ARRAY_SIZE 7
	#define VCMD_RES_CREATE_LAST_LEVEL 8
	#define VCMD_RES_CREATE_NR_SAMPLES 9
	/* resp res_id since protocol version 3 */

	#define VCMD_RES_CREATE2_SIZE 11
	#define VCMD_RES_CREATE2_RES_HANDLE 0 /* must be 0 since protocol version 3 */
	#define VCMD_RES_CREATE2_TARGET 1
	#define VCMD_RES_CREATE2_FORMAT 2
	#define VCMD_RES_CREATE2_BIND 3
	#define VCMD_RES_CREATE2_WIDTH 4
	#define VCMD_RES_CREATE2_HEIGHT 5
	#define VCMD_RES_CREATE2_DEPTH 6
	#define VCMD_RES_CREATE2_ARRAY_SIZE 7
	#define VCMD_RES_CREATE2_LAST_LEVEL 8
	#define VCMD_RES_CREATE2_NR_SAMPLES 9
	#define VCMD_RES_CREATE2_DATA_SIZE 10
	/* resp res_id since protocol version 3, and fd if data_size >0 */

	#define VCMD_RES_UNREF_SIZE 1
	#define VCMD_RES_UNREF_RES_HANDLE 0

	#define VCMD_TRANSFER_HDR_SIZE 11
	#define VCMD_TRANSFER_RES_HANDLE 0
	#define VCMD_TRANSFER_LEVEL 1
	#define VCMD_TRANSFER_STRIDE 2
	#define VCMD_TRANSFER_LAYER_STRIDE 3
	#define VCMD_TRANSFER_X 4
	#define VCMD_TRANSFER_Y 5
	#define VCMD_TRANSFER_Z 6
	#define VCMD_TRANSFER_WIDTH 7
	#define VCMD_TRANSFER_HEIGHT 8
	#define VCMD_TRANSFER_DEPTH 9
	#define VCMD_TRANSFER_DATA_SIZE 10

	#define VCMD_TRANSFER2_HDR_SIZE 10
	#define VCMD_TRANSFER2_RES_HANDLE 0
	#define VCMD_TRANSFER2_LEVEL 1
	#define VCMD_TRANSFER2_X 2
	#define VCMD_TRANSFER2_Y 3
	#define VCMD_TRANSFER2_Z 4
	#define VCMD_TRANSFER2_WIDTH 5
	#define VCMD_TRANSFER2_HEIGHT 6
	#define VCMD_TRANSFER2_DEPTH 7
	#define VCMD_TRANSFER2_DATA_SIZE 8
	#define VCMD_TRANSFER2_OFFSET 9

	#define VCMD_BUSY_WAIT_FLAG_WAIT 1

	#define VCMD_BUSY_WAIT_SIZE 2
	#define VCMD_BUSY_WAIT_HANDLE 0
	#define VCMD_BUSY_WAIT_FLAGS 1

	#define VCMD_PING_PROTOCOL_VERSION_SIZE 0

	#define VCMD_PROTOCOL_VERSION_SIZE 1
	#define VCMD_PROTOCOL_VERSION_VERSION 0

	#ifdef VIRGL_RENDERER_UNSTABLE_APIS

	enum vcmd_param {
	VCMD_PARAM_MAX_TIMELINE_COUNT = 1,
	};
	#define VCMD_GET_PARAM_SIZE 1
	#define VCMD_GET_PARAM_PARAM 0
	/* resp param validity and value */

	#define VCMD_GET_CAPSET_SIZE 2
	#define VCMD_GET_CAPSET_ID 0
	#define VCMD_GET_CAPSET_VERSION 1
	/* resp capset validity and contents */

	#define VCMD_CONTEXT_INIT_SIZE 1
	#define VCMD_CONTEXT_INIT_CAPSET_ID 0

	enum vcmd_blob_type {
	VCMD_BLOB_TYPE_GUEST = 1,
	VCMD_BLOB_TYPE_HOST3D = 2,
	VCMD_BLOB_TYPE_HOST3D_GUEST = 3,
	};

	enum vcmd_blob_flag {
	VCMD_BLOB_FLAG_MAPPABLE = 1 << 0,
	VCMD_BLOB_FLAG_SHAREABLE = 1 << 1,
	VCMD_BLOB_FLAG_CROSS_DEVICE = 1 << 2,
	};

	#define VCMD_RES_CREATE_BLOB_SIZE 6
	#define VCMD_RES_CREATE_BLOB_TYPE 0
	#define VCMD_RES_CREATE_BLOB_FLAGS 1
	#define VCMD_RES_CREATE_BLOB_SIZE_LO 2
	#define VCMD_RES_CREATE_BLOB_SIZE_HI 3
	#define VCMD_RES_CREATE_BLOB_ID_LO 4
	#define VCMD_RES_CREATE_BLOB_ID_HI 5
	/* resp res_id and mmap'able fd */

	#define VCMD_SYNC_CREATE_SIZE 2
	#define VCMD_SYNC_CREATE_VALUE_LO 0
	#define VCMD_SYNC_CREATE_VALUE_HI 1
	/* resp sync id */

	#define VCMD_SYNC_UNREF_SIZE 1
	#define VCMD_SYNC_UNREF_ID 0

	#define VCMD_SYNC_READ_SIZE 1
	#define VCMD_SYNC_READ_ID 0
	/* resp sync value */

	#define VCMD_SYNC_WRITE_SIZE 3
	#define VCMD_SYNC_WRITE_ID 0
	#define VCMD_SYNC_WRITE_VALUE_LO 1
	#define VCMD_SYNC_WRITE_VALUE_HI 2

	enum vcmd_sync_wait_flag {
	VCMD_SYNC_WAIT_FLAG_ANY = 1 << 0,
	};
	#define VCMD_SYNC_WAIT_SIZE(count) (2 + 3 * count)
	#define VCMD_SYNC_WAIT_FLAGS 0
	#define VCMD_SYNC_WAIT_TIMEOUT 1
	#define VCMD_SYNC_WAIT_ID(n) (2 + 3 * (n) + 0)
	#define VCMD_SYNC_WAIT_VALUE_LO(n) (2 + 3 * (n) + 1)
	#define VCMD_SYNC_WAIT_VALUE_HI(n) (2 + 3 * (n) + 2)
	/* resp poll'able fd */

	enum vcmd_submit_cmd2_flag {
	VCMD_SUBMIT_CMD2_FLAG_RING_IDX = 1 << 0,
	};

	struct vcmd_submit_cmd2_batch {
	uint32_t flags;

	uint32_t cmd_offset;
	uint32_t cmd_size;

	/* sync_count pairs of (id, val) starting at sync_offset */
	uint32_t sync_offset;
	uint32_t sync_count;

	/* ignored unless VCMD_SUBMIT_CMD2_FLAG_RING_IDX is set */
	uint32_t ring_idx;
	};
	#define VCMD_SUBMIT_CMD2_BATCH_COUNT 0
	#define VCMD_SUBMIT_CMD2_BATCH_FLAGS(n) (1 + 8 * (n) + 0)
	#define VCMD_SUBMIT_CMD2_BATCH_CMD_OFFSET(n) (1 + 8 * (n) + 1)
	#define VCMD_SUBMIT_CMD2_BATCH_CMD_SIZE(n) (1 + 8 * (n) + 2)
	#define VCMD_SUBMIT_CMD2_BATCH_SYNC_OFFSET(n) (1 + 8 * (n) + 3)
	#define VCMD_SUBMIT_CMD2_BATCH_SYNC_COUNT(n) (1 + 8 * (n) + 4)
	#define VCMD_SUBMIT_CMD2_BATCH_RING_IDX(n) (1 + 8 * (n) + 5)

	#endif /* VIRGL_RENDERER_UNSTABLE_APIS */

	#endif /* VTEST_PROTOCOL */