1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
/* Compiler implementation of the D programming language
* Copyright (C) 1999-2018 by The D Language Foundation, All Rights Reserved
* written by Walter Bright
* http://www.digitalmars.com
* Distributed under the Boost Software License, Version 1.0.
* http://www.boost.org/LICENSE_1_0.txt
* https://github.com/D-Programming-Language/dmd/blob/master/src/sideeffect.c
*/
#include <stdio.h>
#include <assert.h>
#include "mars.h"
#include "init.h"
#include "expression.h"
#include "template.h"
#include "statement.h"
#include "mtype.h"
#include "utf.h"
#include "declaration.h"
#include "aggregate.h"
#include "scope.h"
#include "attrib.h"
#include "tokens.h"
bool walkPostorder(Expression *e, StoppableVisitor *v);
bool lambdaHasSideEffect(Expression *e);
Expression *semantic(Expression *e, Scope *sc);
/**************************************************
* Front-end expression rewriting should create temporary variables for
* non trivial sub-expressions in order to:
* 1. save evaluation order
* 2. prevent sharing of sub-expression in AST
*/
bool isTrivialExp(Expression *e)
{
class IsTrivialExp : public StoppableVisitor
{
public:
IsTrivialExp() {}
void visit(Expression *e)
{
/* Bugzilla 11201: CallExp is always non trivial expression,
* especially for inlining.
*/
if (e->op == TOKcall)
{
stop = true;
return;
}
// stop walking if we determine this expression has side effects
stop = lambdaHasSideEffect(e);
}
};
IsTrivialExp v;
return walkPostorder(e, &v) == false;
}
/********************************************
* Determine if Expression has any side effects.
*/
bool hasSideEffect(Expression *e)
{
class LambdaHasSideEffect : public StoppableVisitor
{
public:
LambdaHasSideEffect() {}
void visit(Expression *e)
{
// stop walking if we determine this expression has side effects
stop = lambdaHasSideEffect(e);
}
};
LambdaHasSideEffect v;
return walkPostorder(e, &v);
}
/********************************************
* Determine if the call of f, or function type or delegate type t1, has any side effects.
* Returns:
* 0 has any side effects
* 1 nothrow + constant purity
* 2 nothrow + strong purity
*/
int callSideEffectLevel(FuncDeclaration *f)
{
/* Bugzilla 12760: ctor call always has side effects.
*/
if (f->isCtorDeclaration())
return 0;
assert(f->type->ty == Tfunction);
TypeFunction *tf = (TypeFunction *)f->type;
if (tf->isnothrow)
{
PURE purity = f->isPure();
if (purity == PUREstrong)
return 2;
if (purity == PUREconst)
return 1;
}
return 0;
}
int callSideEffectLevel(Type *t)
{
t = t->toBasetype();
TypeFunction *tf;
if (t->ty == Tdelegate)
tf = (TypeFunction *)((TypeDelegate *)t)->next;
else
{
assert(t->ty == Tfunction);
tf = (TypeFunction *)t;
}
tf->purityLevel();
PURE purity = tf->purity;
if (t->ty == Tdelegate && purity > PUREweak)
{
if (tf->isMutable())
purity = PUREweak;
else if (!tf->isImmutable())
purity = PUREconst;
}
if (tf->isnothrow)
{
if (purity == PUREstrong)
return 2;
if (purity == PUREconst)
return 1;
}
return 0;
}
bool lambdaHasSideEffect(Expression *e)
{
switch (e->op)
{
// Sort the cases by most frequently used first
case TOKassign:
case TOKplusplus:
case TOKminusminus:
case TOKdeclaration:
case TOKconstruct:
case TOKblit:
case TOKaddass:
case TOKminass:
case TOKcatass:
case TOKmulass:
case TOKdivass:
case TOKmodass:
case TOKshlass:
case TOKshrass:
case TOKushrass:
case TOKandass:
case TOKorass:
case TOKxorass:
case TOKpowass:
case TOKin:
case TOKremove:
case TOKassert:
case TOKhalt:
case TOKdelete:
case TOKnew:
case TOKnewanonclass:
return true;
case TOKcall:
{
CallExp *ce = (CallExp *)e;
/* Calling a function or delegate that is pure nothrow
* has no side effects.
*/
if (ce->e1->type)
{
Type *t = ce->e1->type->toBasetype();
if (t->ty == Tdelegate)
t = ((TypeDelegate *)t)->next;
if (t->ty == Tfunction &&
(ce->f ? callSideEffectLevel(ce->f)
: callSideEffectLevel(ce->e1->type)) > 0)
{
}
else
return true;
}
break;
}
case TOKcast:
{
CastExp *ce = (CastExp *)e;
/* if:
* cast(classtype)func() // because it may throw
*/
if (ce->to->ty == Tclass && ce->e1->op == TOKcall && ce->e1->type->ty == Tclass)
return true;
break;
}
default:
break;
}
return false;
}
/***********************************
* The result of this expression will be discarded.
* Print error messages if the operation has no side effects (and hence is meaningless).
* Returns:
* true if expression has no side effects
*/
bool discardValue(Expression *e)
{
if (lambdaHasSideEffect(e)) // check side-effect shallowly
return false;
switch (e->op)
{
case TOKcast:
{
CastExp *ce = (CastExp *)e;
if (ce->to->equals(Type::tvoid))
{
/*
* Don't complain about an expression with no effect if it was cast to void
*/
return false;
}
break; // complain
}
case TOKerror:
return false;
case TOKvar:
{
VarDeclaration *v = ((VarExp *)e)->var->isVarDeclaration();
if (v && (v->storage_class & STCtemp))
{
// Bugzilla 5810: Don't complain about an internal generated variable.
return false;
}
break;
}
case TOKcall:
/* Issue 3882: */
if (global.params.warnings != DIAGNOSTICoff && !global.gag)
{
CallExp *ce = (CallExp *)e;
if (e->type->ty == Tvoid)
{
/* Don't complain about calling void-returning functions with no side-effect,
* because purity and nothrow are inferred, and because some of the
* runtime library depends on it. Needs more investigation.
*
* One possible solution is to restrict this message to only be called in hierarchies that
* never call assert (and or not called from inside unittest blocks)
*/
}
else if (ce->e1->type)
{
Type *t = ce->e1->type->toBasetype();
if (t->ty == Tdelegate)
t = ((TypeDelegate *)t)->next;
if (t->ty == Tfunction &&
(ce->f ? callSideEffectLevel(ce->f)
: callSideEffectLevel(ce->e1->type)) > 0)
{
const char *s;
if (ce->f)
s = ce->f->toPrettyChars();
else if (ce->e1->op == TOKstar)
{
// print 'fp' if ce->e1 is (*fp)
s = ((PtrExp *)ce->e1)->e1->toChars();
}
else
s = ce->e1->toChars();
e->warning("calling %s without side effects discards return value of type %s, prepend a cast(void) if intentional",
s, e->type->toChars());
}
}
}
return false;
case TOKscope:
e->error("%s has no effect", e->toChars());
return true;
case TOKandand:
{
AndAndExp *aae = (AndAndExp *)e;
return discardValue(aae->e2);
}
case TOKoror:
{
OrOrExp *ooe = (OrOrExp *)e;
return discardValue(ooe->e2);
}
case TOKquestion:
{
CondExp *ce = (CondExp *)e;
/* Bugzilla 6178 & 14089: Either CondExp::e1 or e2 may have
* redundant expression to make those types common. For example:
*
* struct S { this(int n); int v; alias v this; }
* S[int] aa;
* aa[1] = 0;
*
* The last assignment statement will be rewitten to:
*
* 1 in aa ? aa[1].value = 0 : (aa[1] = 0, aa[1].this(0)).value;
*
* The last DotVarExp is necessary to take assigned value.
*
* int value = (aa[1] = 0); // value = aa[1].value
*
* To avoid false error, discardValue() should be called only when
* the both tops of e1 and e2 have actually no side effects.
*/
if (!lambdaHasSideEffect(ce->e1) &&
!lambdaHasSideEffect(ce->e2))
{
return discardValue(ce->e1) |
discardValue(ce->e2);
}
return false;
}
case TOKcomma:
{
CommaExp *ce = (CommaExp *)e;
/* Check for compiler-generated code of the form auto __tmp, e, __tmp;
* In such cases, only check e for side effect (it's OK for __tmp to have
* no side effect).
* See Bugzilla 4231 for discussion
*/
CommaExp *firstComma = ce;
while (firstComma->e1->op == TOKcomma)
firstComma = (CommaExp *)firstComma->e1;
if (firstComma->e1->op == TOKdeclaration &&
ce->e2->op == TOKvar &&
((DeclarationExp *)firstComma->e1)->declaration == ((VarExp*)ce->e2)->var)
{
return false;
}
// Don't check e1 until we cast(void) the a,b code generation
//discardValue(ce->e1);
return discardValue(ce->e2);
}
case TOKtuple:
/* Pass without complaint if any of the tuple elements have side effects.
* Ideally any tuple elements with no side effects should raise an error,
* this needs more investigation as to what is the right thing to do.
*/
if (!hasSideEffect(e))
break;
return false;
default:
break;
}
e->error("%s has no effect in expression (%s)", Token::toChars(e->op), e->toChars());
return true;
}
/**************************************************
* Build a temporary variable to copy the value of e into.
* Params:
* stc = storage classes will be added to the made temporary variable
* name = name for temporary variable
* e = original expression
* Returns:
* Newly created temporary variable.
*/
VarDeclaration *copyToTemp(StorageClass stc, const char *name, Expression *e)
{
assert(name && name[0] == '_' && name[1] == '_');
Identifier *id = Identifier::generateId(name);
ExpInitializer *ez = new ExpInitializer(e->loc, e);
VarDeclaration *vd = new VarDeclaration(e->loc, e->type, id, ez);
vd->storage_class = stc;
vd->storage_class |= STCtemp;
vd->storage_class |= STCctfe; // temporary is always CTFEable
return vd;
}
/**************************************************
* Build a temporary variable to extract e's evaluation, if e is not trivial.
* Params:
* sc = scope
* name = name for temporary variable
* e0 = a new side effect part will be appended to it.
* e = original expression
* alwaysCopy = if true, build new temporary variable even if e is trivial.
* Returns:
* When e is trivial and alwaysCopy == false, e itself is returned.
* Otherwise, a new VarExp is returned.
* Note:
* e's lvalue-ness will be handled well by STCref or STCrvalue.
*/
Expression *extractSideEffect(Scope *sc, const char *name,
Expression **e0, Expression *e, bool alwaysCopy = false)
{
if (!alwaysCopy && isTrivialExp(e))
return e;
VarDeclaration *vd = copyToTemp(0, name, e);
if (e->isLvalue())
vd->storage_class |= STCref;
else
vd->storage_class |= STCrvalue;
Expression *de = new DeclarationExp(vd->loc, vd);
Expression *ve = new VarExp(vd->loc, vd);
de = semantic(de, sc);
ve = semantic(ve, sc);
*e0 = Expression::combine(*e0, de);
return ve;
}
|