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-bordeaux1.fr machine (x86_64 architecture), and agregate them in the final report:

The target is 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.8.0 lcov report (development 16746-c2cb716) Lines: 19 165 11.5 %
Date: 2014-08-31 Functions: 8 15 53.3 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 3 72 4.2 %

           Branch data     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. It is distributed in the hope that it will be useful, but WITHOUT
       8                 :            : ANY WARRANTY WHATSOEVER.
       9                 :            : 
      10                 :            : Check the License for details. You should have received a copy of it, along
      11                 :            : with the package; see the file 'COPYING'. If not, write to the Free Software
      12                 :            : Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */
      13                 :            : #include "pari.h"
      14                 :            : #include "paripriv.h"
      15                 :            : #include "mt.h"
      16                 :            : #include <pthread.h>
      17                 :            : 
      18                 :            : struct mt_queue
      19                 :            : {
      20                 :            :   long no;
      21                 :            :   pari_sp avma;
      22                 :            :   GEN input, output;
      23                 :            :   GEN worker;
      24                 :            :   long workid;
      25                 :            :   pthread_cond_t cond;
      26                 :            :   pthread_mutex_t mut;
      27                 :            :   pthread_cond_t *pcond;
      28                 :            :   pthread_mutex_t *pmut;
      29                 :            : };
      30                 :            : 
      31                 :            : struct mt_pstate
      32                 :            : {
      33                 :            :   pthread_t *th;
      34                 :            :   struct pari_thread *pth;
      35                 :            :   struct mt_queue *mq;
      36                 :            :   long n, nbint, last;
      37                 :            :   long pending;
      38                 :            :   pthread_cond_t pcond;
      39                 :            :   pthread_mutex_t pmut;
      40                 :            : };
      41                 :            : 
      42                 :            : static THREAD long mt_thread_no = -1;
      43                 :            : static struct mt_pstate *pari_mt;
      44                 :            : 
      45                 :            : #define LOCK(x) pthread_mutex_lock(x); do
      46                 :            : #define UNLOCK(x) while(0); pthread_mutex_unlock(x)
      47                 :            : 
      48                 :            : void
      49                 :   40671559 : mt_sigint_block(void)
      50                 :            : {
      51         [ -  + ]:   40671559 :   if (mt_thread_no>=0)
      52                 :          0 :     pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED,NULL);
      53                 :   40671559 : }
      54                 :            : 
      55                 :            : void
      56                 :   40671559 : mt_sigint_unblock(void)
      57                 :            : {
      58         [ -  + ]:   40671559 :   if (mt_thread_no>=0)
      59                 :          0 :     pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS,NULL);
      60                 :   40671559 : }
      61                 :            : 
      62                 :            : void
      63                 :        367 : mt_err_recover(long er)
      64                 :            : {
      65                 :            :   (void) er;
      66         [ -  + ]:        367 :   if (mt_thread_no>=0)
      67                 :            :   {
      68                 :          0 :     struct mt_pstate *mt = pari_mt;
      69                 :          0 :     struct mt_queue *mq = mt->mq+mt_thread_no;
      70                 :          0 :     LOCK(mq->pmut)
      71                 :            :     {
      72                 :          0 :       mq->output = pari_err_last();
      73                 :          0 :       pthread_cond_signal(mq->pcond);
      74                 :          0 :     } UNLOCK(mq->pmut);
      75                 :          0 :     pthread_exit((void*)1);
      76                 :            :   }
      77                 :        367 : }
      78                 :            : 
      79                 :            : void
      80                 :          0 : mt_sigint(void)
      81                 :            : {
      82         [ #  # ]:          0 :   if (pari_mt) pthread_cond_broadcast(&pari_mt->pcond);
      83                 :          0 : }
      84                 :            : 
      85                 :            : int
      86                 :     185148 : mt_is_parallel(void)
      87                 :            : {
      88                 :     185148 :   return !!pari_mt;
      89                 :            : }
      90                 :            : 
      91                 :            : int
      92                 :    5327298 : mt_is_thread(void)
      93                 :            : {
      94                 :    5327298 :   return mt_thread_no>=0;
      95                 :            : }
      96                 :            : 
      97                 :          8 : void mt_broadcast(GEN code) {(void) code;}
      98                 :            : 
      99                 :        166 : void pari_mt_init(void)
     100                 :            : {
     101                 :        166 :   pari_mt = NULL;
     102                 :            : #ifdef _SC_NPROCESSORS_CONF
     103                 :        166 :   pari_mt_nbthreads = sysconf(_SC_NPROCESSORS_CONF);
     104                 :            : #else
     105                 :            :   pari_mt_nbthreads = 1;
     106                 :            : #endif
     107                 :        166 : }
     108                 :            : 
     109                 :        166 : void pari_mt_close(void) { }
     110                 :            : 
     111                 :            : static void*
     112                 :          0 : mt_queue_run(void *arg)
     113                 :            : {
     114                 :          0 :   GEN args = pari_thread_start((struct pari_thread*) arg);
     115                 :          0 :   pari_sp av = avma;
     116                 :          0 :   struct mt_queue *mq = (struct mt_queue *) args;
     117                 :          0 :   mt_thread_no = mq->no;
     118                 :          0 :   LOCK(mq->pmut)
     119                 :            :   {
     120                 :          0 :     mq->avma = av;
     121                 :          0 :     pthread_cond_signal(mq->pcond);
     122                 :          0 :   } UNLOCK(mq->pmut);
     123                 :            :   for(;;)
     124                 :            :   {
     125                 :            :     GEN work, done;
     126                 :          0 :     LOCK(&mq->mut)
     127                 :            :     {
     128         [ #  # ]:          0 :       while(!mq->input)
     129                 :          0 :         pthread_cond_wait(&mq->cond, &mq->mut);
     130                 :          0 :     } UNLOCK(&mq->mut);
     131                 :          0 :     avma = mq->avma;
     132                 :          0 :     work = mq->input;
     133                 :          0 :     pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS,NULL);
     134                 :          0 :     done = closure_callgenvec(mq->worker,work);
     135                 :          0 :     pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED,NULL);
     136                 :          0 :     LOCK(mq->pmut)
     137                 :            :     {
     138                 :          0 :       mq->avma = av;
     139                 :          0 :       mq->input = NULL;
     140                 :          0 :       mq->output = done;
     141                 :          0 :       pthread_cond_signal(mq->pcond);
     142                 :          0 :     } UNLOCK(mq->pmut);
     143                 :          0 :   }
     144                 :            :   return NULL;
     145                 :            : }
     146                 :            : 
     147                 :            : static long
     148                 :          0 : mt_queue_check(struct mt_pstate *mt)
     149                 :            : {
     150                 :            :   long i;
     151         [ #  # ]:          0 :   for(i=0; i<mt->n; i++)
     152                 :            :   {
     153                 :          0 :     struct mt_queue *mq = mt->mq+i;
     154         [ #  # ]:          0 :     if (mq->output) return i;
     155                 :            :   }
     156                 :          0 :   return -1;
     157                 :            : }
     158                 :            : 
     159                 :            : static GEN
     160                 :          0 : mtpthread_queue_get(struct mt_state *junk, long *workid, long *pending)
     161                 :            : {
     162                 :          0 :   struct mt_pstate *mt = pari_mt;
     163                 :            :   struct mt_queue *mq;
     164                 :          0 :   GEN done = NULL;
     165                 :            :   long last;
     166                 :            :   (void) junk;
     167         [ #  # ]:          0 :   if (mt->nbint<mt->n) { mt->last = mt->nbint; *pending = mt->pending; return NULL; }
     168         [ #  # ]:          0 :   if ((last = mt_queue_check(mt)) < 0)
     169                 :            :   {
     170         [ #  # ]:          0 :     BLOCK_SIGINT_START
     171                 :          0 :     LOCK(&mt->pmut)
     172                 :            :     {
     173         [ #  # ]:          0 :       while ((last = mt_queue_check(mt)) < 0)
     174                 :            :       {
     175                 :          0 :         pthread_cond_wait(&mt->pcond, &mt->pmut);
     176         [ #  # ]:          0 :         if (PARI_SIGINT_pending)
     177                 :            :         {
     178                 :          0 :           int sig = PARI_SIGINT_pending;
     179                 :          0 :           PARI_SIGINT_pending = 0;
     180                 :          0 :           pthread_mutex_unlock(&mt->pmut);
     181                 :          0 :           PARI_SIGINT_block = 0;
     182                 :          0 :           raise(sig);
     183                 :          0 :           PARI_SIGINT_block = 1;
     184                 :          0 :           pthread_mutex_lock(&mt->pmut);
     185                 :            :         }
     186                 :            :       }
     187                 :          0 :     } UNLOCK(&mt->pmut);
     188 [ #  # ][ #  # ]:          0 :     BLOCK_SIGINT_END
                 [ #  # ]
     189                 :            :   }
     190                 :          0 :   mq = mt->mq+last;
     191         [ #  # ]:          0 :   if (mq->output==err_e_STACK) pari_err(e_STACK);
     192                 :          0 :   done = gcopy(mq->output);
     193                 :          0 :   mq->output = NULL;
     194         [ #  # ]:          0 :   if (workid) *workid = mq->workid;
     195         [ #  # ]:          0 :   if (typ(done)==t_ERROR) pari_err(0,done);
     196                 :          0 :   mt->last = last;
     197                 :          0 :   mt->pending--;
     198                 :          0 :   *pending = mt->pending;
     199                 :          0 :   return done;
     200                 :            : }
     201                 :            : 
     202                 :            : static void
     203                 :          0 : mtpthread_queue_submit(struct mt_state *junk, long workid, GEN work)
     204                 :            : {
     205                 :          0 :   struct mt_pstate *mt = pari_mt;
     206                 :          0 :   struct mt_queue *mq = mt->mq+mt->last;
     207                 :            :   (void) junk;
     208         [ #  # ]:          0 :   if (!work) { mt->nbint=mt->n; return; }
     209         [ #  # ]:          0 :   BLOCK_SIGINT_START
     210         [ #  # ]:          0 :   if (mt->nbint<mt->n)
     211                 :            :   {
     212                 :          0 :     mt->nbint++;
     213         [ #  # ]:          0 :     if (!mq->avma)
     214                 :            :     {
     215                 :          0 :       LOCK(mq->pmut)
     216                 :            :       {
     217         [ #  # ]:          0 :         while(!mq->avma)
     218                 :          0 :           pthread_cond_wait(mq->pcond, mq->pmut);
     219                 :          0 :       } UNLOCK(mq->pmut);
     220                 :            :     }
     221                 :            :   }
     222                 :          0 :   LOCK(&mq->mut)
     223                 :            :   {
     224                 :          0 :     mq->output = NULL;
     225                 :          0 :     mq->workid = workid;
     226                 :          0 :     mq->input = gcopy_avma(work, &mq->avma);
     227                 :          0 :     pthread_cond_signal(&mq->cond);
     228                 :          0 :   } UNLOCK(&mq->mut);
     229                 :          0 :   mt->pending++;
     230 [ #  # ][ #  # ]:          0 :   BLOCK_SIGINT_END
                 [ #  # ]
     231                 :            : }
     232                 :            : 
     233                 :            : void
     234                 :          0 : mt_queue_reset(void)
     235                 :            : {
     236                 :          0 :   struct mt_pstate *mt = pari_mt;
     237                 :            :   long i;
     238         [ #  # ]:          0 :   for (i=0; i<mt->n; i++)
     239                 :          0 :     pthread_cancel(mt->th[i]);
     240         [ #  # ]:          0 :   for (i=0; i<mt->n; i++)
     241                 :          0 :     pthread_join(mt->th[i],NULL);
     242         [ #  # ]:          0 :   if (DEBUGLEVEL) pari_warn(warner,"stop threads");
     243                 :          0 :   pari_mt = NULL;
     244         [ #  # ]:          0 :   for (i=0;i<mt->n;i++)
     245                 :            :   {
     246                 :          0 :     struct mt_queue *mq = mt->mq+i;
     247                 :          0 :     pthread_cond_destroy(&mq->cond);
     248                 :          0 :     pthread_mutex_destroy(&mq->mut);
     249                 :          0 :     pari_thread_free(&mt->pth[i]);
     250                 :            :   }
     251                 :          0 :   pari_free(mt->mq);
     252                 :          0 :   pari_free(mt->pth);
     253                 :          0 :   pari_free(mt->th);
     254                 :          0 :   pari_free(mt);
     255                 :          0 : }
     256                 :            : 
     257                 :            : void
     258                 :          0 : mt_queue_start(struct pari_mt *pt, GEN worker)
     259                 :            : {
     260         [ #  # ]:          0 :   if (pari_mt)
     261                 :          0 :     return mtsingle_queue_start(pt, worker);
     262                 :            :   else
     263                 :            :   {
     264                 :          0 :     long NBT = pari_mt_nbthreads;
     265                 :          0 :     struct mt_pstate *mt =
     266                 :            :            (struct mt_pstate*) pari_malloc(sizeof(struct mt_pstate));
     267         [ #  # ]:          0 :     long mtparisize = GP_DATA->threadsize? GP_DATA->threadsize: pari_mainstack->rsize;
     268                 :          0 :     long mtparisizemax = GP_DATA->threadsizemax;
     269                 :            :     long i;
     270                 :          0 :     mt->mq  = (struct mt_queue *) pari_malloc(sizeof(*mt->mq)*NBT);
     271                 :          0 :     mt->th  = (pthread_t *) pari_malloc(sizeof(*mt->th)*NBT);
     272                 :          0 :     mt->pth = (struct pari_thread *) pari_malloc(sizeof(*mt->pth)*NBT);
     273                 :          0 :     mt->pending = 0;
     274                 :          0 :     mt->n = NBT;
     275                 :          0 :     mt->nbint = 0;
     276                 :          0 :     mt->last = 0;
     277                 :          0 :     pari_mt = mt;
     278                 :          0 :     pthread_cond_init(&mt->pcond,NULL);
     279                 :          0 :     pthread_mutex_init(&mt->pmut,NULL);
     280         [ #  # ]:          0 :     for (i=0;i<NBT;i++)
     281                 :            :     {
     282                 :          0 :       struct mt_queue *mq = mt->mq+i;
     283                 :          0 :       mq->no     = i;
     284                 :          0 :       mq->avma   = 0;
     285                 :          0 :       mq->worker = worker;
     286                 :          0 :       mq->input  = NULL;
     287                 :          0 :       mq->output = NULL;
     288                 :          0 :       mq->pcond  = &mt->pcond;
     289                 :          0 :       mq->pmut   = &mt->pmut;
     290                 :          0 :       pthread_cond_init(&mq->cond,NULL);
     291                 :          0 :       pthread_mutex_init(&mq->mut,NULL);
     292         [ #  # ]:          0 :       if (mtparisizemax)
     293                 :          0 :         pari_thread_valloc(&mt->pth[i],mtparisize,mtparisizemax,(GEN)mq);
     294                 :            :       else
     295                 :          0 :         pari_thread_alloc(&mt->pth[i],mtparisize,(GEN)mq);
     296                 :            :     }
     297         [ #  # ]:          0 :     if (DEBUGLEVEL) pari_warn(warner,"start threads");
     298         [ #  # ]:          0 :     for (i=0;i<NBT;i++)
     299                 :          0 :       pthread_create(&mt->th[i],NULL, &mt_queue_run, (void*)&mt->pth[i]);
     300                 :          0 :     pt->get=&mtpthread_queue_get;
     301                 :          0 :     pt->submit=&mtpthread_queue_submit;
     302                 :          0 :     pt->end=&mt_queue_reset;
     303                 :            :   }
     304                 :            : }

Generated by: LCOV version 1.9