blob: 00103240afd593ebbe25aacd67f621f1bb70b493 [file] [log] [blame]
Vladimir Marangozov58e64a82000-09-03 23:47:08 +00001/* Parse tree node implementation */
2
Tim Peters1d6a7292000-09-26 06:11:54 +00003#include "Python.h"
Vladimir Marangozov58e64a82000-09-03 23:47:08 +00004#include "node.h"
5#include "errcode.h"
6
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007node *
Thomas Wouters23c9e002000-07-22 19:20:54 +00008PyNode_New(int type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00009{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000010 node *n = (node *) PyObject_MALLOC(1 * sizeof(node));
11 if (n == NULL)
12 return NULL;
13 n->n_type = type;
14 n->n_str = NULL;
15 n->n_lineno = 0;
16 n->n_nchildren = 0;
17 n->n_child = NULL;
18 return n;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000019}
20
Tim Peters623fdb92002-07-08 19:11:07 +000021/* See comments at XXXROUNDUP below. Returns -1 on overflow. */
Tim Peters755ebea2002-07-08 06:32:09 +000022static int
23fancy_roundup(int n)
24{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000025 /* Round up to the closest power of 2 >= n. */
26 int result = 256;
27 assert(n > 128);
28 while (result < n) {
29 result <<= 1;
30 if (result <= 0)
31 return -1;
32 }
33 return result;
Tim Peters755ebea2002-07-08 06:32:09 +000034}
35
36/* A gimmick to make massive numbers of reallocs quicker. The result is
Tim Peterse561dc22002-07-15 17:58:03 +000037 * a number >= the input. In PyNode_AddChild, it's used like so, when
38 * we're about to add child number current_size + 1:
39 *
40 * if XXXROUNDUP(current_size) < XXXROUNDUP(current_size + 1):
41 * allocate space for XXXROUNDUP(current_size + 1) total children
42 * else:
43 * we already have enough space
44 *
45 * Since a node starts out empty, we must have
46 *
47 * XXXROUNDUP(0) < XXXROUNDUP(1)
48 *
49 * so that we allocate space for the first child. One-child nodes are very
50 * common (presumably that would change if we used a more abstract form
51 * of syntax tree), so to avoid wasting memory it's desirable that
52 * XXXROUNDUP(1) == 1. That in turn forces XXXROUNDUP(0) == 0.
53 *
54 * Else for 2 <= n <= 128, we round up to the closest multiple of 4. Why 4?
55 * Rounding up to a multiple of an exact power of 2 is very efficient, and
56 * most nodes with more than one child have <= 4 kids.
57 *
58 * Else we call fancy_roundup() to grow proportionately to n. We've got an
Tim Peters755ebea2002-07-08 06:32:09 +000059 * extreme case then (like test_longexp.py), and on many platforms doing
60 * anything less than proportional growth leads to exorbitant runtime
61 * (e.g., MacPython), or extreme fragmentation of user address space (e.g.,
62 * Win98).
Tim Peterse561dc22002-07-15 17:58:03 +000063 *
64 * In a run of compileall across the 2.3a0 Lib directory, Andrew MacIntyre
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000065 * reported that, with this scheme, 89% of PyObject_REALLOC calls in
Tim Peterse561dc22002-07-15 17:58:03 +000066 * PyNode_AddChild passed 1 for the size, and 9% passed 4. So this usually
67 * wastes very little memory, but is very effective at sidestepping
Thomas Wouters73e5a5b2006-06-08 15:35:45 +000068 * platform-realloc disasters on vulnerable platforms.
Tim Peterse561dc22002-07-15 17:58:03 +000069 *
70 * Note that this would be straightforward if a node stored its current
71 * capacity. The code is tricky to avoid that.
Tim Peters755ebea2002-07-08 06:32:09 +000072 */
Serhiy Storchaka67c719b2014-09-05 10:10:23 +030073#define XXXROUNDUP(n) ((n) <= 1 ? (n) : \
74 (n) <= 128 ? (int)_Py_SIZE_ROUND_UP((n), 4) : \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000075 fancy_roundup(n))
Tim Peters755ebea2002-07-08 06:32:09 +000076
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000077
Jeremy Hylton94988062000-06-20 19:10:44 +000078int
Antoine Pitrou9ed5f272013-08-13 20:18:52 +020079PyNode_AddChild(node *n1, int type, char *str, int lineno, int col_offset)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000080{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000081 const int nch = n1->n_nchildren;
82 int current_capacity;
83 int required_capacity;
84 node *n;
Tim Peters755ebea2002-07-08 06:32:09 +000085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000086 if (nch == INT_MAX || nch < 0)
87 return E_OVERFLOW;
Tim Peters755ebea2002-07-08 06:32:09 +000088
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000089 current_capacity = XXXROUNDUP(nch);
90 required_capacity = XXXROUNDUP(nch + 1);
91 if (current_capacity < 0 || required_capacity < 0)
92 return E_OVERFLOW;
93 if (current_capacity < required_capacity) {
Christian Heimes724b8282013-12-04 08:42:46 +010094 if ((size_t)required_capacity > PY_SIZE_MAX / sizeof(node)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000095 return E_NOMEM;
96 }
97 n = n1->n_child;
98 n = (node *) PyObject_REALLOC(n,
99 required_capacity * sizeof(node));
100 if (n == NULL)
101 return E_NOMEM;
102 n1->n_child = n;
103 }
Tim Peters755ebea2002-07-08 06:32:09 +0000104
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000105 n = &n1->n_child[n1->n_nchildren++];
106 n->n_type = type;
107 n->n_str = str;
108 n->n_lineno = lineno;
109 n->n_col_offset = col_offset;
110 n->n_nchildren = 0;
111 n->n_child = NULL;
112 return 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000113}
Guido van Rossum03a24cd1990-11-18 17:37:06 +0000114
Guido van Rossum3f5da241990-12-20 15:06:42 +0000115/* Forward */
Tim Petersdbd9ba62000-07-09 03:09:57 +0000116static void freechildren(node *);
Jesus Ceae9c53182012-08-03 14:28:37 +0200117static Py_ssize_t sizeofchildren(node *n);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000118
119
120void
Thomas Wouters23c9e002000-07-22 19:20:54 +0000121PyNode_Free(node *n)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000123 if (n != NULL) {
124 freechildren(n);
125 PyObject_FREE(n);
126 }
Guido van Rossum3f5da241990-12-20 15:06:42 +0000127}
128
Jesus Ceae9c53182012-08-03 14:28:37 +0200129Py_ssize_t
130_PyNode_SizeOf(node *n)
131{
132 Py_ssize_t res = 0;
133
134 if (n != NULL)
135 res = sizeof(node) + sizeofchildren(n);
136 return res;
137}
138
Guido van Rossum03a24cd1990-11-18 17:37:06 +0000139static void
Thomas Wouters23c9e002000-07-22 19:20:54 +0000140freechildren(node *n)
Guido van Rossum03a24cd1990-11-18 17:37:06 +0000141{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000142 int i;
143 for (i = NCH(n); --i >= 0; )
144 freechildren(CHILD(n, i));
145 if (n->n_child != NULL)
146 PyObject_FREE(n->n_child);
147 if (STR(n) != NULL)
148 PyObject_FREE(STR(n));
Guido van Rossum03a24cd1990-11-18 17:37:06 +0000149}
Jesus Ceae9c53182012-08-03 14:28:37 +0200150
151static Py_ssize_t
152sizeofchildren(node *n)
153{
154 Py_ssize_t res = 0;
155 int i;
156 for (i = NCH(n); --i >= 0; )
157 res += sizeofchildren(CHILD(n, i));
158 if (n->n_child != NULL)
159 /* allocated size of n->n_child array */
160 res += XXXROUNDUP(NCH(n)) * sizeof(node);
161 if (STR(n) != NULL)
162 res += strlen(STR(n)) + 1;
163 return res;
164}