socket_timeout_v7.patch
application/octet-stream
Filename: socket_timeout_v7.patch
Type: application/octet-stream
Part: 2
Message:
RE: Timeout parameters
Patch
Format: unified
Series: patch v7
| File | + | − |
|---|---|---|
| doc/src/sgml/libpq.sgml | 14 | 0 |
| src/interfaces/libpq/fe-connect.c | 22 | 0 |
| src/interfaces/libpq/fe-misc.c | 27 | 0 |
| src/interfaces/libpq/libpq-int.h | 2 | 0 |
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index c1d1b6b2db..5ab0325eb5 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -1249,6 +1249,20 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
</listitem>
</varlistentry>
+ <varlistentry id="socket_timeout" xreflabel="socket_timeout">
+ <term><literal>socket_timeout</literal></term>
+ <listitem>
+ <para>
+ Controls the number of second (write as a decimal integer, e.g. 10) of
+ client's waiting time for individual socket read/write operations before
+ closing the connection. This can be used both as a force global query
+ timeout and network problems detector. A value of zero (the default) turns
+ this off, which means wait indefinitely. The minimum allowed timeout is 2
+ seconds, so a value of 1 is interpreted as 2.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry id="libpq-connect-tty" xreflabel="tty">
<term><literal>tty</literal></term>
<listitem>
diff --git a/src/interfaces/libpq/fe-connect.c b/src/interfaces/libpq/fe-connect.c
index c96a52bb1b..e9448f7e08 100644
--- a/src/interfaces/libpq/fe-connect.c
+++ b/src/interfaces/libpq/fe-connect.c
@@ -208,6 +208,10 @@ static const internalPQconninfoOption PQconninfoOptions[] = {
"Connect-timeout", "", 10, /* strlen(INT32_MAX) == 10 */
offsetof(struct pg_conn, connect_timeout)},
+ {"socket_timeout", NULL, NULL, NULL,
+ "Socket-timeout", "", 10, /* strlen(INT32_MAX) == 10 */
+ offsetof(struct pg_conn, pgsocket_timeout)},
+
{"dbname", "PGDATABASE", NULL, NULL,
"Database-Name", "", 20,
offsetof(struct pg_conn, dbName)},
@@ -405,6 +409,8 @@ static char *passwordFromFile(const char *hostname, const char *port, const char
const char *username, const char *pgpassfile);
static void pgpassfileWarning(PGconn *conn);
static void default_threadlock(int acquire);
+static bool parse_int_param(const char *value, int *result, PGconn *conn,
+ const char *context);
/* global variable because fe-auth.c needs to access it */
@@ -1234,6 +1240,20 @@ connectOptions2(PGconn *conn)
goto oom_error;
}
+ if (conn->pgsocket_timeout)
+ {
+ if (parse_int_param(conn->pgsocket_timeout,
+ &conn->socket_timeout, conn, "socket_timeout"))
+ {
+ /*
+ * Rounding could cause communication to fail;
+ * insist on at least two seconds.
+ */
+ if(conn->socket_timeout > 0 && conn->socket_timeout < 2)
+ conn->socket_timeout = 2;
+ }
+ }
+
/*
* Validate target_session_attrs option.
*/
@@ -3651,6 +3671,8 @@ freePGconn(PGconn *conn)
free(conn->pgtty);
if (conn->connect_timeout)
free(conn->connect_timeout);
+ if (conn->pgsocket_timeout)
+ free(conn->pgsocket_timeout);
if (conn->pgoptions)
free(conn->pgoptions);
if (conn->appname)
diff --git a/src/interfaces/libpq/fe-misc.c b/src/interfaces/libpq/fe-misc.c
index e5ef8d44bd..59f047e732 100644
--- a/src/interfaces/libpq/fe-misc.c
+++ b/src/interfaces/libpq/fe-misc.c
@@ -983,6 +983,33 @@ pqFlush(PGconn *conn)
int
pqWait(int forRead, int forWrite, PGconn *conn)
{
+ int result;
+
+ if (conn->socket_timeout > 0)
+ {
+ time_t finish_time;
+
+ /* calculate the finish time based on start + timeout */
+ finish_time = time(NULL) + conn->socket_timeout;
+ result = pqSocketCheck(conn, forRead, forWrite, finish_time);
+
+ if (result < 0)
+ return EOF;
+
+ if (result == 0)
+ {
+ printfPQExpBuffer(&conn->errorMessage,
+ libpq_gettext("timeout expired\n"));
+ conn->status = CONNECTION_BAD;
+ pqsecure_close(conn);
+ closesocket(conn->sock);
+ conn->sock = -1;
+ return EOF;
+ }
+
+ return 0;
+ }
+
return pqWaitTimed(forRead, forWrite, conn, (time_t) -1);
}
diff --git a/src/interfaces/libpq/libpq-int.h b/src/interfaces/libpq/libpq-int.h
index 4a93d8edbc..816ebda4dc 100644
--- a/src/interfaces/libpq/libpq-int.h
+++ b/src/interfaces/libpq/libpq-int.h
@@ -336,6 +336,7 @@ struct pg_conn
char *pgtty; /* tty on which the backend messages is
* displayed (OBSOLETE, NOT USED) */
char *connect_timeout; /* connection timeout (numeric string) */
+ char *pgsocket_timeout; /* socket timeout (numeric string) */
char *client_encoding_initial; /* encoding to use */
char *pgoptions; /* options to start the backend with */
char *appname; /* application name */
@@ -500,6 +501,7 @@ struct pg_conn
/* Buffer for receiving various parts of messages */
PQExpBufferData workBuffer; /* expansible string */
+ int socket_timeout; /* socket timeout (numeric)*/
};
/* PGcancel stores all data necessary to cancel a connection. A copy of this