erts: Add map construction to driver API

erl_drv_output_term() and erl_drv_send_term() can send messages
containing maps with the use of the new ERL_DRV_MAP.

The driver API minor version is updated as new functionality is added.

8 files changed, 191 insertions, 43 deletions

diff --git a/erts/doc/src/erl_driver.xml b/erts/doc/src/erl_driver.xml
index c2f7fa4588..710c9b19cf 100644
--- a/erts/doc/src/erl_driver.xml
+++ b/erts/doc/src/erl_driver.xml
@@ -4,7 +4,7 @@
 <cref>
   <header>
     <copyright>
-      <year>2001</year><year>2013</year>
+      <year>2001</year><year>2014</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -1742,15 +1742,19 @@ typedef struct ErlIOVec {
           term consists of one to four elements in the array. The
           term first has a term type, and then arguments. The
 	  <c>port</c> parameter specifies the sending port.</p>
-        <p>Tuple and lists (with the exception of strings, see below),
+        <p>Tuples, maps and lists (with the exception of strings, see below),
           are built in reverse polish notation, so that to build a
           tuple, the elements are given first, and then the tuple
-          term, with a count. Likewise for lists.</p>
+          term, with a count. Likewise for lists and maps.</p>
         <p>A tuple must be specified with the number of elements. (The
           elements precede the <c>ERL_DRV_TUPLE</c> term.)</p>
         <p>A list must be specified with the number of elements,
           including the tail, which is the last term preceding
           <c>ERL_DRV_LIST</c>.</p>
+        <p>A map must be specified with the number of key-value pairs <c>N</c>.
+	  The key-value pairs must precede the <c>ERL_DRV_MAP</c> in this order:
+	  <c>key1,value1,key2,value2,...,keyN,valueN</c>.
+	  Duplicate keys are not allowed.</p>
         <p>The special term <c>ERL_DRV_STRING_CONS</c> is used to
           "splice" in a string in a list, a string given this way is
           not a list per se, but the elements are elements of the
@@ -1774,6 +1778,7 @@ ERL_DRV_PID          ErlDrvTermData pid (from driver_connected(ErlDrvPort port)
 ERL_DRV_STRING_CONS  char *str, int len
 ERL_DRV_FLOAT        double *dbl
 ERL_DRV_EXT2TERM     char *buf, ErlDrvUInt len
+ERL_DRV_MAP          int sz
         </pre>
 	<p>The unsigned integer data type <c>ErlDrvUInt</c> and the
 	  signed integer data type <c>ErlDrvSInt</c> are 64 bits wide
@@ -1856,6 +1861,24 @@ ERL_DRV_EXT2TERM     char *buf, ErlDrvUInt len
     };
     erl_drv_output_term(driver_mk_port(drvport), spec, sizeof(spec) / sizeof(spec[0]));
         ]]></code>
+
+        <p>To build the map <c>#{key1 => 100, key2 => {200, 300}}</c>, the
+          following call could be made.</p>
+        <code type="none"><![CDATA[
+    ErlDrvPort port = ...
+    ErlDrvTermData spec[] = {
+          ERL_DRV_ATOM, driver_mk_atom("key1"),
+	  ERL_DRV_INT, 100,
+          ERL_DRV_ATOM, driver_mk_atom("key2"),
+	    ERL_DRV_INT, 200,
+	    ERL_DRV_INT, 300,
+	  ERL_DRV_TUPLE, 2,
+	ERL_DRV_MAP, 2
+    };
+    erl_drv_output_term(driver_mk_port(drvport), spec, sizeof(spec) / sizeof(spec[0]));
+        ]]>
+      </code>
+
 	<p>If you want to pass a binary and don't already have the content
 	of the binary in an <c>ErlDrvBinary</c>, you can benefit from using
 	<c>ERL_DRV_BUF2BINARY</c> instead of creating an <c>ErlDrvBinary</c>
diff --git a/erts/emulator/beam/erl_driver.h b/erts/emulator/beam/erl_driver.h
index 2bd3181bdc..ab9ee63104 100644
--- a/erts/emulator/beam/erl_driver.h
+++ b/erts/emulator/beam/erl_driver.h
@@ -1,7 +1,7 @@
 /*
  * %CopyrightBegin%
  *
- * Copyright Ericsson AB 1999-2013. All Rights Reserved.
+ * Copyright Ericsson AB 1999-2014. All Rights Reserved.
  *
  * The contents of this file are subject to the Erlang Public License,
  * Version 1.1, (the "License"); you may not use this file except in
@@ -605,6 +605,8 @@ EXTERN int null_func(void);
 #define ERL_DRV_INT64       ((ErlDrvTermData) 15) /* ErlDrvSInt64 * */
 #define ERL_DRV_UINT64      ((ErlDrvTermData) 16) /* ErlDrvUInt64 * */
 
