PostgreSQL可以被扩展来在独立进程中运行用户提供的代码。这种进程被postgres
启动、停止和监控,这使它们的生命期与服务器的状态紧密联系。这些进程具有选项可以挂接上PostgreSQL的共享内存区域,并且可以从内部连接到数据库。它们也可以连续地运行多个事务,就像一个正常的被客户端连接的服务器进程。同样,通过链接到libpq,它们可以连接到服务器并像一个正常客户端应用工作。
警告
在使用后台工作者进程时具有相当大的鲁棒性和安全性风险,因为它们由C
语言编写,对数据具有无限制的访问权。希望使用包括后台工作者进程在内的模块的管理员必须要极度小心。只有仔细审计过的模块才会被允许运行后台工作者进程。
通过将模块名放在shared_preload_libraries
中,可以在PostgreSQL被启动时初始化后台工作者。 一个希望运行后台工作者的模块需要通过在其_PG_init()
函数中调用RegisterBackgroundWorker(
来注册它。 也可以在系统启动后通过调用BackgroundWorker
*
worker
)RegisterDynamicBackgroundWorker(
来启动后台工作者。
不像只能通过postmaster调用的BackgroundWorker
*worker
, BackgroundWorkerHandle
**handle
)RegisterBackgroundWorker
,RegisterDynamicBackgroundWorker
必须从一个常规后端或其他后台工作者调用。
typedef void (*bgworker_main_type)(Datum main_arg);
typedef struct BackgroundWorker
{
char bgw_name[BGW_MAXLEN];
char bgw_type[BGW_MAXLEN];
int bgw_flags;
BgWorkerStartTime bgw_start_time;
int bgw_restart_time; /* in seconds, or BGW_NEVER_RESTART */
char bgw_library_name[BGW_MAXLEN];
char bgw_function_name[BGW_MAXLEN];
Datum bgw_main_arg;
char bgw_extra[BGW_EXTRALEN];
int bgw_notify_pid;
} BackgroundWorker;
bgw_name
和bgw_type
是要被用在日志消息、进程列表和类似环境中的字符串。对于同种类型的所有后台工作者,bgw_type
应该相同,例如这样才可能将进程列表中的这些工作组分组。另一方面,bgw_name
可以包含有关特定进程的额外信息(通常,
bgw_name
中的字符串在某种程度上也会包含类型,但是并没有严格的要求)。
bgw_flags
是一个按位与的位掩码,它用于指示模块想要的能力。可能的值是:
bgw_start_time
是服务器状态,在该状态中postgres
会启动该进程,它可以是BgWorkerStart_PostmasterStart
(在postgres
本身完成初始化之后立即启动,这种进程不能使用数据库连接)、BgWorkerStart_ConsistentState
(当一个热后备中达到一个一致性状态之后立即启动,允许进程连接到数据库并运行只读查询)和
BgWorkerStart_RecoveryFinished
(在系统进入到正常读写状态后立即启动)之一。注意后两种值在服务器不是一个热后备的情况下是等同的。注意这种设置仅仅表示何时启动进程,当一个不同状态到达时它们不会停止。
bgw_restart_time
是在崩溃情况下postgres
启动进程之前等待的时间间隔,以秒计。它可以是任何正值,或者BGW_NEVER_RESTART
,表示在出现崩溃后不重启进程。
bgw_library_name
是应该在其中定位后台工作者初始入口点的库名称。所指的库将被工作者进程动态载入并且bgw_function_name
将被用来标识要调用的函数。如果从核心代码载入一个函数,这必须被设置为"postgres"。
bgw_function_name
是一个动态载入库中的一个函数名,该函数将被用作一个新后台工作者的初始入口点。
bgw_main_arg
是后台工作者主函数的Datum
参数。这个主函数应该有一个单一的Datum
类型的参数,并且返回void
。bgw_main_arg
将被作为参数传递。此外,全局变量MyBgworkerEntry
指向注册时传入的
BackgroundWorker
结构的一份拷贝,工作者会发现检查这个结构会很有用。
在 Windows (以及任何定义了EXEC_BACKEND
的地方)上或者动态后台工作者中,用引用的方式传递Datum
是不安全的,只有传值才安全。如果要求一个参数,最安全的方式是传递一个 int32 或者其他的小型值,并且把它当做共享内存中分配的一个数组的索引来使用。如果被传递的是一个cstring
或者text
这样的值,那么在新的后台工作者进程中该指针将不会有效。
bgw_extra
可以包含要传递给后台工作者的额外数据。与bgw_main_arg
不同,这个数据不会被作为一个参数传递给工作者的主函数,而是按照上面所述通过MyBgworkerEntry
来访问。
bgw_notify_pid
是一个PostgreSQL后端进程的PID, 当后台工作者进程启动或者退出时,postmaster会向这个PID所指的进程发送SIGUSR1
。 对于在postmaster启动时注册的工作者,它应该为0;或者注册该工作者的后端不希望等待该工作者启动时,它也应该为0。否则,它应该被初始化为MyProcPid
。
一旦运行起来,进程可以通过调用BackgroundWorkerInitializeConnection(
或者char *dbname
, char *username
)BackgroundWorkerInitializeConnectionByOid(
来连接到一个数据库。这使得该进程可以使用Oid dboid
, Oid useroid
)SPI
接口运行事务和查询。 如果dbname
为NULL或者dboid
为InvalidOid
,该会话没有连接到任何特定数据库,但共享的目录可以被访问。
如果username
为NULL或者useroid
为InvalidOid
,该进程将以在initdb
阶段创建的超级用户身份运行。如果BGWORKER_BYPASS_ALLOWCONN
被指定为flags
,就可以绕过该限制连接不允许用户连接的数据库。在每一个后台进程中,只能调用两者之一,并且只能调用一次,所以不可能切换数据库。
当控制到达后台工作者的主函数时,信号初始会被阻塞,并且必须被它解除阻塞。这是为了允许进程自定义它的信号处理器。在新进程中可以通过调用BackgroundWorkerUnblockSignals
来解除对信号的阻塞,还可以通过调用BackgroundWorkerBlockSignals
来阻塞信号。
如果一个后台工作者的bgw_restart_time
被配置为 BGW_NEVER_RESTART
,或者它退出时的退出码为0,又或者它是被 TerminateBackgroundWorker
所终止,它将会被postmaster在退出时自动解除 注册。否则,它将在等待通过bgw_restart_time
配置的时间段之后被重新启动,
或者在postmaster因为一次后端失败重新初始化集簇时立刻被重启。需要临时禁止执行的后端应该使用 可中断的休眠而不是退出,这可以通过调用WaitLatch()
实现。 调用该函数时要确保WL_POSTMASTER_DEATH
标志被设置,并且验证在 postgres
本身被终止的紧急情况下产生的快速退出返回码。
当一个后台工作者是通过RegisterDynamicBackgroundWorker
函数 注册时,后端可以执行该注册以获得有关该工作者的状态信息。希望这样做的后端应该把一个 BackgroundWorkerHandle *
的地址作为第二个参数传递给 RegisterDynamicBackgroundWorker
。如果工作者被成功地注册,
这个指针将被用一个非透明句柄初始化,它之后会被传递给 GetBackgroundWorkerPid(
或者 BackgroundWorkerHandle *
, pid_t *
)TerminateBackgroundWorker(
。 BackgroundWorkerHandle *
)GetBackgroundWorkerPid
可以被用来测试工作者的状态:返回值为 BGWH_NOT_YET_STARTED
表示该工作者还未被postmaster启动; BGWH_STOPPED
表示它已经被启动但是不再运行; 而BGWH_STARTED
表示它正在运行。在最后一种情况下,PID也将被通过
第二个参数返回。 TerminateBackgroundWorker
导致postmaster发送SIGTERM
给工作者(如果它在运行),并且在它不再运行时尽快解除注册。
在某些情况下,一个注册后台工作者的进程可能希望等待该工作者启动起来。其实现方式是:把 bgw_notify_pid
初始化成MyProcPid
并且接着 把注册时得到的BackgroundWorkerHandle *
传递给 WaitForBackgroundWorkerStartup(
函数。 这个函数将阻塞直到postmaster已经尝试启动该后台工作者,或者直到postmaster死亡。如果后台 工作者正在运行,返回值将是BackgroundWorkerHandle
*handle
, pid_t *
)BGWH_STARTED
,并且其PID将被写入到所提供的地址。 否则,返回值将是BGWH_STOPPED
或者 BGWH_POSTMASTER_DIED
。
进程也可以等待一个后台工作者关闭,方法是使用WaitForBackgroundWorkerShutdown(
函数并且传入注册时得到的BackgroundWorkerHandle *handle
)BackgroundWorkerHandle *
。这个函数将阻塞直至后台工作者退出或者postmaster死掉。当后台工作者退出时,返回值是BGWH_STOPPED
,如果postmaster死掉则会返回BGWH_POSTMASTER_DIED
。
如果一个后台工作者通过服务器编程接口(SPI)用NOTIFY
命令发送异步通知,在提交外层事务之后它应该显式地调用ProcessCompletedNotifies
,这样通知才能被发送出去。如果一个后台工作者通过SPI使用LISTEN
注册为接收异步通知,它将记录那些通知,但是对于工作者来说没有程序化的方式可以拦截以及响应那些通知。
src/test/modules/worker_spi
模块包含了一个实例,它展示了一些有用的技巧。
注册的后台工作者的最大数量由max_worker_processes限制。
更多建议: