Code coverage tests

This page documents the degree to which the PARI/GP source code is tested by our public test suite, distributed with the source distribution in directory src/test/. This is measured by the gcov utility; we then process gcov output using the lcov frond-end.

We test a few variants depending on Configure flags on the pari.math.u-bordeaux.fr machine (x86_64 architecture), and agregate them in the final report:

The target is to exceed 90% coverage for all mathematical modules (given that branches depending on DEBUGLEVEL or DEBUGMEM are not covered). This script is run to produce the results below.

LCOV - code coverage report
Current view: top level - mt - pthread.c (source / functions) Hit Total Coverage
Test: PARI/GP v2.16.2 lcov report (development 29395-ef22f77854) Lines: 215 227 94.7 %
Date: 2024-06-15 09:03:40 Functions: 21 23 91.3 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /* Copyright (C) 2013  The PARI group.
       2             : 
       3             : This file is part of the PARI/GP package.
       4             : 
       5             : PARI/GP is free software; you can redistribute it and/or modify it under the
       6             : terms of the GNU General Public License as published by the Free Software
       7             : Foundation; either version 2 of the License, or (at your option) any later
       8             : version. It is distributed in the hope that it will be useful, but WITHOUT
       9             : ANY WARRANTY WHATSOEVER.
      10             : 
      11             : Check the License for details. You should have received a copy of it, along
      12             : with the package; see the file 'COPYING'. If not, write to the Free Software
      13             : Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */
      14             : #include <pthread.h>
      15             : #include "pari.h"
      16             : #include "paripriv.h"
      17             : #include "mt.h"
      18             : #if defined(_WIN32)
      19             : #  include "../systems/mingw/mingw.h"
      20             : #endif
      21             : 
      22             : #define DEBUGLEVEL DEBUGLEVEL_mt
      23             : 
      24             : struct mt_queue
      25             : {
      26             :   long no;
      27             :   pari_sp avma;
      28             :   struct pari_mainstack *mainstack;
      29             :   GEN input, output;
      30             :   GEN worker;
      31             :   long workid;
      32             :   pthread_cond_t cond;
      33             :   pthread_mutex_t mut;
      34             :   pthread_cond_t *pcond;
      35             :   pthread_mutex_t *pmut;
      36             : };
      37             : 
      38             : struct mt_pstate
      39             : {
      40             :   pthread_t *th;
      41             :   struct pari_thread *pth;
      42             :   struct mt_queue *mq;
      43             :   long n, nbint, last;
      44             :   long pending;
      45             :   pthread_cond_t pcond;
      46             :   pthread_mutex_t pmut;
      47             : };
      48             : 
      49             : static THREAD long mt_thread_no = -1;
      50             : static struct mt_pstate *pari_mt;
      51             : 
      52             : #define LOCK(x) pthread_mutex_lock(x); do
      53             : #define UNLOCK(x) while(0); pthread_mutex_unlock(x)
      54             : 
      55             : void
      56   198415480 : mt_sigint_block(void)
      57             : {
      58   198415480 :   if (mt_thread_no>=0)
      59    27747710 :     pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED,NULL);
      60   199864963 : }
      61             : 
      62             : void
      63   198897556 : mt_sigint_unblock(void)
      64             : {
      65   198897556 :   if (mt_thread_no>=0)
      66    28213908 :     pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS,NULL);
      67   199871740 : }
      68             : 
      69             : void
      70        1752 : mt_err_recover(long er)
      71             : {
      72        1752 :   if (mt_thread_no>=0)
      73             :   {
      74          10 :     struct mt_pstate *mt = pari_mt;
      75          10 :     struct mt_queue *mq = mt->mq+mt_thread_no;
      76          10 :     GEN err = pari_err_last();
      77          10 :     err = err_get_num(err)==e_STACK ? err_e_STACK: bin_copy(copy_bin(err));
      78          10 :     LOCK(mq->pmut)
      79             :     {
      80          10 :       mq->output = err;
      81          10 :       pthread_cond_signal(mq->pcond);
      82          10 :     } UNLOCK(mq->pmut);
      83           9 :     pthread_exit((void*)1);
      84             :   }
      85        1742 :   else mtsingle_err_recover(er);
      86        1742 : }
      87             : 
      88             : void
      89           0 : mt_break_recover(void)
      90             : {
      91           0 :   if (mt_thread_no<0) mtsingle_err_recover(0);
      92           0 : }
      93             : 
      94             : void
      95           0 : mt_sigint(void)
      96             : {
      97           0 :   if (pari_mt) pthread_cond_broadcast(&pari_mt->pcond);
      98           0 : }
      99             : 
     100             : int
     101      216136 : mt_is_parallel(void)
     102             : {
     103      216136 :   return !!pari_mt;
     104             : }
     105             : 
     106             : int
     107    30899322 : mt_is_thread(void)
     108             : {
     109    30899322 :   return mt_thread_no>=0 ? 1: mtsingle_is_thread();
     110             : }
     111             : 
     112             : long
     113      380501 : mt_nbthreads(void)
     114             : {
     115      380501 :   return pari_mt ? 1: pari_mt_nbthreads;
     116             : }
     117             : 
     118             : void
     119      320244 : mt_thread_init(void) { mt_thread_no = 0; }
     120             : 
     121             : void
     122          13 : mt_export_add(const char *str, GEN val)
     123             : {
     124          13 :   if (pari_mt)
     125           0 :     pari_err(e_MISC,"export() not allowed during parallel sections");
     126          13 :   export_add(str, val);
     127          13 : }
     128             : 
     129             : void
     130           8 : mt_export_del(const char *str)
     131             : {
     132           8 :   if (pari_mt)
     133           0 :     pari_err(e_MISC,"unexport() not allowed during parallel sections");
     134           8 :   export_del(str);
     135           8 : }
     136             : 
     137           1 : void mt_broadcast(GEN code) {(void) code;}
     138             : 
     139         259 : void pari_mt_init(void)
     140             : {
     141         259 :   pari_mt = NULL;
     142             : #ifdef _SC_NPROCESSORS_CONF
     143         259 :   if (!pari_mt_nbthreads) pari_mt_nbthreads = sysconf(_SC_NPROCESSORS_CONF);
     144             : #elif defined(_WIN32)
     145             :   if (!pari_mt_nbthreads) pari_mt_nbthreads = win32_nbthreads();
     146             : #else
     147             :   pari_mt_nbthreads = 1;
     148             : #endif
     149         259 : }
     150             : 
     151         259 : void pari_mt_close(void) { }
     152             : 
     153             : static void
     154      321137 : mt_queue_cleanup(void *arg)
     155             : {
     156             :   (void) arg;
     157      321137 :   pari_thread_close();
     158      319728 : }
     159             : 
     160             : static void
     161      320459 : mt_queue_unlock(void *arg)
     162      320459 : { pthread_mutex_unlock((pthread_mutex_t*) arg); }
     163             : 
     164             : static void*
     165      322607 : mt_queue_run(void *arg)
     166             : {
     167      322607 :   GEN args = pari_thread_start((struct pari_thread*) arg);
     168      320223 :   pari_sp av = avma;
     169      320223 :   struct mt_queue *mq = (struct mt_queue *) args;
     170      320223 :   mt_thread_no = mq->no;
     171      320223 :   pthread_cleanup_push(mt_queue_cleanup,NULL);
     172      320716 :   LOCK(mq->pmut)
     173             :   {
     174      322613 :     mq->mainstack = pari_mainstack;
     175      322613 :     mq->avma = av;
     176      322613 :     pthread_cond_signal(mq->pcond);
     177      322613 :   } UNLOCK(mq->pmut);
     178             :   for(;;)
     179      433642 :   {
     180             :     GEN work, done;
     181      756216 :     LOCK(&mq->mut)
     182             :     {
     183      756197 :       pthread_cleanup_push(mt_queue_unlock, &mq->mut);
     184     1166830 :       while(!mq->input)
     185      733188 :         pthread_cond_wait(&mq->cond, &mq->mut);
     186      433642 :       pthread_cleanup_pop(0);
     187      433606 :     } UNLOCK(&mq->mut);
     188      433622 :     pari_mainstack = mq->mainstack;
     189      433622 :     set_avma(mq->avma);
     190      433511 :     work = mq->input;
     191      433511 :     pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS,NULL);
     192      433648 :     done = closure_callgenvec(mq->worker,work);
     193      432486 :     pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED,NULL);
     194      433538 :     LOCK(mq->pmut)
     195             :     {
     196      433656 :       mq->mainstack = pari_mainstack;
     197      433656 :       mq->avma = av;
     198      433656 :       mq->input = NULL;
     199      433656 :       mq->output = done;
     200      433656 :       pthread_cond_signal(mq->pcond);
     201      433656 :     } UNLOCK(mq->pmut);
     202             :   }
     203             :   pthread_cleanup_pop(1);
     204             : #ifdef __GNUC__
     205             :   return NULL; /* LCOV_EXCL_LINE */
     206             : #endif
     207             : }
     208             : 
     209             : static long
     210      600724 : mt_queue_check(struct mt_pstate *mt)
     211             : {
     212             :   long i;
     213     4603568 :   for(i=0; i<mt->n; i++)
     214             :   {
     215     4436503 :     struct mt_queue *mq = mt->mq+i;
     216     4436503 :     if (mq->output) return i;
     217             :   }
     218      167065 :   return -1;
     219             : }
     220             : 
     221             : static GEN
     222      700491 : mtpthread_queue_get(struct mt_state *junk, long *workid, long *pending)
     223             : {
     224      700491 :   struct mt_pstate *mt = pari_mt;
     225             :   struct mt_queue *mq;
     226      700491 :   GEN done = NULL;
     227             :   long last;
     228             :   (void) junk;
     229      700491 :   if (mt->nbint<mt->n)
     230             :   {
     231      266830 :     mt->last = mt->nbint;
     232      266830 :     *pending = mt->pending;
     233      266830 :     return NULL;
     234             :   }
     235      433661 :   BLOCK_SIGINT_START
     236      433661 :   LOCK(&mt->pmut)
     237             :   {
     238      600724 :     while ((last = mt_queue_check(mt)) < 0)
     239             :     {
     240      167065 :       pthread_cond_wait(&mt->pcond, &mt->pmut);
     241      167065 :       if (PARI_SIGINT_pending)
     242             :       {
     243           2 :         int sig = PARI_SIGINT_pending;
     244           2 :         PARI_SIGINT_pending = 0;
     245           2 :         pthread_mutex_unlock(&mt->pmut);
     246           2 :         PARI_SIGINT_block = 0;
     247           2 :         raise(sig);
     248           0 :         PARI_SIGINT_block = 1;
     249           0 :         pthread_mutex_lock(&mt->pmut);
     250             :       }
     251             :     }
     252      433659 :   } UNLOCK(&mt->pmut);
     253      433659 :   BLOCK_SIGINT_END
     254      433659 :   mq = mt->mq+last;
     255      433659 :   done = gcopy(mq->output);
     256      433659 :   mq->output = NULL;
     257      433659 :   if (workid) *workid = mq->workid;
     258      433659 :   if (typ(done) == t_ERROR)
     259             :   {
     260           5 :     if (err_get_num(done)==e_STACK)
     261           0 :       pari_err(e_STACKTHREAD);
     262             :     else
     263           5 :       pari_err(0,done);
     264             :   }
     265      433654 :   mt->last = last;
     266      433654 :   mt->pending--;
     267      433654 :   *pending = mt->pending;
     268      433654 :   return done;
     269             : }
     270             : 
     271             : static void
     272      700491 : mtpthread_queue_submit(struct mt_state *junk, long workid, GEN work)
     273             : {
     274      700491 :   struct mt_pstate *mt = pari_mt;
     275      700491 :   struct mt_queue *mq = mt->mq+mt->last;
     276             :   (void) junk;
     277      700491 :   if (!work) { mt->nbint=mt->n; return; }
     278      433711 :   BLOCK_SIGINT_START
     279      433711 :   if (mt->nbint<mt->n)
     280             :   {
     281      322176 :     mt->nbint++;
     282      322176 :     LOCK(mq->pmut)
     283             :     {
     284      387701 :       while(!mq->avma)
     285       65525 :         pthread_cond_wait(mq->pcond, mq->pmut);
     286      322176 :     } UNLOCK(mq->pmut);
     287             :   }
     288      433711 :   LOCK(&mq->mut)
     289             :   {
     290      433711 :     mq->output = NULL;
     291      433711 :     mq->workid = workid;
     292      433711 :     BLOCK_SIGINT_START
     293             :     {
     294      433711 :       pari_sp av = avma;
     295      433711 :       struct pari_mainstack *st = pari_mainstack;
     296      433711 :       pari_mainstack = mq->mainstack;
     297      433711 :       set_avma(mq->avma);
     298      433711 :       mq->input = gcopy(work);
     299      433711 :       mq->avma = avma;
     300      433711 :       mq->mainstack = pari_mainstack;
     301      433711 :       pari_mainstack = st;
     302      433711 :       set_avma(av);
     303             :     }
     304      433711 :     BLOCK_SIGINT_END
     305      433711 :     pthread_cond_signal(&mq->cond);
     306      433711 :   } UNLOCK(&mq->mut);
     307      433711 :   mt->pending++;
     308      433711 :   BLOCK_SIGINT_END
     309             : }
     310             : 
     311             : void
     312       55691 : mt_queue_reset(void)
     313             : {
     314       55691 :   struct mt_pstate *mt = pari_mt;
     315             :   long i;
     316       55691 :   BLOCK_SIGINT_START
     317      378304 :   for (i=0; i<mt->n; i++)
     318      322613 :     pthread_cancel(mt->th[i]);
     319      378304 :   for (i=0; i<mt->n; i++)
     320      322613 :     pthread_join(mt->th[i],NULL);
     321       55691 :   pari_mt = NULL;
     322       55691 :   BLOCK_SIGINT_END
     323       55691 :   if (DEBUGLEVEL) pari_warn(warner,"stopping %ld threads", mt->n);
     324      378304 :   for (i=0;i<mt->n;i++)
     325             :   {
     326      322613 :     struct mt_queue *mq = mt->mq+i;
     327      322613 :     pthread_cond_destroy(&mq->cond);
     328      322613 :     pthread_mutex_destroy(&mq->mut);
     329      322613 :     pari_thread_free(&mt->pth[i]);
     330             :   }
     331       55691 :   pari_free(mt->mq);
     332       55691 :   pari_free(mt->pth);
     333       55691 :   pari_free(mt->th);
     334       55691 :   pari_free(mt);
     335       55691 : }
     336             : 
     337             : static long
     338       55691 : closure_has_clone(GEN fun)
     339             : {
     340       55691 :   if (isclone(fun)) return 1;
     341       55685 :   if (lg(fun) >= 8)
     342             :   {
     343       55126 :     GEN f = closure_get_frame(fun);
     344       55126 :     long i, l = lg(f);
     345      202684 :     for (i = 1; i < l; i++)
     346      149069 :       if (isclone(gel(f,i))) return 1;
     347             :   }
     348       54174 :   return 0;
     349             : }
     350             : 
     351             : void
     352      127433 : mt_queue_start_lim(struct pari_mt *pt, GEN worker, long lim)
     353             : {
     354      127433 :   if (lim==0) lim = pari_mt_nbthreads;
     355      127414 :   else        lim = minss(pari_mt_nbthreads, lim);
     356      127433 :   if (mt_thread_no >= 0)
     357       41737 :     mtsequential_queue_start(pt, worker);
     358       85696 :   else if (pari_mt || lim <= 1)
     359       30005 :     mtsingle_queue_start(pt, worker);
     360             :   else
     361             :   {
     362             :     struct mt_pstate *mt =
     363       55691 :            (struct mt_pstate*) pari_malloc(sizeof(struct mt_pstate));
     364       55691 :     long mtparisize = GP_DATA->threadsize? GP_DATA->threadsize: pari_mainstack->rsize;
     365       55691 :     long mtparisizemax = GP_DATA->threadsizemax;
     366             :     long i;
     367       55691 :     if (closure_has_clone(worker))
     368        1517 :       worker = gcopy(worker); /* to avoid clone_lock race */
     369       55691 :     mt->mq  = (struct mt_queue *) pari_malloc(sizeof(*mt->mq)*lim);
     370       55691 :     mt->th  = (pthread_t *) pari_malloc(sizeof(*mt->th)*lim);
     371       55691 :     mt->pth = (struct pari_thread *) pari_malloc(sizeof(*mt->pth)*lim);
     372       55691 :     mt->pending = 0;
     373       55691 :     mt->n = lim;
     374       55691 :     mt->nbint = 0;
     375       55691 :     mt->last = 0;
     376       55691 :     pthread_cond_init(&mt->pcond,NULL);
     377       55691 :     pthread_mutex_init(&mt->pmut,NULL);
     378      378304 :     for (i=0;i<lim;i++)
     379             :     {
     380      322613 :       struct mt_queue *mq = mt->mq+i;
     381      322613 :       mq->no     = i;
     382      322613 :       mq->avma = 0;
     383      322613 :       mq->mainstack = NULL;
     384      322613 :       mq->worker = worker;
     385      322613 :       mq->input  = NULL;
     386      322613 :       mq->output = NULL;
     387      322613 :       mq->pcond  = &mt->pcond;
     388      322613 :       mq->pmut   = &mt->pmut;
     389      322613 :       pthread_cond_init(&mq->cond,NULL);
     390      322613 :       pthread_mutex_init(&mq->mut,NULL);
     391      322613 :       if (mtparisizemax)
     392           0 :         pari_thread_valloc(&mt->pth[i],mtparisize,mtparisizemax,(GEN)mq);
     393             :       else
     394      322613 :         pari_thread_alloc(&mt->pth[i],mtparisize,(GEN)mq);
     395             :     }
     396       55691 :     if (DEBUGLEVEL) pari_warn(warner,"starting %ld threads", lim);
     397       55691 :     BLOCK_SIGINT_START
     398      378304 :     for (i=0;i<lim;i++)
     399      322613 :       pthread_create(&mt->th[i],NULL, &mt_queue_run, (void*)&mt->pth[i]);
     400       55691 :     pari_mt = mt;
     401       55691 :     BLOCK_SIGINT_END
     402       55691 :     pt->get=&mtpthread_queue_get;
     403       55691 :     pt->submit=&mtpthread_queue_submit;
     404       55691 :     pt->end=&mt_queue_reset;
     405             :   }
     406      127433 : }

Generated by: LCOV version 1.16