+#define ERL_DRV_MAP         ((ErlDrvTermData) 17) /* ErlDrvUInt */
+
 #ifndef ERL_DRIVER_TYPES_ONLY
 
 /* make terms for driver_output_term and driver_send_term */
diff --git a/erts/emulator/beam/erl_map.c b/erts/emulator/beam/erl_map.c
index 57f156509c..2fff7f9390 100644
--- a/erts/emulator/beam/erl_map.c
+++ b/erts/emulator/beam/erl_map.c
@@ -786,3 +786,34 @@ BIF_RETTYPE maps_values_1(BIF_ALIST_1) {
     }
     BIF_ERROR(BIF_P, BADARG);
 }
+
+int erts_validate_and_sort_map(map_t* mp)
+{
+    Eterm *ks  = map_get_keys(mp);
+    Eterm *vs  = map_get_values(mp);
+    Uint   sz  = map_get_size(mp);
+    Uint   ix,jx;
+    Eterm  tmp;
+    int c;
+
+    /* sort */
+
+    for (ix = 1; ix < sz; ix++) {
+	jx = ix;
+	while( jx > 0 && (c = CMP_TERM(ks[jx],ks[jx-1])) <= 0 ) {
+	    /* identical key -> error */
+	    if (c == 0) return 0;
+
+	    tmp = ks[jx];
+	    ks[jx] = ks[jx - 1];
+	    ks[jx - 1] = tmp;
+
+	    tmp = vs[jx];
+	    vs[jx] = vs[jx - 1];
+	    vs[jx - 1] = tmp;
+
+	    jx--;
+	}
+    }
+    return 1;
+}
diff --git a/erts/emulator/beam/erl_map.h b/erts/emulator/beam/erl_map.h
index 616ecd24ce..cfacb2ec28 100644
--- a/erts/emulator/beam/erl_map.h
+++ b/erts/emulator/beam/erl_map.h
@@ -1,7 +1,7 @@
 /*
  * %CopyrightBegin%
  * 
- * Copyright Ericsson AB 2013. All Rights Reserved.
+ * Copyright Ericsson AB 2014. All Rights Reserved.
  * 
  * The contents of this file are subject to the Erlang Public License,
  * Version 1.1, (the "License"); you may not use this file except in
@@ -67,6 +67,6 @@ int   erts_maps_update(Process *p, Eterm key, Eterm value, Eterm map, Eterm *res
 int   erts_maps_find(Eterm key, Eterm map, Eterm *value);
 int   erts_maps_get(Eterm key, Eterm map, Eterm *value);
 int   erts_maps_remove(Process *p, Eterm key, Eterm map, Eterm *res);
-
+int   erts_validate_and_sort_map(map_t* map);
 #endif
 
diff --git a/erts/emulator/beam/external.c b/erts/emulator/beam/external.c
index 57251286c8..a4cc3435c3 100644
--- a/erts/emulator/beam/external.c
+++ b/erts/emulator/beam/external.c
@@ -3795,37 +3795,10 @@ dec_term_atom_common:
      */
 
     while (maps_head) {
-	map_t *mp  = (map_t*)maps_head;
-	Eterm *ks  = map_get_keys(mp);
-	Eterm *vs  = map_get_values(mp);
-	Uint   sz  = map_get_size(mp);
-	Uint   ix,jx;
-	Eterm  tmp;
-	int c;
-
 	next  = (Eterm *)(EXPAND_POINTER(*maps_head));
-
-	/* sort */
-
-	for ( ix = 1; ix < sz; ix++) {
-	    jx = ix;
-	    while( jx > 0 && (c = CMP_TERM(ks[jx],ks[jx-1])) <= 0 ) {
-		/* identical key -> error */
-		if (c == 0) goto error;
-
-		tmp = ks[jx];
-		ks[jx] = ks[jx - 1];
-		ks[jx - 1] = tmp;
-
-		tmp = vs[jx];
-		vs[jx] = vs[jx - 1];
-		vs[jx - 1] = tmp;
-
-		jx--;
-	    }
-
-	}
 	*maps_head = MAP_HEADER;
+	if (!erts_validate_and_sort_map((map_t*)maps_head))
+	    goto error;
 	maps_head  = next;
     }
 
