From 706dd4584b4002e0d948b81d103dd5c4b70db077 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sun, 12 Jun 2016 21:54:09 +0200 Subject: [PATCH] spellcheck mc. Don't ask why --- src/mc/AddressSpace.hpp | 2 +- src/mc/Channel.hpp | 2 +- src/mc/Checker.hpp | 2 +- src/mc/ChunkedData.cpp | 4 ++-- src/mc/CommunicationDeterminismChecker.cpp | 2 +- src/mc/DwarfExpression.cpp | 2 +- src/mc/ObjectInformation.cpp | 8 ++++---- src/mc/PageStore.cpp | 4 ++-- src/mc/Process.cpp | 10 ++++----- src/mc/Process.hpp | 8 ++++---- src/mc/RegionSnapshot.cpp | 2 +- src/mc/RegionSnapshot.hpp | 2 +- src/mc/Transition.hpp | 4 ++-- src/mc/mc_client_api.cpp | 4 ++-- src/mc/mc_comm_pattern.h | 2 +- src/mc/mc_dwarf.cpp | 16 +++++++-------- src/mc/mc_forward.hpp | 2 +- src/mc/mc_request.cpp | 2 +- src/mc/mc_smx.cpp | 2 +- src/mc/mc_unw.h | 2 +- src/smpi/smpi_mpi_dt.cpp | 6 +++--- tools/internal/spell_dict.txt | 24 ++++++++++++++++++++++ 22 files changed, 68 insertions(+), 44 deletions(-) diff --git a/src/mc/AddressSpace.hpp b/src/mc/AddressSpace.hpp index 02db2c4b86..c3d1e70b3a 100644 --- a/src/mc/AddressSpace.hpp +++ b/src/mc/AddressSpace.hpp @@ -24,7 +24,7 @@ namespace mc { /** Process index used when no process is available * - * The expected behaviour is that if a process index is needed it will fail. + * The expected behavior is that if a process index is needed it will fail. * */ const int ProcessIndexMissing = -1; diff --git a/src/mc/Channel.hpp b/src/mc/Channel.hpp index 4766e163c9..64219c4eac 100644 --- a/src/mc/Channel.hpp +++ b/src/mc/Channel.hpp @@ -18,7 +18,7 @@ namespace mc { /** A channel for exchanging messages between model-checker and model-checked * - * This hides the way the messages are transfered. Currently, they are sent + * This hides the way the messages are transferred. Currently, they are sent * over a SOCK_DGRAM socket. */ class Channel { diff --git a/src/mc/Checker.hpp b/src/mc/Checker.hpp index 58fa3d63ea..70a9031b86 100644 --- a/src/mc/Checker.hpp +++ b/src/mc/Checker.hpp @@ -21,7 +21,7 @@ namespace mc { /** A model-checking algorithm * * The goal is to move the data/state/configuration of a model-checking - * algorihms in subclasses. Implementing this interface will probably + * algorithms in subclasses. Implementing this interface will probably * not be really mandatory, you might be able to write your * model-checking algorithm as plain imperative code instead. * diff --git a/src/mc/ChunkedData.cpp b/src/mc/ChunkedData.cpp index ff1da46351..8db8c4e928 100644 --- a/src/mc/ChunkedData.cpp +++ b/src/mc/ChunkedData.cpp @@ -9,7 +9,7 @@ #include -#include // xbt_pagesize and friends +#include #include #include "src/mc/AddressSpace.hpp" @@ -22,7 +22,7 @@ namespace mc { /** Take a per-page snapshot of a region * * @param data The start of the region (must be at the beginning of a page) - * @param pag_count Number of pages of the region + * @param page_count Number of pages of the region * @return Snapshot page numbers of this new snapshot */ ChunkedData::ChunkedData(PageStore& store, AddressSpace& as, diff --git a/src/mc/CommunicationDeterminismChecker.cpp b/src/mc/CommunicationDeterminismChecker.cpp index 87088ed178..e0f7a77e00 100644 --- a/src/mc/CommunicationDeterminismChecker.cpp +++ b/src/mc/CommunicationDeterminismChecker.cpp @@ -519,7 +519,7 @@ int CommunicationDeterminismChecker::main(void) std::unique_ptr(MC_state_new(++expandedStatesCount_)); /* If comm determinism verification, we cannot stop the exploration if - some communications are not finished (at least, data are transfered). + some communications are not finished (at least, data are transferred). These communications are incomplete and they cannot be analyzed and compared with the initial pattern. */ bool compare_snapshots = all_communications_are_finished() diff --git a/src/mc/DwarfExpression.cpp b/src/mc/DwarfExpression.cpp index 35017da245..6cdba68ae1 100644 --- a/src/mc/DwarfExpression.cpp +++ b/src/mc/DwarfExpression.cpp @@ -80,7 +80,7 @@ void execute( break; } - // Push the CFA (Canonical Frame Addresse): + // Push the CFA (Canonical Frame Address): case DW_OP_call_frame_cfa: { /* See 6.4 of DWARF4 (http://dwarfstd.org/doc/DWARF4.pdf#page=140): diff --git a/src/mc/ObjectInformation.cpp b/src/mc/ObjectInformation.cpp index b4c585102e..59280f996f 100644 --- a/src/mc/ObjectInformation.cpp +++ b/src/mc/ObjectInformation.cpp @@ -32,7 +32,7 @@ ObjectInformation::ObjectInformation() * * An offset is applied to address found in DWARF: * - * * for an executable obejct, addresses are virtual address + * * for an executable object, addresses are virtual address * (there is no offset) i.e. * \f$\text{virtual address} = \{dwarf address}\f$; * @@ -66,7 +66,7 @@ simgrid::mc::Frame* ObjectInformation::find_function(const void *ip) const * during the binary search (only at the end) so it is not included * in the index entry. We could use parallel arrays as well. * - * We cannot really use the std:: alogrithm for this. + * We cannot really use the std:: algorithm for this. * We could use std::binary_search by including the high_pc inside * the FunctionIndexEntry. */ @@ -87,7 +87,7 @@ simgrid::mc::Frame* ObjectInformation::find_function(const void *ip) const /* At this point, the search is over. * Either we have found the correct function or we do not know * any function corresponding to this instruction address. - * Only at the point do we derefernce the function pointer. */ + * Only at the point do we dereference the function pointer. */ else if ((std::uint64_t) ip < base[k].function->range.end()) return base[k].function; else @@ -153,7 +153,7 @@ void ObjectInformation::remove_global_variable(const char* name) * name. * * \param var_name Name of the local variable (or parameter to ignore) - * \param subprogram_name Name of the subprogram fo ignore (nullptr for any) + * \param subprogram_name Name of the subprogram to ignore (nullptr for any) * \param subprogram (possibly inlined) Subprogram of the scope * \param scope Current scope */ diff --git a/src/mc/PageStore.cpp b/src/mc/PageStore.cpp index 8634716406..f8bb9bff65 100644 --- a/src/mc/PageStore.cpp +++ b/src/mc/PageStore.cpp @@ -5,7 +5,7 @@ * under the terms of the license (GNU LGPL) which comes with this package. */ #include -#include // memcpy, memcp +#include // memcpy, memcmp #include @@ -23,7 +23,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_page_snapshot, mc, namespace simgrid { namespace mc { -/** @brief Compte a hash for the given memory page +/** @brief Compute a hash for the given memory page * * The page is used before inserting the page in the page store * in order to find duplicate of this page in the page store. diff --git a/src/mc/Process.cpp b/src/mc/Process.cpp index 0f4a0b0d87..9197cb95e4 100644 --- a/src/mc/Process.cpp +++ b/src/mc/Process.cpp @@ -241,7 +241,7 @@ Process::~Process() /** Refresh the information about the process * - * Do not use direclty, this is used by the getters when appropriate + * Do not use directly, this is used by the getters when appropriate * in order to have fresh data. */ void Process::refresh_heap() @@ -345,7 +345,7 @@ void Process::init_memory_map_info() regfree(&res.so_re); regfree(&res.version_re); - // Resolve time (including accross differents objects): + // Resolve time (including across different objects): for (auto const& object_info : this->object_infos) postProcessObjectInformation(this, object_info.get()); @@ -388,14 +388,14 @@ simgrid::mc::Frame* Process::find_function(RemotePtr ip) const return info ? info->find_function((void*) ip.address()) : nullptr; } -/** Find (one occurence of) the named variable definition +/** Find (one occurrence of) the named variable definition */ simgrid::mc::Variable* Process::find_variable(const char* name) const { // First lookup the variable in the executable shared object. // A global variable used directly by the executable code from a library // is reinstanciated in the executable memory .data/.bss. - // We need to look up the variable in the execvutable first. + // We need to look up the variable in the executable first. if (this->binary_info) { std::shared_ptr const& info = this->binary_info; simgrid::mc::Variable* var = info->find_variable(name); @@ -479,7 +479,7 @@ const void *Process::read_bytes(void* buffer, std::size_t size, mc_model_checker->process().read( remote(remote_smpi_privatisation_regions + process_index)); - // Address translation in the privaization segment: + // Address translation in the privatization segment: size_t offset = address.address() - (std::uint64_t)info->start_rw; address = remote((char*)privatisation_region.address + offset); } diff --git a/src/mc/Process.hpp b/src/mc/Process.hpp index d5ff78233f..e797a0a106 100644 --- a/src/mc/Process.hpp +++ b/src/mc/Process.hpp @@ -74,13 +74,13 @@ struct IgnoredHeapRegion { /** Representation of a process * - * This class is mixing a lot of different responsabilities and is tied + * This class is mixing a lot of different responsibilities and is tied * to SIMIX. It should probably be split into different classes. * - * Responsabilities: + * Responsibilities: * * - reading from the process memory (`AddressSpace`); - * - accessing the system state of the porcess (heap, …); + * - accessing the system state of the process (heap, …); * - storing the SIMIX state of the process; * - privatization; * - communication with the model-checked process; @@ -318,7 +318,7 @@ public: // Libunwind-data */ unw_addr_space_t unw_addr_space; - /** Underlying libunwind addres-space + /** Underlying libunwind address-space * * The `find_proc_info`, `put_unwind_info`, `get_dyn_info_list_addr` * operations of the native MC address space is currently delegated diff --git a/src/mc/RegionSnapshot.cpp b/src/mc/RegionSnapshot.cpp index 94acf100e2..7acb69d634 100644 --- a/src/mc/RegionSnapshot.cpp +++ b/src/mc/RegionSnapshot.cpp @@ -78,7 +78,7 @@ RegionSnapshot dense_region( void *start_addr, void* permanent_addr, size_t size) { // When KSM support is enables, we allocate memory using mmap: - // * we don't want to madvise bits of the heap; + // * we don't want to advise bits of the heap as mergable; // * mmap gives data aligned on page boundaries which is merge friendly. simgrid::mc::Buffer data; if (_sg_mc_ksm) diff --git a/src/mc/RegionSnapshot.hpp b/src/mc/RegionSnapshot.hpp index 182c6f185b..a701e412c6 100644 --- a/src/mc/RegionSnapshot.hpp +++ b/src/mc/RegionSnapshot.hpp @@ -103,7 +103,7 @@ public: * * * privatized (SMPI global variable privatisation). * - * This is handled with a variant based approch: + * This is handled with a variant based approach: * * * `storage_type` identified the type of storage; * diff --git a/src/mc/Transition.hpp b/src/mc/Transition.hpp index c0a6d0af6e..b15c6fda41 100644 --- a/src/mc/Transition.hpp +++ b/src/mc/Transition.hpp @@ -13,8 +13,8 @@ namespace mc { /** An element in the recorded path * * At each decision point, we need to record which process transition - * is trigerred and potentially which value is associated with this - * transition. The value is used to find which communication is triggerred + * is triggered and potentially which value is associated with this + * transition. The value is used to find which communication is triggered * in things like waitany and for associating a given value of MC_random() * calls. */ diff --git a/src/mc/mc_client_api.cpp b/src/mc/mc_client_api.cpp index d12eeffb74..0e4fcf05ef 100644 --- a/src/mc/mc_client_api.cpp +++ b/src/mc/mc_client_api.cpp @@ -15,7 +15,7 @@ #include "src/mc/Client.hpp" #include "src/mc/ModelChecker.hpp" -/** \file mc_client_api.cpp +/** @file mc_client_api.cpp * * This is the implementation of the API used by the user simulated program to * communicate with the MC (declared in modelchecker.h). @@ -70,7 +70,7 @@ void MC_automaton_new_propositional_symbol_pointer(const char *name, int* value) /** @brief Register a stack in the model checker * * The stacks are allocated in the heap. The MC handle them especially - * when we analyse/compare the content of the heap so it must be told where + * when we analyze/compare the content of the heap so it must be told where * they are with this function. * * @param stack diff --git a/src/mc/mc_comm_pattern.h b/src/mc/mc_comm_pattern.h index 2b128bf71c..6f4c1dac26 100644 --- a/src/mc/mc_comm_pattern.h +++ b/src/mc/mc_comm_pattern.h @@ -36,7 +36,7 @@ struct PatternCommunicationList { SG_BEGIN_DECL() /** - * Type: `xbt_dynar_t` + * Type: `xbt_dynar_t` */ extern XBT_PRIVATE xbt_dynar_t initial_communications_pattern; diff --git a/src/mc/mc_dwarf.cpp b/src/mc/mc_dwarf.cpp index 64b71b037a..d619a96667 100644 --- a/src/mc/mc_dwarf.cpp +++ b/src/mc/mc_dwarf.cpp @@ -38,7 +38,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dwarf, mc, "DWARF processing"); * * The default for a given language is defined in the DWARF spec. * - * \param language consant as defined by the DWARf spec + * \param language constant as defined by the DWARf spec */ static uint64_t MC_dwarf_default_lower_bound(int lang); @@ -67,7 +67,7 @@ static uint64_t MC_dwarf_array_element_count(Dwarf_Die * die, Dwarf_Die * unit); * \param info the resulting object fot the library/binary file (output) * \param die the current DIE * \param unit the DIE of the compile unit of the current DIE - * \param frame containg frame if any + * \param frame containing frame if any */ static void MC_dwarf_handle_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, Dwarf_Die * unit, simgrid::mc::Frame* frame, @@ -79,12 +79,12 @@ static void MC_dwarf_handle_type_die(simgrid::mc::ObjectInformation* info, Dwarf Dwarf_Die * unit, simgrid::mc::Frame* frame, const char *ns); -/** \brief Calls MC_dwarf_handle_die on all childrend of the given die +/** \brief Calls MC_dwarf_handle_die on all children of the given die * * \param info the resulting object fot the library/binary file (output) * \param die the current DIE * \param unit the DIE of the compile unit of the current DIE - * \param frame containg frame if any + * \param frame containing frame if any */ static void MC_dwarf_handle_children(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, Dwarf_Die * unit, simgrid::mc::Frame* frame, @@ -95,7 +95,7 @@ static void MC_dwarf_handle_children(simgrid::mc::ObjectInformation* info, Dwarf * \param info the resulting object fot the library/binary file (output) * \param die the current DIE * \param unit the DIE of the compile unit of the current DIE - * \param frame containg frame if any + * \param frame containing frame if any */ static void MC_dwarf_handle_variable_die(simgrid::mc::ObjectInformation* info, Dwarf_Die * die, Dwarf_Die * unit, simgrid::mc::Frame* frame, @@ -585,7 +585,7 @@ static void MC_dwarf_add_members(simgrid::mc::ObjectInformation* info, Dwarf_Die if (boost::algorithm::starts_with(member.name, "__vptr$") || boost::algorithm::starts_with(member.name, "__vptr.")) member.flags |= simgrid::mc::Member::VIRTUAL_POINTER_FLAG; - // A cleaner stolution would be to check against the type: + // A cleaner solution would be to check against the type: // --- // tag: DW_TAG_member // name: "_vptr$Foo" @@ -1393,7 +1393,7 @@ namespace dwarf { * * DWARF and libunwind does not use the same convention for numbering the * registers on some architectures. The function makes the necessary - * convertion. + * conversion. */ int dwarf_register_to_libunwind(int dwarf_register) { @@ -1401,7 +1401,7 @@ int dwarf_register_to_libunwind(int dwarf_register) // It seems for this arch, DWARF and libunwind agree in the numbering: return dwarf_register; #elif defined(__i386__) - // Could't find the authoritative source of information for this. + // Couldn't find the authoritative source of information for this. // This is inspired from http://source.winehq.org/source/dlls/dbghelp/cpu_i386.c#L517. switch (dwarf_register) { case 0: diff --git a/src/mc/mc_forward.hpp b/src/mc/mc_forward.hpp index 692d867cf9..e36347e0c7 100644 --- a/src/mc/mc_forward.hpp +++ b/src/mc/mc_forward.hpp @@ -4,7 +4,7 @@ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -/** \file mc_forward.hpp +/** @file mc_forward.hpp * * Forward definitions for MC types */ diff --git a/src/mc/mc_request.cpp b/src/mc/mc_request.cpp index 962e954162..d89c89d767 100644 --- a/src/mc/mc_request.cpp +++ b/src/mc/mc_request.cpp @@ -142,7 +142,7 @@ bool request_depend(smx_simcall_t r1, smx_simcall_t r2) if (r1->issuer == r2->issuer) return false; - /* Wait with timeout transitions are not considered by the independance theorem, thus we consider them as dependant with all other transitions */ + /* Wait with timeout transitions are not considered by the independence theorem, thus we consider them as dependant with all other transitions */ if ((r1->call == SIMCALL_COMM_WAIT && simcall_comm_wait__get__timeout(r1) > 0) || (r2->call == SIMCALL_COMM_WAIT && simcall_comm_wait__get__timeout(r2) > 0)) diff --git a/src/mc/mc_smx.cpp b/src/mc/mc_smx.cpp index 8ed02492e8..daf6b83ab8 100644 --- a/src/mc/mc_smx.cpp +++ b/src/mc/mc_smx.cpp @@ -136,7 +136,7 @@ const char* MC_smx_process_get_host_name(smx_process_t p) /* HACK, Horrible hack to find the offset of the id in the simgrid::s4u::Host. Offsetof is not supported for non-POD types but this should - work in pratice for the targets currently supported by the MC + work in practice for the targets currently supported by the MC as long as we do not add funny features to the Host class (such as virtual base). diff --git a/src/mc/mc_unw.h b/src/mc/mc_unw.h index 87d3fa9f6c..6d1fe47e90 100644 --- a/src/mc/mc_unw.h +++ b/src/mc/mc_unw.h @@ -7,7 +7,7 @@ #ifndef SIMGRID_MC_UNW_H #define SIMGRID_MC_UNW_H -/** \file +/** @file * Libunwind implementation for the model-checker * * Libunwind provides an pluggable stack unwinding API: the way the current diff --git a/src/smpi/smpi_mpi_dt.cpp b/src/smpi/smpi_mpi_dt.cpp index 9b75129f89..74edd06575 100644 --- a/src/smpi/smpi_mpi_dt.cpp +++ b/src/smpi/smpi_mpi_dt.cpp @@ -287,7 +287,7 @@ int smpi_datatype_copy(void *sendbuf, int sendcount, MPI_Datatype sendtype, * Copies noncontiguous data into contiguous memory. * @param contiguous_vector - output vector * @param noncontiguous_vector - input vector - * @param type - pointer contening : + * @param type - pointer containing : * - stride - stride of between noncontiguous data * - block_length - the width or height of blocked matrix * - count - the number of rows of matrix @@ -495,7 +495,7 @@ void use_contiguous(MPI_Datatype* d){ } /* Create a Sub type contiguous to be able to serialize and unserialize it the structure s_smpi_mpi_contiguous_t is - * erived from s_smpi_subtype which required the functions unserialize and serialize */ + * derived from s_smpi_subtype which required the functions unserialize and serialize */ s_smpi_mpi_contiguous_t* smpi_datatype_contiguous_create( MPI_Aint lb, int block_count, MPI_Datatype old_type, int size_oldtype){ if(block_count==0) @@ -549,7 +549,7 @@ int smpi_datatype_vector(int count, int blocklen, int stride, MPI_Datatype old_t DT_FLAG_VECTOR); retval=MPI_SUCCESS; }else{ - /* in this situation the data are contignous thus it's not required to serialize and unserialize it*/ + /* in this situation the data are contiguous thus it's not required to serialize and unserialize it*/ smpi_datatype_create(new_type, count * blocklen * smpi_datatype_size(old_type), 0, ((count -1) * stride + blocklen)* smpi_datatype_size(old_type), 0, nullptr, DT_FLAG_VECTOR|DT_FLAG_CONTIGUOUS); retval=MPI_SUCCESS; diff --git a/tools/internal/spell_dict.txt b/tools/internal/spell_dict.txt index 01e1109f31..fd23149d65 100644 --- a/tools/internal/spell_dict.txt +++ b/tools/internal/spell_dict.txt @@ -1,13 +1,19 @@ +ABI addtogroup +addr API +api argc argv atof callgrind calloc cfg +comm const cplusplus +cpp +cpu defgroup dict dicts @@ -22,6 +28,8 @@ Gbytes GPU hideinitializer hpp +http +https inlining ingroup int @@ -33,20 +41,31 @@ kcachegrind KILLME lat LGPL +libdw +libunwind lmm LTL malloc Mbytes mc +MCed +MCer +memcpy +memcmp Mflops +mmap +ModelChecker +modelchecker MPI msg +mutex nullptr ok Paje param pid printf +proc pstate RngStream SD @@ -59,16 +78,21 @@ simix SIMIX sizeof SMPI +smpi smx src +std struct syscall +syscalls tesh +testany todo TODO valgrind VM VMs +waitany xbt XBT xml -- 2.20.1