PostgreSQL Source Code  git master
Functions
fe-trace.c File Reference
#include "postgres_fe.h"
#include <ctype.h>
#include <limits.h>
#include <sys/time.h>
#include <unistd.h>
#include "libpq-fe.h"
#include "libpq-int.h"
#include "port/pg_bswap.h"
Include dependency graph for fe-trace.c:

Go to the source code of this file.

Functions

void PQtrace (PGconn *conn, FILE *debug_port)
 
void PQuntrace (PGconn *conn)
 
void PQsetTraceFlags (PGconn *conn, int flags)
 
static void pqTraceFormatTimestamp (char *timestr, size_t ts_len)
 
static void pqTraceOutputByte1 (FILE *pfdebug, const char *data, int *cursor)
 
static int pqTraceOutputInt16 (FILE *pfdebug, const char *data, int *cursor)
 
static int pqTraceOutputInt32 (FILE *pfdebug, const char *data, int *cursor, bool suppress)
 
static void pqTraceOutputString (FILE *pfdebug, const char *data, int *cursor, bool suppress)
 
static void pqTraceOutputNchar (FILE *pfdebug, int len, const char *data, int *cursor)
 
static void pqTraceOutput_NotificationResponse (FILE *f, const char *message, int *cursor, bool regress)
 
