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 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
//! implements SideEffectChecker
//! SideEffectCheckerを実装
//! 関数や不変型に副作用がないかチェックする
use erg_common::config::ErgConfig;
use erg_common::log;
use erg_common::traits::{Locational, Stream};
use erg_common::Str;
use erg_parser::token::TokenKind;
use crate::error::{EffectError, EffectErrors};
use crate::hir::{Array, Def, Dict, Expr, Params, Set, Signature, Tuple, HIR};
use crate::ty::{HasType, Visibility};
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
enum BlockKind {
// forbid side effects
Func,
ConstFunc,
ConstInstant, // e.g. Type definition
// allow side effects
Proc,
Instant,
Module,
}
use BlockKind::*;
/// Checks code for side effects.
/// For example:
/// * check if expressions with side effects are not used in functions
/// * check if methods that change internal state are not defined in immutable classes
#[derive(Debug)]
pub struct SideEffectChecker {
cfg: ErgConfig,
path_stack: Vec<Visibility>,
block_stack: Vec<BlockKind>,
errs: EffectErrors,
}
impl SideEffectChecker {
pub fn new(cfg: ErgConfig) -> Self {
Self {
cfg,
path_stack: vec![],
block_stack: vec![],
errs: EffectErrors::empty(),
}
}
fn full_path(&self) -> String {
self.path_stack.iter().fold(String::new(), |acc, vis| {
if vis.is_public() {
acc + "." + &vis.def_namespace[..]
} else {
acc + "::" + &vis.def_namespace[..]
}
})
}
/// It is permitted to define a procedure in a function,
/// and of course it is permitted to cause side effects in a procedure
///
/// However, it is not permitted to cause side effects within an instant block in a function
/// (side effects are allowed in instant blocks in procedures and modules)
fn in_context_effects_allowed(&self) -> bool {
// if toplevel
if self.block_stack.len() == 1 {
return true;
}
match (
self.block_stack.get(self.block_stack.len() - 2).unwrap(),
self.block_stack.last().unwrap(),
) {
(_, Func | ConstInstant) => false,
(_, Proc) => true,
(Proc | Module | Instant, Instant) => true,
_ => false,
}
}
pub fn check(mut self, hir: HIR) -> Result<HIR, (HIR, EffectErrors)> {
self.path_stack.push(Visibility::private(hir.name.clone()));
self.block_stack.push(Module);
log!(info "the side-effects checking process has started.{RESET}");
// At the top level, there is no problem with side effects, only check for purity violations.
// トップレベルでは副作用があっても問題なく、純粋性違反がないかのみチェックする
for expr in hir.module.iter() {
match expr {
Expr::Def(def) => {
self.check_def(def);
}
Expr::ClassDef(class_def) => {
if let Some(req_sup) = &class_def.require_or_sup {
self.check_expr(req_sup);
}
// TODO: grow
for def in class_def.methods.iter() {
self.check_expr(def);
}
}
Expr::PatchDef(patch_def) => {
self.check_expr(patch_def.base.as_ref());
// TODO: grow
for def in patch_def.methods.iter() {
self.check_expr(def);
}
}
Expr::Call(call) => {
for parg in call.args.pos_args.iter() {
self.check_expr(&parg.expr);
}
for kwarg in call.args.kw_args.iter() {
self.check_expr(&kwarg.expr);
}
}
Expr::BinOp(bin) => {
self.check_expr(&bin.lhs);
self.check_expr(&bin.rhs);
}
Expr::UnaryOp(unary) => {
self.check_expr(&unary.expr);
}
Expr::Accessor(_) | Expr::Lit(_) => {}
Expr::Array(array) => match array {
Array::Normal(arr) => {
for elem in arr.elems.pos_args.iter() {
self.check_expr(&elem.expr);
}
}
Array::WithLength(arr) => {
self.check_expr(&arr.elem);
self.check_expr(&arr.len);
}
Array::Comprehension(arr) => {
self.check_expr(&arr.elem);
self.check_expr(&arr.guard);
}
},
Expr::Tuple(tuple) => match tuple {
Tuple::Normal(tuple) => {
for elem in tuple.elems.pos_args.iter() {
self.check_expr(&elem.expr);
}
}
},
Expr::Record(rec) => {
self.path_stack
.push(Visibility::private(Str::ever("<record>")));
self.block_stack.push(Instant);
for attr in rec.attrs.iter() {
self.check_def(attr);
}
self.path_stack.pop();
self.block_stack.pop();
}
Expr::Set(set) => match set {
Set::Normal(set) => {
for elem in set.elems.pos_args.iter() {
self.check_expr(&elem.expr);
}
}
Set::WithLength(set) => {
self.check_expr(&set.elem);
self.check_expr(&set.len);
}
},
Expr::Dict(dict) => match dict {
Dict::Normal(dict) => {
for kv in dict.kvs.iter() {
self.check_expr(&kv.key);
self.check_expr(&kv.value);
}
}
other => todo!("{other}"),
},
Expr::TypeAsc(tasc) => {
self.check_expr(&tasc.expr);
}
Expr::Lambda(lambda) => {
let is_proc = lambda.is_procedural();
if is_proc {
self.path_stack
.push(Visibility::private(Str::ever("<lambda!>")));
self.block_stack.push(Proc);
} else {
self.path_stack
.push(Visibility::private(Str::ever("<lambda>")));
self.block_stack.push(Func);
}
lambda.body.iter().for_each(|chunk| self.check_expr(chunk));
self.path_stack.pop();
self.block_stack.pop();
}
Expr::ReDef(_)
| Expr::Code(_)
| Expr::Compound(_)
| Expr::Import(_)
| Expr::Dummy(_) => {}
}
}
log!(info "the side-effects checking process has completed, found errors: {}{RESET}", self.errs.len());
if self.errs.is_empty() {
Ok(hir)
} else {
Err((hir, self.errs))
}
}
fn check_params(&mut self, params: &Params) {
for nd_param in params.non_defaults.iter() {
if nd_param.vi.t.is_procedure() && !nd_param.inspect().unwrap().ends_with('!') {
self.errs.push(EffectError::proc_assign_error(
self.cfg.input.clone(),
line!() as usize,
nd_param.raw.pat.loc(),
self.full_path(),
));
}
}
if let Some(var_arg) = params.var_params.as_deref() {
if var_arg.vi.t.is_procedure() && !var_arg.inspect().unwrap().ends_with('!') {
self.errs.push(EffectError::proc_assign_error(
self.cfg.input.clone(),
line!() as usize,
var_arg.raw.pat.loc(),
self.full_path(),
));
}
}
for d_param in params.defaults.iter() {
if d_param.sig.vi.t.is_procedure() && !d_param.inspect().unwrap().ends_with('!') {
self.errs.push(EffectError::proc_assign_error(
self.cfg.input.clone(),
line!() as usize,
d_param.sig.raw.pat.loc(),
self.full_path(),
));
}
self.check_expr(&d_param.default_val);
}
}
fn check_def(&mut self, def: &Def) {
let name_and_vis = Visibility::new(def.sig.vis().clone(), def.sig.inspect().clone());
self.path_stack.push(name_and_vis);
let is_procedural = def.sig.is_procedural();
let is_subr = def.sig.is_subr();
let is_const = def.sig.is_const();
match (is_procedural, is_subr, is_const) {
(true, true, true) => {
panic!("user-defined constant procedures are not allowed");
}
(true, true, false) => {
self.block_stack.push(Proc);
}
(_, false, false) => {
self.block_stack.push(Instant);
}
(false, true, true) => {
self.block_stack.push(ConstFunc);
}
(false, true, false) => {
self.block_stack.push(Func);
}
(_, false, true) => {
self.block_stack.push(ConstInstant);
}
}
if let Signature::Subr(sig) = &def.sig {
self.check_params(&sig.params);
}
let last_idx = def.body.block.len() - 1;
for (i, chunk) in def.body.block.iter().enumerate() {
self.check_expr(chunk);
// e.g. `echo = print!`
if i == last_idx
&& self.block_stack.last().unwrap() == &Instant
&& !def.sig.is_procedural()
&& chunk.t().is_procedure()
{
self.errs.push(EffectError::proc_assign_error(
self.cfg.input.clone(),
line!() as usize,
def.sig.loc(),
self.full_path(),
));
}
}
self.path_stack.pop();
self.block_stack.pop();
}
/// check if `expr` has side-effects / purity violations.
///
/// returns effects, purity violations will be appended to `self.errs`.
///
/// causes side-effects:
/// ```python
/// p!() // 1 side-effect
/// p!(q!()) // 2 side-effects
/// x =
/// y = r!()
/// y + 1 // 1 side-effect
/// ```
/// causes no side-effects:
/// ```python
/// q! = p!
/// y = f(p!)
/// ```
/// purity violation:
/// ```python
/// for iter, i -> print! i
/// ```
fn check_expr(&mut self, expr: &Expr) {
match expr {
Expr::Lit(_) => {}
Expr::Def(def) => {
self.check_def(def);
}
Expr::ClassDef(class_def) => {
if let Some(req_sup) = &class_def.require_or_sup {
self.check_expr(req_sup);
}
for def in class_def.methods.iter() {
self.check_expr(def);
}
}
Expr::PatchDef(patch_def) => {
self.check_expr(patch_def.base.as_ref());
for def in patch_def.methods.iter() {
self.check_expr(def);
}
}
Expr::Array(array) => match array {
Array::Normal(arr) => {
for elem in arr.elems.pos_args.iter() {
self.check_expr(&elem.expr);
}
}
Array::WithLength(arr) => {
self.check_expr(&arr.elem);
self.check_expr(&arr.len);
}
Array::Comprehension(arr) => {
self.check_expr(&arr.elem);
self.check_expr(&arr.guard);
}
},
Expr::Tuple(tuple) => match tuple {
Tuple::Normal(tup) => {
for arg in tup.elems.pos_args.iter() {
self.check_expr(&arg.expr);
}
}
},
Expr::Record(record) => {
self.path_stack
.push(Visibility::private(Str::ever("<record>")));
self.block_stack.push(Instant);
for attr in record.attrs.iter() {
self.check_def(attr);
}
self.path_stack.pop();
self.block_stack.pop();
}
Expr::Set(set) => match set {
Set::Normal(set) => {
for elem in set.elems.pos_args.iter() {
self.check_expr(&elem.expr);
}
}
Set::WithLength(set) => {
self.check_expr(&set.elem);
self.check_expr(&set.len);
}
},
Expr::Dict(dict) => match dict {
Dict::Normal(dict) => {
for kv in dict.kvs.iter() {
self.check_expr(&kv.key);
self.check_expr(&kv.value);
}
}
other => todo!("{other}"),
},
Expr::Call(call) => {
if (call.obj.t().is_procedure()
|| call
.attr_name
.as_ref()
.map(|name| name.is_procedural())
.unwrap_or(false))
&& !self.in_context_effects_allowed()
{
self.errs.push(EffectError::has_effect(
self.cfg.input.clone(),
line!() as usize,
expr,
self.full_path(),
));
}
call.args
.pos_args
.iter()
.for_each(|parg| self.check_expr(&parg.expr));
call.args
.kw_args
.iter()
.for_each(|kwarg| self.check_expr(&kwarg.expr));
}
Expr::UnaryOp(unary) => {
self.check_expr(&unary.expr);
}
Expr::BinOp(bin) => {
self.check_expr(&bin.lhs);
self.check_expr(&bin.rhs);
if (bin.op.kind == TokenKind::IsOp || bin.op.kind == TokenKind::IsNotOp)
&& !self.in_context_effects_allowed()
{
self.errs.push(EffectError::has_effect(
self.cfg.input.clone(),
line!() as usize,
expr,
self.full_path(),
));
}
}
Expr::Lambda(lambda) => {
let is_proc = lambda.is_procedural();
if is_proc {
self.path_stack
.push(Visibility::private(Str::ever("<lambda!>")));
self.block_stack.push(Proc);
} else {
self.path_stack
.push(Visibility::private(Str::ever("<lambda>")));
self.block_stack.push(Func);
}
self.check_params(&lambda.params);
lambda.body.iter().for_each(|chunk| self.check_expr(chunk));
self.path_stack.pop();
self.block_stack.pop();
}
Expr::TypeAsc(type_asc) => {
self.check_expr(&type_asc.expr);
}
Expr::Accessor(acc) => {
if !self.in_context_effects_allowed() && acc.ref_t().is_mut_type() {
self.errs.push(EffectError::touch_mut_error(
self.cfg.input.clone(),
line!() as usize,
expr,
self.full_path(),
));
}
}
Expr::ReDef(_)
| Expr::Code(_)
| Expr::Compound(_)
| Expr::Import(_)
| Expr::Dummy(_) => {}
}
}
pub(crate) fn is_impure(expr: &Expr) -> bool {
match expr {
Expr::Call(call) => {
call.ref_t().is_procedure()
|| call
.args
.pos_args
.iter()
.any(|parg| Self::is_impure(&parg.expr))
|| call
.args
.var_args
.iter()
.any(|varg| Self::is_impure(&varg.expr))
|| call
.args
.kw_args
.iter()
.any(|kwarg| Self::is_impure(&kwarg.expr))
}
Expr::BinOp(bin) => Self::is_impure(&bin.lhs) || Self::is_impure(&bin.rhs),
Expr::UnaryOp(unary) => Self::is_impure(&unary.expr),
Expr::Array(arr) => match arr {
Array::Normal(arr) => arr
.elems
.pos_args
.iter()
.any(|elem| Self::is_impure(&elem.expr)),
Array::WithLength(arr) => Self::is_impure(&arr.elem) || Self::is_impure(&arr.len),
_ => todo!(),
},
Expr::Tuple(tup) => match tup {
Tuple::Normal(tup) => tup
.elems
.pos_args
.iter()
.any(|elem| Self::is_impure(&elem.expr)),
},
Expr::Set(set) => match set {
Set::Normal(set) => set
.elems
.pos_args
.iter()
.any(|elem| Self::is_impure(&elem.expr)),
Set::WithLength(set) => Self::is_impure(&set.elem) || Self::is_impure(&set.len),
},
Expr::Dict(dict) => match dict {
Dict::Normal(dict) => dict
.kvs
.iter()
.any(|kv| Self::is_impure(&kv.key) || Self::is_impure(&kv.value)),
_ => todo!(),
},
Expr::Lambda(lambda) => {
lambda.op.is_procedural() || lambda.body.iter().any(Self::is_impure)
}
Expr::Def(def) => def.sig.is_procedural() || def.body.block.iter().any(Self::is_impure),
/*
Expr::ClassDef(class_def) => {
class_def.methods.iter().any(|def| Self::is_impure(def))
}
Expr::PatchDef(patch_def) => {
patch_def.methods.iter().any(|def| Self::is_impure(def))
}*/
Expr::Code(block) | Expr::Compound(block) => block.iter().any(Self::is_impure),
_ => false,
}
}
pub(crate) fn is_pure(expr: &Expr) -> bool {
!Self::is_impure(expr)
}
}