lib: Fixup comment indentations in thread.c

Somewhere along the way the indentation for comments got
all messed up.  Let's make it follow our standards and
also look right too.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
This commit is contained in:
Donald Sharp 2020-08-12 09:46:44 -04:00
parent c64e4ca2a7
commit d279ef571e

View File

@ -726,17 +726,16 @@ static void thread_free(struct thread_master *master, struct thread *thread)
static int fd_poll(struct thread_master *m, struct pollfd *pfds, nfds_t pfdsize, static int fd_poll(struct thread_master *m, struct pollfd *pfds, nfds_t pfdsize,
nfds_t count, const struct timeval *timer_wait) nfds_t count, const struct timeval *timer_wait)
{ {
/* If timer_wait is null here, that means poll() should block /*
* indefinitely, * If timer_wait is null here, that means poll() should block
* unless the thread_master has overridden it by setting * indefinitely, unless the thread_master has overridden it by setting
* ->selectpoll_timeout. * ->selectpoll_timeout.
*
* If the value is positive, it specifies the maximum number of * If the value is positive, it specifies the maximum number of
* milliseconds * milliseconds to wait. If the timeout is -1, it specifies that
* to wait. If the timeout is -1, it specifies that we should never wait * we should never wait and always return immediately even if no
* and * event is detected. If the value is zero, the behavior is default.
* always return immediately even if no event is detected. If the value */
* is
* zero, the behavior is default. */
int timeout = -1; int timeout = -1;
/* number of file descriptors with events */ /* number of file descriptors with events */
@ -860,7 +859,7 @@ funcname_thread_add_timer_timeval(struct thread_master *m,
frr_with_mutex(&m->mtx) { frr_with_mutex(&m->mtx) {
if (t_ptr && *t_ptr) if (t_ptr && *t_ptr)
// thread is already scheduled; don't reschedule /* thread is already scheduled; don't reschedule */
return NULL; return NULL;
thread = thread_get(m, type, func, arg, debugargpass); thread = thread_get(m, type, func, arg, debugargpass);
@ -940,7 +939,7 @@ struct thread *funcname_thread_add_event(struct thread_master *m,
frr_with_mutex(&m->mtx) { frr_with_mutex(&m->mtx) {
if (t_ptr && *t_ptr) if (t_ptr && *t_ptr)
// thread is already scheduled; don't reschedule /* thread is already scheduled; don't reschedule */
break; break;
thread = thread_get(m, THREAD_EVENT, func, arg, debugargpass); thread = thread_get(m, THREAD_EVENT, func, arg, debugargpass);
@ -1047,11 +1046,12 @@ static void do_thread_cancel(struct thread_master *master)
struct cancel_req *cr; struct cancel_req *cr;
struct listnode *ln; struct listnode *ln;
for (ALL_LIST_ELEMENTS_RO(master->cancel_req, ln, cr)) { for (ALL_LIST_ELEMENTS_RO(master->cancel_req, ln, cr)) {
/* If this is an event object cancellation, linear search /*
* through event * If this is an event object cancellation, linear search
* list deleting any events which have the specified argument. * through event list deleting any events which have the
* We also * specified argument. We also need to check every thread
* need to check every thread in the ready queue. */ * in the ready queue.
*/
if (cr->eventobj) { if (cr->eventobj) {
struct thread *t; struct thread *t;
@ -1075,11 +1075,12 @@ static void do_thread_cancel(struct thread_master *master)
continue; continue;
} }
/* The pointer varies depending on whether the cancellation /*
* request was * The pointer varies depending on whether the cancellation
* made asynchronously or not. If it was, we need to check * request was made asynchronously or not. If it was, we
* whether the * need to check whether the thread even exists anymore
* thread even exists anymore before cancelling it. */ * before cancelling it.
*/
thread = (cr->thread) ? cr->thread : *cr->threadref; thread = (cr->thread) ? cr->thread : *cr->threadref;
if (!thread) if (!thread)
@ -1304,17 +1305,16 @@ static void thread_process_io(struct thread_master *m, unsigned int num)
ready++; ready++;
/* Unless someone has called thread_cancel from another pthread, /*
* the only * Unless someone has called thread_cancel from another
* thing that could have changed in m->handler.pfds while we * pthread, the only thing that could have changed in
* were * m->handler.pfds while we were asleep is the .events
* asleep is the .events field in a given pollfd. Barring * field in a given pollfd. Barring thread_cancel() that
* thread_cancel() * value should be a superset of the values we have in our
* that value should be a superset of the values we have in our * copy, so there's no need to update it. Similarily,
* copy, so * barring deletion, the fd should still be a valid index
* there's no need to update it. Similarily, barring deletion, * into the master's pfds.
* the fd */
* should still be a valid index into the master's pfds. */
if (pfds[i].revents & (POLLIN | POLLHUP)) { if (pfds[i].revents & (POLLIN | POLLHUP)) {
thread_process_io_helper(m, m->read[pfds[i].fd], POLLIN, thread_process_io_helper(m, m->read[pfds[i].fd], POLLIN,
pfds[i].revents, i); pfds[i].revents, i);
@ -1427,11 +1427,10 @@ struct thread *thread_fetch(struct thread_master *m, struct thread *fetch)
* *
* - If there are events pending, set the poll() timeout to zero * - If there are events pending, set the poll() timeout to zero
* - If there are no events pending, but there are timers * - If there are no events pending, but there are timers
* pending, set the * pending, set the timeout to the smallest remaining time on
* timeout to the smallest remaining time on any timer * any timer.
* - If there are neither timers nor events pending, but there * - If there are neither timers nor events pending, but there
* are file * are file descriptors pending, block indefinitely in poll()
* descriptors pending, block indefinitely in poll()
* - If nothing is pending, it's time for the application to die * - If nothing is pending, it's time for the application to die
* *
* In every case except the last, we need to hit poll() at least * In every case except the last, we need to hit poll() at least