DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (b6d82b1a6b02)

VCS Links

Line Code
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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: set ts=8 sts=2 et sw=2 tw=80:
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef jit_TypePolicy_h
#define jit_TypePolicy_h

#include "mozilla/TypeTraits.h"

#include "jit/IonTypes.h"
#include "jit/JitAllocPolicy.h"

namespace js {
namespace jit {

class MInstruction;
class MDefinition;

extern MDefinition* AlwaysBoxAt(TempAllocator& alloc, MInstruction* at,
                                MDefinition* operand);

// A type policy directs the type analysis phases, which insert conversion,
// boxing, unboxing, and type changes as necessary.
class TypePolicy {
 public:
  // Analyze the inputs of the instruction and perform one of the following
  // actions for each input:
  //  * Nothing; the input already type-checks.
  //  * If untyped, optionally ask the input to try and specialize its value.
  //  * Replace the operand with a conversion instruction.
  //  * Insert an unconditional deoptimization (no conversion possible).
  virtual MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                         MInstruction* def) const = 0;
};

struct TypeSpecializationData {
 protected:
  // Specifies three levels of specialization:
  //  - < Value. This input is expected and required.
  //  - == None. This op should not be specialized.
  MIRType specialization_;

  MIRType thisTypeSpecialization() { return specialization_; }

 public:
  MIRType specialization() const { return specialization_; }
};

#define EMPTY_DATA_                            \
  struct Data {                                \
    static const TypePolicy* thisTypePolicy(); \
  }

#define INHERIT_DATA_(DATA_TYPE)               \
  struct Data : public DATA_TYPE {             \
    static const TypePolicy* thisTypePolicy(); \
  }

#define SPECIALIZATION_DATA_ INHERIT_DATA_(TypeSpecializationData)

class NoTypePolicy {
 public:
  struct Data {
    static const TypePolicy* thisTypePolicy() { return nullptr; }
  };
};

class BoxInputsPolicy final : public TypePolicy {
 public:
  constexpr BoxInputsPolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

class ArithPolicy final : public TypePolicy {
 public:
  constexpr ArithPolicy() {}
  SPECIALIZATION_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override;
};

class AllDoublePolicy final : public TypePolicy {
 public:
  constexpr AllDoublePolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

class BitwisePolicy final : public TypePolicy {
 public:
  constexpr BitwisePolicy() {}
  SPECIALIZATION_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override;
};

class ComparePolicy final : public TypePolicy {
 public:
  constexpr ComparePolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override;
};

class SameValuePolicy final : public TypePolicy {
 public:
  constexpr SameValuePolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override;
};

// Policy for MTest instructions.
class TestPolicy final : public TypePolicy {
 public:
  constexpr TestPolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override;
};

class TypeBarrierPolicy final : public TypePolicy {
 public:
  constexpr TypeBarrierPolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override;
};

class CallPolicy final : public TypePolicy {
 public:
  constexpr CallPolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override;
};

// Policy for MPow. First operand Double; second Double or Int32.
class PowPolicy final : public TypePolicy {
 public:
  constexpr PowPolicy() {}
  SPECIALIZATION_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override;
};

// Policy for MSign. Operand is either Double or Int32.
class SignPolicy final : public TypePolicy {
 public:
  constexpr SignPolicy() {}
  SPECIALIZATION_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override;
};

// Expect a string for operand Op. If the input is a Value, it is unboxed.
template <unsigned Op>
class StringPolicy final : public TypePolicy {
 public:
  constexpr StringPolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Expect a string for operand Op. Else a ToString instruction is inserted.
template <unsigned Op>
class ConvertToStringPolicy final : public TypePolicy {
 public:
  constexpr ConvertToStringPolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Expect an Boolean for operand Op. If the input is a Value, it is unboxed.
template <unsigned Op>
class BooleanPolicy final : private TypePolicy {
 public:
  constexpr BooleanPolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Expects either an Int32 or a boxed Int32 for operand Op; may unbox if needed.
template <unsigned Op>
class UnboxedInt32Policy final : private TypePolicy {
 public:
  constexpr UnboxedInt32Policy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Expect an Int for operand Op. Else a ToInt32 instruction is inserted.
template <unsigned Op>
class ConvertToInt32Policy final : public TypePolicy {
 public:
  constexpr ConvertToInt32Policy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Expect an Int for operand Op. Else a TruncateToInt32 instruction is inserted.
template <unsigned Op>
class TruncateToInt32Policy final : public TypePolicy {
 public:
  constexpr TruncateToInt32Policy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Expect a double for operand Op. If the input is a Value, it is unboxed.
template <unsigned Op>
class DoublePolicy final : public TypePolicy {
 public:
  constexpr DoublePolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Expect a float32 for operand Op. If the input is a Value, it is unboxed.
template <unsigned Op>
class Float32Policy final : public TypePolicy {
 public:
  constexpr Float32Policy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Expect a float32 OR a double for operand Op, but will prioritize Float32
// if the result type is set as such. If the input is a Value, it is unboxed.
template <unsigned Op>
class FloatingPointPolicy final : public TypePolicy {
 public:
  constexpr FloatingPointPolicy() {}
  SPECIALIZATION_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override;
};

template <unsigned Op>
class NoFloatPolicy final : public TypePolicy {
 public:
  constexpr NoFloatPolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Policy for guarding variadic instructions such as object / array state
// instructions.
template <unsigned FirstOp>
class NoFloatPolicyAfter final : public TypePolicy {
 public:
  constexpr NoFloatPolicyAfter() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override;
};

// Box objects or strings as an input to a ToDouble instruction.
class ToDoublePolicy final : public TypePolicy {
 public:
  constexpr ToDoublePolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Box objects, strings and undefined as input to a ToInt32 instruction.
class ToInt32Policy final : public TypePolicy {
 public:
  constexpr ToInt32Policy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

// Box objects as input to a ToString instruction.
class ToStringPolicy final : public TypePolicy {
 public:
  constexpr ToStringPolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* def);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override {
    return staticAdjustInputs(alloc, def);
  }
};

template <unsigned Op>
class ObjectPolicy final : public TypePolicy {
 public:
  constexpr ObjectPolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* ins);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override {
    return staticAdjustInputs(alloc, ins);
  }
};

// Single-object input. If the input is a Value, it is unboxed. If it is
// a primitive, we use ValueToNonNullObject.
typedef ObjectPolicy<0> SingleObjectPolicy;

template <unsigned Op>
class BoxPolicy final : public TypePolicy {
 public:
  constexpr BoxPolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* ins);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override {
    return staticAdjustInputs(alloc, ins);
  }
};

// Boxes everything except inputs of type Type.
template <unsigned Op, MIRType Type>
class BoxExceptPolicy final : public TypePolicy {
 public:
  constexpr BoxExceptPolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* ins);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override {
    return staticAdjustInputs(alloc, ins);
  }
};

// Box if not a typical property id (string, symbol, int32).
template <unsigned Op>
class CacheIdPolicy final : public TypePolicy {
 public:
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* ins);
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override {
    return staticAdjustInputs(alloc, ins);
  }
};

// Combine multiple policies.
template <class... Policies>
class MixPolicy final : public TypePolicy {
  template <class P>
  static bool staticAdjustInputsHelper(TempAllocator& alloc,
                                       MInstruction* ins) {
    return P::staticAdjustInputs(alloc, ins);
  }

