Initial inet data type implementation

Author: mkgrgis

Makefile

@@ -23,7 +23,7 @@ GISTEST=nogis
 endif
 
 ifndef REGRESS
-REGRESS = extra/sqlite_fdw_post types/bitstring types/bool types/float4 types/float8 types/int4 types/int8 types/numeric types/$(GISTEST) types/macaddr types/macaddr8 types/out_of_range types/timestamp types/uuid extra/join extra/limit extra/aggregates extra/prepare extra/select_having extra/select extra/insert extra/update extra/encodings sqlite_fdw type_$(GISTEST) aggregate selectfunc 
+REGRESS = extra/sqlite_fdw_post types/bitstring types/bool types/float4 types/float8 types/inet types/int4 types/int8 types/numeric types/$(GISTEST) types/macaddr types/macaddr8 types/out_of_range types/timestamp types/uuid extra/join extra/limit extra/aggregates extra/prepare extra/select_having extra/select extra/insert extra/update extra/encodings sqlite_fdw type_$(GISTEST) aggregate selectfunc 
 endif
 
 REGRESS_OPTS = --encoding=utf8

README.md

@@ -48,18 +48,20 @@ Features
  	- `bool`: `text`(1..5) and `int`,
  	- `double precision`, `float` and `numeric`: `real` values and special values with `text` affinity (`+Infinity`, `-Infinity`, `NaN`),
  	- `macaddr`: `text`(12..17) or `blob`(6) or `integer`,
