xpu_postgis.h

/*
 * xpu_postgis.h
 *
 * Collection of PostGIS functions & operators for xPU devices.
 * --
 * Copyright 2011-2023 (C) KaiGai Kohei <kaigai@kaigai.gr.jp>
 * Copyright 2014-2023 (C) PG-Strom Developers Team
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the PostgreSQL License.
 */
#ifndef XPU_POSTGIS_H
#define XPU_POSTGIS_H

/*
 * GSERIALIZED; on-disk data layout of geometry values
 */
#define G1FLAG_Z			0x01
#define G1FLAG_M			0x02
#define G1FLAG_BBOX			0x04
#define G1FLAG_GEODETIC		0x08
#define G1FLAG_READONLY		0x10
#define G1FLAG_SOLID		0x20

#define G2FLAG_Z			0x01
#define G2FLAG_M			0x02
#define G2FLAG_BBOX			0x04
#define G2FLAG_GEODETIC		0x08
#define G2FLAG_EXTENDED		0x10
#define G2FLAG_RESERVED1	0x20 /* RESERVED FOR FUTURE USES */
#define G2FLAG_VER_0		0x40
#define G2FLAG_RESERVED2	0x80 /* RESERVED FOR FUTURE VERSIONS */

#define G2FLAG_X_SOLID			0x00000001
#define G2FLAG_X_CHECKED_VALID	0x00000002	/* To Be Implemented? */
#define G2FLAG_X_IS_VALID		0x00000004	/* To Be Implemented? */
#define G2FLAG_X_HAS_HASH		0x00000008	/* To Be Implemented? */

typedef struct
{
	uint8_t		srid[3];	/* 24bits SRID */
	uint8_t		gflags;		/* GxFLAG_* above */
	char		data[1];
} __GSERIALIZED;

typedef struct
{
	int32_t		vl_len_;	/* varlena header */
	__GSERIALIZED body;
} GSERIALIZED;

/* see LWTYPE definitions; at liblwgeom.h */
#define GEOM_POINTTYPE				1
#define GEOM_LINETYPE				2
#define GEOM_POLYGONTYPE			3
#define GEOM_MULTIPOINTTYPE			4
#define GEOM_MULTILINETYPE			5
#define GEOM_MULTIPOLYGONTYPE		6
#define GEOM_COLLECTIONTYPE			7
#define GEOM_CIRCSTRINGTYPE			8
#define GEOM_COMPOUNDTYPE			9
#define GEOM_CURVEPOLYTYPE			10
#define GEOM_MULTICURVETYPE			11
#define GEOM_MULTISURFACETYPE		12
#define GEOM_POLYHEDRALSURFACETYPE	13
#define GEOM_TRIANGLETYPE			14
#define GEOM_TINTYPE				15
#define GEOM_NUMTYPES				16
#define GEOM_INVALID_VARLENA		255
#define GEOM_TYPE_IS_VALID(gs_type)	((gs_type) >= 1 && (gs_type) < GEOM_NUMTYPES)

/* see LWFLAG_* in CPU code; at liblwgeom.h */
#define GEOM_FLAG__Z			0x01
#define GEOM_FLAG__M			0x02
#define GEOM_FLAG__ZM			0x03	/* == GEOM_FLAG__Z | GEOM_FLAG__M */
#define GEOM_FLAG__BBOX			0x04
#define GEOM_FLAG__GEODETIC		0x08
#define GEOM_FLAG__READONLY		0x10
#define GEOM_FLAG__SOLID		0x20
#define GEOM_FLAGS_NDIMS(flags)		\
	(2 + ((flags) & GEOM_FLAG__Z) + (((flags) & GEOM_FLAG__M) >> 1))

/*
 * boundary box
 */
typedef struct
{
	float4_t	xmin, xmax;
	float4_t	ymin, ymax;
} geom_bbox_2d;

typedef struct
{
	float4_t	xmin, xmax;
	float4_t	ymin, ymax;
	float4_t	zmin, zmax;
} geom_bbox_3d;

typedef struct
{
	float4_t	xmin, xmax;
	float4_t	ymin, ymax;
	float4_t	mmin, mmax;
} geom_bbox_3dm;

typedef struct
{
	float4_t	xmin, xmax;
	float4_t	ymin, ymax;
	float4_t	zmin, zmax;
	float4_t	mmin, mmax;
} geom_bbox_4d;

typedef union
{
	geom_bbox_2d	d2;
	geom_bbox_3d	d3;
	geom_bbox_3dm	d3m;
	geom_bbox_4d	d4;
} geom_bbox;

typedef struct {
	KVEC_DATUM_COMMON_FIELD;
	float4_t		xmin[KVEC_UNITSZ];
	float4_t		xmax[KVEC_UNITSZ];
	float4_t		ymin[KVEC_UNITSZ];
	float4_t		ymax[KVEC_UNITSZ];
} kvec_box2df_t;
__PGSTROM_SQLTYPE_SIMPLE_DECLARATION(box2df, geom_bbox_2d);

INLINE_FUNCTION(size_t)
geometry_bbox_size(uint32_t geom_flags)
{
	if ((geom_flags & GEOM_FLAG__GEODETIC) != 0)
		return sizeof(float) * 6;

	return sizeof(float) * 2 * GEOM_FLAGS_NDIMS(geom_flags);
}

/* some SRID definitions */
#define SRID_UNKNOWN		0
#define SRID_MAXIMUM		999999
#define SRID_USER_MAXIMUM	998999

typedef struct
{
	KVEC_DATUM_COMMON_FIELD;
	uint8_t			type[KVEC_UNITSZ];
	uint16_t		flags[KVEC_UNITSZ];
	int32_t			srid[KVEC_UNITSZ];
	uint32_t		nitems[KVEC_UNITSZ];
	uint32_t		rawsize[KVEC_UNITSZ];
	const char	   *rawdata[KVEC_UNITSZ];
	const geom_bbox *bbox[KVEC_UNITSZ];
} kvec_geometry_t;

typedef struct
{
	XPU_DATUM_COMMON_FIELD;
	uint8_t		type;		/* one of GEOM_*TYPE */
	uint16_t	flags;		/* combination of GEOM_FLAG__* */
	int32_t		srid;		/* SRID of this geometry */
	uint32_t	nitems;		/* # of items; what it exactly means depends on
							 * the geometry type */
	uint32_t	rawsize;	/* length of the rawdata buffer */
	const char *rawdata;	/* pointer to the raw-data; it may not be aligned,
							 * so needs to copy local buffer once */
	const geom_bbox *bbox;	/* boundary box if any */
} xpu_geometry_t;

EXTERN_DATA xpu_datum_operators	xpu_geometry_ops;

/*
 * POINT2D, POINT3D, POINT3DM, POINT4D
 */
typedef struct
{
	double	x, y;
} POINT2D;

typedef struct
{
	double	x, y, z;
} POINT3D;

typedef struct
{
	double	x, y, z;
} POINT3DZ;

typedef struct
{
	double	x, y, m;
} POINT3DM;

typedef struct
{
	double	x, y, z, m;
} POINT4D;

#endif /* XPU_POSTGIS_H */