Branch data     Line data    Source code

       1                 :             : /* -------------------------------------------------------------------------
       2                 :             :  *
       3                 :             :  * pgstat_checkpointer.c
       4                 :             :  *        Implementation of checkpoint statistics.
       5                 :             :  *
       6                 :             :  * This file contains the implementation of checkpoint statistics. It is kept
       7                 :             :  * separate from pgstat.c to enforce the line between the statistics access /
       8                 :             :  * storage implementation and the details about individual types of
       9                 :             :  * statistics.
      10                 :             :  *
      11                 :             :  * Copyright (c) 2001-2026, PostgreSQL Global Development Group
      12                 :             :  *
      13                 :             :  * IDENTIFICATION
      14                 :             :  *        src/backend/utils/activity/pgstat_checkpointer.c
      15                 :             :  * -------------------------------------------------------------------------
      16                 :             :  */
      17                 :             : 
      18                 :             : #include "postgres.h"
      19                 :             : 
      20                 :             : #include "utils/memutils.h"
      21                 :             : #include "utils/pgstat_internal.h"
      22                 :             : 
      23                 :             : 
      24                 :             : PgStat_CheckpointerStats PendingCheckpointerStats = {0};
      25                 :             : 
      26                 :             : 
      27                 :             : /*
      28                 :             :  * Report checkpointer and IO statistics
      29                 :             :  */
      30                 :             : void
      31                 :           4 : pgstat_report_checkpointer(void)
      32                 :             : {
      33                 :           4 :         PgStatShared_Checkpointer *stats_shmem = &pgStatLocal.shmem->checkpointer;
      34                 :             : 
      35         [ +  - ]:           4 :         Assert(!pgStatLocal.shmem->is_shutdown);
      36                 :           4 :         pgstat_assert_is_up();
      37                 :             : 
      38                 :             :         /*
      39                 :             :          * This function can be called even if nothing at all has happened. In
      40                 :             :          * this case, avoid unnecessarily modifying the stats entry.
      41                 :             :          */
      42         [ +  + ]:           4 :         if (pg_memory_is_all_zeros(&PendingCheckpointerStats,
      43                 :             :                                                            sizeof(struct PgStat_CheckpointerStats)))
      44                 :           3 :                 return;
      45                 :             : 
      46                 :           1 :         pgstat_begin_changecount_write(&stats_shmem->changecount);
      47                 :             : 
      48                 :             : #define CHECKPOINTER_ACC(fld) stats_shmem->stats.fld += PendingCheckpointerStats.fld
      49                 :           1 :         CHECKPOINTER_ACC(num_timed);
      50                 :           1 :         CHECKPOINTER_ACC(num_requested);
      51                 :           1 :         CHECKPOINTER_ACC(num_performed);
      52                 :           1 :         CHECKPOINTER_ACC(restartpoints_timed);
      53                 :           1 :         CHECKPOINTER_ACC(restartpoints_requested);
      54                 :           1 :         CHECKPOINTER_ACC(restartpoints_performed);
      55                 :           1 :         CHECKPOINTER_ACC(write_time);
      56                 :           1 :         CHECKPOINTER_ACC(sync_time);
      57                 :           1 :         CHECKPOINTER_ACC(buffers_written);
      58                 :           1 :         CHECKPOINTER_ACC(slru_written);
      59                 :             : #undef CHECKPOINTER_ACC
      60                 :             : 
      61                 :           1 :         pgstat_end_changecount_write(&stats_shmem->changecount);
      62                 :             : 
      63                 :             :         /*
      64                 :             :          * Clear out the statistics buffer, so it can be re-used.
      65                 :             :          */
      66   [ +  -  +  -  :          12 :         MemSet(&PendingCheckpointerStats, 0, sizeof(PendingCheckpointerStats));
          +  -  -  +  +  
                      + ]
      67                 :             : 
      68                 :             :         /*
      69                 :             :          * Report IO statistics
      70                 :             :          */
      71                 :           1 :         pgstat_flush_io(false);
      72         [ -  + ]:           4 : }
      73                 :             : 
      74                 :             : /*
      75                 :             :  * pgstat_fetch_stat_checkpointer() -
      76                 :             :  *
      77                 :             :  * Support function for the SQL-callable pgstat* functions. Returns
      78                 :             :  * a pointer to the checkpointer statistics struct.
      79                 :             :  */
      80                 :             : PgStat_CheckpointerStats *
      81                 :           4 : pgstat_fetch_stat_checkpointer(void)
      82                 :             : {
      83                 :           4 :         pgstat_snapshot_fixed(PGSTAT_KIND_CHECKPOINTER);
      84                 :             : 
      85                 :           4 :         return &pgStatLocal.snapshot.checkpointer;
      86                 :             : }
      87                 :             : 
      88                 :             : void
      89                 :           6 : pgstat_checkpointer_init_shmem_cb(void *stats)
      90                 :             : {
      91                 :           6 :         PgStatShared_Checkpointer *stats_shmem = (PgStatShared_Checkpointer *) stats;
      92                 :             : 
      93                 :           6 :         LWLockInitialize(&stats_shmem->lock, LWTRANCHE_PGSTATS_DATA);
      94                 :           6 : }
      95                 :             : 
      96                 :             : void
      97                 :           2 : pgstat_checkpointer_reset_all_cb(TimestampTz ts)
      98                 :             : {
      99                 :           2 :         PgStatShared_Checkpointer *stats_shmem = &pgStatLocal.shmem->checkpointer;
     100                 :             : 
     101                 :             :         /* see explanation above PgStatShared_Checkpointer for the reset protocol */
     102                 :           2 :         LWLockAcquire(&stats_shmem->lock, LW_EXCLUSIVE);
     103                 :           4 :         pgstat_copy_changecounted_stats(&stats_shmem->reset_offset,
     104                 :           2 :                                                                         &stats_shmem->stats,
     105                 :             :                                                                         sizeof(stats_shmem->stats),
     106                 :           2 :                                                                         &stats_shmem->changecount);
     107                 :           2 :         stats_shmem->stats.stat_reset_timestamp = ts;
     108                 :           2 :         LWLockRelease(&stats_shmem->lock);
     109                 :           2 : }
     110                 :             : 
     111                 :             : void
     112                 :          11 : pgstat_checkpointer_snapshot_cb(void)
     113                 :             : {
     114                 :          11 :         PgStatShared_Checkpointer *stats_shmem = &pgStatLocal.shmem->checkpointer;
     115                 :          11 :         PgStat_CheckpointerStats *reset_offset = &stats_shmem->reset_offset;
     116                 :          11 :         PgStat_CheckpointerStats reset;
     117                 :             : 
     118                 :          11 :         pgstat_copy_changecounted_stats(&pgStatLocal.snapshot.checkpointer,
     119                 :          11 :                                                                         &stats_shmem->stats,
     120                 :             :                                                                         sizeof(stats_shmem->stats),
     121                 :          11 :                                                                         &stats_shmem->changecount);
     122                 :             : 
     123                 :          11 :         LWLockAcquire(&stats_shmem->lock, LW_SHARED);
     124                 :          11 :         memcpy(&reset, reset_offset, sizeof(stats_shmem->stats));
     125                 :          11 :         LWLockRelease(&stats_shmem->lock);
     126                 :             : 
     127                 :             :         /* compensate by reset offsets */
     128                 :             : #define CHECKPOINTER_COMP(fld) pgStatLocal.snapshot.checkpointer.fld -= reset.fld;
     129                 :          11 :         CHECKPOINTER_COMP(num_timed);
     130                 :          11 :         CHECKPOINTER_COMP(num_requested);
     131                 :          11 :         CHECKPOINTER_COMP(num_performed);
     132                 :          11 :         CHECKPOINTER_COMP(restartpoints_timed);
     133                 :          11 :         CHECKPOINTER_COMP(restartpoints_requested);
     134                 :          11 :         CHECKPOINTER_COMP(restartpoints_performed);
     135                 :          11 :         CHECKPOINTER_COMP(write_time);
     136                 :          11 :         CHECKPOINTER_COMP(sync_time);
     137                 :          11 :         CHECKPOINTER_COMP(buffers_written);
     138                 :          11 :         CHECKPOINTER_COMP(slru_written);
     139                 :             : #undef CHECKPOINTER_COMP
     140                 :          11 : }