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.18.1 lcov report (development 30093-5ee0843b38) Lines: 220 232 94.8 %
Date: 2025-03-25 09:19:38 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   203656768 : mt_sigint_block(void)
      57             : {
      58   203656768 :   if (mt_thread_no>=0)
      59    28225506 :     pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED,NULL);
      60   205168318 : }
      61             : 
      62             : void
      63   204065985 : mt_sigint_unblock(void)
      64             : {
      65   204065985 :   if (mt_thread_no>=0)
      66    28624596 :     pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS,NULL);
      67   205190890 : }
      68             : 
      69             : void
      70        1845 : mt_err_recover(long er)
      71             : {
      72        1845 :   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 :     pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED,NULL);
      79          10 :     LOCK(mq->pmut)
      80             :     {
      81          10 :       mq->output = err;
      82          10 :       pthread_cond_signal(mq->pcond);
      83          10 :     } UNLOCK(mq->pmut);
      84          10 :     pthread_exit((void*)1);
      85             :   }
      86        1835 :   else mtsingle_err_recover(er);
      87        1835 : }
      88             : 
      89             : void
      90           0 : mt_break_recover(void)
      91             : {
      92           0 :   if (mt_thread_no<0) mtsingle_err_recover(0);
      93           0 : }
      94             : 
      95             : void
      96           0 : mt_sigint(void)
      97             : {
      98           0 :   if (pari_mt) pthread_cond_broadcast(&pari_mt->pcond);
      99           0 : }
     100             : 
     101             : int
     102      220358 : mt_is_parallel(void)
     103             : {
     104      220358 :   return !!pari_mt;
     105             : }
     106             : 
     107             : int
     108    30907400 : mt_is_thread(void)
     109             : {
     110    30907400 :   return mt_thread_no>=0 ? 1: mtsingle_is_thread();
     111             : }
     112             : 
     113             : long
     114      383225 : mt_nbthreads(void)
     115             : {
     116      383225 :   return pari_mt ? 1: pari_mt_nbthreads;
     117             : }
     118             : 
     119             : void
     120      333808 : mt_thread_init(void) { mt_thread_no = 0; }
     121             : 
     122             : void
     123          13 : mt_export_add(const char *str, GEN val)
     124             : {
     125          13 :   if (pari_mt)
     126           0 :     pari_err(e_MISC,"export() not allowed during parallel sections");
     127          13 :   export_add(str, val);
     128          13 : }
     129             : 
     130             : void
     131           8 : mt_export_del(const char *str)
     132             : {
     133           8 :   if (pari_mt)
     134           0 :     pari_err(e_MISC,"unexport() not allowed during parallel sections");
     135           8 :   export_del(str);
     136           8 : }
     137             : 
     138           1 : void mt_broadcast(GEN code) {(void) code;}
     139             : 
     140         265 : void pari_mt_init(void)
     141             : {
     142         265 :   pari_mt = NULL;
     143             : #ifdef _SC_NPROCESSORS_CONF
     144         265 :   if (!pari_mt_nbthreads) pari_mt_nbthreads = sysconf(_SC_NPROCESSORS_CONF);
     145             : #elif defined(_WIN32)
     146             :   if (!pari_mt_nbthreads) pari_mt_nbthreads = win32_nbthreads();
     147             : #else
     148             :   pari_mt_nbthreads = 1;
     149             : #endif
     150         265 : }
     151             : 
     152         265 : void pari_mt_close(void) { }
     153             : 
     154             : static void
     155      334545 : mt_queue_cleanup(void *arg)
     156             : {
     157             :   (void) arg;
     158      334545 :   pari_thread_close();
     159      333524 : }
     160             : 
     161             : static void
     162      334379 : mt_queue_unlock(void *arg)
     163      334379 : { pthread_mutex_unlock((pthread_mutex_t*) arg); }
     164             : 
     165             : static void*
     166      335359 : mt_queue_run(void *arg)
     167             : {
     168      335359 :   GEN args = pari_thread_start((struct pari_thread*) arg);
     169      333717 :   pari_sp av = avma;
     170      333717 :   struct mt_queue *mq = (struct mt_queue *) args;
     171      333717 :   mt_thread_no = mq->no;
     172      333717 :   pthread_cleanup_push(mt_queue_cleanup,NULL);
     173      333954 :   LOCK(mq->pmut)
     174             :   {
     175      335360 :     mq->mainstack = pari_mainstack;
     176      335360 :     mq->avma = av;
     177      335360 :     pthread_cond_signal(mq->pcond);
     178      335360 :   } UNLOCK(mq->pmut);
     179             :   for(;;)
     180      445780 :   {
     181             :     GEN work, done;
     182      781103 :     LOCK(&mq->mut)
     183             :     {
     184      781082 :       pthread_cleanup_push(mt_queue_unlock, &mq->mut);
     185     1203335 :       while(!mq->input)
     186      757504 :         pthread_cond_wait(&mq->cond, &mq->mut);
     187      445831 :       pthread_cleanup_pop(0);
     188      445835 :     } UNLOCK(&mq->mut);
     189      445820 :     pari_mainstack = mq->mainstack;
     190      445820 :     set_avma(mq->avma);
     191      445743 :     work = mq->input;
     192      445743 :     pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS,NULL);
     193      445838 :     done = closure_callgenvec(mq->worker,work);
     194      444233 :     pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED,NULL);
     195      445684 :     LOCK(mq->pmut)
     196             :     {
     197      445807 :       mq->mainstack = pari_mainstack;
     198      445807 :       mq->avma = av;
     199      445807 :       mq->input = NULL;
     200      445807 :       mq->output = done;
     201      445807 :       pthread_cond_signal(mq->pcond);
     202      445807 :     } UNLOCK(mq->pmut);
     203             :   }
     204             :   pthread_cleanup_pop(1);
     205             : #ifdef __GNUC__
     206             :   return NULL; /* LCOV_EXCL_LINE */
     207             : #endif
     208             : }
     209             : 
     210             : static long
     211      636378 : mt_queue_check(struct mt_pstate *mt)
     212             : {
     213             :   long i;
     214     4798097 :   for(i=0; i<mt->n; i++)
     215             :   {
     216     4607529 :     struct mt_queue *mq = mt->mq+i;
     217     4607529 :     if (mq->output) return i;
     218             :   }
     219      190568 :   return -1;
     220             : }
     221             : 
     222             : static GEN
     223      718470 : mtpthread_queue_get(struct mt_state *junk, long *workid, long *pending)
     224             : {
     225      718470 :   struct mt_pstate *mt = pari_mt;
     226             :   struct mt_queue *mq;
     227      718470 :   GEN done = NULL;
     228             :   long last;
     229             :   (void) junk;
     230      718470 :   if (mt->nbint<mt->n)
     231             :   {
     232      272658 :     mt->last = mt->nbint;
     233      272658 :     *pending = mt->pending;
     234      272658 :     return NULL;
     235             :   }
     236      445812 :   BLOCK_SIGINT_START
     237      445812 :   LOCK(&mt->pmut)
     238             :   {
     239      636378 :     while ((last = mt_queue_check(mt)) < 0)
     240             :     {
     241      190568 :       pthread_cond_wait(&mt->pcond, &mt->pmut);
     242      190568 :       if (PARI_SIGINT_pending)
     243             :       {
     244           2 :         int sig = PARI_SIGINT_pending;
     245           2 :         PARI_SIGINT_pending = 0;
     246           2 :         pthread_mutex_unlock(&mt->pmut);
     247           2 :         PARI_SIGINT_block = 0;
     248           2 :         raise(sig);
     249           0 :         PARI_SIGINT_block = 1;
     250           0 :         pthread_mutex_lock(&mt->pmut);
     251             :       }
     252             :     }
     253      445810 :   } UNLOCK(&mt->pmut);
     254      445810 :   BLOCK_SIGINT_END
     255      445810 :   mq = mt->mq+last;
     256      445810 :   done = gcopy(mq->output);
     257      445810 :   mq->output = NULL;
     258      445810 :   if (workid) *workid = mq->workid;
     259      445810 :   if (typ(done) == t_ERROR)
     260             :   {
     261           5 :     if (err_get_num(done)==e_STACK)
     262           0 :       pari_err(e_STACKTHREAD);
     263             :     else
     264           5 :       pari_err(0,done);
     265             :   }
     266      445805 :   mt->last = last;
     267      445805 :   mt->pending--;
     268      445805 :   *pending = mt->pending;
     269      445805 :   return done;
     270             : }
     271             : 
     272             : static void
     273      718470 : mtpthread_queue_submit(struct mt_state *junk, long workid, GEN work)
     274             : {
     275      718470 :   struct mt_pstate *mt = pari_mt;
     276      718470 :   struct mt_queue *mq = mt->mq+mt->last;
     277             :   (void) junk;
     278      718470 :   if (!work) { mt->nbint=mt->n; return; }
     279      445866 :   BLOCK_SIGINT_START
     280      445866 :   if (mt->nbint<mt->n)
     281             :   {
     282      334923 :     mt->nbint++;
     283      334923 :     LOCK(mq->pmut)
     284             :     {
     285      418217 :       while(!mq->avma)
     286       83294 :         pthread_cond_wait(mq->pcond, mq->pmut);
     287      334923 :     } UNLOCK(mq->pmut);
     288             :   }
     289      445866 :   LOCK(&mq->mut)
     290             :   {
     291      445866 :     mq->output = NULL;
     292      445866 :     mq->workid = workid;
     293      445866 :     BLOCK_SIGINT_START
     294             :     {
     295      445866 :       pari_sp av = avma;
     296      445866 :       struct pari_mainstack *st = pari_mainstack;
     297      445866 :       pari_mainstack = mq->mainstack;
     298      445866 :       set_avma(mq->avma);
     299      445866 :       mq->input = gcopy(work);
     300      445866 :       mq->avma = avma;
     301      445866 :       mq->mainstack = pari_mainstack;
     302      445866 :       pari_mainstack = st;
     303      445866 :       set_avma(av);
     304             :     }
     305      445866 :     BLOCK_SIGINT_END
     306      445866 :     pthread_cond_signal(&mq->cond);
     307      445866 :   } UNLOCK(&mq->mut);
     308      445866 :   mt->pending++;
     309      445866 :   BLOCK_SIGINT_END
     310             : }
     311             : 
     312             : void
     313       62610 : mt_queue_reset(void)
     314             : {
     315       62610 :   struct mt_pstate *mt = pari_mt;
     316             :   long i;
     317       62610 :   BLOCK_SIGINT_START
     318      397970 :   for (i=0; i<mt->n; i++)
     319      335360 :     pthread_cancel(mt->th[i]);
     320      397970 :   for (i=0; i<mt->n; i++)
     321      335360 :     pthread_join(mt->th[i],NULL);
     322       62610 :   pari_mt = NULL;
     323       62610 :   BLOCK_SIGINT_END
     324       62610 :   if (DEBUGLEVEL) pari_warn(warner,"stopping %ld threads", mt->n);
     325       62610 :   BLOCK_SIGINT_START
     326      397970 :   for (i=0;i<mt->n;i++)
     327             :   {
     328      335360 :     struct mt_queue *mq = mt->mq+i;
     329      335360 :     pthread_cond_destroy(&mq->cond);
     330      335360 :     pthread_mutex_destroy(&mq->mut);
     331      335360 :     pari_thread_free(&mt->pth[i]);
     332             :   }
     333       62610 :   pthread_cond_destroy(&mt->pcond);
     334       62610 :   pthread_mutex_destroy(&mt->pmut);
     335       62610 :   BLOCK_SIGINT_END
     336       62610 :   pari_free(mt->mq);
     337       62610 :   pari_free(mt->pth);
     338       62610 :   pari_free(mt->th);
     339       62610 :   pari_free(mt);
     340       62610 : }
     341             : 
     342             : static long
     343       62610 : closure_has_clone(GEN fun)
     344             : {
     345       62610 :   if (isclone(fun)) return 1;
     346       62604 :   if (lg(fun) >= 8)
     347             :   {
     348       62098 :     GEN f = closure_get_frame(fun);
     349       62098 :     long i, l = lg(f);
     350      229816 :     for (i = 1; i < l; i++)
     351      169232 :       if (isclone(gel(f,i))) return 1;
     352             :   }
     353       61090 :   return 0;
     354             : }
     355             : 
     356             : void
     357      141574 : mt_queue_start_lim(struct pari_mt *pt, GEN worker, long lim)
     358             : {
     359      141574 :   if (lim==0) lim = pari_mt_nbthreads;
     360      141555 :   else        lim = minss(pari_mt_nbthreads, lim);
     361      141574 :   if (mt_thread_no >= 0)
     362       42364 :     mtsequential_queue_start(pt, worker);
     363       99210 :   else if (pari_mt || lim <= 1)
     364       36600 :     mtsingle_queue_start(pt, worker);
     365             :   else
     366             :   {
     367             :     struct mt_pstate *mt =
     368       62610 :            (struct mt_pstate*) pari_malloc(sizeof(struct mt_pstate));
     369       62610 :     long mtparisize = GP_DATA->threadsize? GP_DATA->threadsize: pari_mainstack->rsize;
     370       62610 :     long mtparisizemax = GP_DATA->threadsizemax;
     371             :     long i;
     372       62610 :     if (closure_has_clone(worker))
     373        1520 :       worker = gcopy(worker); /* to avoid clone_lock race */
     374       62610 :     mt->mq  = (struct mt_queue *) pari_malloc(sizeof(*mt->mq)*lim);
     375       62610 :     mt->th  = (pthread_t *) pari_malloc(sizeof(*mt->th)*lim);
     376       62610 :     mt->pth = (struct pari_thread *) pari_malloc(sizeof(*mt->pth)*lim);
     377       62610 :     mt->pending = 0;
     378       62610 :     mt->n = lim;
     379       62610 :     mt->nbint = 0;
     380       62610 :     mt->last = 0;
     381       62610 :     pthread_cond_init(&mt->pcond,NULL);
     382       62610 :     pthread_mutex_init(&mt->pmut,NULL);
     383      397970 :     for (i=0;i<lim;i++)
     384             :     {
     385      335360 :       struct mt_queue *mq = mt->mq+i;
     386      335360 :       mq->no     = i;
     387      335360 :       mq->avma = 0;
     388      335360 :       mq->mainstack = NULL;
     389      335360 :       mq->worker = worker;
     390      335360 :       mq->input  = NULL;
     391      335360 :       mq->output = NULL;
     392      335360 :       mq->pcond  = &mt->pcond;
     393      335360 :       mq->pmut   = &mt->pmut;
     394      335360 :       pthread_cond_init(&mq->cond,NULL);
     395      335360 :       pthread_mutex_init(&mq->mut,NULL);
     396      335360 :       if (mtparisizemax)
     397           0 :         pari_thread_valloc(&mt->pth[i],mtparisize,mtparisizemax,(GEN)mq);
     398             :       else
     399      335360 :         pari_thread_alloc(&mt->pth[i],mtparisize,(GEN)mq);
     400             :     }
     401       62610 :     if (DEBUGLEVEL) pari_warn(warner,"starting %ld threads", lim);
     402       62610 :     BLOCK_SIGINT_START
     403      397970 :     for (i=0;i<lim;i++)
     404      335360 :       pthread_create(&mt->th[i],NULL, &mt_queue_run, (void*)&mt->pth[i]);
     405       62610 :     pari_mt = mt;
     406       62610 :     BLOCK_SIGINT_END
     407       62610 :     pt->get=&mtpthread_queue_get;
     408       62610 :     pt->submit=&mtpthread_queue_submit;
     409       62610 :     pt->end=&mt_queue_reset;
     410             :   }
     411      141574 : }

Generated by: LCOV version 1.16