  template <class P, class... Rest>
  static typename mozilla::EnableIf<(sizeof...(Rest) > 0), bool>::Type
  staticAdjustInputsHelper(TempAllocator& alloc, MInstruction* ins) {
    return P::staticAdjustInputs(alloc, ins) &&
           MixPolicy::staticAdjustInputsHelper<Rest...>(alloc, ins);
  }

 public:
  constexpr MixPolicy() {}
  EMPTY_DATA_;
  static MOZ_MUST_USE bool staticAdjustInputs(TempAllocator& alloc,
                                              MInstruction* ins) {
    return MixPolicy::staticAdjustInputsHelper<Policies...>(alloc, ins);
  }
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override {
    return staticAdjustInputs(alloc, ins);
  }
};

class CallSetElementPolicy final : public TypePolicy {
 public:
  constexpr CallSetElementPolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override;
};

// First operand will be boxed to a Value (except for an object)
// Second operand (if specified) will forcefully be unboxed to an object
class InstanceOfPolicy final : public TypePolicy {
 public:
  constexpr InstanceOfPolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override;
};

class StoreTypedArrayHolePolicy;

class StoreUnboxedScalarPolicy : public TypePolicy {
 private:
  constexpr StoreUnboxedScalarPolicy() {}
  static MOZ_MUST_USE bool adjustValueInput(TempAllocator& alloc,
                                            MInstruction* ins,
                                            Scalar::Type arrayType,
                                            MDefinition* value,
                                            int valueOperand);

  friend class StoreTypedArrayHolePolicy;

 public:
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override;
};

class StoreTypedArrayHolePolicy final : public StoreUnboxedScalarPolicy {
 public:
  constexpr StoreTypedArrayHolePolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override;
};

class StoreUnboxedObjectOrNullPolicy final : public TypePolicy {
 public:
  constexpr StoreUnboxedObjectOrNullPolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override;
};

class StoreUnboxedStringPolicy final : public TypePolicy {
 public:
  constexpr StoreUnboxedStringPolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* def) const override;
};

// Accepts integers and doubles. Everything else is boxed.
class ClampPolicy final : public TypePolicy {
 public:
  constexpr ClampPolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override;
};

class FilterTypeSetPolicy final : public TypePolicy {
 public:
  constexpr FilterTypeSetPolicy() {}
  EMPTY_DATA_;
  MOZ_MUST_USE bool adjustInputs(TempAllocator& alloc,
                                 MInstruction* ins) const override;
};

#undef SPECIALIZATION_DATA_
#undef INHERIT_DATA_
#undef EMPTY_DATA_

}  // namespace jit
}  // namespace js

#endif /* jit_TypePolicy_h */