Changeset 11df881

Timestamp:

Jul 20, 2022, 11:42:29 AM (3 years ago)

Author:

Andrew Beach <ajbeach@…>

Branches:

ADT, ast-experimental, master, pthread-emulation, qualifiedEnum

Children:

b585593

Parents:

0577df2

Message:

Updated documentation on pre-resolver passes, moving code to headers instead of uses. Note that some comments were just copied over, I don't know if they are accurate.

Location:

src

Files:

• CodeGen/FixNames.cc (modified) (1 diff)
• CodeGen/FixNames.h (modified) (2 diffs)
• Concurrency/Keywords.h (modified) (1 diff)
• ControlStruct/ExceptDecl.cc (modified) (1 diff)
• ControlStruct/ExceptDecl.h (modified) (2 diffs)
• ControlStruct/HoistControlDecls.hpp (modified) (1 diff)
• InitTweak/GenInit.cc (modified) (1 diff)
• InitTweak/GenInit.h (modified) (2 diffs)
• Tuples/Tuples.cc (modified) (1 diff)
• Tuples/Tuples.h (modified) (1 diff)
• Validate/Autogen.hpp (modified) (1 diff)
• Validate/CompoundLiteral.hpp (modified) (1 diff)
• Validate/EnumAndPointerDecay.cpp (modified) (1 diff)
• Validate/EnumAndPointerDecay.hpp (modified) (2 diffs)
• Validate/FindSpecialDecls.h (modified) (2 diffs)
• Validate/FixQualifiedTypes.cpp (modified) (2 diffs)
• Validate/FixQualifiedTypes.hpp (modified) (2 diffs)
• Validate/FixReturnTypes.cpp (modified) (1 diff)
• Validate/FixReturnTypes.hpp (modified) (2 diffs)
• Validate/ForallPointerDecay.hpp (modified) (1 diff)
• Validate/GenericParameter.cpp (modified) (1 diff)
• Validate/GenericParameter.hpp (modified) (2 diffs)
• Validate/HoistStruct.hpp (modified) (1 diff)
• Validate/HoistTypeDecls.cpp (modified) (1 diff)
• Validate/HoistTypeDecls.hpp (modified) (2 diffs)
• Validate/LabelAddressFixer.cpp (modified) (1 diff)
• Validate/LabelAddressFixer.hpp (modified) (2 diffs)
• Validate/LinkReferenceToTypes.hpp (modified) (1 diff)
• Validate/ReplaceTypedef.cpp (modified) (1 diff)
• Validate/ReplaceTypedef.hpp (modified) (2 diffs)
• Validate/VerifyCtorDtorAssign.cpp (modified) (1 diff)
• Validate/VerifyCtorDtorAssign.hpp (modified) (2 diffs)
• main.cc (modified) (2 diffs)

src/CodeGen/FixNames.cc

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// FixNames.cc --
+// FixNames.cc -- Adjustments to typed declarations.
 //
 // Author           : Richard C. Bilson

src/CodeGen/FixNames.h

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// FixNames.h --
+// FixNames.h -- Adjustments to typed declarations.
 //
 // Author           : Richard C. Bilson
@@ -26 +26 @@
         /// mangles object and function names
         void fixNames( std::list< Declaration* > & translationUnit );
-        void fixNames( ast::TranslationUnit & translationUnit );
+/// Sets scope levels and fills in main's default return.
+void fixNames( ast::TranslationUnit & translationUnit );
 } // namespace CodeGen
 

src/Concurrency/Keywords.h

@@ -28 +28 @@
         void implementThreadStarter( std::list< Declaration * > & translationUnit );
 
-/// Implement the sue-like keywords and the suspend keyword.
+/// Implement the sue-like keywords and the suspend keyword. Pre-Autogen
 void implementKeywords( ast::TranslationUnit & translationUnit );
-/// Implement the mutex parameters and mutex statement.
+/// Implement the mutex parameters and mutex statement. Post-Autogen
 void implementMutex( ast::TranslationUnit & translationUnit );
-/// Add the thread starter code to constructors.
+/// Add the thread starter code to constructors. Post-Autogen
 void implementThreadStarter( ast::TranslationUnit & translationUnit );
 };

src/ControlStruct/ExceptDecl.cc

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// ExceptDecl.cc --
+// ExceptDecl.cc -- Handles declarations of exception types.
 //
 // Author           : Henry Xue

