1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 #![allow(non_snake_case)]
13 use rustc::hir::def_id::DefId;
14 use rustc::ty::subst::Substs;
15 use rustc::ty::{self, AdtKind, Ty, TyCtxt};
16 use rustc::ty::layout::{Layout, Primitive};
17 use rustc::traits::Reveal;
18 use middle::const_val::ConstVal;
19 use rustc_const_eval::ConstContext;
20 use rustc_const_eval::EvalHint::ExprTypeChecked;
21 use util::nodemap::FxHashSet;
22 use lint::{LateContext, LintContext, LintArray};
23 use lint::{LintPass, LateLintPass};
26 use std::{i8, i16, i32, i64, u8, u16, u32, u64, f32, f64};
39 "comparisons made useless by limits of the types involved"
45 "literal out of range for its type"
51 "shift exceeds the type's number of bits"
55 VARIANT_SIZE_DIFFERENCES,
57 "detects enums with widely varying variant sizes"
60 #[derive(Copy, Clone)]
61 pub struct TypeLimits {
62 /// Id of the last visited negated expression
63 negated_expr_id: ast::NodeId,
67 pub fn new() -> TypeLimits {
68 TypeLimits { negated_expr_id: ast::DUMMY_NODE_ID }
72 impl LintPass for TypeLimits {
73 fn get_lints(&self) -> LintArray {
74 lint_array!(UNUSED_COMPARISONS,
80 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TypeLimits {
81 fn check_expr(&mut self, cx: &LateContext, e: &hir::Expr) {
83 hir::ExprUnary(hir::UnNeg, ref expr) => {
84 // propagate negation, if the negation itself isn't negated
85 if self.negated_expr_id != e.id {
86 self.negated_expr_id = expr.id;
89 hir::ExprBinary(binop, ref l, ref r) => {
90 if is_comparison(binop) && !check_limits(cx, binop, &l, &r) {
91 cx.span_lint(UNUSED_COMPARISONS,
93 "comparison is useless due to type limits");
96 if binop.node.is_shift() {
97 let opt_ty_bits = match cx.tables.node_id_to_type(l.id).sty {
98 ty::TyInt(t) => Some(int_ty_bits(t, cx.sess().target.int_type)),
99 ty::TyUint(t) => Some(uint_ty_bits(t, cx.sess().target.uint_type)),
103 if let Some(bits) = opt_ty_bits {
104 let exceeding = if let hir::ExprLit(ref lit) = r.node {
105 if let ast::LitKind::Int(shift, _) = lit.node {
111 let const_cx = ConstContext::with_tables(cx.tcx, cx.tables);
112 match const_cx.eval(&r, ExprTypeChecked) {
113 Ok(ConstVal::Integral(i)) => {
123 cx.span_lint(EXCEEDING_BITSHIFTS,
125 "bitshift exceeds the type's number of bits");
130 hir::ExprLit(ref lit) => {
131 match cx.tables.node_id_to_type(e.id).sty {
134 ast::LitKind::Int(v, ast::LitIntType::Signed(_)) |
135 ast::LitKind::Int(v, ast::LitIntType::Unsuffixed) => {
136 let int_type = if let ast::IntTy::Is = t {
137 cx.sess().target.int_type
141 let (_, max) = int_ty_range(int_type);
142 let max = max as u128;
143 let negative = self.negated_expr_id == e.id;
145 // Detect literal value out of range [min, max] inclusive
146 // avoiding use of -min to prevent overflow/panic
147 if (negative && v > max + 1) ||
148 (!negative && v > max) {
149 cx.span_lint(OVERFLOWING_LITERALS,
151 &format!("literal out of range for {:?}", t));
159 let uint_type = if let ast::UintTy::Us = t {
160 cx.sess().target.uint_type
164 let (min, max) = uint_ty_range(uint_type);
165 let lit_val: u128 = match lit.node {
166 // _v is u8, within range by definition
167 ast::LitKind::Byte(_v) => return,
168 ast::LitKind::Int(v, _) => v,
171 if lit_val < min || lit_val > max {
172 cx.span_lint(OVERFLOWING_LITERALS,
174 &format!("literal out of range for {:?}", t));
178 let (min, max) = float_ty_range(t);
179 let lit_val: f64 = match lit.node {
180 ast::LitKind::Float(v, _) |
181 ast::LitKind::FloatUnsuffixed(v) => {
182 match v.as_str().parse() {
189 if lit_val < min || lit_val > max {
190 cx.span_lint(OVERFLOWING_LITERALS,
192 &format!("literal out of range for {:?}", t));
201 fn is_valid<T: cmp::PartialOrd>(binop: hir::BinOp, v: T, min: T, max: T) -> bool {
203 hir::BiLt => v > min && v <= max,
204 hir::BiLe => v >= min && v < max,
205 hir::BiGt => v >= min && v < max,
206 hir::BiGe => v > min && v <= max,
207 hir::BiEq | hir::BiNe => v >= min && v <= max,
212 fn rev_binop(binop: hir::BinOp) -> hir::BinOp {
213 codemap::respan(binop.span,
215 hir::BiLt => hir::BiGt,
216 hir::BiLe => hir::BiGe,
217 hir::BiGt => hir::BiLt,
218 hir::BiGe => hir::BiLe,
223 // for isize & usize, be conservative with the warnings, so that the
224 // warnings are consistent between 32- and 64-bit platforms
225 fn int_ty_range(int_ty: ast::IntTy) -> (i128, i128) {
227 ast::IntTy::Is => (i64::min_value() as i128, i64::max_value() as i128),
228 ast::IntTy::I8 => (i8::min_value() as i64 as i128, i8::max_value() as i128),
229 ast::IntTy::I16 => (i16::min_value() as i64 as i128, i16::max_value() as i128),
230 ast::IntTy::I32 => (i32::min_value() as i64 as i128, i32::max_value() as i128),
231 ast::IntTy::I64 => (i64::min_value() as i128, i64::max_value() as i128),
232 ast::IntTy::I128 =>(i128::min_value() as i128, i128::max_value()),
236 fn uint_ty_range(uint_ty: ast::UintTy) -> (u128, u128) {
238 ast::UintTy::Us => (u64::min_value() as u128, u64::max_value() as u128),
239 ast::UintTy::U8 => (u8::min_value() as u128, u8::max_value() as u128),
240 ast::UintTy::U16 => (u16::min_value() as u128, u16::max_value() as u128),
241 ast::UintTy::U32 => (u32::min_value() as u128, u32::max_value() as u128),
242 ast::UintTy::U64 => (u64::min_value() as u128, u64::max_value() as u128),
243 ast::UintTy::U128 => (u128::min_value(), u128::max_value()),
247 fn float_ty_range(float_ty: ast::FloatTy) -> (f64, f64) {
249 ast::FloatTy::F32 => (f32::MIN as f64, f32::MAX as f64),
250 ast::FloatTy::F64 => (f64::MIN, f64::MAX),
254 fn int_ty_bits(int_ty: ast::IntTy, target_int_ty: ast::IntTy) -> u64 {
256 ast::IntTy::Is => int_ty_bits(target_int_ty, target_int_ty),
258 ast::IntTy::I16 => 16 as u64,
259 ast::IntTy::I32 => 32,
260 ast::IntTy::I64 => 64,
261 ast::IntTy::I128 => 128,
265 fn uint_ty_bits(uint_ty: ast::UintTy, target_uint_ty: ast::UintTy) -> u64 {
267 ast::UintTy::Us => uint_ty_bits(target_uint_ty, target_uint_ty),
268 ast::UintTy::U8 => 8,
269 ast::UintTy::U16 => 16,
270 ast::UintTy::U32 => 32,
271 ast::UintTy::U64 => 64,
272 ast::UintTy::U128 => 128,
276 fn check_limits(cx: &LateContext,
281 let (lit, expr, swap) = match (&l.node, &r.node) {
282 (&hir::ExprLit(_), _) => (l, r, true),
283 (_, &hir::ExprLit(_)) => (r, l, false),
286 // Normalize the binop so that the literal is always on the RHS in
288 let norm_binop = if swap { rev_binop(binop) } else { binop };
289 match cx.tables.node_id_to_type(expr.id).sty {
290 ty::TyInt(int_ty) => {
291 let (min, max) = int_ty_range(int_ty);
292 let lit_val: i128 = match lit.node {
293 hir::ExprLit(ref li) => {
295 ast::LitKind::Int(v, ast::LitIntType::Signed(_)) |
296 ast::LitKind::Int(v, ast::LitIntType::Unsuffixed) => v as i128,
302 is_valid(norm_binop, lit_val, min, max)
304 ty::TyUint(uint_ty) => {
305 let (min, max) :(u128, u128) = uint_ty_range(uint_ty);
306 let lit_val: u128 = match lit.node {
307 hir::ExprLit(ref li) => {
309 ast::LitKind::Int(v, _) => v,
315 is_valid(norm_binop, lit_val, min, max)
321 fn is_comparison(binop: hir::BinOp) -> bool {
323 hir::BiEq | hir::BiLt | hir::BiLe | hir::BiNe | hir::BiGe | hir::BiGt => true,
333 "proper use of libc types in foreign modules"
336 struct ImproperCTypesVisitor<'a, 'tcx: 'a> {
337 cx: &'a LateContext<'a, 'tcx>,
342 FfiUnsafe(&'static str),
343 FfiBadStruct(DefId, &'static str),
344 FfiBadUnion(DefId, &'static str),
345 FfiBadEnum(DefId, &'static str),
348 /// Check if this enum can be safely exported based on the
349 /// "nullable pointer optimization". Currently restricted
350 /// to function pointers and references, but could be
351 /// expanded to cover NonZero raw pointers and newtypes.
352 /// FIXME: This duplicates code in trans.
353 fn is_repr_nullable_ptr<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
354 def: &'tcx ty::AdtDef,
355 substs: &Substs<'tcx>)
357 if def.variants.len() == 2 {
360 if def.variants[0].fields.is_empty() {
362 } else if def.variants[1].fields.is_empty() {
368 if def.variants[data_idx].fields.len() == 1 {
369 match def.variants[data_idx].fields[0].ty(tcx, substs).sty {
383 impl<'a, 'tcx> ImproperCTypesVisitor<'a, 'tcx> {
384 /// Check if the given type is "ffi-safe" (has a stable, well-defined
385 /// representation which can be exported to C code).
386 fn check_type_for_ffi(&self, cache: &mut FxHashSet<Ty<'tcx>>, ty: Ty<'tcx>) -> FfiResult {
387 use self::FfiResult::*;
388 let cx = self.cx.tcx;
390 // Protect against infinite recursion, for example
391 // `struct S(*mut S);`.
392 // FIXME: A recursion limit is necessary as well, for irregular
394 if !cache.insert(ty) {
399 ty::TyAdt(def, substs) => {
400 match def.adt_kind() {
402 if !cx.lookup_repr_hints(def.did).contains(&attr::ReprExtern) {
403 return FfiUnsafe("found struct without foreign-function-safe \
404 representation annotation in foreign module, \
405 consider adding a #[repr(C)] attribute to the type");
408 // We can't completely trust repr(C) markings; make sure the
409 // fields are actually safe.
410 if def.struct_variant().fields.is_empty() {
411 return FfiUnsafe("found zero-size struct in foreign module, consider \
412 adding a member to this struct");
415 for field in &def.struct_variant().fields {
416 let field_ty = cx.normalize_associated_type(&field.ty(cx, substs));
417 let r = self.check_type_for_ffi(cache, field_ty);
420 FfiBadStruct(..) | FfiBadUnion(..) | FfiBadEnum(..) => {
424 return FfiBadStruct(def.did, s);
431 if !cx.lookup_repr_hints(def.did).contains(&attr::ReprExtern) {
432 return FfiUnsafe("found union without foreign-function-safe \
433 representation annotation in foreign module, \
434 consider adding a #[repr(C)] attribute to the type");
437 for field in &def.struct_variant().fields {
438 let field_ty = cx.normalize_associated_type(&field.ty(cx, substs));
439 let r = self.check_type_for_ffi(cache, field_ty);
442 FfiBadStruct(..) | FfiBadUnion(..) | FfiBadEnum(..) => {
446 return FfiBadUnion(def.did, s);
453 if def.variants.is_empty() {
454 // Empty enums are okay... although sort of useless.
458 // Check for a repr() attribute to specify the size of the
460 let repr_hints = cx.lookup_repr_hints(def.did);
461 match &repr_hints[..] {
463 // Special-case types like `Option<extern fn()>`.
464 if !is_repr_nullable_ptr(cx, def, substs) {
465 return FfiUnsafe("found enum without foreign-function-safe \
466 representation annotation in foreign \
467 module, consider adding a #[repr(...)] \
468 attribute to the type");
472 if !hint.is_ffi_safe() {
473 // FIXME: This shouldn't be reachable: we should check
475 return FfiUnsafe("enum has unexpected #[repr(...)] attribute");
478 // Enum with an explicitly sized discriminant; either
479 // a C-style enum or a discriminated union.
481 // The layout of enum variants is implicitly repr(C).
482 // FIXME: Is that correct?
485 // FIXME: This shouldn't be reachable: we should check
487 return FfiUnsafe("enum has too many #[repr(...)] attributes");
491 // Check the contained variants.
492 for variant in &def.variants {
493 for field in &variant.fields {
494 let arg = cx.normalize_associated_type(&field.ty(cx, substs));
495 let r = self.check_type_for_ffi(cache, arg);
498 FfiBadStruct(..) | FfiBadUnion(..) | FfiBadEnum(..) => {
502 return FfiBadEnum(def.did, s);
513 FfiUnsafe("found Rust type `char` in foreign module, while \
514 `u32` or `libc::wchar_t` should be used")
517 // Primitive types with a stable representation.
518 ty::TyBool | ty::TyInt(..) | ty::TyUint(..) | ty::TyFloat(..) | ty::TyNever => FfiSafe,
521 FfiUnsafe("found Rust slice type in foreign module, \
522 consider using a raw pointer instead")
525 ty::TyDynamic(..) => {
526 FfiUnsafe("found Rust trait type in foreign module, \
527 consider using a raw pointer instead")
531 FfiUnsafe("found Rust type `str` in foreign module; \
532 consider using a `*const libc::c_char`")
536 FfiUnsafe("found Rust tuple type in foreign module; \
537 consider using a struct instead")
540 ty::TyRawPtr(ref m) |
541 ty::TyRef(_, ref m) => self.check_type_for_ffi(cache, m.ty),
543 ty::TyArray(ty, _) => self.check_type_for_ffi(cache, ty),
545 ty::TyFnPtr(bare_fn) => {
547 Abi::Rust | Abi::RustIntrinsic | Abi::PlatformIntrinsic | Abi::RustCall => {
548 return FfiUnsafe("found function pointer with Rust calling convention in \
549 foreign module; consider using an `extern` function \
555 let sig = cx.erase_late_bound_regions(&bare_fn.sig);
556 if !sig.output().is_nil() {
557 let r = self.check_type_for_ffi(cache, sig.output());
565 for arg in sig.inputs() {
566 let r = self.check_type_for_ffi(cache, arg);
581 ty::TyProjection(..) |
583 ty::TyFnDef(..) => bug!("Unexpected type in foreign function"),
587 fn check_type_for_ffi_and_report_errors(&mut self, sp: Span, ty: Ty<'tcx>) {
588 // it is only OK to use this function because extern fns cannot have
589 // any generic types right now:
590 let ty = self.cx.tcx.normalize_associated_type(&ty);
592 match self.check_type_for_ffi(&mut FxHashSet(), ty) {
593 FfiResult::FfiSafe => {}
594 FfiResult::FfiUnsafe(s) => {
595 self.cx.span_lint(IMPROPER_CTYPES, sp, s);
597 FfiResult::FfiBadStruct(_, s) => {
598 // FIXME: This diagnostic is difficult to read, and doesn't
599 // point at the relevant field.
600 self.cx.span_lint(IMPROPER_CTYPES,
602 &format!("found non-foreign-function-safe member in struct \
603 marked #[repr(C)]: {}",
606 FfiResult::FfiBadUnion(_, s) => {
607 // FIXME: This diagnostic is difficult to read, and doesn't
608 // point at the relevant field.
609 self.cx.span_lint(IMPROPER_CTYPES,
611 &format!("found non-foreign-function-safe member in union \
612 marked #[repr(C)]: {}",
615 FfiResult::FfiBadEnum(_, s) => {
616 // FIXME: This diagnostic is difficult to read, and doesn't
617 // point at the relevant variant.
618 self.cx.span_lint(IMPROPER_CTYPES,
620 &format!("found non-foreign-function-safe member in enum: {}",
626 fn check_foreign_fn(&mut self, id: ast::NodeId, decl: &hir::FnDecl) {
627 let def_id = self.cx.tcx.hir.local_def_id(id);
628 let sig = self.cx.tcx.item_type(def_id).fn_sig();
629 let sig = self.cx.tcx.erase_late_bound_regions(&sig);
631 for (input_ty, input_hir) in sig.inputs().iter().zip(&decl.inputs) {
632 self.check_type_for_ffi_and_report_errors(input_hir.span, input_ty);
635 if let hir::Return(ref ret_hir) = decl.output {
636 let ret_ty = sig.output();
637 if !ret_ty.is_nil() {
638 self.check_type_for_ffi_and_report_errors(ret_hir.span, ret_ty);
643 fn check_foreign_static(&mut self, id: ast::NodeId, span: Span) {
644 let def_id = self.cx.tcx.hir.local_def_id(id);
645 let ty = self.cx.tcx.item_type(def_id);
646 self.check_type_for_ffi_and_report_errors(span, ty);
650 #[derive(Copy, Clone)]
651 pub struct ImproperCTypes;
653 impl LintPass for ImproperCTypes {
654 fn get_lints(&self) -> LintArray {
655 lint_array!(IMPROPER_CTYPES)
659 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for ImproperCTypes {
660 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
661 let mut vis = ImproperCTypesVisitor { cx: cx };
662 if let hir::ItemForeignMod(ref nmod) = it.node {
663 if nmod.abi != Abi::RustIntrinsic && nmod.abi != Abi::PlatformIntrinsic {
664 for ni in &nmod.items {
666 hir::ForeignItemFn(ref decl, _, _) => {
667 vis.check_foreign_fn(ni.id, decl);
669 hir::ForeignItemStatic(ref ty, _) => {
670 vis.check_foreign_static(ni.id, ty.span);
679 pub struct VariantSizeDifferences;
681 impl LintPass for VariantSizeDifferences {
682 fn get_lints(&self) -> LintArray {
683 lint_array!(VARIANT_SIZE_DIFFERENCES)
687 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for VariantSizeDifferences {
688 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
689 if let hir::ItemEnum(ref enum_definition, ref gens) = it.node {
690 if gens.ty_params.is_empty() {
691 // sizes only make sense for non-generic types
692 let t = cx.tcx.item_type(cx.tcx.hir.local_def_id(it.id));
693 let layout = cx.tcx.infer_ctxt((), Reveal::All).enter(|infcx| {
694 let ty = cx.tcx.erase_regions(&t);
695 ty.layout(&infcx).unwrap_or_else(|e| {
696 bug!("failed to get layout for `{}`: {}", t, e)
700 if let Layout::General { ref variants, ref size, discr, .. } = *layout {
701 let discr_size = Primitive::Int(discr).size(&cx.tcx.data_layout).bytes();
703 debug!("enum `{}` is {} bytes large with layout:\n{:#?}",
704 t, size.bytes(), layout);
706 let (largest, slargest, largest_index) = enum_definition.variants
709 .map(|(variant, variant_layout)| {
710 // Subtract the size of the enum discriminant
711 let bytes = variant_layout.min_size
713 .saturating_sub(discr_size);
715 debug!("- variant `{}` is {} bytes large", variant.node.name, bytes);
719 .fold((0, 0, 0), |(l, s, li), (idx, size)| if size > l {
727 // we only warn if the largest variant is at least thrice as large as
728 // the second-largest.
729 if largest > slargest * 3 && slargest > 0 {
730 cx.span_lint(VARIANT_SIZE_DIFFERENCES,
731 enum_definition.variants[largest_index].span,
732 &format!("enum variant is more than three times larger \
733 ({} bytes) than the next largest",