static void pqTraceOutput_Bind (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_Close (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_CommandComplete (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_DataRow (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_Describe (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutputNR (FILE *f, const char *type, const char *message, int *cursor, bool regress)
 
static void pqTraceOutput_ErrorResponse (FILE *f, const char *message, int *cursor, bool regress)
 
static void pqTraceOutput_NoticeResponse (FILE *f, const char *message, int *cursor, bool regress)
 
static void pqTraceOutput_Execute (FILE *f, const char *message, int *cursor, bool regress)
 
static void pqTraceOutput_CopyFail (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_FunctionCall (FILE *f, const char *message, int *cursor, bool regress)
 
static void pqTraceOutput_CopyInResponse (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_CopyOutResponse (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_BackendKeyData (FILE *f, const char *message, int *cursor, bool regress)
 
static void pqTraceOutput_Parse (FILE *f, const char *message, int *cursor, bool regress)
 
static void pqTraceOutput_Query (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_Authentication (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_ParameterStatus (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_ParameterDescription (FILE *f, const char *message, int *cursor, bool regress)
 
static void pqTraceOutput_RowDescription (FILE *f, const char *message, int *cursor, bool regress)
 
static void pqTraceOutput_NegotiateProtocolVersion (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_FunctionCallResponse (FILE *f, const char *message, int *cursor)
 
static void pqTraceOutput_CopyBothResponse (FILE *f, const char *message, int *cursor, int length)
 
static void pqTraceOutput_ReadyForQuery (FILE *f, const char *message, int *cursor)
 
void pqTraceOutputMessage (PGconn *conn, const char *message, bool toServer)
 
void pqTraceOutputNoTypeByteMessage (PGconn *conn, const char *message)
 

Function Documentation

◆ PQsetTraceFlags()

void PQsetTraceFlags ( PGconn *  conn,
int  flags 
)

Definition at line 64 of file fe-trace.c.

65 {
66  if (conn == NULL)
67  return;
68  /* If PQtrace() failed, do nothing. */
69  if (conn->Pfdebug == NULL)
70  return;
71  conn->traceFlags = flags;
72 }
conn
PGconn * conn
Definition: streamutil.c:55
pg_conn::Pfdebug
FILE * Pfdebug
Definition: libpq-int.h:426
pg_conn::traceFlags
int traceFlags
Definition: libpq-int.h:427

References conn, pg_conn::Pfdebug, and pg_conn::traceFlags.

Referenced by main().

◆ PQtrace()

void PQtrace ( PGconn *  conn,
FILE *  debug_port 
)

Definition at line 35 of file fe-trace.c.

36 {
37  if (conn == NULL)
38  return;
39  PQuntrace(conn);
40  if (debug_port == NULL)
41  return;
42 
43  conn->Pfdebug = debug_port;
44  conn->traceFlags = 0;
45 }
PQuntrace
void PQuntrace(PGconn *conn)
Definition: fe-trace.c:49

References conn, pg_conn::Pfdebug, PQuntrace(), and pg_conn::traceFlags.

Referenced by main().

◆ pqTraceFormatTimestamp()

static void pqTraceFormatTimestamp ( char *  timestr,
size_t  ts_len 
)
static

Definition at line 80 of file fe-trace.c.

81 {
82  struct timeval tval;
83  time_t now;
84 
85  gettimeofday(&tval, NULL);
86 
87  /*
88  * MSVC's implementation of timeval uses a long for tv_sec, however,
89  * localtime() expects a time_t pointer. Here we'll assign tv_sec to a
90  * local time_t variable so that we pass localtime() the correct pointer
91  * type.
92  */
93  now = tval.tv_sec;
94  strftime(timestr, ts_len,
95  "%Y-%m-%d %H:%M:%S",
96  localtime(&now));
97  /* append microseconds */
98  snprintf(timestr + strlen(timestr), ts_len - strlen(timestr),
99  ".%06u", (unsigned int) (tval.tv_usec));
100 }
now
Datum now(PG_FUNCTION_ARGS)
Definition: timestamp.c:1618
snprintf
#define snprintf
Definition: port.h:238
gettimeofday
int gettimeofday(struct timeval *tp, void *tzp)
Definition: win32gettimeofday.c:53

References gettimeofday(), now(), and snprintf.

Referenced by pqTraceOutputMessage(), and pqTraceOutputNoTypeByteMessage().

◆ pqTraceOutput_Authentication()

static void pqTraceOutput_Authentication ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 428 of file fe-trace.c.

429 {
430  fprintf(f, "Authentication\t");
431  pqTraceOutputInt32(f, message, cursor, false);
432 }
pqTraceOutputInt32
static int pqTraceOutputInt32(FILE *pfdebug, const char *data, int *cursor, bool suppress)
Definition: fe-trace.c:144
fprintf
#define fprintf
Definition: port.h:242
cursor
Definition: type.h:137

References fprintf, and pqTraceOutputInt32().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_BackendKeyData()

static void pqTraceOutput_BackendKeyData ( FILE *  f,
const char *  message,
int *  cursor,
bool  regress 
)
static

Definition at line 399 of file fe-trace.c.

400 {
401  fprintf(f, "BackendKeyData\t");
402  pqTraceOutputInt32(f, message, cursor, regress);
403  pqTraceOutputInt32(f, message, cursor, regress);
404 }

References fprintf, and pqTraceOutputInt32().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Bind()

static void pqTraceOutput_Bind ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 228 of file fe-trace.c.

229 {
230  int nparams;
231 
232  fprintf(f, "Bind\t");
233  pqTraceOutputString(f, message, cursor, false);
234  pqTraceOutputString(f, message, cursor, false);
235  nparams = pqTraceOutputInt16(f, message, cursor);
236 
237  for (int i = 0; i < nparams; i++)
238  pqTraceOutputInt16(f, message, cursor);
239 
240  nparams = pqTraceOutputInt16(f, message, cursor);
241 
242  for (int i = 0; i < nparams; i++)
243  {
244  int nbytes;
245 
246  nbytes = pqTraceOutputInt32(f, message, cursor, false);
247  if (nbytes == -1)
248  continue;
249  pqTraceOutputNchar(f, nbytes, message, cursor);
250  }
251 
252  nparams = pqTraceOutputInt16(f, message, cursor);
253  for (int i = 0; i < nparams; i++)
254  pqTraceOutputInt16(f, message, cursor);
255 }
pqTraceOutputString
static void pqTraceOutputString(FILE *pfdebug, const char *data, int *cursor, bool suppress)
Definition: fe-trace.c:163
pqTraceOutputNchar
static void pqTraceOutputNchar(FILE *pfdebug, int len, const char *data, int *cursor)
Definition: fe-trace.c:188
pqTraceOutputInt16
static int pqTraceOutputInt16(FILE *pfdebug, const char *data, int *cursor)
Definition: fe-trace.c:125
i
int i
Definition: isn.c:73

References fprintf, i, pqTraceOutputInt16(), pqTraceOutputInt32(), pqTraceOutputNchar(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Close()

static void pqTraceOutput_Close ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 258 of file fe-trace.c.

259 {
260  fprintf(f, "Close\t");
261  pqTraceOutputByte1(f, message, cursor);
262  pqTraceOutputString(f, message, cursor, false);
263 }
pqTraceOutputByte1
static void pqTraceOutputByte1(FILE *pfdebug, const char *data, int *cursor)
Definition: fe-trace.c:106

References fprintf, pqTraceOutputByte1(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CommandComplete()

static void pqTraceOutput_CommandComplete ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 266 of file fe-trace.c.

267 {
268  fprintf(f, "CommandComplete\t");
269  pqTraceOutputString(f, message, cursor, false);
270 }

References fprintf, and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CopyBothResponse()

static void pqTraceOutput_CopyBothResponse ( FILE *  f,
const char *  message,
int *  cursor,
int  length 
)
static

Definition at line 494 of file fe-trace.c.

495 {
496  fprintf(f, "CopyBothResponse\t");
497  pqTraceOutputByte1(f, message, cursor);
498 
499  while (length > *cursor)
500  pqTraceOutputInt16(f, message, cursor);
501 }

References fprintf, pqTraceOutputByte1(), and pqTraceOutputInt16().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CopyFail()

static void pqTraceOutput_CopyFail ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 340 of file fe-trace.c.

341 {
342  fprintf(f, "CopyFail\t");
343  pqTraceOutputString(f, message, cursor, false);
344 }

References fprintf, and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CopyInResponse()

static void pqTraceOutput_CopyInResponse ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 373 of file fe-trace.c.

374 {
375  int nfields;
376 
377  fprintf(f, "CopyInResponse\t");
378  pqTraceOutputByte1(f, message, cursor);
379  nfields = pqTraceOutputInt16(f, message, cursor);
380 
381  for (int i = 0; i < nfields; i++)
382  pqTraceOutputInt16(f, message, cursor);
383 }

References fprintf, i, pqTraceOutputByte1(), and pqTraceOutputInt16().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_CopyOutResponse()

static void pqTraceOutput_CopyOutResponse ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 386 of file fe-trace.c.

387 {
388  int nfields;
389 
390  fprintf(f, "CopyOutResponse\t");
391  pqTraceOutputByte1(f, message, cursor);
392  nfields = pqTraceOutputInt16(f, message, cursor);
393 
394  for (int i = 0; i < nfields; i++)
395  pqTraceOutputInt16(f, message, cursor);
396 }

References fprintf, i, pqTraceOutputByte1(), and pqTraceOutputInt16().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_DataRow()

static void pqTraceOutput_DataRow ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 273 of file fe-trace.c.

274 {
275  int nfields;
276  int len;
277  int i;
278 
279  fprintf(f, "DataRow\t");
280  nfields = pqTraceOutputInt16(f, message, cursor);
281  for (i = 0; i < nfields; i++)
282  {
283  len = pqTraceOutputInt32(f, message, cursor, false);
284  if (len == -1)
285  continue;
286  pqTraceOutputNchar(f, len, message, cursor);
287  }
288 }
len
const void size_t len
Definition: pg_crc32c_sse42.c:24

References fprintf, i, len, pqTraceOutputInt16(), pqTraceOutputInt32(), and pqTraceOutputNchar().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Describe()

static void pqTraceOutput_Describe ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 291 of file fe-trace.c.

292 {
293  fprintf(f, "Describe\t");
294  pqTraceOutputByte1(f, message, cursor);
295  pqTraceOutputString(f, message, cursor, false);
296 }

References fprintf, pqTraceOutputByte1(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_ErrorResponse()

static void pqTraceOutput_ErrorResponse ( FILE *  f,
const char *  message,
int *  cursor,
bool  regress 
)
static

Definition at line 320 of file fe-trace.c.

321 {
322  pqTraceOutputNR(f, "ErrorResponse", message, cursor, regress);
323 }
pqTraceOutputNR
static void pqTraceOutputNR(FILE *f, const char *type, const char *message, int *cursor, bool regress)
Definition: fe-trace.c:300

References pqTraceOutputNR().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Execute()

static void pqTraceOutput_Execute ( FILE *  f,
const char *  message,
int *  cursor,
bool  regress 
)
static

Definition at line 332 of file fe-trace.c.

333 {
334  fprintf(f, "Execute\t");
335  pqTraceOutputString(f, message, cursor, false);
336  pqTraceOutputInt32(f, message, cursor, false);
337 }

References fprintf, pqTraceOutputInt32(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_FunctionCall()

static void pqTraceOutput_FunctionCall ( FILE *  f,
const char *  message,
int *  cursor,
bool  regress 
)
static

Definition at line 347 of file fe-trace.c.

348 {
349  int nfields;
350  int nbytes;
351 
352  fprintf(f, "FunctionCall\t");
353  pqTraceOutputInt32(f, message, cursor, regress);
354  nfields = pqTraceOutputInt16(f, message, cursor);
355 
356  for (int i = 0; i < nfields; i++)
357  pqTraceOutputInt16(f, message, cursor);
358 
359  nfields = pqTraceOutputInt16(f, message, cursor);
360 
361  for (int i = 0; i < nfields; i++)
362  {
363  nbytes = pqTraceOutputInt32(f, message, cursor, false);
364  if (nbytes == -1)
365  continue;
366  pqTraceOutputNchar(f, nbytes, message, cursor);
367  }
368 
369  pqTraceOutputInt16(f, message, cursor);
370 }

References fprintf, i, pqTraceOutputInt16(), pqTraceOutputInt32(), and pqTraceOutputNchar().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_FunctionCallResponse()

static void pqTraceOutput_FunctionCallResponse ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 483 of file fe-trace.c.

484 {
485  int len;
486 
487  fprintf(f, "FunctionCallResponse\t");
488  len = pqTraceOutputInt32(f, message, cursor, false);
489  if (len != -1)
490  pqTraceOutputNchar(f, len, message, cursor);
491 }

References fprintf, len, pqTraceOutputInt32(), and pqTraceOutputNchar().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_NegotiateProtocolVersion()

static void pqTraceOutput_NegotiateProtocolVersion ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 475 of file fe-trace.c.

476 {
477  fprintf(f, "NegotiateProtocolVersion\t");
478  pqTraceOutputInt32(f, message, cursor, false);
479  pqTraceOutputInt32(f, message, cursor, false);
480 }

References fprintf, and pqTraceOutputInt32().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_NoticeResponse()

static void pqTraceOutput_NoticeResponse ( FILE *  f,
const char *  message,
int *  cursor,
bool  regress 
)
static

Definition at line 326 of file fe-trace.c.

327 {
328  pqTraceOutputNR(f, "NoticeResponse", message, cursor, regress);
329 }

References pqTraceOutputNR().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_NotificationResponse()

static void pqTraceOutput_NotificationResponse ( FILE *  f,
const char *  message,
int *  cursor,
bool  regress 
)
static

Definition at line 219 of file fe-trace.c.

220 {
221  fprintf(f, "NotificationResponse\t");
222  pqTraceOutputInt32(f, message, cursor, regress);
223  pqTraceOutputString(f, message, cursor, false);
224  pqTraceOutputString(f, message, cursor, false);
225 }

References fprintf, pqTraceOutputInt32(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_ParameterDescription()

static void pqTraceOutput_ParameterDescription ( FILE *  f,
const char *  message,
int *  cursor,
bool  regress 
)
static

Definition at line 443 of file fe-trace.c.

444 {
445  int nfields;
446 
447  fprintf(f, "ParameterDescription\t");
448  nfields = pqTraceOutputInt16(f, message, cursor);
449 
450  for (int i = 0; i < nfields; i++)
451  pqTraceOutputInt32(f, message, cursor, regress);
452 }

References fprintf, i, pqTraceOutputInt16(), and pqTraceOutputInt32().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_ParameterStatus()

static void pqTraceOutput_ParameterStatus ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 435 of file fe-trace.c.

436 {
437  fprintf(f, "ParameterStatus\t");
438  pqTraceOutputString(f, message, cursor, false);
439  pqTraceOutputString(f, message, cursor, false);
440 }

References fprintf, and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Parse()

static void pqTraceOutput_Parse ( FILE *  f,
const char *  message,
int *  cursor,
bool  regress 
)
static

Definition at line 407 of file fe-trace.c.

408 {
409  int nparams;
410 
411  fprintf(f, "Parse\t");
412  pqTraceOutputString(f, message, cursor, false);
413  pqTraceOutputString(f, message, cursor, false);
414  nparams = pqTraceOutputInt16(f, message, cursor);
415 
416  for (int i = 0; i < nparams; i++)
417  pqTraceOutputInt32(f, message, cursor, regress);
418 }

References fprintf, i, pqTraceOutputInt16(), pqTraceOutputInt32(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_Query()

static void pqTraceOutput_Query ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 421 of file fe-trace.c.

422 {
423  fprintf(f, "Query\t");
424  pqTraceOutputString(f, message, cursor, false);
425 }

References fprintf, and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_ReadyForQuery()

static void pqTraceOutput_ReadyForQuery ( FILE *  f,
const char *  message,
int *  cursor 
)
static

Definition at line 504 of file fe-trace.c.

505 {
506  fprintf(f, "ReadyForQuery\t");
507  pqTraceOutputByte1(f, message, cursor);
508 }

References fprintf, and pqTraceOutputByte1().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutput_RowDescription()

static void pqTraceOutput_RowDescription ( FILE *  f,
const char *  message,
int *  cursor,
bool  regress 
)
static

Definition at line 455 of file fe-trace.c.

456 {
457  int nfields;
458 
459  fprintf(f, "RowDescription\t");
460  nfields = pqTraceOutputInt16(f, message, cursor);
461 
462  for (int i = 0; i < nfields; i++)
463  {
464  pqTraceOutputString(f, message, cursor, false);
465  pqTraceOutputInt32(f, message, cursor, regress);
466  pqTraceOutputInt16(f, message, cursor);
467  pqTraceOutputInt32(f, message, cursor, regress);
468  pqTraceOutputInt16(f, message, cursor);
469  pqTraceOutputInt32(f, message, cursor, false);
470  pqTraceOutputInt16(f, message, cursor);
471  }
472 }

References fprintf, i, pqTraceOutputInt16(), pqTraceOutputInt32(), and pqTraceOutputString().

Referenced by pqTraceOutputMessage().

◆ pqTraceOutputByte1()

static void pqTraceOutputByte1 ( FILE *  pfdebug,
const char *  data,
int *  cursor 
)
static

Definition at line 106 of file fe-trace.c.

107 {
108  const char *v = data + *cursor;
109 
110  /*
111  * Show non-printable data in hex format, including the terminating \0
112  * that completes ErrorResponse and NoticeResponse messages.
113  */
114  if (!isprint((unsigned char) *v))
115  fprintf(pfdebug, " \\x%02x", *v);
116  else
117  fprintf(pfdebug, " %c", *v);
118  *cursor += 1;
119 }
data
const void * data
Definition: pg_crc32c_sse42.c:23

References data, and fprintf.

Referenced by pqTraceOutput_Close(), pqTraceOutput_CopyBothResponse(), pqTraceOutput_CopyInResponse(), pqTraceOutput_CopyOutResponse(), pqTraceOutput_Describe(), pqTraceOutput_ReadyForQuery(), and pqTraceOutputNR().

◆ pqTraceOutputInt16()

static int pqTraceOutputInt16 ( FILE *  pfdebug,
const char *  data,
int *  cursor 
)
static

Definition at line 125 of file fe-trace.c.

126 {
127  uint16 tmp;
128  int result;
129 
130  memcpy(&tmp, data + *cursor, 2);
131  *cursor += 2;
132  result = (int) pg_ntoh16(tmp);
133  fprintf(pfdebug, " %d", result);
134 
135  return result;
136 }
uint16
unsigned short uint16
Definition: c.h:505
pg_ntoh16
#define pg_ntoh16(x)
Definition: pg_bswap.h:124

References data, fprintf, and pg_ntoh16.

Referenced by pqTraceOutput_Bind(), pqTraceOutput_CopyBothResponse(), pqTraceOutput_CopyInResponse(), pqTraceOutput_CopyOutResponse(), pqTraceOutput_DataRow(), pqTraceOutput_FunctionCall(), pqTraceOutput_ParameterDescription(), pqTraceOutput_Parse(), and pqTraceOutput_RowDescription().

◆ pqTraceOutputInt32()

static int pqTraceOutputInt32 ( FILE *  pfdebug,
const char *  data,
int *  cursor,
bool  suppress 
)
static

Definition at line 144 of file fe-trace.c.

145 {
146  int result;
147 
148  memcpy(&result, data + *cursor, 4);
149  *cursor += 4;
150  result = (int) pg_ntoh32(result);
151  if (suppress)
152  fprintf(pfdebug, " NNNN");
153  else
154  fprintf(pfdebug, " %d", result);
155 
156  return result;
157 }
pg_ntoh32
#define pg_ntoh32(x)
Definition: pg_bswap.h:125

References data, fprintf, and pg_ntoh32.

Referenced by pqTraceOutput_Authentication(), pqTraceOutput_BackendKeyData(), pqTraceOutput_Bind(), pqTraceOutput_DataRow(), pqTraceOutput_Execute(), pqTraceOutput_FunctionCall(), pqTraceOutput_FunctionCallResponse(), pqTraceOutput_NegotiateProtocolVersion(), pqTraceOutput_NotificationResponse(), pqTraceOutput_ParameterDescription(), pqTraceOutput_Parse(), pqTraceOutput_RowDescription(), and pqTraceOutputNoTypeByteMessage().

◆ pqTraceOutputMessage()

void pqTraceOutputMessage ( PGconn *  conn,
const char *  message,
bool  toServer 
)

Definition at line 514 of file fe-trace.c.

515 {
516  char id;
517  int length;
518  char *prefix = toServer ? "F" : "B";
519  int logCursor = 0;
520  bool regress;
521 
522  if ((conn->traceFlags & PQTRACE_SUPPRESS_TIMESTAMPS) == 0)
523  {
524  char timestr[128];
525 
526  pqTraceFormatTimestamp(timestr, sizeof(timestr));
527  fprintf(conn->Pfdebug, "%s\t", timestr);
528  }
529  regress = (conn->traceFlags & PQTRACE_REGRESS_MODE) != 0;
530 
531  id = message[logCursor++];
532 
533  memcpy(&length, message + logCursor, 4);
534  length = (int) pg_ntoh32(length);
535  logCursor += 4;
536 
537  /*
538  * In regress mode, suppress the length of ErrorResponse and
539  * NoticeResponse. The F (file name), L (line number) and R (routine
540  * name) fields can change as server code is modified, and if their
541  * lengths differ from the originals, that would break tests.
542  */
543  if (regress && !toServer && (id == PqMsg_ErrorResponse || id == PqMsg_NoticeResponse))
544  fprintf(conn->Pfdebug, "%s\tNN\t", prefix);
545  else
546  fprintf(conn->Pfdebug, "%s\t%d\t", prefix, length);
547 
548  switch (id)
549  {
550  case PqMsg_ParseComplete:
551  fprintf(conn->Pfdebug, "ParseComplete");
552  /* No message content */
553  break;
554  case PqMsg_BindComplete:
555  fprintf(conn->Pfdebug, "BindComplete");
556  /* No message content */
557  break;
558  case PqMsg_CloseComplete:
559  fprintf(conn->Pfdebug, "CloseComplete");
560  /* No message content */
561  break;
562  case PqMsg_NotificationResponse:
563  pqTraceOutput_NotificationResponse(conn->Pfdebug, message, &logCursor, regress);
564  break;
565  case PqMsg_Bind:
566  pqTraceOutput_Bind(conn->Pfdebug, message, &logCursor);
567  break;
568  case PqMsg_CopyDone:
569  fprintf(conn->Pfdebug, "CopyDone");
570  /* No message content */
571  break;
572  case PqMsg_CommandComplete:
573  /* Close(F) and CommandComplete(B) use the same identifier. */
574  Assert(PqMsg_Close == PqMsg_CommandComplete);
575  if (toServer)
576  pqTraceOutput_Close(conn->Pfdebug, message, &logCursor);
577  else
578  pqTraceOutput_CommandComplete(conn->Pfdebug, message, &logCursor);
579  break;
580  case PqMsg_CopyData:
581  /* Drop COPY data to reduce the overhead of logging. */
582  break;
583  case PqMsg_Describe:
584  /* Describe(F) and DataRow(B) use the same identifier. */
585  Assert(PqMsg_Describe == PqMsg_DataRow);
586  if (toServer)
587  pqTraceOutput_Describe(conn->Pfdebug, message, &logCursor);
588  else
589  pqTraceOutput_DataRow(conn->Pfdebug, message, &logCursor);
590  break;
591  case PqMsg_Execute:
592  /* Execute(F) and ErrorResponse(B) use the same identifier. */
593  Assert(PqMsg_Execute == PqMsg_ErrorResponse);
594  if (toServer)
595  pqTraceOutput_Execute(conn->Pfdebug, message, &logCursor, regress);
596  else
597  pqTraceOutput_ErrorResponse(conn->Pfdebug, message, &logCursor, regress);
598  break;
599  case PqMsg_CopyFail:
600  pqTraceOutput_CopyFail(conn->Pfdebug, message, &logCursor);
601  break;
602  case PqMsg_FunctionCall:
603  pqTraceOutput_FunctionCall(conn->Pfdebug, message, &logCursor, regress);
604  break;
605  case PqMsg_CopyInResponse:
606  pqTraceOutput_CopyInResponse(conn->Pfdebug, message, &logCursor);
607  break;
608  case PqMsg_Flush:
609  /* Flush(F) and CopyOutResponse(B) use the same identifier */
610  Assert(PqMsg_CopyOutResponse == PqMsg_Flush);
611  if (toServer)
612  fprintf(conn->Pfdebug, "Flush"); /* no message content */
613  else
614  pqTraceOutput_CopyOutResponse(conn->Pfdebug, message, &logCursor);
615  break;
616  case PqMsg_EmptyQueryResponse:
617  fprintf(conn->Pfdebug, "EmptyQueryResponse");
618  /* No message content */
619  break;
620  case PqMsg_BackendKeyData:
621  pqTraceOutput_BackendKeyData(conn->Pfdebug, message, &logCursor, regress);
622  break;
623  case PqMsg_NoData:
624  fprintf(conn->Pfdebug, "NoData");
625  /* No message content */
626  break;
627  case PqMsg_NoticeResponse:
628  pqTraceOutput_NoticeResponse(conn->Pfdebug, message, &logCursor, regress);
629  break;
630  case PqMsg_Parse:
631  pqTraceOutput_Parse(conn->Pfdebug, message, &logCursor, regress);
632  break;
633  case PqMsg_Query:
634  pqTraceOutput_Query(conn->Pfdebug, message, &logCursor);
635  break;
636  case PqMsg_AuthenticationRequest:
637  pqTraceOutput_Authentication(conn->Pfdebug, message, &logCursor);
638  break;
639  case PqMsg_PortalSuspended:
640  fprintf(conn->Pfdebug, "PortalSuspended");
641  /* No message content */
642  break;
643  case PqMsg_Sync:
644  /* ParameterStatus(B) and Sync(F) use the same identifier */
645  Assert(PqMsg_ParameterStatus == PqMsg_Sync);
646  if (toServer)
647  fprintf(conn->Pfdebug, "Sync"); /* no message content */
648  else
649  pqTraceOutput_ParameterStatus(conn->Pfdebug, message, &logCursor);
650  break;
651  case PqMsg_ParameterDescription:
652  pqTraceOutput_ParameterDescription(conn->Pfdebug, message, &logCursor, regress);
653  break;
654  case PqMsg_RowDescription:
655  pqTraceOutput_RowDescription(conn->Pfdebug, message, &logCursor, regress);
656  break;
657  case PqMsg_NegotiateProtocolVersion:
658  pqTraceOutput_NegotiateProtocolVersion(conn->Pfdebug, message, &logCursor);
659  break;
660  case PqMsg_FunctionCallResponse:
661  pqTraceOutput_FunctionCallResponse(conn->Pfdebug, message, &logCursor);
662  break;
663  case PqMsg_CopyBothResponse:
664  pqTraceOutput_CopyBothResponse(conn->Pfdebug, message, &logCursor, length);
665  break;
666  case PqMsg_Terminate:
667  fprintf(conn->Pfdebug, "Terminate");
668  /* No message content */
669  break;
670  case PqMsg_ReadyForQuery:
671  pqTraceOutput_ReadyForQuery(conn->Pfdebug, message, &logCursor);
672  break;
673  default:
674  fprintf(conn->Pfdebug, "Unknown message: %02x", id);
675  break;
676  }
677 
678  fputc('\n', conn->Pfdebug);
679 
680  /*
681  * Verify the printing routine did it right. Note that the one-byte
682  * message identifier is not included in the length, but our cursor does
683  * include it.
684  */
685  if (logCursor - 1 != length)
686  fprintf(conn->Pfdebug,
687  "mismatched message length: consumed %d, expected %d\n",
688  logCursor - 1, length);
689 }
Assert
#define Assert(condition)
Definition: c.h:858
pqTraceOutput_RowDescription
static void pqTraceOutput_RowDescription(FILE *f, const char *message, int *cursor, bool regress)
Definition: fe-trace.c:455
pqTraceOutput_FunctionCall
static void pqTraceOutput_FunctionCall(FILE *f, const char *message, int *cursor, bool regress)
Definition: fe-trace.c:347
pqTraceOutput_CopyInResponse
static void pqTraceOutput_CopyInResponse(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:373
pqTraceOutput_BackendKeyData
static void pqTraceOutput_BackendKeyData(FILE *f, const char *message, int *cursor, bool regress)
Definition: fe-trace.c:399
pqTraceOutput_Parse
static void pqTraceOutput_Parse(FILE *f, const char *message, int *cursor, bool regress)
Definition: fe-trace.c:407
pqTraceOutput_NoticeResponse
static void pqTraceOutput_NoticeResponse(FILE *f, const char *message, int *cursor, bool regress)
Definition: fe-trace.c:326
pqTraceOutput_ParameterDescription
static void pqTraceOutput_ParameterDescription(FILE *f, const char *message, int *cursor, bool regress)
Definition: fe-trace.c:443
pqTraceOutput_DataRow
static void pqTraceOutput_DataRow(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:273
pqTraceOutput_Query
static void pqTraceOutput_Query(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:421
pqTraceOutput_NegotiateProtocolVersion
static void pqTraceOutput_NegotiateProtocolVersion(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:475
pqTraceOutput_CopyBothResponse
static void pqTraceOutput_CopyBothResponse(FILE *f, const char *message, int *cursor, int length)
Definition: fe-trace.c:494
pqTraceOutput_Bind
static void pqTraceOutput_Bind(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:228
pqTraceOutput_ErrorResponse
static void pqTraceOutput_ErrorResponse(FILE *f, const char *message, int *cursor, bool regress)
Definition: fe-trace.c:320
pqTraceOutput_Close
static void pqTraceOutput_Close(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:258
pqTraceOutput_Authentication
static void pqTraceOutput_Authentication(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:428
pqTraceOutput_Describe
static void pqTraceOutput_Describe(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:291
pqTraceOutput_NotificationResponse
static void pqTraceOutput_NotificationResponse(FILE *f, const char *message, int *cursor, bool regress)
Definition: fe-trace.c:219
pqTraceOutput_CommandComplete
static void pqTraceOutput_CommandComplete(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:266
pqTraceOutput_ParameterStatus
static void pqTraceOutput_ParameterStatus(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:435
pqTraceOutput_Execute
static void pqTraceOutput_Execute(FILE *f, const char *message, int *cursor, bool regress)
Definition: fe-trace.c:332
pqTraceOutput_CopyOutResponse
static void pqTraceOutput_CopyOutResponse(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:386
pqTraceOutput_ReadyForQuery
static void pqTraceOutput_ReadyForQuery(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:504
pqTraceFormatTimestamp
static void pqTraceFormatTimestamp(char *timestr, size_t ts_len)
Definition: fe-trace.c:80
pqTraceOutput_CopyFail
static void pqTraceOutput_CopyFail(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:340
pqTraceOutput_FunctionCallResponse
static void pqTraceOutput_FunctionCallResponse(FILE *f, const char *message, int *cursor)
Definition: fe-trace.c:483
PQTRACE_SUPPRESS_TIMESTAMPS
#define PQTRACE_SUPPRESS_TIMESTAMPS
Definition: libpq-fe.h:442
PQTRACE_REGRESS_MODE
#define PQTRACE_REGRESS_MODE
Definition: libpq-fe.h:444
PqMsg_CloseComplete
#define PqMsg_CloseComplete
Definition: protocol.h:40
PqMsg_CopyDone
#define PqMsg_CopyDone
Definition: protocol.h:64
PqMsg_NotificationResponse
#define PqMsg_NotificationResponse
Definition: protocol.h:41
PqMsg_BindComplete
#define PqMsg_BindComplete
Definition: protocol.h:39
PqMsg_CopyData
#define PqMsg_CopyData
Definition: protocol.h:65
PqMsg_ParameterDescription
#define PqMsg_ParameterDescription
Definition: protocol.h:58
PqMsg_FunctionCall
#define PqMsg_FunctionCall
Definition: protocol.h:23
PqMsg_Describe
#define PqMsg_Describe
Definition: protocol.h:21
PqMsg_FunctionCallResponse
#define PqMsg_FunctionCallResponse
Definition: protocol.h:53
PqMsg_ReadyForQuery
#define PqMsg_ReadyForQuery
Definition: protocol.h:55
PqMsg_AuthenticationRequest
#define PqMsg_AuthenticationRequest
Definition: protocol.h:50
PqMsg_CopyInResponse
#define PqMsg_CopyInResponse
Definition: protocol.h:45
PqMsg_EmptyQueryResponse
#define PqMsg_EmptyQueryResponse
Definition: protocol.h:47
PqMsg_RowDescription
#define PqMsg_RowDescription
Definition: protocol.h:52
PqMsg_CopyBothResponse
#define PqMsg_CopyBothResponse
Definition: protocol.h:54
PqMsg_ParameterStatus
#define PqMsg_ParameterStatus
Definition: protocol.h:51
PqMsg_NoData
#define PqMsg_NoData
Definition: protocol.h:56
PqMsg_NegotiateProtocolVersion
#define PqMsg_NegotiateProtocolVersion
Definition: protocol.h:59
PqMsg_PortalSuspended
#define PqMsg_PortalSuspended
Definition: protocol.h:57
PqMsg_Parse
#define PqMsg_Parse
Definition: protocol.h:25
PqMsg_Bind
#define PqMsg_Bind
Definition: protocol.h:19
PqMsg_Sync
#define PqMsg_Sync
Definition: protocol.h:27
PqMsg_CopyFail
#define PqMsg_CopyFail
Definition: protocol.h:29
PqMsg_Flush
#define PqMsg_Flush
Definition: protocol.h:24
PqMsg_BackendKeyData
#define PqMsg_BackendKeyData
Definition: protocol.h:48
PqMsg_CommandComplete
#define PqMsg_CommandComplete
Definition: protocol.h:42
PqMsg_Query
#define PqMsg_Query
Definition: protocol.h:26
PqMsg_ErrorResponse
#define PqMsg_ErrorResponse
Definition: protocol.h:44
PqMsg_DataRow
#define PqMsg_DataRow
Definition: protocol.h:43
PqMsg_NoticeResponse
#define PqMsg_NoticeResponse
Definition: protocol.h:49
PqMsg_Terminate
#define PqMsg_Terminate
Definition: protocol.h:28
PqMsg_Execute
#define PqMsg_Execute
Definition: protocol.h:22
PqMsg_Close
#define PqMsg_Close
Definition: protocol.h:20
PqMsg_CopyOutResponse
#define PqMsg_CopyOutResponse
Definition: protocol.h:46
PqMsg_ParseComplete
#define PqMsg_ParseComplete
Definition: protocol.h:38

References Assert, conn, fprintf, pg_conn::Pfdebug, pg_ntoh32, PqMsg_AuthenticationRequest, PqMsg_BackendKeyData, PqMsg_Bind, PqMsg_BindComplete, PqMsg_Close, PqMsg_CloseComplete, PqMsg_CommandComplete, PqMsg_CopyBothResponse, PqMsg_CopyData, PqMsg_CopyDone, PqMsg_CopyFail, PqMsg_CopyInResponse, PqMsg_CopyOutResponse, PqMsg_DataRow, PqMsg_Describe, PqMsg_EmptyQueryResponse, PqMsg_ErrorResponse, PqMsg_Execute, PqMsg_Flush, PqMsg_FunctionCall, PqMsg_FunctionCallResponse, PqMsg_NegotiateProtocolVersion, PqMsg_NoData, PqMsg_NoticeResponse, PqMsg_NotificationResponse, PqMsg_ParameterDescription, PqMsg_ParameterStatus, PqMsg_Parse, PqMsg_ParseComplete, PqMsg_PortalSuspended, PqMsg_Query, PqMsg_ReadyForQuery, PqMsg_RowDescription, PqMsg_Sync, PqMsg_Terminate, PQTRACE_REGRESS_MODE, PQTRACE_SUPPRESS_TIMESTAMPS, pqTraceFormatTimestamp(), pqTraceOutput_Authentication(), pqTraceOutput_BackendKeyData(), pqTraceOutput_Bind(), pqTraceOutput_Close(), pqTraceOutput_CommandComplete(), pqTraceOutput_CopyBothResponse(), pqTraceOutput_CopyFail(), pqTraceOutput_CopyInResponse(), pqTraceOutput_CopyOutResponse(), pqTraceOutput_DataRow(), pqTraceOutput_Describe(), pqTraceOutput_ErrorResponse(), pqTraceOutput_Execute(), pqTraceOutput_FunctionCall(), pqTraceOutput_FunctionCallResponse(), pqTraceOutput_NegotiateProtocolVersion(), pqTraceOutput_NoticeResponse(), pqTraceOutput_NotificationResponse(), pqTraceOutput_ParameterDescription(), pqTraceOutput_ParameterStatus(), pqTraceOutput_Parse(), pqTraceOutput_Query(), pqTraceOutput_ReadyForQuery(), pqTraceOutput_RowDescription(), and pg_conn::traceFlags.

Referenced by getCopyDataMessage(), pqFunctionCall3(), pqParseInput3(), and pqPutMsgEnd().

◆ pqTraceOutputNchar()

static void pqTraceOutputNchar ( FILE *  pfdebug,
int  len,
const char *  data,
int *  cursor 
)
static

Definition at line 188 of file fe-trace.c.

189 {
190  int i,
191  next; /* first char not yet printed */
192  const char *v = data + *cursor;
193 
194  fprintf(pfdebug, " \'");
195 
196  for (next = i = 0; i < len; ++i)
197  {
198  if (isprint((unsigned char) v[i]))
199  continue;
200  else
201  {
202  fwrite(v + next, 1, i - next, pfdebug);
203  fprintf(pfdebug, "\\x%02x", v[i]);
204  next = i + 1;
205  }
206  }
207  if (next < len)
208  fwrite(v + next, 1, len - next, pfdebug);
209 
210  fprintf(pfdebug, "\'");
211  *cursor += len;
212 }
next
static int32 next
Definition: blutils.c:221

References data, fprintf, i, len, and next.

Referenced by pqTraceOutput_Bind(), pqTraceOutput_DataRow(), pqTraceOutput_FunctionCall(), and pqTraceOutput_FunctionCallResponse().

◆ pqTraceOutputNoTypeByteMessage()

void pqTraceOutputNoTypeByteMessage ( PGconn *  conn,
const char *  message 
)

Definition at line 696 of file fe-trace.c.

697 {
698  int length;
699  int logCursor = 0;
700 
701  if ((conn->traceFlags & PQTRACE_SUPPRESS_TIMESTAMPS) == 0)
702  {
703  char timestr[128];
704 
705  pqTraceFormatTimestamp(timestr, sizeof(timestr));
706  fprintf(conn->Pfdebug, "%s\t", timestr);
707  }
708 
709  memcpy(&length, message + logCursor, 4);
710  length = (int) pg_ntoh32(length);
711  logCursor += 4;
712 
713  fprintf(conn->Pfdebug, "F\t%d\t", length);
714 
715  switch (length)
716  {
717  case 16: /* CancelRequest */
718  fprintf(conn->Pfdebug, "CancelRequest\t");
719  pqTraceOutputInt32(conn->Pfdebug, message, &logCursor, false);
720  pqTraceOutputInt32(conn->Pfdebug, message, &logCursor, false);
721  pqTraceOutputInt32(conn->Pfdebug, message, &logCursor, false);
722  break;
723  case 8: /* GSSENCRequest or SSLRequest */
724  /* These messages do not reach here. */
725  default:
726  fprintf(conn->Pfdebug, "Unknown message: length is %d", length);
727  break;
728  }
729 
730  fputc('\n', conn->Pfdebug);
731 }

References conn, fprintf, pg_conn::Pfdebug, pg_ntoh32, PQTRACE_SUPPRESS_TIMESTAMPS, pqTraceFormatTimestamp(), pqTraceOutputInt32(), and pg_conn::traceFlags.

Referenced by pqPutMsgEnd().

◆ pqTraceOutputNR()

static void pqTraceOutputNR ( FILE *  f,
const char *  type,
const char *  message,
int *  cursor,
bool  regress 
)
static

Definition at line 300 of file fe-trace.c.

302 {
303  fprintf(f, "%s\t", type);
304  for (;;)
305  {
306  char field;
307  bool suppress;
308 
309  pqTraceOutputByte1(f, message, cursor);
310  field = message[*cursor - 1];
311  if (field == '\0')
312  break;
313 
314  suppress = regress && (field == 'L' || field == 'F' || field == 'R');
315  pqTraceOutputString(f, message, cursor, suppress);
316  }
317 }
type
const char * type
Definition: wait_event_funcs.c:27

References fprintf, pqTraceOutputByte1(), pqTraceOutputString(), and type.

Referenced by pqTraceOutput_ErrorResponse(), and pqTraceOutput_NoticeResponse().

◆ pqTraceOutputString()

static void pqTraceOutputString ( FILE *  pfdebug,
const char *  data,
int *  cursor,
bool  suppress 
)
static

Definition at line 163 of file fe-trace.c.

164 {
165  int len;
166 
167  if (suppress)
168  {
169  fprintf(pfdebug, " \"SSSS\"");
170  *cursor += strlen(data + *cursor) + 1;
171  }
172  else
173  {
174  len = fprintf(pfdebug, " \"%s\"", data + *cursor);
175 
176  /*
177  * This is a null-terminated string. So add 1 after subtracting 3
178  * which is the double quotes and space length from len.
179  */
180  *cursor += (len - 3 + 1);
181  }
182 }

References data, fprintf, and len.

Referenced by pqTraceOutput_Bind(), pqTraceOutput_Close(), pqTraceOutput_CommandComplete(), pqTraceOutput_CopyFail(), pqTraceOutput_Describe(), pqTraceOutput_Execute(), pqTraceOutput_NotificationResponse(), pqTraceOutput_ParameterStatus(), pqTraceOutput_Parse(), pqTraceOutput_Query(), pqTraceOutput_RowDescription(), and pqTraceOutputNR().

◆ PQuntrace()

void PQuntrace ( PGconn *  conn)

Definition at line 49 of file fe-trace.c.

50 {
51  if (conn == NULL)
52  return;
53  if (conn->Pfdebug)
54  {
55  fflush(conn->Pfdebug);
56  conn->Pfdebug = NULL;
57  }
58 
59  conn->traceFlags = 0;
60 }
fflush
static void const char fflush(stdout)

References conn, fflush(), pg_conn::Pfdebug, and pg_conn::traceFlags.

Referenced by PQtrace().