src/ControlStruct/ExceptDecl.h

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// ExceptDecl.h --
+// ExceptDecl.h -- Handles declarations of exception types.
 //
 // Author           : Henry Xue
@@ -25 +25 @@
 
 namespace ControlStruct {
-        void translateExcept( std::list< Declaration *> & translationUnit );
-        void translateExcept( ast::TranslationUnit & translationUnit );
+/// Unfold exception declarations into raw structure declarations.
+/// Also builds vtable declarations and converts vtable types.
+void translateExcept( std::list< Declaration *> & translationUnit );
+void translateExcept( ast::TranslationUnit & translationUnit );
 }

src/ControlStruct/HoistControlDecls.hpp

@@ -21 +21 @@
 
 namespace ControlStruct {
-// Hoist declarations out of control flow statements into compound statement.
+/// Hoist declarations out of control flow statements into compound statement.
+/// Must happen before auto-gen routines are added.
 void hoistControlDecls( ast::TranslationUnit & translationUnit );
 } // namespace ControlStruct

src/InitTweak/GenInit.cc

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// GenInit.cc --
+// GenInit.cc -- Generate initializers, and other stuff.
 //
 // Author           : Rob Schluntz

src/InitTweak/GenInit.h

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// GenInit.h --
+// GenInit.h -- Generate initializers, and other stuff.
 //
 // Author           : Rodolfo G. Esteves
@@ -29 +29 @@
         void genInit( ast::TranslationUnit & translationUnit );
 
-        /// Converts return statements into copy constructor calls on the hidden return variable
+        /// Converts return statements into copy constructor calls on the hidden return variable.
+        /// This pass must happen before auto-gen.
         void fixReturnStatements( std::list< Declaration * > & translationUnit );
         void fixReturnStatements( ast::TranslationUnit & translationUnit );

src/Tuples/Tuples.cc

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// Tuples.h --
+// Tuples.cc -- A collection of tuple operations.
 //
 // Author           : Andrew Beach

src/Tuples/Tuples.h

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// Tuples.h --
+// Tuples.h -- A collection of tuple operations.
 //
 // Author           : Rodolfo G. Esteves

src/Validate/Autogen.hpp

