150 Options options = Options.instance(context);
151 lint = Lint.instance(context);
152 fileManager = context.get(JavaFileManager.class);
153
154 source = Source.instance(context);
155 target = Target.instance(context);
156 warnOnAnyAccessToMembers = options.isSet("warnOnAccessToMembers");
157
158 disablePreviewCheck = false;
159
160 Target target = Target.instance(context);
161 syntheticNameChar = target.syntheticNameChar();
162
163 profile = Profile.instance(context);
164 preview = Preview.instance(context);
165
166 allowModules = Feature.MODULES.allowedInSource(source);
167 allowRecords = Feature.RECORDS.allowedInSource(source);
168 allowSealed = Feature.SEALED_CLASSES.allowedInSource(source);
169 allowPrimitivePatterns = preview.isEnabled() && Feature.PRIMITIVE_PATTERNS.allowedInSource(source);
170 }
171
172 /** Character for synthetic names
173 */
174 char syntheticNameChar;
175
176 /** A table mapping flat names of all compiled classes for each module in this run
177 * to their symbols; maintained from outside.
178 */
179 private Map<Pair<ModuleSymbol, Name>,ClassSymbol> compiled = new HashMap<>();
180
181 /** Are modules allowed
182 */
183 private final boolean allowModules;
184
185 /** Are records allowed
186 */
187 private final boolean allowRecords;
188
189 /** Are sealed classes allowed
190 */
191 private final boolean allowSealed;
192
193 /** Are primitive patterns allowed
194 */
195 private final boolean allowPrimitivePatterns;
196
197 /** Whether to force suppression of deprecation and preview warnings.
198 * This happens when attributing import statements for JDK 9+.
199 * @see Feature#DEPRECATION_ON_IMPORT
200 */
201 private boolean importSuppression;
202
203 /* *************************************************************************
204 * Errors and Warnings
205 **************************************************************************/
206
207 Lint setLint(Lint newLint) {
208 Lint prev = lint;
209 lint = newLint;
210 return prev;
211 }
212
213 boolean setImportSuppression(boolean newImportSuppression) {
214 boolean prev = importSuppression;
215 importSuppression = newImportSuppression;
216 return prev;
654 /** Check that type is a class or interface type.
655 * @param pos Position to be used for error reporting.
656 * @param t The type to be checked.
657 */
658 Type checkClassType(DiagnosticPosition pos, Type t) {
659 if (!t.hasTag(CLASS) && !t.hasTag(ERROR)) {
660 return typeTagError(pos,
661 diags.fragment(Fragments.TypeReqClass),
662 asTypeParam(t));
663 } else {
664 return t;
665 }
666 }
667 //where
668 private Object asTypeParam(Type t) {
669 return (t.hasTag(TYPEVAR))
670 ? diags.fragment(Fragments.TypeParameter(t))
671 : t;
672 }
673
674 /** Check that type is a valid qualifier for a constructor reference expression
675 */
676 Type checkConstructorRefType(DiagnosticPosition pos, Type t) {
677 t = checkClassOrArrayType(pos, t);
678 if (t.hasTag(CLASS)) {
679 if ((t.tsym.flags() & (ABSTRACT | INTERFACE)) != 0) {
680 log.error(pos, Errors.AbstractCantBeInstantiated(t.tsym));
681 t = types.createErrorType(t);
682 } else if ((t.tsym.flags() & ENUM) != 0) {
683 log.error(pos, Errors.EnumCantBeInstantiated);
684 t = types.createErrorType(t);
685 } else {
686 t = checkClassType(pos, t, true);
687 }
688 } else if (t.hasTag(ARRAY)) {
689 if (!types.isReifiable(((ArrayType)t).elemtype)) {
690 log.error(pos, Errors.GenericArrayCreation);
691 t = types.createErrorType(t);
692 }
693 }
711 args = args.tail;
712 }
713 }
714 return t;
715 }
716
717 /** Check that type is a reference type, i.e. a class, interface or array type
718 * or a type variable.
719 * @param pos Position to be used for error reporting.
720 * @param t The type to be checked.
721 */
722 Type checkRefType(DiagnosticPosition pos, Type t) {
723 if (t.isReference())
724 return t;
725 else
726 return typeTagError(pos,
727 diags.fragment(Fragments.TypeReqRef),
728 t);
729 }
730
731 /** Check that each type is a reference type, i.e. a class, interface or array type
732 * or a type variable.
733 * @param trees Original trees, used for error reporting.
734 * @param types The types to be checked.
735 */
736 List<Type> checkRefTypes(List<JCExpression> trees, List<Type> types) {
737 List<JCExpression> tl = trees;
738 for (List<Type> l = types; l.nonEmpty(); l = l.tail) {
739 l.head = checkRefType(tl.head.pos(), l.head);
740 tl = tl.tail;
741 }
742 return types;
743 }
744
745 /** Check that type is a null or reference type.
746 * @param pos Position to be used for error reporting.
747 * @param t The type to be checked.
748 */
749 Type checkNullOrRefType(DiagnosticPosition pos, Type t) {
750 if (t.isReference() || t.hasTag(BOT))
1102 * Warning: we can't use flags() here since this method
1103 * is called during class enter, when flags() would cause a premature
1104 * completion.
1105 * @param flags The set of modifiers given in a definition.
1106 * @param sym The defined symbol.
1107 * @param tree The declaration
1108 */
1109 long checkFlags(long flags, Symbol sym, JCTree tree) {
1110 final DiagnosticPosition pos = tree.pos();
1111 long mask;
1112 long implicit = 0;
1113
1114 switch (sym.kind) {
1115 case VAR:
1116 if (TreeInfo.isReceiverParam(tree))
1117 mask = ReceiverParamFlags;
1118 else if (sym.owner.kind != TYP)
1119 mask = LocalVarFlags;
1120 else if ((sym.owner.flags_field & INTERFACE) != 0)
1121 mask = implicit = InterfaceVarFlags;
1122 else
1123 mask = VarFlags;
1124 break;
1125 case MTH:
1126 if (sym.name == names.init) {
1127 if ((sym.owner.flags_field & ENUM) != 0) {
1128 // enum constructors cannot be declared public or
1129 // protected and must be implicitly or explicitly
1130 // private
1131 implicit = PRIVATE;
1132 mask = PRIVATE;
1133 } else
1134 mask = ConstructorFlags;
1135 } else if ((sym.owner.flags_field & INTERFACE) != 0) {
1136 if ((sym.owner.flags_field & ANNOTATION) != 0) {
1137 mask = AnnotationTypeElementMask;
1138 implicit = PUBLIC | ABSTRACT;
1139 } else if ((flags & (DEFAULT | STATIC | PRIVATE)) != 0) {
1140 mask = InterfaceMethodMask;
1141 implicit = (flags & PRIVATE) != 0 ? 0 : PUBLIC;
1142 if ((flags & DEFAULT) != 0) {
1143 implicit |= ABSTRACT;
1144 }
1145 } else {
1146 mask = implicit = InterfaceMethodFlags;
1147 }
1148 } else if ((sym.owner.flags_field & RECORD) != 0) {
1149 mask = RecordMethodFlags;
1150 } else {
1151 mask = MethodFlags;
1152 }
1153 if ((flags & STRICTFP) != 0) {
1154 log.warning(tree.pos(), LintWarnings.Strictfp);
1155 }
1156 // Imply STRICTFP if owner has STRICTFP set.
1157 if (((flags|implicit) & Flags.ABSTRACT) == 0 ||
1158 ((flags) & Flags.DEFAULT) != 0)
1159 implicit |= sym.owner.flags_field & STRICTFP;
1160 break;
1161 case TYP:
1162 if (sym.owner.kind.matches(KindSelector.VAL_MTH) ||
1163 (sym.isDirectlyOrIndirectlyLocal() && (flags & ANNOTATION) != 0)) {
1164 boolean implicitlyStatic = !sym.isAnonymous() &&
1165 ((flags & RECORD) != 0 || (flags & ENUM) != 0 || (flags & INTERFACE) != 0);
1166 boolean staticOrImplicitlyStatic = (flags & STATIC) != 0 || implicitlyStatic;
1167 // local statics are allowed only if records are allowed too
1168 mask = staticOrImplicitlyStatic && allowRecords && (flags & ANNOTATION) == 0 ? StaticLocalFlags : LocalClassFlags;
1169 implicit = implicitlyStatic ? STATIC : implicit;
1170 } else if (sym.owner.kind == TYP) {
1171 // statics in inner classes are allowed only if records are allowed too
1172 mask = ((flags & STATIC) != 0) && allowRecords && (flags & ANNOTATION) == 0 ? ExtendedMemberStaticClassFlags : ExtendedMemberClassFlags;
1173 if (sym.owner.owner.kind == PCK ||
1174 (sym.owner.flags_field & STATIC) != 0) {
1175 mask |= STATIC;
1176 } else if (!allowRecords && ((flags & ENUM) != 0 || (flags & RECORD) != 0)) {
1177 log.error(pos, Errors.StaticDeclarationNotAllowedInInnerClasses);
1178 }
1179 // Nested interfaces and enums are always STATIC (Spec ???)
1180 if ((flags & (INTERFACE | ENUM | RECORD)) != 0 ) implicit = STATIC;
1181 } else {
1182 mask = ExtendedClassFlags;
1183 }
1184 // Interfaces are always ABSTRACT
1185 if ((flags & INTERFACE) != 0) implicit |= ABSTRACT;
1186
1187 if ((flags & ENUM) != 0) {
1188 // enums can't be declared abstract, final, sealed or non-sealed
1189 mask &= ~(ABSTRACT | FINAL | SEALED | NON_SEALED);
1190 implicit |= implicitEnumFinalFlag(tree);
1191 }
1192 if ((flags & RECORD) != 0) {
1193 // records can't be declared abstract
1194 mask &= ~ABSTRACT;
1195 implicit |= FINAL;
1196 }
1197 if ((flags & STRICTFP) != 0) {
1198 log.warning(tree.pos(), LintWarnings.Strictfp);
1199 }
1200 // Imply STRICTFP if owner has STRICTFP set.
1201 implicit |= sym.owner.flags_field & STRICTFP;
1202 break;
1203 default:
1204 throw new AssertionError();
1205 }
1206 long illegal = flags & ExtendedStandardFlags & ~mask;
1207 if (illegal != 0) {
1208 if ((illegal & INTERFACE) != 0) {
1209 log.error(pos, ((flags & ANNOTATION) != 0) ? Errors.AnnotationDeclNotAllowedHere : Errors.IntfNotAllowedHere);
1210 mask |= INTERFACE;
1211 }
1212 else {
1213 log.error(pos,
1214 Errors.ModNotAllowedHere(asFlagSet(illegal)));
1215 }
1216 }
1217 else if ((sym.kind == TYP ||
1218 // ISSUE: Disallowing abstract&private is no longer appropriate
1219 // in the presence of inner classes. Should it be deleted here?
1220 checkDisjoint(pos, flags,
1221 ABSTRACT,
1222 PRIVATE | STATIC | DEFAULT))
1223 &&
1224 checkDisjoint(pos, flags,
1225 STATIC | PRIVATE,
1226 DEFAULT)
1227 &&
1228 checkDisjoint(pos, flags,
1229 ABSTRACT | INTERFACE,
1230 FINAL | NATIVE | SYNCHRONIZED)
1231 &&
1232 checkDisjoint(pos, flags,
1233 PUBLIC,
1234 PRIVATE | PROTECTED)
1235 &&
1236 checkDisjoint(pos, flags,
1237 PRIVATE,
1238 PUBLIC | PROTECTED)
1239 &&
1240 checkDisjoint(pos, flags,
1241 FINAL,
1242 VOLATILE)
1243 &&
1244 (sym.kind == TYP ||
1245 checkDisjoint(pos, flags,
1246 ABSTRACT | NATIVE,
1247 STRICTFP))
1248 && checkDisjoint(pos, flags,
1249 FINAL,
1250 SEALED | NON_SEALED)
1251 && checkDisjoint(pos, flags,
1252 SEALED,
1253 FINAL | NON_SEALED)
1254 && checkDisjoint(pos, flags,
1255 SEALED,
1256 ANNOTATION)) {
1257 // skip
1258 }
1259 return flags & (mask | ~ExtendedStandardFlags) | implicit;
1260 }
1261
1262 /** Determine if this enum should be implicitly final.
1263 *
1264 * If the enum has no specialized enum constants, it is final.
1265 *
1266 * If the enum does have specialized enum constants, it is
1267 * <i>not</i> final.
1268 */
1269 private long implicitEnumFinalFlag(JCTree tree) {
1270 if (!tree.hasTag(CLASSDEF)) return 0;
1271 class SpecialTreeVisitor extends JCTree.Visitor {
1272 boolean specialized;
1273 SpecialTreeVisitor() {
1274 this.specialized = false;
1275 }
1276
2033 return true;
2034 }
2035 }
2036 }
2037 return false;
2038 }
2039
2040 /** Check that a given method conforms with any method it overrides.
2041 * @param tree The tree from which positions are extracted
2042 * for errors.
2043 * @param m The overriding method.
2044 */
2045 void checkOverride(Env<AttrContext> env, JCMethodDecl tree, MethodSymbol m) {
2046 ClassSymbol origin = (ClassSymbol)m.owner;
2047 if ((origin.flags() & ENUM) != 0 && names.finalize.equals(m.name)) {
2048 if (m.overrides(syms.enumFinalFinalize, origin, types, false)) {
2049 log.error(tree.pos(), Errors.EnumNoFinalize);
2050 return;
2051 }
2052 }
2053 if (allowRecords && origin.isRecord()) {
2054 // let's find out if this is a user defined accessor in which case the @Override annotation is acceptable
2055 Optional<? extends RecordComponent> recordComponent = origin.getRecordComponents().stream()
2056 .filter(rc -> rc.accessor == tree.sym && (rc.accessor.flags_field & GENERATED_MEMBER) == 0).findFirst();
2057 if (recordComponent.isPresent()) {
2058 return;
2059 }
2060 }
2061
2062 for (Type t = origin.type; t.hasTag(CLASS);
2063 t = types.supertype(t)) {
2064 if (t != origin.type) {
2065 checkOverride(tree, t, origin, m);
2066 }
2067 for (Type t2 : types.interfaces(t)) {
2068 checkOverride(tree, t2, origin, m);
2069 }
2070 }
2071
2072 final boolean explicitOverride = m.attribute(syms.overrideType.tsym) != null;
2468 /** Check that all abstract methods implemented by a class are
2469 * mutually compatible.
2470 * @param pos Position to be used for error reporting.
2471 * @param c The class whose interfaces are checked.
2472 */
2473 void checkCompatibleSupertypes(DiagnosticPosition pos, Type c) {
2474 List<Type> supertypes = types.interfaces(c);
2475 Type supertype = types.supertype(c);
2476 if (supertype.hasTag(CLASS) &&
2477 (supertype.tsym.flags() & ABSTRACT) != 0)
2478 supertypes = supertypes.prepend(supertype);
2479 for (List<Type> l = supertypes; l.nonEmpty(); l = l.tail) {
2480 if (!l.head.getTypeArguments().isEmpty() &&
2481 !checkCompatibleAbstracts(pos, l.head, l.head, c))
2482 return;
2483 for (List<Type> m = supertypes; m != l; m = m.tail)
2484 if (!checkCompatibleAbstracts(pos, l.head, m.head, c))
2485 return;
2486 }
2487 checkCompatibleConcretes(pos, c);
2488 }
2489
2490 /** Check that all non-override equivalent methods accessible from 'site'
2491 * are mutually compatible (JLS 8.4.8/9.4.1).
2492 *
2493 * @param pos Position to be used for error reporting.
2494 * @param site The class whose methods are checked.
2495 * @param sym The method symbol to be checked.
2496 */
2497 void checkOverrideClashes(DiagnosticPosition pos, Type site, MethodSymbol sym) {
2498 ClashFilter cf = new ClashFilter(site);
2499 //for each method m1 that is overridden (directly or indirectly)
2500 //by method 'sym' in 'site'...
2501
2502 ArrayList<Symbol> symbolsByName = new ArrayList<>();
2503 types.membersClosure(site, false).getSymbolsByName(sym.name, cf).forEach(symbolsByName::add);
2504 for (Symbol m1 : symbolsByName) {
2505 if (!sym.overrides(m1, site.tsym, types, false)) {
2506 continue;
2507 }
4837 }
4838 } else {
4839 Assert.error("Unknown pattern: " + currentPattern.getTag());
4840 }
4841 return false;
4842 }
4843
4844 /** check if a type is a subtype of Externalizable, if that is available. */
4845 boolean isExternalizable(Type t) {
4846 try {
4847 syms.externalizableType.complete();
4848 } catch (CompletionFailure e) {
4849 return false;
4850 }
4851 return types.isSubtype(t, syms.externalizableType);
4852 }
4853
4854 /**
4855 * Check structure of serialization declarations.
4856 */
4857 public void checkSerialStructure(JCClassDecl tree, ClassSymbol c) {
4858 (new SerialTypeVisitor()).visit(c, tree);
4859 }
4860
4861 /**
4862 * This visitor will warn if a serialization-related field or
4863 * method is declared in a suspicious or incorrect way. In
4864 * particular, it will warn for cases where the runtime
4865 * serialization mechanism will silently ignore a mis-declared
4866 * entity.
4867 *
4868 * Distinguished serialization-related fields and methods:
4869 *
4870 * Methods:
4871 *
4872 * private void writeObject(ObjectOutputStream stream) throws IOException
4873 * ANY-ACCESS-MODIFIER Object writeReplace() throws ObjectStreamException
4874 *
4875 * private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException
4876 * private void readObjectNoData() throws ObjectStreamException
4877 * ANY-ACCESS-MODIFIER Object readResolve() throws ObjectStreamException
4878 *
4879 * Fields:
4880 *
4881 * private static final long serialVersionUID
4882 * private static final ObjectStreamField[] serialPersistentFields
4883 *
4884 * Externalizable: methods defined on the interface
4885 * public void writeExternal(ObjectOutput) throws IOException
4886 * public void readExternal(ObjectInput) throws IOException
4887 */
4888 private class SerialTypeVisitor extends ElementKindVisitor14<Void, JCClassDecl> {
4889 SerialTypeVisitor() {
4890 this.lint = Check.this.lint;
4891 }
4892
4893 private static final Set<String> serialMethodNames =
4894 Set.of("writeObject", "writeReplace",
4895 "readObject", "readObjectNoData",
4896 "readResolve");
4897
4898 private static final Set<String> serialFieldNames =
4899 Set.of("serialVersionUID", "serialPersistentFields");
4900
4901 // Type of serialPersistentFields
4902 private final Type OSF_TYPE = new Type.ArrayType(syms.objectStreamFieldType, syms.arrayClass);
4903
4904 Lint lint;
4905
4906 @Override
4907 public Void defaultAction(Element e, JCClassDecl p) {
4908 throw new IllegalArgumentException(Objects.requireNonNullElse(e.toString(), ""));
4909 }
4910
4930 if (sym.kind == VAR) {
4931 svuidSym = (VarSymbol)sym;
4932 break;
4933 }
4934 }
4935
4936 if (svuidSym == null) {
4937 log.warning(p.pos(), LintWarnings.MissingSVUID(c));
4938 }
4939
4940 // Check for serialPersistentFields to gate checks for
4941 // non-serializable non-transient instance fields
4942 boolean serialPersistentFieldsPresent =
4943 c.members()
4944 .getSymbolsByName(names.serialPersistentFields, sym -> sym.kind == VAR)
4945 .iterator()
4946 .hasNext();
4947
4948 // Check declarations of serialization-related methods and
4949 // fields
4950 for(Symbol el : c.getEnclosedElements()) {
4951 runUnderLint(el, p, (enclosed, tree) -> {
4952 String name = null;
4953 switch(enclosed.getKind()) {
4954 case FIELD -> {
4955 if (!serialPersistentFieldsPresent) {
4956 var flags = enclosed.flags();
4957 if ( ((flags & TRANSIENT) == 0) &&
4958 ((flags & STATIC) == 0)) {
4959 Type varType = enclosed.asType();
4960 if (!canBeSerialized(varType)) {
4961 // Note per JLS arrays are
4962 // serializable even if the
4963 // component type is not.
4964 log.warning(
4965 TreeInfo.diagnosticPositionFor(enclosed, tree),
4966 LintWarnings.NonSerializableInstanceField);
4967 } else if (varType.hasTag(ARRAY)) {
4968 ArrayType arrayType = (ArrayType)varType;
4969 Type elementType = arrayType.elemtype;
5004 // will also pull in default methods from
5005 // superinterfaces. In other words, the runtime checks
5006 // (which long predate default methods on interfaces)
5007 // do not admit the possibility of inheriting methods
5008 // this way, a difference from general inheritance.
5009
5010 // The current implementation just checks the enclosed
5011 // elements and does not directly check the inherited
5012 // methods. If all the types are being checked this is
5013 // less of a concern; however, there are cases that
5014 // could be missed. In particular, readResolve and
5015 // writeReplace could, in principle, by inherited from
5016 // a non-serializable superclass and thus not checked
5017 // even if compiled with a serializable child class.
5018 case METHOD -> {
5019 var method = (MethodSymbol)enclosed;
5020 name = method.getSimpleName().toString();
5021 if (serialMethodNames.contains(name)) {
5022 switch (name) {
5023 case "writeObject" -> checkWriteObject(tree, e, method);
5024 case "writeReplace" -> checkWriteReplace(tree,e, method);
5025 case "readObject" -> checkReadObject(tree,e, method);
5026 case "readObjectNoData" -> checkReadObjectNoData(tree, e, method);
5027 case "readResolve" -> checkReadResolve(tree, e, method);
5028 default -> throw new AssertionError();
5029 }
5030 }
5031 }
5032 }
5033 });
5034 }
5035
5036 return null;
5037 }
5038
5039 boolean canBeSerialized(Type type) {
5040 return type.isPrimitive() || rs.isSerializable(type);
5041 }
5042
5043 /**
5044 * Check that Externalizable class needs a public no-arg
5045 * constructor.
5046 *
5047 * Check that a Serializable class has access to the no-arg
5048 * constructor of its first nonserializable superclass.
5049 */
5050 private void checkCtorAccess(JCClassDecl tree, ClassSymbol c) {
5051 if (isExternalizable(c.type)) {
5052 for(var sym : c.getEnclosedElements()) {
5053 if (sym.isConstructor() &&
5054 ((sym.flags() & PUBLIC) == PUBLIC)) {
5055 if (((MethodSymbol)sym).getParameters().isEmpty()) {
5056 return;
5057 }
5058 }
5059 }
5060 log.warning(tree.pos(),
5061 LintWarnings.ExternalizableMissingPublicNoArgCtor);
5062 } else {
5146 // Warn if serialPersistentFields is initialized to a
5147 // literal null.
5148 JCTree spfDecl = TreeInfo.declarationFor(spf, tree);
5149 if (spfDecl != null && spfDecl.getTag() == VARDEF) {
5150 JCVariableDecl variableDef = (JCVariableDecl) spfDecl;
5151 JCExpression initExpr = variableDef.init;
5152 if (initExpr != null && TreeInfo.isNull(initExpr)) {
5153 log.warning(initExpr.pos(),
5154 LintWarnings.SPFNullInit);
5155 }
5156 }
5157 }
5158
5159 private void checkWriteObject(JCClassDecl tree, Element e, MethodSymbol method) {
5160 // The "synchronized" modifier is seen in the wild on
5161 // readObject and writeObject methods and is generally
5162 // innocuous.
5163
5164 // private void writeObject(ObjectOutputStream stream) throws IOException
5165 checkPrivateNonStaticMethod(tree, method);
5166 checkReturnType(tree, e, method, syms.voidType);
5167 checkOneArg(tree, e, method, syms.objectOutputStreamType);
5168 checkExceptions(tree, e, method, syms.ioExceptionType);
5169 checkExternalizable(tree, e, method);
5170 }
5171
5172 private void checkWriteReplace(JCClassDecl tree, Element e, MethodSymbol method) {
5173 // ANY-ACCESS-MODIFIER Object writeReplace() throws
5174 // ObjectStreamException
5175
5176 // Excluding abstract, could have a more complicated
5177 // rule based on abstract-ness of the class
5178 checkConcreteInstanceMethod(tree, e, method);
5179 checkReturnType(tree, e, method, syms.objectType);
5180 checkNoArgs(tree, e, method);
5181 checkExceptions(tree, e, method, syms.objectStreamExceptionType);
5182 }
5183
5184 private void checkReadObject(JCClassDecl tree, Element e, MethodSymbol method) {
5185 // The "synchronized" modifier is seen in the wild on
5186 // readObject and writeObject methods and is generally
5187 // innocuous.
5188
5189 // private void readObject(ObjectInputStream stream)
5190 // throws IOException, ClassNotFoundException
5191 checkPrivateNonStaticMethod(tree, method);
5192 checkReturnType(tree, e, method, syms.voidType);
5193 checkOneArg(tree, e, method, syms.objectInputStreamType);
5194 checkExceptions(tree, e, method, syms.ioExceptionType, syms.classNotFoundExceptionType);
5195 checkExternalizable(tree, e, method);
5196 }
5197
5198 private void checkReadObjectNoData(JCClassDecl tree, Element e, MethodSymbol method) {
5199 // private void readObjectNoData() throws ObjectStreamException
5200 checkPrivateNonStaticMethod(tree, method);
5201 checkReturnType(tree, e, method, syms.voidType);
5202 checkNoArgs(tree, e, method);
5203 checkExceptions(tree, e, method, syms.objectStreamExceptionType);
5204 checkExternalizable(tree, e, method);
5205 }
5206
5207 private void checkReadResolve(JCClassDecl tree, Element e, MethodSymbol method) {
5208 // ANY-ACCESS-MODIFIER Object readResolve()
5209 // throws ObjectStreamException
5210
5211 // Excluding abstract, could have a more complicated
5212 // rule based on abstract-ness of the class
5213 checkConcreteInstanceMethod(tree, e, method);
5214 checkReturnType(tree,e, method, syms.objectType);
5215 checkNoArgs(tree, e, method);
5216 checkExceptions(tree, e, method, syms.objectStreamExceptionType);
5217 }
5218
5219 private void checkWriteExternalRecord(JCClassDecl tree, Element e, MethodSymbol method, boolean isExtern) {
5220 //public void writeExternal(ObjectOutput) throws IOException
5221 checkExternMethodRecord(tree, e, method, syms.objectOutputType, isExtern);
5222 }
5223
5224 private void checkReadExternalRecord(JCClassDecl tree, Element e, MethodSymbol method, boolean isExtern) {
5225 // public void readExternal(ObjectInput) throws IOException
5226 checkExternMethodRecord(tree, e, method, syms.objectInputType, isExtern);
5227 }
5228
5229 private void checkExternMethodRecord(JCClassDecl tree, Element e, MethodSymbol method, Type argType,
5230 boolean isExtern) {
5231 if (isExtern && isExternMethod(tree, e, method, argType)) {
5232 log.warning(
5233 TreeInfo.diagnosticPositionFor(method, tree),
5234 LintWarnings.IneffectualExternalizableMethodRecord(method.getSimpleName().toString()));
5235 }
5236 }
5446 case FIELD -> {
5447 var field = (VarSymbol)enclosed;
5448 switch(name) {
5449 case "serialPersistentFields" -> {
5450 log.warning(
5451 TreeInfo.diagnosticPositionFor(field, tree),
5452 LintWarnings.IneffectualSerialFieldRecord);
5453 }
5454
5455 case "serialVersionUID" -> {
5456 // Could generate additional warning that
5457 // svuid value is not checked to match for
5458 // records.
5459 checkSerialVersionUID(tree, e, field);
5460 }}
5461 }
5462
5463 case METHOD -> {
5464 var method = (MethodSymbol)enclosed;
5465 switch(name) {
5466 case "writeReplace" -> checkWriteReplace(tree, e, method);
5467 case "readResolve" -> checkReadResolve(tree, e, method);
5468
5469 case "writeExternal" -> checkWriteExternalRecord(tree, e, method, isExtern);
5470 case "readExternal" -> checkReadExternalRecord(tree, e, method, isExtern);
5471
5472 default -> {
5473 if (serialMethodNames.contains(name)) {
5474 log.warning(
5475 TreeInfo.diagnosticPositionFor(method, tree),
5476 LintWarnings.IneffectualSerialMethodRecord(name));
5477 }
5478 }}
5479 }}});
5480 }
5481 return null;
5482 }
5483
5484 void checkConcreteInstanceMethod(JCClassDecl tree,
5485 Element enclosing,
5486 MethodSymbol method) {
5487 if ((method.flags() & (STATIC | ABSTRACT)) != 0) {
5488 log.warning(
5489 TreeInfo.diagnosticPositionFor(method, tree),
5490 LintWarnings.SerialConcreteInstanceMethod(method.getSimpleName()));
5491 }
5492 }
5493
5494 private void checkReturnType(JCClassDecl tree,
5495 Element enclosing,
5496 MethodSymbol method,
5497 Type expectedReturnType) {
5498 // Note: there may be complications checking writeReplace
5499 // and readResolve since they return Object and could, in
5500 // principle, have covariant overrides and any synthetic
5501 // bridge method would not be represented here for
5502 // checking.
5503 Type rtype = method.getReturnType();
5504 if (!types.isSameType(expectedReturnType, rtype)) {
5505 log.warning(
5506 TreeInfo.diagnosticPositionFor(method, tree),
5507 LintWarnings.SerialMethodUnexpectedReturnType(method.getSimpleName(),
5508 rtype, expectedReturnType));
5509 }
5510 }
5511
5512 private void checkOneArg(JCClassDecl tree,
5513 Element enclosing,
5514 MethodSymbol method,
5515 Type expectedType) {
5516 String name = method.getSimpleName().toString();
5517
5518 var parameters= method.getParameters();
5519
5520 if (parameters.size() != 1) {
5521 log.warning(
5522 TreeInfo.diagnosticPositionFor(method, tree),
5523 LintWarnings.SerialMethodOneArg(method.getSimpleName(), parameters.size()));
5524 return;
5525 }
5526
5527 Type parameterType = parameters.get(0).asType();
5528 if (!types.isSameType(parameterType, expectedType)) {
5529 log.warning(
5530 TreeInfo.diagnosticPositionFor(method, tree),
5531 LintWarnings.SerialMethodParameterType(method.getSimpleName(),
5532 expectedType,
5533 parameterType));
5534 }
5535 }
5536
5537 private boolean hasExactlyOneArgWithType(JCClassDecl tree,
5538 Element enclosing,
5539 MethodSymbol method,
5540 Type expectedType) {
5541 var parameters = method.getParameters();
5542 return (parameters.size() == 1) &&
5543 types.isSameType(parameters.get(0).asType(), expectedType);
5544 }
5545
5546
5547 private void checkNoArgs(JCClassDecl tree, Element enclosing, MethodSymbol method) {
5548 var parameters = method.getParameters();
5549 if (!parameters.isEmpty()) {
5550 log.warning(
5551 TreeInfo.diagnosticPositionFor(parameters.get(0), tree),
5552 LintWarnings.SerialMethodNoArgs(method.getSimpleName()));
5553 }
5554 }
5555
5556 private void checkExternalizable(JCClassDecl tree, Element enclosing, MethodSymbol method) {
5557 // If the enclosing class is externalizable, warn for the method
5558 if (isExternalizable((Type)enclosing.asType())) {
5559 log.warning(
5560 TreeInfo.diagnosticPositionFor(method, tree),
5561 LintWarnings.IneffectualSerialMethodExternalizable(method.getSimpleName()));
5562 }
5563 return;
5564 }
5565
5566 private void checkExceptions(JCClassDecl tree,
5567 Element enclosing,
5568 MethodSymbol method,
5569 Type... declaredExceptions) {
5570 for (Type thrownType: method.getThrownTypes()) {
5571 // For each exception in the throws clause of the
5572 // method, if not an Error and not a RuntimeException,
5573 // check if the exception is a subtype of a declared
5574 // exception from the throws clause of the
5575 // serialization method in question.
5576 if (types.isSubtype(thrownType, syms.runtimeExceptionType) ||
5577 types.isSubtype(thrownType, syms.errorType) ) {
5578 continue;
5579 } else {
5580 boolean declared = false;
5581 for (Type declaredException : declaredExceptions) {
5582 if (types.isSubtype(thrownType, declaredException)) {
5583 declared = true;
5584 continue;
5585 }
5586 }
5587 if (!declared) {
5588 log.warning(
5589 TreeInfo.diagnosticPositionFor(method, tree),
5590 LintWarnings.SerialMethodUnexpectedException(method.getSimpleName(),
5591 thrownType));
5592 }
5593 }
5594 }
5595 return;
5596 }
5597
5598 private <E extends Element> Void runUnderLint(E symbol, JCClassDecl p, BiConsumer<E, JCClassDecl> task) {
5599 Lint prevLint = lint;
5600 try {
5601 lint = lint.augment((Symbol) symbol);
5602
5603 if (lint.isEnabled(LintCategory.SERIAL)) {
5604 task.accept(symbol, p);
5605 }
5606
5607 return null;
5608 } finally {
5609 lint = prevLint;
5610 }
5611 }
5612
5613 }
5614
5615 void checkRequiresIdentity(JCTree tree, Lint lint) {
|
150 Options options = Options.instance(context);
151 lint = Lint.instance(context);
152 fileManager = context.get(JavaFileManager.class);
153
154 source = Source.instance(context);
155 target = Target.instance(context);
156 warnOnAnyAccessToMembers = options.isSet("warnOnAccessToMembers");
157
158 disablePreviewCheck = false;
159
160 Target target = Target.instance(context);
161 syntheticNameChar = target.syntheticNameChar();
162
163 profile = Profile.instance(context);
164 preview = Preview.instance(context);
165
166 allowModules = Feature.MODULES.allowedInSource(source);
167 allowRecords = Feature.RECORDS.allowedInSource(source);
168 allowSealed = Feature.SEALED_CLASSES.allowedInSource(source);
169 allowPrimitivePatterns = preview.isEnabled() && Feature.PRIMITIVE_PATTERNS.allowedInSource(source);
170 allowValueClasses = (!preview.isPreview(Feature.VALUE_CLASSES) || preview.isEnabled()) &&
171 Feature.VALUE_CLASSES.allowedInSource(source);
172 }
173
174 /** Character for synthetic names
175 */
176 char syntheticNameChar;
177
178 /** A table mapping flat names of all compiled classes for each module in this run
179 * to their symbols; maintained from outside.
180 */
181 private Map<Pair<ModuleSymbol, Name>,ClassSymbol> compiled = new HashMap<>();
182
183 /** Are modules allowed
184 */
185 private final boolean allowModules;
186
187 /** Are records allowed
188 */
189 private final boolean allowRecords;
190
191 /** Are sealed classes allowed
192 */
193 private final boolean allowSealed;
194
195 /** Are primitive patterns allowed
196 */
197 private final boolean allowPrimitivePatterns;
198
199 /** Are value classes allowed
200 */
201 private final boolean allowValueClasses;
202
203 /** Whether to force suppression of deprecation and preview warnings.
204 * This happens when attributing import statements for JDK 9+.
205 * @see Feature#DEPRECATION_ON_IMPORT
206 */
207 private boolean importSuppression;
208
209 /* *************************************************************************
210 * Errors and Warnings
211 **************************************************************************/
212
213 Lint setLint(Lint newLint) {
214 Lint prev = lint;
215 lint = newLint;
216 return prev;
217 }
218
219 boolean setImportSuppression(boolean newImportSuppression) {
220 boolean prev = importSuppression;
221 importSuppression = newImportSuppression;
222 return prev;
660 /** Check that type is a class or interface type.
661 * @param pos Position to be used for error reporting.
662 * @param t The type to be checked.
663 */
664 Type checkClassType(DiagnosticPosition pos, Type t) {
665 if (!t.hasTag(CLASS) && !t.hasTag(ERROR)) {
666 return typeTagError(pos,
667 diags.fragment(Fragments.TypeReqClass),
668 asTypeParam(t));
669 } else {
670 return t;
671 }
672 }
673 //where
674 private Object asTypeParam(Type t) {
675 return (t.hasTag(TYPEVAR))
676 ? diags.fragment(Fragments.TypeParameter(t))
677 : t;
678 }
679
680 void checkConstraintsOfValueClass(JCClassDecl tree, ClassSymbol c) {
681 DiagnosticPosition pos = tree.pos();
682 for (Type st : types.closure(c.type)) {
683 if (st == null || st.tsym == null || st.tsym.kind == ERR)
684 continue;
685 if (st.tsym == syms.objectType.tsym || st.tsym == syms.recordType.tsym || st.isInterface())
686 continue;
687 if (!st.tsym.isAbstract()) {
688 if (c != st.tsym) {
689 log.error(pos, Errors.ConcreteSupertypeForValueClass(c, st));
690 }
691 continue;
692 }
693 // dealing with an abstract value or value super class below.
694 for (Symbol s : st.tsym.members().getSymbols(NON_RECURSIVE)) {
695 if (s.kind == MTH) {
696 if ((s.flags() & (SYNCHRONIZED | STATIC)) == SYNCHRONIZED) {
697 log.error(pos, Errors.SuperClassMethodCannotBeSynchronized(s, c, st));
698 }
699 break;
700 }
701 }
702 }
703 }
704
705 /** Check that type is a valid qualifier for a constructor reference expression
706 */
707 Type checkConstructorRefType(DiagnosticPosition pos, Type t) {
708 t = checkClassOrArrayType(pos, t);
709 if (t.hasTag(CLASS)) {
710 if ((t.tsym.flags() & (ABSTRACT | INTERFACE)) != 0) {
711 log.error(pos, Errors.AbstractCantBeInstantiated(t.tsym));
712 t = types.createErrorType(t);
713 } else if ((t.tsym.flags() & ENUM) != 0) {
714 log.error(pos, Errors.EnumCantBeInstantiated);
715 t = types.createErrorType(t);
716 } else {
717 t = checkClassType(pos, t, true);
718 }
719 } else if (t.hasTag(ARRAY)) {
720 if (!types.isReifiable(((ArrayType)t).elemtype)) {
721 log.error(pos, Errors.GenericArrayCreation);
722 t = types.createErrorType(t);
723 }
724 }
742 args = args.tail;
743 }
744 }
745 return t;
746 }
747
748 /** Check that type is a reference type, i.e. a class, interface or array type
749 * or a type variable.
750 * @param pos Position to be used for error reporting.
751 * @param t The type to be checked.
752 */
753 Type checkRefType(DiagnosticPosition pos, Type t) {
754 if (t.isReference())
755 return t;
756 else
757 return typeTagError(pos,
758 diags.fragment(Fragments.TypeReqRef),
759 t);
760 }
761
762 /** Check that type is an identity type, i.e. not a value type.
763 * When not discernible statically, give it the benefit of doubt
764 * and defer to runtime.
765 *
766 * @param pos Position to be used for error reporting.
767 * @param t The type to be checked.
768 */
769 boolean checkIdentityType(DiagnosticPosition pos, Type t) {
770 if (t.hasTag(TYPEVAR)) {
771 t = types.skipTypeVars(t, false);
772 }
773 if (t.isIntersection()) {
774 IntersectionClassType ict = (IntersectionClassType)t;
775 boolean result = true;
776 for (Type component : ict.getExplicitComponents()) {
777 result &= checkIdentityType(pos, component);
778 }
779 return result;
780 }
781 if (t.isPrimitive() || (t.isValueClass() && !t.tsym.isAbstract())) {
782 typeTagError(pos, diags.fragment(Fragments.TypeReqIdentity), t);
783 return false;
784 }
785 return true;
786 }
787
788 /** Check that each type is a reference type, i.e. a class, interface or array type
789 * or a type variable.
790 * @param trees Original trees, used for error reporting.
791 * @param types The types to be checked.
792 */
793 List<Type> checkRefTypes(List<JCExpression> trees, List<Type> types) {
794 List<JCExpression> tl = trees;
795 for (List<Type> l = types; l.nonEmpty(); l = l.tail) {
796 l.head = checkRefType(tl.head.pos(), l.head);
797 tl = tl.tail;
798 }
799 return types;
800 }
801
802 /** Check that type is a null or reference type.
803 * @param pos Position to be used for error reporting.
804 * @param t The type to be checked.
805 */
806 Type checkNullOrRefType(DiagnosticPosition pos, Type t) {
807 if (t.isReference() || t.hasTag(BOT))
1159 * Warning: we can't use flags() here since this method
1160 * is called during class enter, when flags() would cause a premature
1161 * completion.
1162 * @param flags The set of modifiers given in a definition.
1163 * @param sym The defined symbol.
1164 * @param tree The declaration
1165 */
1166 long checkFlags(long flags, Symbol sym, JCTree tree) {
1167 final DiagnosticPosition pos = tree.pos();
1168 long mask;
1169 long implicit = 0;
1170
1171 switch (sym.kind) {
1172 case VAR:
1173 if (TreeInfo.isReceiverParam(tree))
1174 mask = ReceiverParamFlags;
1175 else if (sym.owner.kind != TYP)
1176 mask = LocalVarFlags;
1177 else if ((sym.owner.flags_field & INTERFACE) != 0)
1178 mask = implicit = InterfaceVarFlags;
1179 else {
1180 boolean isInstanceField = (flags & STATIC) == 0;
1181 boolean isInstanceFieldOfValueClass = isInstanceField && sym.owner.type.isValueClass();
1182 boolean isRecordField = isInstanceField && (sym.owner.flags_field & RECORD) != 0;
1183 if (allowValueClasses && (isInstanceFieldOfValueClass || isRecordField)) {
1184 implicit |= FINAL | STRICT;
1185 mask = ValueFieldFlags;
1186 } else {
1187 mask = VarFlags;
1188 }
1189 }
1190 break;
1191 case MTH:
1192 if (sym.name == names.init) {
1193 if ((sym.owner.flags_field & ENUM) != 0) {
1194 // enum constructors cannot be declared public or
1195 // protected and must be implicitly or explicitly
1196 // private
1197 implicit = PRIVATE;
1198 mask = PRIVATE;
1199 } else
1200 mask = ConstructorFlags;
1201 } else if ((sym.owner.flags_field & INTERFACE) != 0) {
1202 if ((sym.owner.flags_field & ANNOTATION) != 0) {
1203 mask = AnnotationTypeElementMask;
1204 implicit = PUBLIC | ABSTRACT;
1205 } else if ((flags & (DEFAULT | STATIC | PRIVATE)) != 0) {
1206 mask = InterfaceMethodMask;
1207 implicit = (flags & PRIVATE) != 0 ? 0 : PUBLIC;
1208 if ((flags & DEFAULT) != 0) {
1209 implicit |= ABSTRACT;
1210 }
1211 } else {
1212 mask = implicit = InterfaceMethodFlags;
1213 }
1214 } else if ((sym.owner.flags_field & RECORD) != 0) {
1215 mask = ((sym.owner.flags_field & VALUE_CLASS) != 0 && (flags & Flags.STATIC) == 0) ?
1216 RecordMethodFlags & ~SYNCHRONIZED : RecordMethodFlags;
1217 } else {
1218 // value objects do not have an associated monitor/lock
1219 mask = ((sym.owner.flags_field & VALUE_CLASS) != 0 && (flags & Flags.STATIC) == 0) ?
1220 MethodFlags & ~SYNCHRONIZED : MethodFlags;
1221 }
1222 if ((flags & STRICTFP) != 0) {
1223 log.warning(tree.pos(), LintWarnings.Strictfp);
1224 }
1225 // Imply STRICTFP if owner has STRICTFP set.
1226 if (((flags|implicit) & Flags.ABSTRACT) == 0 ||
1227 ((flags) & Flags.DEFAULT) != 0)
1228 implicit |= sym.owner.flags_field & STRICTFP;
1229 break;
1230 case TYP:
1231 if (sym.owner.kind.matches(KindSelector.VAL_MTH) ||
1232 (sym.isDirectlyOrIndirectlyLocal() && (flags & ANNOTATION) != 0)) {
1233 boolean implicitlyStatic = !sym.isAnonymous() &&
1234 ((flags & RECORD) != 0 || (flags & ENUM) != 0 || (flags & INTERFACE) != 0);
1235 boolean staticOrImplicitlyStatic = (flags & STATIC) != 0 || implicitlyStatic;
1236 // local statics are allowed only if records are allowed too
1237 mask = staticOrImplicitlyStatic && allowRecords && (flags & ANNOTATION) == 0 ? ExtendedStaticLocalClassFlags : ExtendedLocalClassFlags;
1238 implicit = implicitlyStatic ? STATIC : implicit;
1239 } else if (sym.owner.kind == TYP) {
1240 // statics in inner classes are allowed only if records are allowed too
1241 mask = ((flags & STATIC) != 0) && allowRecords && (flags & ANNOTATION) == 0 ? ExtendedMemberStaticClassFlags : ExtendedMemberClassFlags;
1242 if (sym.owner.owner.kind == PCK ||
1243 (sym.owner.flags_field & STATIC) != 0) {
1244 mask |= STATIC;
1245 } else if (!allowRecords && ((flags & ENUM) != 0 || (flags & RECORD) != 0)) {
1246 log.error(pos, Errors.StaticDeclarationNotAllowedInInnerClasses);
1247 }
1248 // Nested interfaces and enums are always STATIC (Spec ???)
1249 if ((flags & (INTERFACE | ENUM | RECORD)) != 0 ) implicit = STATIC;
1250 } else {
1251 mask = ExtendedClassFlags;
1252 }
1253 if ((flags & (VALUE_CLASS | SEALED | ABSTRACT)) == (VALUE_CLASS | SEALED) ||
1254 (flags & (VALUE_CLASS | NON_SEALED | ABSTRACT)) == (VALUE_CLASS | NON_SEALED)) {
1255 log.error(pos, Errors.NonAbstractValueClassCantBeSealedOrNonSealed);
1256 }
1257 // Interfaces are always ABSTRACT
1258 if ((flags & INTERFACE) != 0) implicit |= ABSTRACT;
1259
1260 if ((flags & (INTERFACE | VALUE_CLASS)) == 0) {
1261 implicit |= IDENTITY_TYPE;
1262 }
1263
1264 if ((flags & ENUM) != 0) {
1265 // enums can't be declared abstract, final, sealed or non-sealed or value
1266 mask &= ~(ABSTRACT | FINAL | SEALED | NON_SEALED | VALUE_CLASS);
1267 implicit |= implicitEnumFinalFlag(tree);
1268 }
1269 if ((flags & RECORD) != 0) {
1270 // records can't be declared abstract
1271 mask &= ~ABSTRACT;
1272 implicit |= FINAL;
1273 }
1274 if ((flags & STRICTFP) != 0) {
1275 log.warning(tree.pos(), LintWarnings.Strictfp);
1276 }
1277 // Imply STRICTFP if owner has STRICTFP set.
1278 implicit |= sym.owner.flags_field & STRICTFP;
1279
1280 // concrete value classes are implicitly final
1281 if ((flags & (ABSTRACT | INTERFACE | VALUE_CLASS)) == VALUE_CLASS) {
1282 implicit |= FINAL;
1283 }
1284 break;
1285 default:
1286 throw new AssertionError();
1287 }
1288 long illegal = flags & ExtendedStandardFlags & ~mask;
1289 if (illegal != 0) {
1290 if ((illegal & INTERFACE) != 0) {
1291 log.error(pos, ((flags & ANNOTATION) != 0) ? Errors.AnnotationDeclNotAllowedHere : Errors.IntfNotAllowedHere);
1292 mask |= INTERFACE;
1293 }
1294 else {
1295 log.error(pos,
1296 Errors.ModNotAllowedHere(asFlagSet(illegal)));
1297 }
1298 } else if ((sym.kind == TYP ||
1299 // ISSUE: Disallowing abstract&private is no longer appropriate
1300 // in the presence of inner classes. Should it be deleted here?
1301 checkDisjoint(pos, flags,
1302 ABSTRACT,
1303 PRIVATE | STATIC | DEFAULT))
1304 &&
1305 checkDisjoint(pos, flags,
1306 STATIC | PRIVATE,
1307 DEFAULT)
1308 &&
1309 checkDisjoint(pos, flags,
1310 ABSTRACT | INTERFACE,
1311 FINAL | NATIVE | SYNCHRONIZED)
1312 &&
1313 checkDisjoint(pos, flags,
1314 PUBLIC,
1315 PRIVATE | PROTECTED)
1316 &&
1317 checkDisjoint(pos, flags,
1318 PRIVATE,
1319 PUBLIC | PROTECTED)
1320 &&
1321 // we are using `implicit` here as instance fields of value classes are implicitly final
1322 checkDisjoint(pos, flags | implicit,
1323 FINAL,
1324 VOLATILE)
1325 &&
1326 (sym.kind == TYP ||
1327 checkDisjoint(pos, flags,
1328 ABSTRACT | NATIVE,
1329 STRICTFP))
1330 && checkDisjoint(pos, flags,
1331 FINAL,
1332 SEALED | NON_SEALED)
1333 && checkDisjoint(pos, flags,
1334 SEALED,
1335 FINAL | NON_SEALED)
1336 && checkDisjoint(pos, flags,
1337 SEALED,
1338 ANNOTATION)
1339 && checkDisjoint(pos, flags,
1340 VALUE_CLASS,
1341 ANNOTATION)
1342 && checkDisjoint(pos, flags,
1343 VALUE_CLASS,
1344 INTERFACE) ) {
1345 // skip
1346 }
1347 return flags & (mask | ~ExtendedStandardFlags) | implicit;
1348 }
1349
1350 /** Determine if this enum should be implicitly final.
1351 *
1352 * If the enum has no specialized enum constants, it is final.
1353 *
1354 * If the enum does have specialized enum constants, it is
1355 * <i>not</i> final.
1356 */
1357 private long implicitEnumFinalFlag(JCTree tree) {
1358 if (!tree.hasTag(CLASSDEF)) return 0;
1359 class SpecialTreeVisitor extends JCTree.Visitor {
1360 boolean specialized;
1361 SpecialTreeVisitor() {
1362 this.specialized = false;
1363 }
1364
2121 return true;
2122 }
2123 }
2124 }
2125 return false;
2126 }
2127
2128 /** Check that a given method conforms with any method it overrides.
2129 * @param tree The tree from which positions are extracted
2130 * for errors.
2131 * @param m The overriding method.
2132 */
2133 void checkOverride(Env<AttrContext> env, JCMethodDecl tree, MethodSymbol m) {
2134 ClassSymbol origin = (ClassSymbol)m.owner;
2135 if ((origin.flags() & ENUM) != 0 && names.finalize.equals(m.name)) {
2136 if (m.overrides(syms.enumFinalFinalize, origin, types, false)) {
2137 log.error(tree.pos(), Errors.EnumNoFinalize);
2138 return;
2139 }
2140 }
2141 if (allowValueClasses && origin.isValueClass() && names.finalize.equals(m.name)) {
2142 if (m.overrides(syms.objectFinalize, origin, types, false)) {
2143 log.warning(tree.pos(), Warnings.ValueFinalize);
2144 }
2145 }
2146 if (allowRecords && origin.isRecord()) {
2147 // let's find out if this is a user defined accessor in which case the @Override annotation is acceptable
2148 Optional<? extends RecordComponent> recordComponent = origin.getRecordComponents().stream()
2149 .filter(rc -> rc.accessor == tree.sym && (rc.accessor.flags_field & GENERATED_MEMBER) == 0).findFirst();
2150 if (recordComponent.isPresent()) {
2151 return;
2152 }
2153 }
2154
2155 for (Type t = origin.type; t.hasTag(CLASS);
2156 t = types.supertype(t)) {
2157 if (t != origin.type) {
2158 checkOverride(tree, t, origin, m);
2159 }
2160 for (Type t2 : types.interfaces(t)) {
2161 checkOverride(tree, t2, origin, m);
2162 }
2163 }
2164
2165 final boolean explicitOverride = m.attribute(syms.overrideType.tsym) != null;
2561 /** Check that all abstract methods implemented by a class are
2562 * mutually compatible.
2563 * @param pos Position to be used for error reporting.
2564 * @param c The class whose interfaces are checked.
2565 */
2566 void checkCompatibleSupertypes(DiagnosticPosition pos, Type c) {
2567 List<Type> supertypes = types.interfaces(c);
2568 Type supertype = types.supertype(c);
2569 if (supertype.hasTag(CLASS) &&
2570 (supertype.tsym.flags() & ABSTRACT) != 0)
2571 supertypes = supertypes.prepend(supertype);
2572 for (List<Type> l = supertypes; l.nonEmpty(); l = l.tail) {
2573 if (!l.head.getTypeArguments().isEmpty() &&
2574 !checkCompatibleAbstracts(pos, l.head, l.head, c))
2575 return;
2576 for (List<Type> m = supertypes; m != l; m = m.tail)
2577 if (!checkCompatibleAbstracts(pos, l.head, m.head, c))
2578 return;
2579 }
2580 checkCompatibleConcretes(pos, c);
2581
2582 Type identitySuper = null;
2583 for (Type t : types.closure(c)) {
2584 if (t != c) {
2585 if (t.isIdentityClass() && (t.tsym.flags() & VALUE_BASED) == 0)
2586 identitySuper = t;
2587 if (c.isValueClass() && identitySuper != null && identitySuper.tsym != syms.objectType.tsym) { // Object is special
2588 log.error(pos, Errors.ValueTypeHasIdentitySuperType(c, identitySuper));
2589 break;
2590 }
2591 }
2592 }
2593 }
2594
2595 /** Check that all non-override equivalent methods accessible from 'site'
2596 * are mutually compatible (JLS 8.4.8/9.4.1).
2597 *
2598 * @param pos Position to be used for error reporting.
2599 * @param site The class whose methods are checked.
2600 * @param sym The method symbol to be checked.
2601 */
2602 void checkOverrideClashes(DiagnosticPosition pos, Type site, MethodSymbol sym) {
2603 ClashFilter cf = new ClashFilter(site);
2604 //for each method m1 that is overridden (directly or indirectly)
2605 //by method 'sym' in 'site'...
2606
2607 ArrayList<Symbol> symbolsByName = new ArrayList<>();
2608 types.membersClosure(site, false).getSymbolsByName(sym.name, cf).forEach(symbolsByName::add);
2609 for (Symbol m1 : symbolsByName) {
2610 if (!sym.overrides(m1, site.tsym, types, false)) {
2611 continue;
2612 }
4942 }
4943 } else {
4944 Assert.error("Unknown pattern: " + currentPattern.getTag());
4945 }
4946 return false;
4947 }
4948
4949 /** check if a type is a subtype of Externalizable, if that is available. */
4950 boolean isExternalizable(Type t) {
4951 try {
4952 syms.externalizableType.complete();
4953 } catch (CompletionFailure e) {
4954 return false;
4955 }
4956 return types.isSubtype(t, syms.externalizableType);
4957 }
4958
4959 /**
4960 * Check structure of serialization declarations.
4961 */
4962 public void checkSerialStructure(Env<AttrContext> env, JCClassDecl tree, ClassSymbol c) {
4963 (new SerialTypeVisitor(env)).visit(c, tree);
4964 }
4965
4966 /**
4967 * This visitor will warn if a serialization-related field or
4968 * method is declared in a suspicious or incorrect way. In
4969 * particular, it will warn for cases where the runtime
4970 * serialization mechanism will silently ignore a mis-declared
4971 * entity.
4972 *
4973 * Distinguished serialization-related fields and methods:
4974 *
4975 * Methods:
4976 *
4977 * private void writeObject(ObjectOutputStream stream) throws IOException
4978 * ANY-ACCESS-MODIFIER Object writeReplace() throws ObjectStreamException
4979 *
4980 * private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException
4981 * private void readObjectNoData() throws ObjectStreamException
4982 * ANY-ACCESS-MODIFIER Object readResolve() throws ObjectStreamException
4983 *
4984 * Fields:
4985 *
4986 * private static final long serialVersionUID
4987 * private static final ObjectStreamField[] serialPersistentFields
4988 *
4989 * Externalizable: methods defined on the interface
4990 * public void writeExternal(ObjectOutput) throws IOException
4991 * public void readExternal(ObjectInput) throws IOException
4992 */
4993 private class SerialTypeVisitor extends ElementKindVisitor14<Void, JCClassDecl> {
4994 Env<AttrContext> env;
4995 SerialTypeVisitor(Env<AttrContext> env) {
4996 this.lint = Check.this.lint;
4997 this.env = env;
4998 }
4999
5000 private static final Set<String> serialMethodNames =
5001 Set.of("writeObject", "writeReplace",
5002 "readObject", "readObjectNoData",
5003 "readResolve");
5004
5005 private static final Set<String> serialFieldNames =
5006 Set.of("serialVersionUID", "serialPersistentFields");
5007
5008 // Type of serialPersistentFields
5009 private final Type OSF_TYPE = new Type.ArrayType(syms.objectStreamFieldType, syms.arrayClass);
5010
5011 Lint lint;
5012
5013 @Override
5014 public Void defaultAction(Element e, JCClassDecl p) {
5015 throw new IllegalArgumentException(Objects.requireNonNullElse(e.toString(), ""));
5016 }
5017
5037 if (sym.kind == VAR) {
5038 svuidSym = (VarSymbol)sym;
5039 break;
5040 }
5041 }
5042
5043 if (svuidSym == null) {
5044 log.warning(p.pos(), LintWarnings.MissingSVUID(c));
5045 }
5046
5047 // Check for serialPersistentFields to gate checks for
5048 // non-serializable non-transient instance fields
5049 boolean serialPersistentFieldsPresent =
5050 c.members()
5051 .getSymbolsByName(names.serialPersistentFields, sym -> sym.kind == VAR)
5052 .iterator()
5053 .hasNext();
5054
5055 // Check declarations of serialization-related methods and
5056 // fields
5057 final boolean[] hasWriteReplace = {false};
5058 for(Symbol el : c.getEnclosedElements()) {
5059 runUnderLint(el, p, (enclosed, tree) -> {
5060 String name = null;
5061 switch(enclosed.getKind()) {
5062 case FIELD -> {
5063 if (!serialPersistentFieldsPresent) {
5064 var flags = enclosed.flags();
5065 if ( ((flags & TRANSIENT) == 0) &&
5066 ((flags & STATIC) == 0)) {
5067 Type varType = enclosed.asType();
5068 if (!canBeSerialized(varType)) {
5069 // Note per JLS arrays are
5070 // serializable even if the
5071 // component type is not.
5072 log.warning(
5073 TreeInfo.diagnosticPositionFor(enclosed, tree),
5074 LintWarnings.NonSerializableInstanceField);
5075 } else if (varType.hasTag(ARRAY)) {
5076 ArrayType arrayType = (ArrayType)varType;
5077 Type elementType = arrayType.elemtype;
5112 // will also pull in default methods from
5113 // superinterfaces. In other words, the runtime checks
5114 // (which long predate default methods on interfaces)
5115 // do not admit the possibility of inheriting methods
5116 // this way, a difference from general inheritance.
5117
5118 // The current implementation just checks the enclosed
5119 // elements and does not directly check the inherited
5120 // methods. If all the types are being checked this is
5121 // less of a concern; however, there are cases that
5122 // could be missed. In particular, readResolve and
5123 // writeReplace could, in principle, by inherited from
5124 // a non-serializable superclass and thus not checked
5125 // even if compiled with a serializable child class.
5126 case METHOD -> {
5127 var method = (MethodSymbol)enclosed;
5128 name = method.getSimpleName().toString();
5129 if (serialMethodNames.contains(name)) {
5130 switch (name) {
5131 case "writeObject" -> checkWriteObject(tree, e, method);
5132 case "writeReplace" -> {hasWriteReplace[0] = true; hasAppropriateWriteReplace(tree, method, true);}
5133 case "readObject" -> checkReadObject(tree,e, method);
5134 case "readObjectNoData" -> checkReadObjectNoData(tree, e, method);
5135 case "readResolve" -> checkReadResolve(tree, e, method);
5136 default -> throw new AssertionError();
5137 }
5138 }
5139 }
5140 }
5141 });
5142 }
5143 if (!hasWriteReplace[0] &&
5144 (c.isValueClass() || hasAbstractValueSuperClass(c, Set.of(syms.numberType.tsym))) &&
5145 !c.isAbstract() && !c.isRecord() &&
5146 types.unboxedType(c.type) == Type.noType) {
5147 // we need to check if the class is inheriting an appropriate writeReplace method
5148 MethodSymbol ms = null;
5149 Log.DiagnosticHandler discardHandler = log.new DiscardDiagnosticHandler();
5150 try {
5151 ms = rs.resolveInternalMethod(env.tree, env, c.type, names.writeReplace, List.nil(), List.nil());
5152 } catch (FatalError fe) {
5153 // ignore no method was found
5154 } finally {
5155 log.popDiagnosticHandler(discardHandler);
5156 }
5157 if (ms == null || !hasAppropriateWriteReplace(p, ms, false)) {
5158 log.warning(p.pos(),
5159 c.isValueClass() ? LintWarnings.SerializableValueClassWithoutWriteReplace1 :
5160 LintWarnings.SerializableValueClassWithoutWriteReplace2);
5161 }
5162 }
5163 return null;
5164 }
5165
5166 boolean canBeSerialized(Type type) {
5167 return type.isPrimitive() || rs.isSerializable(type);
5168 }
5169
5170 private boolean hasAbstractValueSuperClass(Symbol c, Set<Symbol> excluding) {
5171 while (c.getKind() == ElementKind.CLASS) {
5172 Type sup = ((ClassSymbol)c).getSuperclass();
5173 if (!sup.hasTag(CLASS) || sup.isErroneous() ||
5174 sup.tsym == syms.objectType.tsym) {
5175 return false;
5176 }
5177 // if it is a value super class it has to be abstract
5178 if (sup.isValueClass() && !excluding.contains(sup.tsym)) {
5179 return true;
5180 }
5181 c = sup.tsym;
5182 }
5183 return false;
5184 }
5185
5186 /**
5187 * Check that Externalizable class needs a public no-arg
5188 * constructor.
5189 *
5190 * Check that a Serializable class has access to the no-arg
5191 * constructor of its first nonserializable superclass.
5192 */
5193 private void checkCtorAccess(JCClassDecl tree, ClassSymbol c) {
5194 if (isExternalizable(c.type)) {
5195 for(var sym : c.getEnclosedElements()) {
5196 if (sym.isConstructor() &&
5197 ((sym.flags() & PUBLIC) == PUBLIC)) {
5198 if (((MethodSymbol)sym).getParameters().isEmpty()) {
5199 return;
5200 }
5201 }
5202 }
5203 log.warning(tree.pos(),
5204 LintWarnings.ExternalizableMissingPublicNoArgCtor);
5205 } else {
5289 // Warn if serialPersistentFields is initialized to a
5290 // literal null.
5291 JCTree spfDecl = TreeInfo.declarationFor(spf, tree);
5292 if (spfDecl != null && spfDecl.getTag() == VARDEF) {
5293 JCVariableDecl variableDef = (JCVariableDecl) spfDecl;
5294 JCExpression initExpr = variableDef.init;
5295 if (initExpr != null && TreeInfo.isNull(initExpr)) {
5296 log.warning(initExpr.pos(),
5297 LintWarnings.SPFNullInit);
5298 }
5299 }
5300 }
5301
5302 private void checkWriteObject(JCClassDecl tree, Element e, MethodSymbol method) {
5303 // The "synchronized" modifier is seen in the wild on
5304 // readObject and writeObject methods and is generally
5305 // innocuous.
5306
5307 // private void writeObject(ObjectOutputStream stream) throws IOException
5308 checkPrivateNonStaticMethod(tree, method);
5309 isExpectedReturnType(tree, method, syms.voidType, true);
5310 checkOneArg(tree, e, method, syms.objectOutputStreamType);
5311 hasExpectedExceptions(tree, method, true, syms.ioExceptionType);
5312 checkExternalizable(tree, e, method);
5313 }
5314
5315 private boolean hasAppropriateWriteReplace(JCClassDecl tree, MethodSymbol method, boolean warn) {
5316 // ANY-ACCESS-MODIFIER Object writeReplace() throws
5317 // ObjectStreamException
5318
5319 // Excluding abstract, could have a more complicated
5320 // rule based on abstract-ness of the class
5321 return isConcreteInstanceMethod(tree, method, warn) &&
5322 isExpectedReturnType(tree, method, syms.objectType, warn) &&
5323 hasNoArgs(tree, method, warn) &&
5324 hasExpectedExceptions(tree, method, warn, syms.objectStreamExceptionType);
5325 }
5326
5327 private void checkReadObject(JCClassDecl tree, Element e, MethodSymbol method) {
5328 // The "synchronized" modifier is seen in the wild on
5329 // readObject and writeObject methods and is generally
5330 // innocuous.
5331
5332 // private void readObject(ObjectInputStream stream)
5333 // throws IOException, ClassNotFoundException
5334 checkPrivateNonStaticMethod(tree, method);
5335 isExpectedReturnType(tree, method, syms.voidType, true);
5336 checkOneArg(tree, e, method, syms.objectInputStreamType);
5337 hasExpectedExceptions(tree, method, true, syms.ioExceptionType, syms.classNotFoundExceptionType);
5338 checkExternalizable(tree, e, method);
5339 }
5340
5341 private void checkReadObjectNoData(JCClassDecl tree, Element e, MethodSymbol method) {
5342 // private void readObjectNoData() throws ObjectStreamException
5343 checkPrivateNonStaticMethod(tree, method);
5344 isExpectedReturnType(tree, method, syms.voidType, true);
5345 hasNoArgs(tree, method, true);
5346 hasExpectedExceptions(tree, method, true, syms.objectStreamExceptionType);
5347 checkExternalizable(tree, e, method);
5348 }
5349
5350 private void checkReadResolve(JCClassDecl tree, Element e, MethodSymbol method) {
5351 // ANY-ACCESS-MODIFIER Object readResolve()
5352 // throws ObjectStreamException
5353
5354 // Excluding abstract, could have a more complicated
5355 // rule based on abstract-ness of the class
5356 isConcreteInstanceMethod(tree, method, true);
5357 isExpectedReturnType(tree, method, syms.objectType, true);
5358 hasNoArgs(tree, method, true);
5359 hasExpectedExceptions(tree, method, true, syms.objectStreamExceptionType);
5360 }
5361
5362 private void checkWriteExternalRecord(JCClassDecl tree, Element e, MethodSymbol method, boolean isExtern) {
5363 //public void writeExternal(ObjectOutput) throws IOException
5364 checkExternMethodRecord(tree, e, method, syms.objectOutputType, isExtern);
5365 }
5366
5367 private void checkReadExternalRecord(JCClassDecl tree, Element e, MethodSymbol method, boolean isExtern) {
5368 // public void readExternal(ObjectInput) throws IOException
5369 checkExternMethodRecord(tree, e, method, syms.objectInputType, isExtern);
5370 }
5371
5372 private void checkExternMethodRecord(JCClassDecl tree, Element e, MethodSymbol method, Type argType,
5373 boolean isExtern) {
5374 if (isExtern && isExternMethod(tree, e, method, argType)) {
5375 log.warning(
5376 TreeInfo.diagnosticPositionFor(method, tree),
5377 LintWarnings.IneffectualExternalizableMethodRecord(method.getSimpleName().toString()));
5378 }
5379 }
5589 case FIELD -> {
5590 var field = (VarSymbol)enclosed;
5591 switch(name) {
5592 case "serialPersistentFields" -> {
5593 log.warning(
5594 TreeInfo.diagnosticPositionFor(field, tree),
5595 LintWarnings.IneffectualSerialFieldRecord);
5596 }
5597
5598 case "serialVersionUID" -> {
5599 // Could generate additional warning that
5600 // svuid value is not checked to match for
5601 // records.
5602 checkSerialVersionUID(tree, e, field);
5603 }}
5604 }
5605
5606 case METHOD -> {
5607 var method = (MethodSymbol)enclosed;
5608 switch(name) {
5609 case "writeReplace" -> hasAppropriateWriteReplace(tree, method, true);
5610 case "readResolve" -> checkReadResolve(tree, e, method);
5611
5612 case "writeExternal" -> checkWriteExternalRecord(tree, e, method, isExtern);
5613 case "readExternal" -> checkReadExternalRecord(tree, e, method, isExtern);
5614
5615 default -> {
5616 if (serialMethodNames.contains(name)) {
5617 log.warning(
5618 TreeInfo.diagnosticPositionFor(method, tree),
5619 LintWarnings.IneffectualSerialMethodRecord(name));
5620 }
5621 }}
5622 }}});
5623 }
5624 return null;
5625 }
5626
5627 boolean isConcreteInstanceMethod(JCClassDecl tree,
5628 MethodSymbol method,
5629 boolean warn) {
5630 if ((method.flags() & (STATIC | ABSTRACT)) != 0) {
5631 if (warn) {
5632 log.warning(
5633 TreeInfo.diagnosticPositionFor(method, tree),
5634 LintWarnings.SerialConcreteInstanceMethod(method.getSimpleName()));
5635 }
5636 return false;
5637 }
5638 return true;
5639 }
5640
5641 private boolean isExpectedReturnType(JCClassDecl tree,
5642 MethodSymbol method,
5643 Type expectedReturnType,
5644 boolean warn) {
5645 // Note: there may be complications checking writeReplace
5646 // and readResolve since they return Object and could, in
5647 // principle, have covariant overrides and any synthetic
5648 // bridge method would not be represented here for
5649 // checking.
5650 Type rtype = method.getReturnType();
5651 if (!types.isSameType(expectedReturnType, rtype)) {
5652 if (warn) {
5653 log.warning(
5654 TreeInfo.diagnosticPositionFor(method, tree),
5655 LintWarnings.SerialMethodUnexpectedReturnType(method.getSimpleName(),
5656 rtype, expectedReturnType));
5657 }
5658 return false;
5659 }
5660 return true;
5661 }
5662
5663 private void checkOneArg(JCClassDecl tree,
5664 Element enclosing,
5665 MethodSymbol method,
5666 Type expectedType) {
5667 String name = method.getSimpleName().toString();
5668
5669 var parameters= method.getParameters();
5670
5671 if (parameters.size() != 1) {
5672 log.warning(
5673 TreeInfo.diagnosticPositionFor(method, tree),
5674 LintWarnings.SerialMethodOneArg(method.getSimpleName(), parameters.size()));
5675 return;
5676 }
5677
5678 Type parameterType = parameters.get(0).asType();
5679 if (!types.isSameType(parameterType, expectedType)) {
5680 log.warning(
5681 TreeInfo.diagnosticPositionFor(method, tree),
5682 LintWarnings.SerialMethodParameterType(method.getSimpleName(),
5683 expectedType,
5684 parameterType));
5685 }
5686 }
5687
5688 private boolean hasExactlyOneArgWithType(JCClassDecl tree,
5689 Element enclosing,
5690 MethodSymbol method,
5691 Type expectedType) {
5692 var parameters = method.getParameters();
5693 return (parameters.size() == 1) &&
5694 types.isSameType(parameters.get(0).asType(), expectedType);
5695 }
5696
5697
5698 boolean hasNoArgs(JCClassDecl tree, MethodSymbol method, boolean warn) {
5699 var parameters = method.getParameters();
5700 if (!parameters.isEmpty()) {
5701 if (warn) {
5702 log.warning(
5703 TreeInfo.diagnosticPositionFor(parameters.get(0), tree),
5704 LintWarnings.SerialMethodNoArgs(method.getSimpleName()));
5705 }
5706 return false;
5707 }
5708 return true;
5709 }
5710
5711 private void checkExternalizable(JCClassDecl tree, Element enclosing, MethodSymbol method) {
5712 // If the enclosing class is externalizable, warn for the method
5713 if (isExternalizable((Type)enclosing.asType())) {
5714 log.warning(
5715 TreeInfo.diagnosticPositionFor(method, tree),
5716 LintWarnings.IneffectualSerialMethodExternalizable(method.getSimpleName()));
5717 }
5718 return;
5719 }
5720
5721 private boolean hasExpectedExceptions(JCClassDecl tree,
5722 MethodSymbol method,
5723 boolean warn,
5724 Type... declaredExceptions) {
5725 for (Type thrownType: method.getThrownTypes()) {
5726 // For each exception in the throws clause of the
5727 // method, if not an Error and not a RuntimeException,
5728 // check if the exception is a subtype of a declared
5729 // exception from the throws clause of the
5730 // serialization method in question.
5731 if (types.isSubtype(thrownType, syms.runtimeExceptionType) ||
5732 types.isSubtype(thrownType, syms.errorType) ) {
5733 continue;
5734 } else {
5735 boolean declared = false;
5736 for (Type declaredException : declaredExceptions) {
5737 if (types.isSubtype(thrownType, declaredException)) {
5738 declared = true;
5739 continue;
5740 }
5741 }
5742 if (!declared) {
5743 if (warn) {
5744 log.warning(
5745 TreeInfo.diagnosticPositionFor(method, tree),
5746 LintWarnings.SerialMethodUnexpectedException(method.getSimpleName(),
5747 thrownType));
5748 }
5749 return false;
5750 }
5751 }
5752 }
5753 return true;
5754 }
5755
5756 private <E extends Element> Void runUnderLint(E symbol, JCClassDecl p, BiConsumer<E, JCClassDecl> task) {
5757 Lint prevLint = lint;
5758 try {
5759 lint = lint.augment((Symbol) symbol);
5760
5761 if (lint.isEnabled(LintCategory.SERIAL)) {
5762 task.accept(symbol, p);
5763 }
5764
5765 return null;
5766 } finally {
5767 lint = prevLint;
5768 }
5769 }
5770
5771 }
5772
5773 void checkRequiresIdentity(JCTree tree, Lint lint) {
|