From deac2c062ec8d469f153bc84e6e6f705bf20f3aa Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Mon, 16 May 2016 08:13:36 +0200 Subject: [PATCH] cosmetics In the code, in the comments, in doxygen... Messy code go away! --- doc/Doxyfile.in | 2 +- include/xbt/base.h | 7 +++---- include/xbt/matrix.h | 3 --- src/simix/ContextBoost.cpp | 5 +---- src/simix/ContextBoost.hpp | 7 ++----- src/simix/ContextRaw.cpp | 12 +++++------ src/surf/AsCluster.cpp | 3 +-- src/xbt/xbt_matrix.c | 42 +++++++++----------------------------- 8 files changed, 23 insertions(+), 58 deletions(-) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 3639a096a3..e8922fa10e 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1439,7 +1439,7 @@ PREDEFINED = XBT_PUBLIC(type)="extern type" \ XBT_PUBLIC_DATA(type)="extern type" \ XBT_PUBLIC_CLASS=class \ XBT_INLINE= \ - XBT_PRIVATE=/** @private / + XBT_PRIVATE= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. diff --git a/include/xbt/base.h b/include/xbt/base.h index 285c3f61c3..9359d530ce 100644 --- a/include/xbt/base.h +++ b/include/xbt/base.h @@ -1,7 +1,6 @@ -/* xbt.h - Public interface to the xbt (simgrid's toolbox) */ +/* xbt.h - Public interface to the xbt (simgrid's toolbox) */ -/* Copyright (c) 2004-2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2015. The SimGrid Team. All rights reserved. */ /* 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. */ @@ -175,7 +174,7 @@ #define TRUE 1 #define FALSE 0 -/*! C++ users need love */ +/* C++ users need love */ #ifndef SG_BEGIN_DECL # ifdef __cplusplus # define SG_BEGIN_DECL() extern "C" { diff --git a/include/xbt/matrix.h b/include/xbt/matrix.h index ac5a628fc2..55363e2950 100644 --- a/include/xbt/matrix.h +++ b/include/xbt/matrix.h @@ -35,16 +35,13 @@ typedef struct { XBT_PUBLIC(xbt_matrix_t) xbt_matrix_new(int lines, int rows, const unsigned long elmsize, void_f_pvoid_t const free_f); XBT_PUBLIC(xbt_matrix_t) xbt_matrix_new_sub(xbt_matrix_t from, int lsize, int rsize, int lpos, int rpos, pvoid_f_pvoid_t const cpy_f); - XBT_PUBLIC(void) xbt_matrix_free(xbt_matrix_t matrix); -XBT_PUBLIC(void) xbt_matrix_free_voidp(void *d); XBT_PUBLIC(void) xbt_matrix_copy_values(xbt_matrix_t dest, xbt_matrix_t src, unsigned int lsize, unsigned int rsize, unsigned int lpos_dst, unsigned int rpos_dst, unsigned int lpos_src, unsigned int rpos_src, pvoid_f_pvoid_t const cpy_f); XBT_PUBLIC(void) xbt_matrix_dump(xbt_matrix_t matrix, const char *name, int coords, void_f_pvoid_t display_fun); -XBT_PUBLIC(void) xbt_matrix_dump_display_double(void *d); XBT_PUBLIC(xbt_matrix_t) xbt_matrix_double_new_zeros(int lines, int rows); XBT_PUBLIC(xbt_matrix_t) xbt_matrix_double_new_id(int lines, int rows); diff --git a/src/simix/ContextBoost.cpp b/src/simix/ContextBoost.cpp index 9108558d6b..44f6dbe2cb 100644 --- a/src/simix/ContextBoost.cpp +++ b/src/simix/ContextBoost.cpp @@ -1,11 +1,8 @@ -/* Copyright (c) 2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2015. The SimGrid Team. All rights reserved. */ /* 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 BoostContext.cpp Userspace context switching implementation based on Boost.Context */ - #include #include diff --git a/src/simix/ContextBoost.hpp b/src/simix/ContextBoost.hpp index 032e116e91..b57adf23d0 100644 --- a/src/simix/ContextBoost.hpp +++ b/src/simix/ContextBoost.hpp @@ -1,12 +1,8 @@ -/* Copyright (c) 2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2015. The SimGrid Team. All rights reserved. */ /* 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 BoostContext.hpp - Userspace context switching implementation based on Boost.Context */ - #ifndef SIMGRID_SIMIX_BOOST_CONTEXT_HPP #define SIMGRID_SIMIX_BOOST_CONTEXT_HPP @@ -26,6 +22,7 @@ class BoostSerialContext; class BoostParallelContext; class BoostContextFactory; +/** @brief Userspace context switching implementation based on Boost.Context */ class BoostContext : public Context { protected: // static static bool parallel_; diff --git a/src/simix/ContextRaw.cpp b/src/simix/ContextRaw.cpp index 88d05bf202..b9bd0fed12 100644 --- a/src/simix/ContextRaw.cpp +++ b/src/simix/ContextRaw.cpp @@ -4,13 +4,6 @@ /* 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 RawContext.cpp - * Fast context switching inspired from SystemV ucontexts. - * - * In contrast to System V context, it does not touch the signal mask - * which avoids making a system call (at least on Linux). - */ - #include #include @@ -35,6 +28,11 @@ namespace simix { class RawContext; class RawContextFactory; +/** @brief Fast context switching inspired from SystemV ucontexts. + * + * The main difference to the System V context is that Raw Contexts are much faster because they don't + * preserve the signal mask when switching. This saves a system call (at least on Linux) on each context switch. + */ class RawContext : public Context { protected: void* stack_ = nullptr; diff --git a/src/surf/AsCluster.cpp b/src/surf/AsCluster.cpp index 8fe7144a12..a42c765832 100644 --- a/src/surf/AsCluster.cpp +++ b/src/surf/AsCluster.cpp @@ -9,8 +9,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_route_cluster, surf, "Routing part of surf"); /* This routing is specifically setup to represent clusters, aka homogeneous sets of machines - * Note that a router is created, easing the interconnexion with the rest of the world. - */ + * Note that a router is created, easing the interconnexion with the rest of the world. */ namespace simgrid { namespace surf { diff --git a/src/xbt/xbt_matrix.c b/src/xbt/xbt_matrix.c index a90d2368b2..4dd4e5302f 100644 --- a/src/xbt/xbt_matrix.c +++ b/src/xbt/xbt_matrix.c @@ -1,5 +1,3 @@ -/* xbt_matrix_t management functions */ - /* Copyright (c) 2006-2014. The SimGrid Team. * All rights reserved. */ @@ -37,10 +35,9 @@ xbt_matrix_t xbt_matrix_new_sub(xbt_matrix_t from, int lsize, int rsize, int lpo /** \brief destructor */ void xbt_matrix_free(xbt_matrix_t mat) { - unsigned int i; if (mat) { if (mat->free_f) { - for (i = 0; i < (mat->lines * mat->rows); i++) { + for (unsigned i = 0; i < (mat->lines * mat->rows); i++) { mat->free_f((void *) &(mat->data[i * mat->elmsize])); } } @@ -49,22 +46,14 @@ void xbt_matrix_free(xbt_matrix_t mat) } } -/** \brief Freeing function for containers of xbt_matrix_t */ -void xbt_matrix_free_voidp(void *d) -{ - xbt_matrix_free((xbt_matrix_t) * (void **) d); -} - /** \brief Display the content of a matrix (debugging purpose) * \param coords: boolean indicating whether we should add the coords of each cell to the output*/ void xbt_matrix_dump(xbt_matrix_t matrix, const char *name, int coords, void_f_pvoid_t display_fun) { - unsigned int i, j; - fprintf(stderr, ">>> Matrix %s dump (%u x %u)\n", name, matrix->lines, matrix->rows); - for (i = 0; i < matrix->lines; i++) { + for (unsigned i = 0; i < matrix->lines; i++) { fprintf(stderr, " "); - for (j = 0; j < matrix->rows; j++) { + for (unsigned j = 0; j < matrix->rows; j++) { if (coords) fprintf(stderr, " (%u,%u)=", i, j); else @@ -76,11 +65,6 @@ void xbt_matrix_dump(xbt_matrix_t matrix, const char *name, int coords, void_f_p fprintf(stderr, "<<< end_of_matrix %s dump\n", name); } -void xbt_matrix_dump_display_double(void *d) -{ - fprintf(stderr, "%.2f", *(double *) d); -} - /** \brief Copy the values from the matrix src into the matrix dst * \param dest: destination * \param src: source @@ -95,8 +79,6 @@ void xbt_matrix_copy_values(xbt_matrix_t dst, xbt_matrix_t src, unsigned int lsi unsigned int lpos_dst, unsigned int rpos_dst,unsigned int lpos_src, unsigned int rpos_src, pvoid_f_pvoid_t const cpy_f) { - unsigned int i, j; - XBT_DEBUG ("Copy a %ux%u submatrix from %ux%u(of %ux%u) to %ux%u (of %ux%u)", lsize, rsize, lpos_src, rpos_src, src->lines, src->rows, lpos_dst, rpos_dst, dst->lines, dst->rows); @@ -111,9 +93,9 @@ void xbt_matrix_copy_values(xbt_matrix_t dst, xbt_matrix_t src, unsigned int lsi xbt_assert(rpos_dst + rsize <= dst->rows); /* Lets get serious here */ - for (i = 0; i < rsize; i++) { + for (unsigned i = 0; i < rsize; i++) { if (cpy_f) { - for (j = 0; j < lsize; j++) + for (unsigned j = 0; j < lsize; j++) xbt_matrix_get_as(dst, j + lpos_dst, i + rpos_dst, void *) = cpy_f(xbt_matrix_get_ptr(src, j + rpos_src, i + lpos_src)); } else { @@ -136,9 +118,8 @@ xbt_matrix_t xbt_matrix_double_new_zeros(int lines, int rows) xbt_matrix_t xbt_matrix_double_new_id(int lines, int rows) { xbt_matrix_t res = xbt_matrix_double_new_zeros(lines, rows); - int i; - for (i = 0; i < lines; i++) + for (int i = 0; i < lines; i++) xbt_matrix_get_as(res, i, i, double) = 1; return res; } @@ -147,9 +128,8 @@ xbt_matrix_t xbt_matrix_double_new_id(int lines, int rows) xbt_matrix_t xbt_matrix_double_new_seq(int lines, int rows) { xbt_matrix_t res = xbt_matrix_new(lines, rows, sizeof(double), NULL); - int i; - for (i = 0; i < lines * rows; i++) + for (int i = 0; i < lines * rows; i++) *(double *) &res->data[i * res->elmsize] = i; return res; @@ -158,13 +138,11 @@ xbt_matrix_t xbt_matrix_double_new_seq(int lines, int rows) /** \brief add to C the result of A*B */ void xbt_matrix_double_addmult(xbt_matrix_t A, xbt_matrix_t B, /*OUT*/ xbt_matrix_t C) { - unsigned int i, j, k; - xbt_assert(A->lines == C->lines, "A->lines != C->lines (%u vs %u)", A->lines, C->lines); xbt_assert(B->rows == C->rows); - for (i = 0; i < C->lines; i++) - for (j = 0; j < C->rows; j++) - for (k = 0; k < B->lines; k++) + for (unsigned i = 0; i < C->lines; i++) + for (unsigned j = 0; j < C->rows; j++) + for (unsigned k = 0; k < B->lines; k++) xbt_matrix_get_as(C, i, j, double) += xbt_matrix_get_as(A, i, k, double) * xbt_matrix_get_as(B, k, j, double); } -- 2.20.1