@@ -22 +22 @@
 namespace Validate {
 
+/// Generate routines for all data types in the translation unit.
+/// A lot of passes have to happen either before or after this pass.
 void autogenerateRoutines( ast::TranslationUnit & translationUnit );
 

src/Validate/CompoundLiteral.hpp

@@ -23 +23 @@
 
 /// Use variables to implement compound literals.
+/// Must happen after auto-gen routines are added.
 void handleCompoundLiterals( ast::TranslationUnit & translationUnit );
 

src/Validate/EnumAndPointerDecay.cpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// EnumAndPointerDecay.cpp --
+// EnumAndPointerDecay.cpp -- Normalizes enumerations and types in functions.
 //
 // Author           : Andrew Beach

src/Validate/EnumAndPointerDecay.hpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// EnumAndPointerDecay.hpp --
+// EnumAndPointerDecay.hpp -- Normalizes enumerations and types in functions.
 //
 // Author           : Andrew Beach
@@ -22 +22 @@
 namespace Validate {
 
+/// Fix the parameter and return types of functions. Also assigns types to
+/// enumeration values. This must happen before Link Reference to Types,
+/// it needs correct types for mangling, and before auto-gen.
 void decayEnumsAndPointers( ast::TranslationUnit & translationUnit );
 

src/Validate/FindSpecialDecls.h

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// FindSpecialDeclarations.h --
+// FindSpecialDeclarations.h -- Find special declarations used in the compiler.
 //
 // Author           : Rob Schluntz
@@ -43 +43 @@
         void findSpecialDecls( std::list< Declaration * > & translationUnit );
 
-/// find and remember some of the special declarations that are useful for
+/// Find and remember some of the special declarations that are useful for
 /// generating code, so that they do not have to be discovered multiple times.
 void findGlobalDecls( ast::TranslationUnit & translationUnit );

src/Validate/FixQualifiedTypes.cpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// FixQualifiedTypes.cpp --
+// FixQualifiedTypes.cpp -- Replace the qualified type with a direct type.
 //
 // Author           : Andrew Beach
@@ -76 +76 @@
                                                         ret->qualifiers = type->qualifiers;
                                                         ast::TypeSubstitution sub( aggr->params, instp->params );
-                                                        // = parent->genericSubstitution();
                                                         auto result = sub.apply(ret);
                                                         return result.node.release();

src/Validate/FixQualifiedTypes.hpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// FixQualifiedTypes.hpp --
+// FixQualifiedTypes.hpp -- Replace the qualified type with a direct type.
 //
 // Author           : Andrew Beach
@@ -22 +22 @@
 namespace Validate {
 
+/// Replaces qualified types with an unqualified NamedTypeDecl.
+/// Must happen after Link References To Types,
+/// because aggregate members are accessed.
 void fixQualifiedTypes( ast::TranslationUnit & translationUnit );
 

src/Validate/FixReturnTypes.cpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// FixReturnTypes.cpp --
+// FixReturnTypes.cpp -- Unifies the representation of return types.
 //
 // Author           : Andrew Beach

src/Validate/FixReturnTypes.hpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// FixReturnTypes.hpp --
+// FixReturnTypes.hpp -- Unifies the representation of return types.
 //
 // Author           : Andrew Beach
@@ -22 +22 @@
 namespace Validate {
 
-// This pass needs to happen early so that other passes can find tuple types
-// in the right places, especially for function return types.
+/// This pass needs to happen early so that other passes can find tuple types
+/// in the right places, especially for function return types.
+/// Must happen before auto-gen.
 void fixReturnTypes( ast::TranslationUnit & translationUnit );
 

src/Validate/ForallPointerDecay.hpp

@@ -29 +29 @@
 /// Also checks that operator names are used properly on functions and
 /// assigns unique IDs. This is a "legacy" pass.
+/// Must be after implement concurrent keywords; because uniqueIds must be
+/// set on declaration before resolution.
+/// Must happen before auto-gen routines are added.
 void decayForallPointers( ast::TranslationUnit & transUnit );
 

src/Validate/GenericParameter.cpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// GenericParameter.hpp --
+// GenericParameter.hpp -- Generic parameter related passes.
 //
 // Author           : Andrew Beach

src/Validate/GenericParameter.hpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// GenericParameter.hpp --
+// GenericParameter.hpp -- Generic parameter related passes.
 //
 // Author           : Andrew Beach
@@ -23 +23 @@
 
 /// Perform substutions for generic parameters and fill in defaults.
+/// Check as early as possible, but it can't happen before Link References to
+/// Types and observed failing when attempted before eliminate typedef.
 void fillGenericParameters( ast::TranslationUnit & translationUnit );
 

src/Validate/HoistStruct.hpp

@@ -22 +22 @@
 namespace Validate {
 
-/// Flattens nested type declarations.
+/// Flattens nested type declarations. (Run right after Fix Qualified Types.)
 void hoistStruct( ast::TranslationUnit & translationUnit );
 

src/Validate/HoistTypeDecls.cpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// HoistTypeDecls.cpp --
+// HoistTypeDecls.cpp -- Hoists declarations of implicitly declared types.
 //
 // Author           : Andrew Beach

src/Validate/HoistTypeDecls.hpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// HoistTypeDecls.hpp --
+// HoistTypeDecls.hpp -- Hoists declarations of implicitly declared types.
 //
 // Author           : Andrew Beach
@@ -22 +22 @@
 namespace Validate {
 
+/// There are some places where a type can be declared but are usually only
+/// referenced (with an *InstType). This inserts the declarations before
+/// they are referenced.
 void hoistTypeDecls( ast::TranslationUnit & translationUnit );
 

src/Validate/LabelAddressFixer.cpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// LabelAddressFixer.cpp --
+// LabelAddressFixer.cpp -- Create label address expressions.
 //
 // Author           : Andrew Beach

src/Validate/LabelAddressFixer.hpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// LabelAddressFixer.hpp --
+// LabelAddressFixer.hpp -- Create label address expressions.
 //
 // Author           : Andrew Beach
@@ -20 +20 @@
 namespace Validate {
 
+/// Label addresses are not actually created in the parser, this pass finds
+/// the patterns that represent the label address expression.
 void fixLabelAddresses( ast::TranslationUnit & translationUnit );
 

src/Validate/LinkReferenceToTypes.hpp

@@ -22 +22 @@
 namespace Validate {
 
+/// Fills in the base value of various instance types, and some related
+/// adjustments, such as setting the sized flag.
+/// Because of the sized flag, it must happen before auto-gen.
 void linkReferenceToTypes( ast::TranslationUnit & translationUnit );
 

src/Validate/ReplaceTypedef.cpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// ReplaceTypedef.cpp --
+// ReplaceTypedef.cpp -- Fill in all typedefs with the underlying type.
 //
 // Author           : Andrew Beach

src/Validate/ReplaceTypedef.hpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// ReplaceTypedef.hpp --
+// ReplaceTypedef.hpp -- Fill in all typedefs with the underlying type.
 //
 // Author           : Andrew Beach
@@ -22 +22 @@
 namespace Validate {
 
+/// Uses of typedef are replaced with the type in the typedef.
 void replaceTypedef( ast::TranslationUnit & translationUnit );
 

src/Validate/VerifyCtorDtorAssign.cpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// VerifyCtorDtorAssign.cpp --
+// VerifyCtorDtorAssign.cpp -- Check the form of operators.
 //
 // Author           : Andrew Beach

src/Validate/VerifyCtorDtorAssign.hpp

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// VerifyCtorDtorAssign.hpp --
+// VerifyCtorDtorAssign.hpp -- Check the form of operators.
 //
 // Author           : Andrew Beach
@@ -22 +22 @@
 namespace Validate {
 
+/// Check that constructors, destructors and assignments all have the correct
+/// form. Must happen before auto-gen or anything that examines operators.
 void verifyCtorDtorAssign( ast::TranslationUnit & translationUnit );
 

src/main.cc

@@ -345 +345 @@
                         }
 
-                        // Must happen before auto-gen, or anything that examines ops.
                         PASS( "Verify Ctor, Dtor & Assign", Validate::verifyCtorDtorAssign( transUnit ) );
-
                         PASS( "Hoist Type Decls", Validate::hoistTypeDecls( transUnit ) );
                         // Hoist Type Decls pulls some declarations out of contexts where
@@ -355 +353 @@
 
                         PASS( "Replace Typedefs", Validate::replaceTypedef( transUnit ) );
-
-                        // Must happen before auto-gen.
                         PASS( "Fix Return Types", Validate::fixReturnTypes( transUnit ) );
-
-                        // Must happen before Link Reference to Types, it needs correct
-                        // types for mangling.
                         PASS( "Enum and Pointer Decay", Validate::decayEnumsAndPointers( transUnit ) );
 
-                        // Must happen before auto-gen, because it uses the sized flag.
                         PASS( "Link Reference To Types", Validate::linkReferenceToTypes( transUnit ) );
 
-                        // Must happen after Link References To Types,
-                        // because aggregate members are accessed.
                         PASS( "Fix Qualified Types", Validate::fixQualifiedTypes( transUnit ) );
-
                         PASS( "Hoist Struct", Validate::hoistStruct( transUnit ) );
                         PASS( "Eliminate Typedef", Validate::eliminateTypedef( transUnit ) );
-
-                        // Check as early as possible. Can't happen before
-                        // LinkReferenceToType, observed failing when attempted
-                        // before eliminateTypedef
                         PASS( "Validate Generic Parameters", Validate::fillGenericParameters( transUnit ) );
-
                         PASS( "Translate Dimensions", Validate::translateDimensionParameters( transUnit ) );
                         PASS( "Check Function Returns", Validate::checkReturnStatements( transUnit ) );
-
-                        // Must happen before Autogen.
                         PASS( "Fix Return Statements", InitTweak::fixReturnStatements( transUnit ) );
-
                         PASS( "Implement Concurrent Keywords", Concurrency::implementKeywords( transUnit ) );
-
-                        // Must be after implement concurrent keywords; because uniqueIds
-                        //   must be set on declaration before resolution.
-                        // Must happen before autogen routines are added.
                         PASS( "Forall Pointer Decay", Validate::decayForallPointers( transUnit ) );
-
-                        // Must happen before autogen routines are added.
                         PASS( "Hoist Control Declarations", ControlStruct::hoistControlDecls( transUnit ) );
 
-                        // Must be after enum and pointer decay.
-                        // Must be before compound literals.
                         PASS( "Generate Autogen Routines", Validate::autogenerateRoutines( transUnit ) );