Introduce dctx->mem as a pointer to the generic scratch memory

Since there are multiple language features that need scratch memory,
it is more convenient for code generation to be able to refer to the
scratch memory by means of a base pointer.  The generic scratch
memory is allocated as part of the 'mem' BPF map.

Signed-off-by: Kris Van Hees <kris.van.hees@oracle.com>

libdtrace/dt_bpf.c

@@ -178,14 +178,17 @@ populate_probes_map(dtrace_hdl_t *dtp, int fd)
  *		with a singleton element (key 0).  This means that every CPU
  *		will see its own copy of this singleton element, and can use it
  *		without interference from other CPUs.  The scratch memory is
- *		used to store the DTrace context and the temporary output
- *		buffer.  The size of the map value (a byte array) is the size
- *		of the DTrace context, rounded up to a multiple of 8 bytes,
- *		plus 8 bytes padding, plus the maximum trace buffer record size
- *		that any of the compiled programs can emit, rounded up to a
- *		multiple of 8 bytes.
- *		The 8 bytes padding is used to ensure proper trace data
- *		alignment.
+ *		used to store the DTrace context, the temporary output buffer,
+ *		and temporary storage for stack traces, string manipulation,
+ *		etc.
+ *		The size of the map value (a byte array) is the sum of:
+ *			- size of the DTrace context, rounded up to the nearest
+ *			  multiple of 8
+ *			- 8 bytes padding for trace buffer alignment purposes
+ *			- maximum trace buffer record size, rounded up to the
+ *			  multiple of 8
+ *			- the greater of the maximum stack trace size and three
+ *			  times the maximum string size
  * - strtab:	String table map.  This is a global map with a singleton
  *		element (key 0) that contains the entire string table as a
  *		concatenation of all unique strings (each terminated with a
@@ -223,7 +226,7 @@ populate_probes_map(dtrace_hdl_t *dtp, int fd)
 int
 dt_bpf_gmap_create(dtrace_hdl_t *dtp)
 {
-	int		stabsz, gvarsz, lvarsz, tvarc, aggsz;
+	int		stabsz, gvarsz, lvarsz, tvarc, aggsz, memsz;
 	int		ci_mapfd, st_mapfd, pr_mapfd;
 	uint32_t	key = 0;
 
@@ -271,12 +274,24 @@ dt_bpf_gmap_create(dtrace_hdl_t *dtp)
 	if (ci_mapfd == -1)
 		return -1;		/* dt_errno is set for us */
 
+	/*
+	 * The size of the map value (a byte array) is the sum of:
+	 *	- size of the DTrace context, rounded up to the nearest
+	 *	  multiple of 8
+	 *	- 8 bytes padding for trace buffer alignment purposes
+	 *	- maximum trace buffer record size, rounded up to the
+	 *	  multiple of 8
+	 *	- the greater of:
+	 *		+ the maximum stack trace size
+	 *		+ three times the maximum string size
+	 */
+	memsz = roundup(sizeof(dt_mstate_t), 8) +
+		8 +
+		roundup(dtp->dt_maxreclen, 8) +
+		MAX(sizeof(uint64_t) * dtp->dt_options[DTRACEOPT_MAXFRAMES],
+		    3 * dtp->dt_options[DTRACEOPT_STRSIZE]);
 	if (create_gmap(dtp, "mem", BPF_MAP_TYPE_PERCPU_ARRAY,
-			sizeof(uint32_t),
-			roundup(sizeof(dt_mstate_t), 8) + 8
-			  + roundup(dtp->dt_maxreclen, 8)
-			  + 8 * dtp->dt_options[DTRACEOPT_MAXFRAMES],
-			1) == -1)
+			sizeof(uint32_t), memsz, 1) == -1)
 		return -1;		/* dt_errno is set for us */
 
 	/*

libdtrace/dt_cg.c

@@ -65,7 +65,7 @@ dt_cg_tramp_prologue_act(dt_pcb_t *pcb, dt_activity_t act)
 	 *	dt_dctx_t	dctx;
 	 *	uint32_t	key;
 	 *	uintptr_t	rc;
-	 *	char		*buf;
+	 *	char		*buf, *mem;
 	 *
 	 *				//     (%r8 = pointer to BPF context)
 	 *				// mov %r8, %r1
@@ -146,22 +146,30 @@ dt_cg_tramp_prologue_act(dt_pcb_t *pcb, dt_activity_t act)
 	emit(dlp,  BPF_ALU64_IMM(BPF_ADD, BPF_REG_0, 8));
 	emit(dlp,  BPF_STORE(BPF_DW, BPF_REG_FP, DCTX_FP(DCTX_BUF), BPF_REG_0));
 
+	/*
+	 *	mem = buf + roundup(dtp->dt_maxreclen, 8);
+	 *				// add %r0, roundup(dtp->dt_maxreclen,
+	 *	dctx.mem = mem;		// stdw [%fp + DCTX_FP(DCTX_BUF)], %r0
+	 */
+	emit(dlp,  BPF_ALU64_IMM(BPF_ADD, BPF_REG_0, roundup(dtp->dt_maxreclen, 8)));
+	emit(dlp,  BPF_STORE(BPF_DW, BPF_REG_FP, DCTX_FP(DCTX_MEM), BPF_REG_0));
+
 	/*
 	 * Store pointer to BPF map "name" in the DTrace context field "fld" at
 	 * "offset".
 	 *
-	 * key = 0;		// stw [%fp + DCTX_FP(offset)], 0
-	 * rc = bpf_map_lookup_elem(&name, &key);
-	 *			// lddw %r1, &name
-	 *			// mov %r2, %fp
-	 *			// add %r2, DCTX_FP(offset)
-	 *			// call bpf_map_lookup_elem
-	 *			//     (%r1 ... %r5 clobbered)
-	 *			//     (%r0 = name BPF map value)
-	 * if (rc == 0)		// jeq %r0, 0, lbl_exit
-	 *	goto exit;
-	 *			//     (%r0 = pointer to map value)
-	 * dctx.fld = rc;	// stdw [%fp + DCTX_FP(offset)], %r0
+	 *	key = 0;		// stw [%fp + DCTX_FP(offset)], 0
+	 *	rc = bpf_map_lookup_elem(&name, &key);
+	 *				// lddw %r1, &name
+	 *				// mov %r2, %fp
+	 *				// add %r2, DCTX_FP(offset)
+	 *				// call bpf_map_lookup_elem
+	 *				//     (%r1 ... %r5 clobbered)
+	 *				//     (%r0 = name BPF map value)
+	 *	if (rc == 0)		// jeq %r0, 0, lbl_exit
+	 *		goto exit;
+	 *				//     (%r0 = pointer to map value)
+	 *	dctx.fld = rc;		// stdw [%fp + DCTX_FP(offset)], %r0
 	 */
 #define DT_CG_STORE_MAP_PTR(name, offset) \
 	do { \

libdtrace/dt_dctx.h

@@ -37,6 +37,7 @@ typedef struct dt_dctx {
 	dt_activity_t	*act;		/* pointer to activity state */
 	dt_mstate_t	*mst;		/* DTrace machine state */
 	char		*buf;		/* Output buffer scratch memory */
+	char		*mem;		/* General scratch memory */
 	char		*strtab;	/* String constant table */
 	char		*agg;		/* Aggregation data */
 	char		*gvars;		/* Global variables */
@@ -47,6 +48,7 @@ typedef struct dt_dctx {
 #define DCTX_ACT	offsetof(dt_dctx_t, act)
 #define DCTX_MST	offsetof(dt_dctx_t, mst)
 #define DCTX_BUF	offsetof(dt_dctx_t, buf)
+#define DCTX_MEM	offsetof(dt_dctx_t, mem)
 #define DCTX_STRTAB	offsetof(dt_dctx_t, strtab)
 #define DCTX_AGG	offsetof(dt_dctx_t, agg)
 #define DCTX_GVARS	offsetof(dt_dctx_t, gvars)

test/unittest/codegen/tst.stack_layout.r

@@ -1,12 +1,12 @@
 Base:          0
-dctx:        -64
-%r0:         -72
-%r1:         -80
-%r2:         -88
-%r3:         -96
-%r4:        -104
-%r5:        -112
-%r6:        -120
-%r7:        -128
-%r8:        -136
-scratch:    -137 .. -512
+dctx:        -72
+%r0:         -80
+%r1:         -88
+%r2:         -96
+%r3:        -104
+%r4:        -112
+%r5:        -120
+%r6:        -128
+%r7:        -136
+%r8:        -144
+scratch:    -145 .. -512