diff --git a/erts/emulator/beam/io.c b/erts/emulator/beam/io.c
index 49af86b36a..3b16cdeb4a 100644
--- a/erts/emulator/beam/io.c
+++ b/erts/emulator/beam/io.c
@@ -1,7 +1,7 @@
 /*
  * %CopyrightBegin%
  *
- * Copyright Ericsson AB 1996-2013. All Rights Reserved.
+ * Copyright Ericsson AB 1996-2014. All Rights Reserved.
  *
  * The contents of this file are subject to the Erlang Public License,
  * Version 1.1, (the "License"); you may not use this file except in
@@ -46,6 +46,7 @@
 #define ERTS_WANT_EXTERNAL_TAGS
 #include "external.h"
 #include "dtrace-wrapper.h"
+#include "erl_map.h"
 
 extern ErlDrvEntry fd_driver_entry;
 extern ErlDrvEntry vanilla_driver_entry;
@@ -5293,6 +5294,17 @@ driver_deliver_term(Eterm to, ErlDrvTermData* data, int len)
 	    depth++;
 	    break;
 	}
+	case ERL_DRV_MAP: { /* int */
+	    ERTS_DDT_CHK_ENOUGH_ARGS(1);
+	    if ((int) ptr[0] < 0) ERTS_DDT_FAIL;
+	    need += MAP_HEADER_SIZE + 1 + 2*ptr[0];
+	    depth -= 2*ptr[0];
+	    if (depth < 0) ERTS_DDT_FAIL;
+	    ptr++;
+	    depth++;
+	    break;
+	}
+
 	default:
 	    ERTS_DDT_FAIL;
 	}
@@ -5529,6 +5541,36 @@ driver_deliver_term(Eterm to, ErlDrvTermData* data, int len)
 	    ptr += 2;
 	    break;
 
+	case ERL_DRV_MAP: { /* int */
+	    int size = (int)ptr[0];
+	    Eterm* tp = hp;
+	    Eterm* vp;
+	    map_t *mp;
+
+	    *tp = make_arityval(size);
+
+	    hp += 1 + size;
+	    mp = (map_t*)hp;
+	    mp->thing_word = MAP_HEADER;
+	    mp->size = size;
+	    mp->keys = make_tuple(tp);
+	    mess = make_map(mp);
+
+	    hp += MAP_HEADER_SIZE + size;   /* advance "heap" pointer */
+
+	    tp += size;    /* point at last key */
+	    vp = hp - 1;   /* point at last value */
+
+	    while(size--) {
+		*vp-- = ESTACK_POP(stack);
+		*tp-- = ESTACK_POP(stack);
+	    }
+	    if (!erts_validate_and_sort_map(mp))
+		ERTS_DDT_FAIL;
+	    ptr++;
+	    break;
+	}
+
 	}
 	ESTACK_PUSH(stack, mess);
     }
diff --git a/erts/emulator/test/send_term_SUITE.erl b/erts/emulator/test/send_term_SUITE.erl
index b631f55a03..8e1f8df43a 100644
--- a/erts/emulator/test/send_term_SUITE.erl
+++ b/erts/emulator/test/send_term_SUITE.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2005-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2005-2014. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -62,7 +62,19 @@ basic(Config) when is_list(Config) ->
 
     ?line [] = term(P, 0),
     ?line Self = self(),