- 	- `macaddr8`: `text`(16..23) or `blob`(8) or `integer`.
+ 	- `macaddr8`: `text`(16..23) or `blob`(8) or `integer`,
+ 	- `inet`: `text`(8..49) or `blob`(4..5 IP v4, 16..17 IP v6) or `integer` (IP v4).
 - Support mixed SQLite [data affinity](https://www.sqlite.org/datatype3.html) output (`INSERT`/`UPDATE`) for such data types as
 	- `timestamp`: `text`(default) or `int`,
  	- `uuid`: `text`(36) or `blob`(16)(default),
  	- `macaddr`: `text`(17) or `blob`(6) or `integer`(default),
- 	- `macaddr8`: `text`(23) or `blob`(8) or `integer`(default).
+ 	- `macaddr8`: `text`(23) or `blob`(8) or `integer`(default),
+ 	- `inet`: `integer` (default for IP v4) or `blob`(4..5 IP v4, 16..17 default for IP v6) or `text`(8..49).
 - Full support for `+Infinity` (means ∞) and `-Infinity` (means -∞) special values for IEEE 754-2008 numbers in `double precision`, `float` and `numeric` columns including such conditions as ` n < '+Infinity'` or ` m > '-Infinity'`.
 - Bidirectional data transformation for `geometry` and `geography` data types for SpatiaLite ↔ PostGIS. [EWKB](https://libgeos.org/specifications/wkb/#extended-wkb) data transport is used. See [GIS support description](GIS.md).
 
 ### Pushing down
 - `WHERE` clauses are pushdowned
-- Aggregate function are pushdowned
+- Aggregate functions are pushdowned
 - `ORDER BY` is pushdowned
 - Joins (left/right/inner/cross/semi) are pushdowned
 - `CASE` expressions are pushdowned.
@@ -254,6 +256,7 @@ SQLite `NULL` affinity always can be transparent converted for a nullable column
 |       float8 |      V+      |       ✔      |      ∅       |      i       |    `NULL`    | REAL         |
 |[geometry](GIS.md)| ∅       |       ∅      |      V+      |      ∅       |      ∅       | BLOB         |
 |[geography](GIS.md)|∅       |       ∅      |      V+      |      ∅       |      ∅       | BLOB         |
+|         inet |      ✔-      |       ∅      |V<br>(Len=4..5, 16..17)|  V+  |    `NULL`    | INT v4, BLOB v6 |
 |         int2 |      ✔-      |       ?      |      ∅       |      ∅       |    `NULL`    | INT          |
 |         int4 |      ✔-      |       ?      |      ∅       |      ∅       |    `NULL`    | INT          |
 |         int8 |      ✔       |       ?      |      ∅       |      ∅       |    `NULL`    | INT          |
@@ -625,6 +628,17 @@ Array support is experimental. Please be careful.
 - `sqlite_fdw` UUID values support exists only for `uuid` columns in foreign table. SQLite documentation recommends to store UUID as value with both `blob` and `text` [affinity](https://www.sqlite.org/datatype3.html). `sqlite_fdw` can pushdown both reading and filtering both `text` and `blob` values.
 - Expected affinity of UUID value in SQLite table determined by `column_type` option of the column
 for `INSERT` and `UPDATE` commands. PostgreSQL supports both `blob` and `text` [affinity](https://www.sqlite.org/datatype3.html).
+- Usual form of UUID from a value with `blob` affinity can be generated with such SQLite query as
+```sql
+select case when typeof(u) = 'blob' then
+	substr(lower(hex(u)),1,8) || '-' ||
+	substr(lower(hex(u)),9,4) || '-' ||
+	substr(lower(hex(u)),13,4) || '-' ||
+	substr(lower(hex(u)),17,4) || '-' ||
+	substr(lower(hex(u)),21,12)
+	else null end uuid_canon
+from "type_UUID";
+```
 
 ### bit and varbit support
 - `sqlite_fdw` PostgreSQL `bit`/`varbit` values support based on `int` SQLite data affinity, because there is no per bit operations for SQLite `blob` affinity data. Maximum SQLite `int` affinity value is 8 bytes length, hence maximum `bit`/`varbit` values length is 64 bits.
@@ -633,6 +647,98 @@ for `INSERT` and `UPDATE` commands. PostgreSQL supports both `blob` and `text` [
 ### MAC address support
 - `sqlite_fdw` PostgreSQL `macaddr`/`macaddr8` values support based on `int` SQLite data affinity, because there is no per bit operations for SQLite `blob` affinity data. For `macaddr` out of range error is possible because this type is 6 bytes length, but SQLite `int` can store value up to 8 bytes.
 - `sqlite_fdw` doesn't pushdown any operations with MAC adresses because there is 3 possible affinities for it in SQLite: `integer`, `blob` and `text`.
+### IP address support
+- `sqlite_fdw` PostgreSQL `inet` values support based on `int` SQLite data affinity for IP v4 and `blob` SQLite data affinity for IP v6.
+- Usual form of IP v4 address with cidr from a value with `integer` affinity can be generated with such SQLite query as
+```sql
+select  case when typeof(ip) = 'integer'
+		then ((ip >> 24) & 255) || '.' || ((ip >> 16) & 255) || '.' || ((ip >> 8) & 255) || '.' || (ip & 255) ||
+			case when (ip >> 32) > 0 then '/' || (ip >> 32) else '' end
+		else null
+		end ipv4_text,
+		ip
+from "type_INET";
+```
+- Usual form of IP v6 or IP v4 address from a value with `blob` affinity can be generated with such SQLite query as
+```sql
+select
+    case
+        when typeof(ip) = 'blob' and (length(ip) = 16 or length(ip) = 17) then
+            lower(
+                substr(hex(ip),1,4)  || ':' ||
+                substr(hex(ip),5,4)  || ':' ||
+                substr(hex(ip),9,4)  || ':' ||
+                substr(hex(ip),13,4) || ':' ||
+                substr(hex(ip),17,4) || ':' ||
+                substr(hex(ip),21,4) || ':' ||
+                substr(hex(ip),25,4) || ':' ||
+                substr(hex(ip),29,4)
+            ) ||
+            case
+                when length(ip) = 17 then
+                    '/' || ((instr('123456789ABCDEF', substr(hex(ip),33,1)) << 4) + instr('123456789ABCDEF', substr(hex(ip),34,1)))
+                else ''
+            end
+        when typeof(ip) = 'blob' and (length(ip) = 4 or length(ip) = 5) then
+                ((instr('123456789ABCDEF', substr(hex(ip),1,1)) << 4) + instr('123456789ABCDEF', substr(hex(ip),2,1))) || '.' ||
+                ((instr('123456789ABCDEF', substr(hex(ip),3,1)) << 4) + instr('123456789ABCDEF', substr(hex(ip),4,1))) || '.' ||
+                ((instr('123456789ABCDEF', substr(hex(ip),5,1)) << 4) + instr('123456789ABCDEF', substr(hex(ip),6,1))) || '.' ||
+                ((instr('123456789ABCDEF', substr(hex(ip),7,1)) << 4) + instr('123456789ABCDEF', substr(hex(ip),8,1)))
+            ||
+            case
+                when length(ip) = 5 then
+                    '/' || ((instr('123456789ABCDEF', substr(hex(ip),9,1)) << 4) + instr('123456789ABCDEF', substr(hex(ip),10,1)))
+                else ''
+            end
+        else null
+    end as ip_text
+from "type_INET";
+```
+- IP address with possible cidr addition enconing as SQLite BLOB value based on such conventions
+```
+ m - mask as number of bits
+ a - bytes of IP address
+
+ IP v4 + cidr
+┏━━━┳━━━┳━━━┳━━━┳━━━┓
+┃ a ┃ a ┃ a ┃ a ┃ m ┃
+┗━━━┻━━━┻━━━┻━━━┻━━━┛
+  0   1   2   3   4  - byte index
+ IP v6 + cidr
+┏━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┓
+┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ m ┃
+┗━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┛
+  0   1   2   3   4   5   5   7   8   9   10  11  12  13  14  15  16  17 - byte index
+
+ IP v4
+┏━━━┳━━━┳━━━┳━━━┓
+┃ a ┃ a ┃ a ┃ a ┃
+┗━━━┻━━━┻━━━┻━━━┛
+  0   1   2   3  - byte index
+ IP v6
+┏━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┳━━━┓
+┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃ a ┃
+┗━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┻━━━┛
+  0   1   2   3   4   5   5   7   8   9   10  11  12  13  14  15  16 - byte index
+```
+- IP address v4 with possible cidr addition enconing as SQLite integer based on such conventions
+```
+ m - mask as number of bits
+ a - IP address bytes
+
+ IP v4 + cidr
+┏━━━┳━━━┳━━━┳━━━┳━━━┓
+┃ m ┃ a ┃ a ┃ a ┃ a ┃
+┗━━━┻━━━┻━━━┻━━━┻━━━┛
+  0   1   2   3   4  - byte index
+
+ IP v4
+┏━━━┳━━━┳━━━┳━━━┓
+┃ a ┃ a ┃ a ┃ a ┃
+┗━━━┻━━━┻━━━┻━━━┛
+  0   1   2   3  - byte index
+```
+- `sqlite_fdw` doesn't pushdown any operations with IP adresses because there is 3 possible affinities for it in SQLite: `integer`, `blob` and `text`.
 
 Tests
 -----

deparse.c

@@ -33,9 +33,11 @@
 #include "parser/parsetree.h"
 #include "parser/parse_type.h"
 #include "utils/builtins.h"
+#include "utils/inet.h"
 #include "utils/lsyscache.h"
 #include "utils/syscache.h"
 #include "utils/typcache.h"
+#include <sys/socket.h>
 
 /*
  * Global context for sqlite_foreign_expr_walker's search of an expression tree.
@@ -362,6 +364,7 @@ sqlite_deparsable_data_type(Param *p)
 		case UUIDOID:
 		case MACADDROID:
 		case MACADDR8OID:
+		case INETOID:
 			return true;
 	}
 #ifdef SQLITE_FDW_GIS_ENABLE
@@ -2373,6 +2376,16 @@ sqlite_deparse_column_ref(StringInfo buf, int varno, int varattno, PlannerInfo *
 					appendStringInfo(buf, ", %d)", mac_len);
 					break;
 				}
+				case INETOID:
+				{
+					elog(DEBUG2, "IP addr unification for \"%s\"", colname);
+					appendStringInfoString(buf, "sqlite_fdw_ipaddr_blob(");
+					if (qualify_col)
+						ADD_REL_QUALIFIER(buf, varno);
+					appendStringInfoString(buf, sqlite_quote_identifier(colname, '`'));
+					appendStringInfoString(buf, ")");
+					break;
+				}
 				default:
 				{
 					no_unification = true;
@@ -2736,6 +2749,24 @@ sqlite_deparse_direct_update_sql(StringInfo buf, PlannerInfo *root,
 				appendStringInfo(buf, "sqlite_fdw_macaddr_blob(");
 			special_affinity = true;
 		}
+		else if (pg_attyp == INETOID)
+		{
+			if (preferred_affinity == SQLITE_TEXT)
+			{
+				appendStringInfo(buf, "sqlite_fdw_ipaddr_str(");
+				special_affinity = true;
+			}
+			else if (preferred_affinity == SQLITE_INTEGER)
+			{
+				appendStringInfo(buf, "sqlite_fdw_ipaddr_int(");
+				special_affinity = true;
+			}
+			else if (preferred_affinity == SQLITE_NULL)
+			{
+				appendStringInfo(buf, "sqlite_fdw_ipaddr_native(");
+				special_affinity = true;
+			}
+		}
 
 		sqlite_deparse_expr((Expr *) tle->expr, &context);
 
@@ -2996,6 +3027,22 @@ sqlite_deparse_const(Const *node, deparse_expr_cxt *context, int showtype)
 
 	switch (node->consttype)
 	{
+		/* Common cases are first as very frequent */
+		case BPCHAROID:
+		case VARCHAROID:
+		case CHAROID:
+		case TEXTOID:
+		case JSONOID:
+		case JSONBOID:
+		case NAMEOID:
+		case DATEOID:
+		case TIMEOID:
+			{
+				/* common branch of constants, deparsable as a text data */
+				extval = OidOutputFunctionCall(typoutput, node->constvalue);
+				sqlite_deparse_string_literal(buf, extval);
+				break;
+			}
 		case INT2OID:
 		case INT4OID:
 		case INT8OID:
@@ -3143,21 +3190,33 @@ sqlite_deparse_const(Const *node, deparse_expr_cxt *context, int showtype)
 				}
 			}
 			break;
-		case BPCHAROID:
-		case VARCHAROID:
-		case CHAROID:
-		case TEXTOID:
-		case JSONOID:
-		case JSONBOID:
-		case NAMEOID:
-		case DATEOID:
-		case TIMEOID:
+		case INETOID:
 			{
-				/* common branch of constants, deparsable as a text data */
-				extval = OidOutputFunctionCall(typoutput, node->constvalue);
-				sqlite_deparse_string_literal(buf, extval);
-				break;
+				inet		   *pg_inet = DatumGetInetP(node->constvalue);
+				unsigned char	bits = ip_bits(pg_inet);
+				unsigned char  *ipaddr = pg_inet->inet_data.ipaddr;
+
+				appendStringInfo(buf, "X\'");
+				for (int i = 0; i < ip_addrsize(pg_inet); i++)
+				{
+					int d1 = (ipaddr[i] >> 4) & 0x0F;
+					int d2 = ipaddr[i] & 0x0F;
+
+					appendStringInfoChar(buf, hex_dig[d1]);
+					appendStringInfoChar(buf, hex_dig[d2]);
+				}
+				/* Is here an address mask? */
+				if (bits < ip_maxbits(pg_inet))
+				{
+					int d1 = (bits >> 4) & 0x0F;
+					int d2 = bits & 0x0F;
+
+					appendStringInfoChar(buf, hex_dig[d1]);
+					appendStringInfoChar(buf, hex_dig[d2]);
+				}
+	  			appendStringInfo(buf, "\'");
 			}
+			break;
 		default:
 			{
 				if (listed_datatype_oid(node->consttype, -1, postGisSQLiteCompatibleTypes))

expected/13.15/type_nogis.out

@@ -533,7 +533,7 @@ SELECT * FROM "type_DOUBLE"; -- OK, +- Inf
 
 --Testcase 47:
 DROP EXTENSION sqlite_fdw CASCADE;
-NOTICE:  drop cascades to 55 other objects
+NOTICE:  drop cascades to 57 other objects
 DETAIL:  drop cascades to server sqlite_svr
 drop cascades to foreign table department
 drop cascades to foreign table employee
@@ -567,6 +567,8 @@ drop cascades to foreign table "type_MACADDRpk"
 drop cascades to foreign table "type_MACADDR"
 drop cascades to foreign table "type_MACADDR8pk"
 drop cascades to foreign table "type_MACADDR8"
+drop cascades to foreign table "type_INETpk"
+drop cascades to foreign table "type_INET"
 drop cascades to foreign table "types_PostGIS"
 drop cascades to foreign table "BitT"
 drop cascades to foreign table notype

expected/13.15/type_postgis.out

@@ -535,7 +535,7 @@ SELECT * FROM "type_DOUBLE"; -- OK, +- Inf
 
 --Testcase 47:
 DROP EXTENSION sqlite_fdw CASCADE;
-NOTICE:  drop cascades to 55 other objects
+NOTICE:  drop cascades to 57 other objects
 DETAIL:  drop cascades to server sqlite_svr
 drop cascades to foreign table department
 drop cascades to foreign table employee
@@ -569,6 +569,8 @@ drop cascades to foreign table "type_MACADDRpk"
 drop cascades to foreign table "type_MACADDR"
 drop cascades to foreign table "type_MACADDR8pk"
 drop cascades to foreign table "type_MACADDR8"
+drop cascades to foreign table "type_INETpk"
+drop cascades to foreign table "type_INET"
 drop cascades to foreign table "types_PostGIS"
 drop cascades to foreign table "BitT"
 drop cascades to foreign table notype