Updated handling of range error to be consistent with real

Makefile

@@ -10,15 +10,21 @@ TESTS = $(wildcard test/sql/*.sql)
 REGRESS = $(patsubst test/sql/%.sql,%,$(TESTS))
 REGRESS_OPTS = --inputdir=test --load-extension=$(EXTENSION)
 
-OPTFLAGS =
+OPTFLAGS = -march=native
 
-# Since runtime dispatch not supported
+# Mac ARM doesn't support -march=native
 ifeq ($(shell uname -s), Darwin)
-	ifeq ($(shell uname -m), x86_64)
+	ifeq ($(shell uname -p), arm)
-		OPTFLAGS = -march=native
+		# no difference with -march=armv8.5-a
+		OPTFLAGS =
 	endif
 endif
 
+# PowerPC doesn't support -march=native
+ifneq ($(filter ppc64%, $(shell uname -m)), )
+	OPTFLAGS =
+endif
+
 # For auto-vectorization:
 # - GCC (needs -ftree-vectorize OR -O3) - https://gcc.gnu.org/projects/tree-ssa/vectorization.html
 # - Clang (could use pragma instead) - https://llvm.org/docs/Vectorizers.html

README.md

@@ -415,7 +415,19 @@ You can use [Reciprocal Rank Fusion](https://github.com/pgvector/pgvector-python
 
 ### Tuning
 
-Use a tool like [PgTune](https://pgtune.leopard.in.ua/) to set initial values for Postgres server parameters.
+Use a tool like [PgTune](https://pgtune.leopard.in.ua/) to set initial values for Postgres server parameters. For instance, `shared_buffers` should typically be 25% of the server’s memory. You can find the config file with:
+
+```sql
+SHOW config_file;
+```
+
+And check individual settings with:
+
+```sql
+SHOW shared_buffers;
+```
+
+Be sure to restart Postgres for changes to take effect.
 
 ### Loading
 

sql/vector.sql

@@ -1,7 +1,7 @@
 -- complain if script is sourced in psql, rather than via CREATE EXTENSION
 \echo Use "CREATE EXTENSION vector" to load this file. \quit
 
--- type
+-- vector type
 
 CREATE TYPE vector;
 
@@ -29,7 +29,7 @@ CREATE TYPE vector (
 	STORAGE   = external
 );
 
--- functions
+-- vector functions
 
 CREATE FUNCTION l2_distance(vector, vector) RETURNS float8
 	AS 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT PARALLEL SAFE;
@@ -58,7 +58,7 @@ CREATE FUNCTION vector_sub(vector, vector) RETURNS vector
 CREATE FUNCTION vector_mul(vector, vector) RETURNS vector
 	AS 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT PARALLEL SAFE;
 
--- private functions
+-- vector private functions
 
 CREATE FUNCTION vector_lt(vector, vector) RETURNS bool
 	AS 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT PARALLEL SAFE;
@@ -99,7 +99,7 @@ CREATE FUNCTION vector_avg(double precision[]) RETURNS vector
 CREATE FUNCTION vector_combine(double precision[], double precision[]) RETURNS double precision[]
 	AS 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT PARALLEL SAFE;
 
--- aggregates
+-- vector aggregates
 
 CREATE AGGREGATE avg(vector) (
 	SFUNC = vector_accum,
@@ -117,7 +117,7 @@ CREATE AGGREGATE sum(vector) (
 	PARALLEL = SAFE
 );
 
--- cast functions
+-- vector cast functions
 
 CREATE FUNCTION vector(vector, integer, boolean) RETURNS vector
 	AS 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT PARALLEL SAFE;
@@ -137,7 +137,7 @@ CREATE FUNCTION array_to_vector(numeric[], integer, boolean) RETURNS vector
 CREATE FUNCTION vector_to_float4(vector, integer, boolean) RETURNS real[]
 	AS 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT PARALLEL SAFE;
 
--- casts
+-- vector casts
 
 CREATE CAST (vector AS vector)
 	WITH FUNCTION vector(vector, integer, boolean) AS IMPLICIT;
@@ -157,7 +157,7 @@ CREATE CAST (double precision[] AS vector)
 CREATE CAST (numeric[] AS vector)
 	WITH FUNCTION array_to_vector(numeric[], integer, boolean) AS ASSIGNMENT;
 
--- operators
+-- vector operators
 
 CREATE OPERATOR <-> (
 	LEFTARG = vector, RIGHTARG = vector, PROCEDURE = l2_distance,
@@ -240,7 +240,7 @@ CREATE ACCESS METHOD hnsw TYPE INDEX HANDLER hnswhandler;
 
 COMMENT ON ACCESS METHOD hnsw IS 'hnsw index access method';
 
--- opclasses
+-- vector opclasses
 
 CREATE OPERATOR CLASS vector_ops
 	DEFAULT FOR TYPE vector USING btree AS

src/hnsw.h

@@ -55,6 +55,11 @@
 #define HNSW_UPDATE_ENTRY_GREATER 1
 #define HNSW_UPDATE_ENTRY_ALWAYS 2
 
+typedef enum HnswType
+{
+	HNSW_TYPE_VECTOR
+}			HnswType;
+
 /* Build phases */
 /* PROGRESS_CREATEIDX_SUBPHASE_INITIALIZE is 1 */
 #define PROGRESS_HNSW_PHASE_LOAD		2
@@ -242,6 +247,7 @@ typedef struct HnswBuildState
 	Relation	index;
 	IndexInfo  *indexInfo;
 	ForkNumber	forkNum;
+	HnswType	type;
 
 	/* Settings */
 	int			dimensions;
@@ -366,7 +372,8 @@ typedef struct HnswVacuumState
 int			HnswGetM(Relation index);
 int			HnswGetEfConstruction(Relation index);
 FmgrInfo   *HnswOptionalProcInfo(Relation index, uint16 procnum);
-bool		HnswNormValue(FmgrInfo *procinfo, Oid collation, Datum *value);
+HnswType	HnswGetType(Relation index);
+bool		HnswNormValue(FmgrInfo *procinfo, Oid collation, Datum *value, HnswType type);
 Buffer		HnswNewBuffer(Relation index, ForkNumber forkNum);
 void		HnswInitPage(Buffer buf, Page page);
 void		HnswInit(void);

src/hnswbuild.c

@@ -489,7 +489,7 @@ InsertTuple(Relation index, Datum *values, bool *isnull, ItemPointer heaptid, Hn
 	/* Normalize if needed */
 	if (buildstate->normprocinfo != NULL)
 	{
-		if (!HnswNormValue(buildstate->normprocinfo, buildstate->collation, &value))
+		if (!HnswNormValue(buildstate->normprocinfo, buildstate->collation, &value, buildstate->type))
 			return false;
 	}
 
@@ -671,10 +671,13 @@ HnswSharedMemoryAlloc(Size size, void *state)
 static void
 InitBuildState(HnswBuildState * buildstate, Relation heap, Relation index, IndexInfo *indexInfo, ForkNumber forkNum)
 {
+	int			maxDimensions = HNSW_MAX_DIM;
+
 	buildstate->heap = heap;
 	buildstate->index = index;
 	buildstate->indexInfo = indexInfo;
 	buildstate->forkNum = forkNum;
+	buildstate->type = HnswGetType(index);
 
 	buildstate->m = HnswGetM(index);
 	buildstate->efConstruction = HnswGetEfConstruction(index);
@@ -684,8 +687,8 @@ InitBuildState(HnswBuildState * buildstate, Relation heap, Relation index, Index
 	if (buildstate->dimensions < 0)
 		elog(ERROR, "column does not have dimensions");
 
-	if (buildstate->dimensions > HNSW_MAX_DIM)
+	if (buildstate->dimensions > maxDimensions)
-		elog(ERROR, "column cannot have more than %d dimensions for hnsw index", HNSW_MAX_DIM);
+		elog(ERROR, "column cannot have more than %d dimensions for hnsw index", maxDimensions);
 
 	if (buildstate->efConstruction < 2 * buildstate->m)
 		elog(ERROR, "ef_construction must be greater than or equal to 2 * m");

src/hnswinsert.c

@@ -622,7 +622,7 @@ HnswInsertTuple(Relation index, Datum *values, bool *isnull, ItemPointer heap_ti
 	normprocinfo = HnswOptionalProcInfo(index, HNSW_NORM_PROC);
 	if (normprocinfo != NULL)
 	{
-		if (!HnswNormValue(normprocinfo, collation, &value))
+		if (!HnswNormValue(normprocinfo, collation, &value, HnswGetType(index)))
 			return;
 	}
 

src/hnswscan.c

@@ -40,29 +40,6 @@ GetScanItems(IndexScanDesc scan, Datum q)
 	return HnswSearchLayer(base, q, ep, hnsw_ef_search, 0, index, procinfo, collation, m, false, NULL);
 }
 
-/*
- * Get dimensions from metapage
- */
-static int
-GetDimensions(Relation index)
-{
-	Buffer		buf;
-	Page		page;
-	HnswMetaPage metap;
-	int			dimensions;
-
-	buf = ReadBuffer(index, HNSW_METAPAGE_BLKNO);
-	LockBuffer(buf, BUFFER_LOCK_SHARE);
-	page = BufferGetPage(buf);
-	metap = HnswPageGetMeta(page);
-
-	dimensions = metap->dimensions;
-
-	UnlockReleaseBuffer(buf);
-
-	return dimensions;
-}
-
 /*
  * Get scan value
  */
@@ -73,7 +50,7 @@ GetScanValue(IndexScanDesc scan)
 	Datum		value;
 
 	if (scan->orderByData->sk_flags & SK_ISNULL)
-		value = PointerGetDatum(InitVector(GetDimensions(scan->indexRelation)));
+		value = PointerGetDatum(NULL);
 	else
 	{
 		value = scan->orderByData->sk_argument;
@@ -84,7 +61,7 @@ GetScanValue(IndexScanDesc scan)
 
 		/* Fine if normalization fails */
 		if (so->normprocinfo != NULL)
-			HnswNormValue(so->normprocinfo, so->collation, &value);
+			HnswNormValue(so->normprocinfo, so->collation, &value, HnswGetType(scan->indexRelation));
 	}
 
 	return value;

src/hnswutils.c

@@ -149,6 +149,15 @@ HnswOptionalProcInfo(Relation index, uint16 procnum)
 	return index_getprocinfo(index, 1, procnum);
 }
 
+/*
+ * Get vector type
+ */
+HnswType
+HnswGetType(Relation index)
+{
+	return HNSW_TYPE_VECTOR;
+}
+
 /*
  * Divide by the norm
  *
@@ -158,19 +167,25 @@ HnswOptionalProcInfo(Relation index, uint16 procnum)
  * if it's different than the original value
  */
 bool
-HnswNormValue(FmgrInfo *procinfo, Oid collation, Datum *value)
+HnswNormValue(FmgrInfo *procinfo, Oid collation, Datum *value, HnswType type)
 {
 	double		norm = DatumGetFloat8(FunctionCall1Coll(procinfo, collation, *value));
 
 	if (norm > 0)
 	{
-		Vector	   *v = DatumGetVector(*value);
+		/* TODO Remove vector-specific code */
-		Vector	   *result = InitVector(v->dim);
+		if (type == HNSW_TYPE_VECTOR)
+		{
+			Vector	   *v = DatumGetVector(*value);
+			Vector	   *result = InitVector(v->dim);
 
-		for (int i = 0; i < v->dim; i++)
+			for (int i = 0; i < v->dim; i++)
-			result->x[i] = v->x[i] / norm;
+				result->x[i] = v->x[i] / norm;
 
-		*value = PointerGetDatum(result);
+			*value = PointerGetDatum(result);
+		}
+		else
+			elog(ERROR, "Unsupported type");
 
 		return true;
 	}
@@ -573,7 +588,12 @@ HnswLoadElement(HnswElement element, float *distance, Datum *q, Relation index,
 
 	/* Calculate distance */
 	if (distance != NULL)
-		*distance = (float) DatumGetFloat8(FunctionCall2Coll(procinfo, collation, *q, PointerGetDatum(&etup->data)));
+	{
+		if (DatumGetPointer(*q) == NULL)
+			*distance = 0;
+		else
+			*distance = (float) DatumGetFloat8(FunctionCall2Coll(procinfo, collation, *q, PointerGetDatum(&etup->data)));
+	}
 
 	UnlockReleaseBuffer(buf);
 }

src/ivfbuild.c

@@ -105,7 +105,7 @@ SampleCallback(Relation index, CALLBACK_ITEM_POINTER, Datum *values,
 	oldCtx = MemoryContextSwitchTo(buildstate->tmpCtx);
 
 	/* Add sample */
-	AddSample(values, state);
+	AddSample(values, buildstate);
 
 	/* Reset memory context */
 	MemoryContextSwitchTo(oldCtx);

src/vector.c

@@ -29,15 +29,6 @@
 #define STATE_DIMS(x) (ARR_DIMS(x)[0] - 1)
 #define CreateStateDatums(dim) palloc(sizeof(Datum) * (dim + 1))
 
-#if defined(__x86_64__) && defined(__gnu_linux__) && defined(__has_attribute) && __has_attribute(target_clones)
-#define RUNTIME_DISPATCH __attribute__((target_clones("default", "avx", "fma", "avx512f")))
-#elif defined(__aarch64__) && defined(__gnu_linux__) && defined(__has_attribute) && __has_attribute(target_clones)
-/* TODO Fix error: target does not support function version dispatcher */
-#define RUNTIME_DISPATCH __attribute__((target_clones("default", "arch=armv8.5-a")))
-#else
-#define RUNTIME_DISPATCH
-#endif
-
 PG_MODULE_MAGIC;
 
 /*
@@ -206,6 +197,8 @@ vector_in(PG_FUNCTION_ARGS)
 
 	while (pt != NULL && *stringEnd != ']')
 	{
+		float		val;
+
 		if (dim == VECTOR_MAX_DIM)
 			ereport(ERROR,
 					(errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
@@ -221,15 +214,23 @@ vector_in(PG_FUNCTION_ARGS)
 					 errmsg("invalid input syntax for type vector: \"%s\"", lit)));
 
 		/* Use strtof like float4in to avoid a double-rounding problem */
-		x[dim] = strtof(pt, &stringEnd);
+		errno = 0;
-		CheckElement(x[dim]);
+		val = strtof(pt, &stringEnd);
-		dim++;
 
 		if (stringEnd == pt)
 			ereport(ERROR,
 					(errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
 					 errmsg("invalid input syntax for type vector: \"%s\"", lit)));
 
+		/* Check for range error like float4in */
+		if (errno == ERANGE && (val == 0 || isinf(val)))
+			ereport(ERROR,
+					(errcode(ERRCODE_NUMERIC_VALUE_OUT_OF_RANGE),
+					 errmsg("\"%s\" is out of range for type vector", pt)));
+
+		CheckElement(val);
+		x[dim++] = val;
+
 		while (vector_isspace(*stringEnd))
 			stringEnd++;
 
@@ -541,23 +542,6 @@ vector_to_float4(PG_FUNCTION_ARGS)
 	PG_RETURN_POINTER(result);
 }
 
-RUNTIME_DISPATCH
-static float
-l2_squared_distance_impl(int16 dim, float *ax, float *bx)
-{
-	float		distance = 0.0;
-
-	/* Auto-vectorized */
-	for (int16 i = 0; i < dim; i++)
-	{
-		float		diff = ax[i] - bx[i];
-
-		distance += diff * diff;
-	}
-
-	return distance;
-}
-
 /*
  * Get the L2 distance between vectors
  */
@@ -567,11 +551,19 @@ l2_distance(PG_FUNCTION_ARGS)
 {
 	Vector	   *a = PG_GETARG_VECTOR_P(0);
 	Vector	   *b = PG_GETARG_VECTOR_P(1);
-	float		distance;
+	float	   *ax = a->x;
+	float	   *bx = b->x;
+	float		distance = 0.0;
+	float		diff;
 
 	CheckDims(a, b);
 
-	distance = l2_squared_distance_impl(a->dim, a->x, b->x);
+	/* Auto-vectorized */
+	for (int i = 0; i < a->dim; i++)
+	{
+		diff = ax[i] - bx[i];
+		distance += diff * diff;
+	}
 
 	PG_RETURN_FLOAT8(sqrt((double) distance));
 }
@@ -586,11 +578,19 @@ vector_l2_squared_distance(PG_FUNCTION_ARGS)
 {
 	Vector	   *a = PG_GETARG_VECTOR_P(0);
 	Vector	   *b = PG_GETARG_VECTOR_P(1);
-	float		distance;
+	float	   *ax = a->x;
+	float	   *bx = b->x;
+	float		distance = 0.0;
+	float		diff;
 
 	CheckDims(a, b);
 
-	distance = l2_squared_distance_impl(a->dim, a->x, b->x);
+	/* Auto-vectorized */
+	for (int i = 0; i < a->dim; i++)
+	{
+		diff = ax[i] - bx[i];
+		distance += diff * diff;
+	}
 
 	PG_RETURN_FLOAT8((double) distance);
 }

test/expected/hnsw_l2.out

@@ -12,14 +12,11 @@ SELECT * FROM t ORDER BY val <-> '[3,3,3]';
  [0,0,0]
 (4 rows)
 
-SELECT * FROM t ORDER BY val <-> (SELECT NULL::vector);
+SELECT COUNT(*) FROM (SELECT * FROM t ORDER BY val <-> (SELECT NULL::vector)) t2;
-   val   
+ count 
----------
+-------
- [0,0,0]
+     4
- [1,1,1]
+(1 row)
- [1,2,3]
- [1,2,4]
-(4 rows)
 
 SELECT COUNT(*) FROM t;
  count 

test/expected/input.out

@@ -63,9 +63,21 @@ SELECT '[1.5e-38,-1.5e-38]'::vector;
 (1 row)
 
 SELECT '[4e38,1]'::vector;
-ERROR:  infinite value not allowed in vector
+ERROR:  "4e38" is out of range for type vector
 LINE 1: SELECT '[4e38,1]'::vector;
                ^
+SELECT '[-4e38,1]'::vector;
+ERROR:  "-4e38" is out of range for type vector
+LINE 1: SELECT '[-4e38,1]'::vector;
+               ^
+SELECT '[1e-46,1]'::vector;
+ERROR:  "1e-46" is out of range for type vector
+LINE 1: SELECT '[1e-46,1]'::vector;
+               ^
+SELECT '[-1e-46,1]'::vector;
+ERROR:  "-1e-46" is out of range for type vector
+LINE 1: SELECT '[-1e-46,1]'::vector;
+               ^
 SELECT '[1,2,3'::vector;
 ERROR:  malformed vector literal: "[1,2,3"
 LINE 1: SELECT '[1,2,3'::vector;

test/sql/hnsw_l2.sql

@@ -7,7 +7,7 @@ CREATE INDEX ON t USING hnsw (val vector_l2_ops);
 INSERT INTO t (val) VALUES ('[1,2,4]');
 
 SELECT * FROM t ORDER BY val <-> '[3,3,3]';
-SELECT * FROM t ORDER BY val <-> (SELECT NULL::vector);
+SELECT COUNT(*) FROM (SELECT * FROM t ORDER BY val <-> (SELECT NULL::vector)) t2;
 SELECT COUNT(*) FROM t;
 
 TRUNCATE t;

test/sql/input.sql

@@ -11,6 +11,9 @@ SELECT '[1.5e38,-1.5e38]'::vector;
 SELECT '[1.5e+38,-1.5e+38]'::vector;
 SELECT '[1.5e-38,-1.5e-38]'::vector;
 SELECT '[4e38,1]'::vector;
+SELECT '[-4e38,1]'::vector;
+SELECT '[1e-46,1]'::vector;
+SELECT '[-1e-46,1]'::vector;
 SELECT '[1,2,3'::vector;
 SELECT '[1,2,3]9'::vector;
 SELECT '1,2,3'::vector;

test/t/016_hnsw_vacuum_recall.pl

@@ -86,7 +86,7 @@ foreach (@queries)
 	push(@expected, $res);
 }
 
-test_recall(0.20, $limit, "before vacuum");
+test_recall(0.19, $limit, "before vacuum");
 test_recall(0.95, 100, "before vacuum");
 
 # TODO Test concurrent inserts with vacuum