-    ?line {blurf,42,[],[-42,{}|"abc"++P],"kalle",3.1416,Self} = term(P, 1),
+    {blurf,42,[],[-42,{}|"abc"++P],"kalle",3.1416,Self,#{}} = term(P, 1),
+
+    Map41 = maps:from_list([{blurf, 42},
+			    {[], [-42,{}|"abc"++P]},
+			    {"kalle", 3.1416},
+			    {Self, #{}}]),
+    Map41 = term(P, 41),
+
+    Map42 = maps:from_list([{42, []},
+			    {[-42,{}|"abc"++P], "kalle"},
+			    {3.1416, Self},
+			    {#{}, blurf}]),
+    Map42 = term(P, 42),
     ?line Deep = lists:seq(0, 199),
     ?line Deep = term(P, 2),
     ?line {B1,B2} = term(P, 3),
@@ -125,7 +137,8 @@ basic(Config) when is_list(Config) ->
                {-1, 36}, % ERL_DRV_INT64
                {-4711, 37}, % ERL_DRV_INT64
                {-20233590931456, 38}, % ERL_DRV_INT64
-               {-9223372036854775808, 39}], % ERL_DRV_INT64
+               {-9223372036854775808, 39},
+	       {#{}, 40}], % ERL_DRV_MAP
     ?line {Terms, Ops} = lists:unzip(Singles),
     ?line Terms = term(P,Ops),
 
diff --git a/erts/emulator/test/send_term_SUITE_data/send_term_drv.c b/erts/emulator/test/send_term_SUITE_data/send_term_drv.c
index f8613487b0..381a4f20d5 100644
--- a/erts/emulator/test/send_term_SUITE_data/send_term_drv.c
+++ b/erts/emulator/test/send_term_SUITE_data/send_term_drv.c
@@ -104,7 +104,7 @@ static void send_term_drv_run(ErlDrvData port, char *buf, ErlDrvSizeT count)
 	    double f = 3.1416;
 
 	    msg[0] = ERL_DRV_ATOM;
-	    msg[1] = driver_mk_atom("blurf"),
+	    msg[1] = driver_mk_atom("blurf");
 	    msg[2] = ERL_DRV_INT;
 	    msg[3] = (ErlDrvTermData) 42;
 	    msg[4] = ERL_DRV_NIL;
@@ -126,9 +126,11 @@ static void send_term_drv_run(ErlDrvData port, char *buf, ErlDrvSizeT count)
 	    msg[20] = (ErlDrvTermData) &f;
 	    msg[21] = ERL_DRV_PID;
 	    msg[22] = driver_connected(erlang_port);
-	    msg[23] = ERL_DRV_TUPLE;
-	    msg[24] = (ErlDrvTermData) 7;
-	    msg += 25;
+	    msg[23] = ERL_DRV_MAP;
+	    msg[24] = (ErlDrvTermData) 0;
+	    msg[25] = ERL_DRV_TUPLE;
+	    msg[26] = (ErlDrvTermData) 8;
+	    msg += 27;
 	}
 	break;
 
@@ -481,6 +483,52 @@ static void send_term_drv_run(ErlDrvData port, char *buf, ErlDrvSizeT count)
 	break;
     }
 
+    case 40: {
+	msg[0] = ERL_DRV_MAP;
+	msg[1] = (ErlDrvTermData) 0;
+	msg += 2;
+	break;
+    }
+
+    case 41:    /* Most term types inside a map */
+    case 42: {
+	double f = 3.1416;
+
+	if (buf[i] == 41) {
+	    *msg++ = ERL_DRV_ATOM;
+	    *msg++ = driver_mk_atom("blurf");
+	}
+	*msg++ = ERL_DRV_INT;
+	*msg++ = (ErlDrvTermData)42;
+	*msg++ = ERL_DRV_NIL;
+	*msg++ = ERL_DRV_INT;
+	*msg++ = (ErlDrvTermData)-42;
+	*msg++ = ERL_DRV_TUPLE;
+	*msg++ = (ErlDrvTermData)0;
+	*msg++ = ERL_DRV_PORT;
+	*msg++ = driver_mk_port(erlang_port);
+	*msg++ = ERL_DRV_STRING_CONS;
+	*msg++ = (ErlDrvTermData)"abc";
+	*msg++ = (ErlDrvTermData)3;
+	*msg++ = ERL_DRV_LIST;
+	*msg++ = (ErlDrvTermData)3;
+	*msg++ = ERL_DRV_STRING;
+	*msg++ = (ErlDrvTermData)"kalle";
+	*msg++ = (ErlDrvTermData)5;
+	*msg++ = ERL_DRV_FLOAT;
+	*msg++ = (ErlDrvTermData)&f;
+	*msg++ = ERL_DRV_PID;
+	*msg++ = driver_connected(erlang_port);
+	*msg++ = ERL_DRV_MAP;
+	*msg++ = (ErlDrvTermData)0;
+	if (buf[i] == 42) {
+	    *msg++ = ERL_DRV_ATOM;
+	    *msg++ = driver_mk_atom("blurf");
+	}
+	*msg++ = ERL_DRV_MAP;
+	*msg++ = (ErlDrvTermData)4;
+	break;
+    }
 
     case 127:			/* Error cases */
 	{
@@ -662,6 +710,22 @@ static void send_term_drv_run(ErlDrvData port, char *buf, ErlDrvSizeT count)
 		FAIL_TERM(msg, 2);
 	    }
 
+	    msg[0] = ERL_DRV_MAP;
+	    msg[1] = (ErlDrvTermData) 0;
+	    FAIL_TERM(msg, 1);
+
+	    /* map with duplicate key */
+	    msg[0] = ERL_DRV_ATOM;
+	    msg[1] = driver_mk_atom("key");
+	    msg[2] = ERL_DRV_NIL;
+	    msg[3] = ERL_DRV_ATOM;
+	    msg[4] = driver_mk_atom("key");
+	    msg[5] = ERL_DRV_INT;
+	    msg[6] = (ErlDrvTermData) -4711;
+	    msg[7] = ERL_DRV_MAP;
+	    msg[8] = 2;
+	    FAIL_TERM(msg, 9);
+
 	    /* Signal end of test case */
 	    msg[0] = ERL_DRV_NIL;
 	    erl_drv_output_term(driver_mk_port(erlang_port), msg, 1);