PostgreSQL Source Code git master
fe-protocol3.c
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * fe-protocol3.c
4 * functions that are specific to frontend/backend protocol version 3
5 *
6 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
8 *
9 *
10 * IDENTIFICATION
11 * src/interfaces/libpq/fe-protocol3.c
12 *
13 *-------------------------------------------------------------------------
14 */
15#include "postgres_fe.h"
16
17#include <ctype.h>
18#include <fcntl.h>
19#include <limits.h>
20
21#ifdef WIN32
22#include "win32.h"
23#else
24#include <unistd.h>
25#include <netinet/tcp.h>
26#endif
27
28#include "common/int.h"
29#include "libpq-fe.h"
30#include "libpq-int.h"
31#include "mb/pg_wchar.h"
32#include "port/pg_bswap.h"
33
34/*
35 * This macro lists the backend message types that could be "long" (more
36 * than a couple of kilobytes).
37 */
38#define VALID_LONG_MESSAGE_TYPE(id) \
39 ((id) == PqMsg_CopyData || \
40 (id) == PqMsg_DataRow || \
41 (id) == PqMsg_ErrorResponse || \
42 (id) == PqMsg_FunctionCallResponse || \
43 (id) == PqMsg_NoticeResponse || \
44 (id) == PqMsg_NotificationResponse || \
45 (id) == PqMsg_RowDescription)
46
47
48static void handleFatalError(PGconn *conn);
49static void handleSyncLoss(PGconn *conn, char id, int msgLength);
50static int getRowDescriptions(PGconn *conn, int msgLength);
51static int getParamDescriptions(PGconn *conn, int msgLength);
52static int getAnotherTuple(PGconn *conn, int msgLength);
53static int getParameterStatus(PGconn *conn);
54static int getBackendKeyData(PGconn *conn, int msgLength);
55static int getNotify(PGconn *conn);
56static int getCopyStart(PGconn *conn, ExecStatusType copytype);
57static int getReadyForQuery(PGconn *conn);
58static void reportErrorPosition(PQExpBuffer msg, const char *query,
59 int loc, int encoding);
60static size_t build_startup_packet(const PGconn *conn, char *packet,
62
63
64/*
65 * parseInput: if appropriate, parse input data from backend
66 * until input is exhausted or a stopping state is reached.
67 * Note that this function will NOT attempt to read more data from the backend.
68 */
69void
71{
72 char id;
73 int msgLength;
74 int avail;
75
76 /*
77 * Loop to parse successive complete messages available in the buffer.
78 */
79 for (;;)
80 {
81 /*
82 * Try to read a message. First get the type code and length. Return
83 * if not enough data.
84 */
86 if (pqGetc(&id, conn))
87 return;
88 if (pqGetInt(&msgLength, 4, conn))
89 return;
90
91 /*
92 * Try to validate message type/length here. A length less than 4 is
93 * definitely broken. Large lengths should only be believed for a few
94 * message types.
95 */
96 if (msgLength < 4)
97 {
98 handleSyncLoss(conn, id, msgLength);
99 return;
100 }
101 if (msgLength > 30000 && !VALID_LONG_MESSAGE_TYPE(id))
102 {
103 handleSyncLoss(conn, id, msgLength);
104 return;
105 }
106
107 /*
108 * Can't process if message body isn't all here yet.
109 */
110 msgLength -= 4;
111 avail = conn->inEnd - conn->inCursor;
112 if (avail < msgLength)
113 {
114 /*
115 * Before returning, enlarge the input buffer if needed to hold
116 * the whole message. This is better than leaving it to
117 * pqReadData because we can avoid multiple cycles of realloc()
118 * when the message is large; also, we can implement a reasonable
119 * recovery strategy if we are unable to make the buffer big
120 * enough.
121 */
122 if (pqCheckInBufferSpace(conn->inCursor + (size_t) msgLength,
123 conn))
124 {
125 /*
126 * Abandon the connection. There's not much else we can
127 * safely do; we can't just ignore the message or we could
128 * miss important changes to the connection state.
129 * pqCheckInBufferSpace() already reported the error.
130 */
132 }
133 return;
134 }
135
136 /*
137 * NOTIFY and NOTICE messages can happen in any state; always process
138 * them right away.
139 *
140 * Most other messages should only be processed while in BUSY state.
141 * (In particular, in READY state we hold off further parsing until
142 * the application collects the current PGresult.)
143 *
144 * However, if the state is IDLE then we got trouble; we need to deal
145 * with the unexpected message somehow.
146 *
147 * ParameterStatus ('S') messages are a special case: in IDLE state we
148 * must process 'em (this case could happen if a new value was adopted
149 * from config file due to SIGHUP), but otherwise we hold off until
150 * BUSY state.
151 */
153 {
154 if (getNotify(conn))
155 return;
156 }
157 else if (id == PqMsg_NoticeResponse)
158 {
159 if (pqGetErrorNotice3(conn, false))
160 return;
161 }
162 else if (conn->asyncStatus != PGASYNC_BUSY)
163 {
164 /* If not IDLE state, just wait ... */
166 return;
167
168 /*
169 * Unexpected message in IDLE state; need to recover somehow.
170 * ERROR messages are handled using the notice processor;
171 * ParameterStatus is handled normally; anything else is just
172 * dropped on the floor after displaying a suitable warning
173 * notice. (An ERROR is very possibly the backend telling us why
174 * it is about to close the connection, so we don't want to just
175 * discard it...)
176 */
177 if (id == PqMsg_ErrorResponse)
178 {
179 if (pqGetErrorNotice3(conn, false /* treat as notice */ ))
180 return;
181 }
182 else if (id == PqMsg_ParameterStatus)
183 {
185 return;
186 }
187 else
188 {
189 /* Any other case is unexpected and we summarily skip it */
191 "message type 0x%02x arrived from server while idle",
192 id);
193 /* Discard the unexpected message */
194 conn->inCursor += msgLength;
195 }
196 }
197 else
198 {
199 /*
200 * In BUSY state, we can process everything.
201 */
202 switch (id)
203 {
205 if (pqGets(&conn->workBuffer, conn))
206 return;
208 {
211 if (!conn->result)
212 {
213 libpq_append_conn_error(conn, "out of memory");
215 }
216 }
217 if (conn->result)
221 break;
223 if (pqGetErrorNotice3(conn, true))
224 return;
226 break;
229 return;
231 {
234 if (!conn->result)
235 {
236 libpq_append_conn_error(conn, "out of memory");
238 }
239 else
240 {
243 }
244 }
245 else
246 {
247 /* Advance the command queue and set us idle */
248 pqCommandQueueAdvance(conn, true, false);
250 }
251 break;
254 {
257 if (!conn->result)
258 {
259 libpq_append_conn_error(conn, "out of memory");
261 }
262 }
264 break;
266 /* If we're doing PQprepare, we're done; else ignore */
267 if (conn->cmd_queue_head &&
269 {
271 {
274 if (!conn->result)
275 {
276 libpq_append_conn_error(conn, "out of memory");
278 }
279 }
281 }
282 break;
284 /* Nothing to do for this message type */
285 break;
287 /* If we're doing PQsendClose, we're done; else ignore */
288 if (conn->cmd_queue_head &&
290 {
292 {
295 if (!conn->result)
296 {
297 libpq_append_conn_error(conn, "out of memory");
299 }
300 }
302 }
303 break;
306 return;
307 break;
309
310 /*
311 * This is expected only during backend startup, but it's
312 * just as easy to handle it as part of the main loop.
313 * Save the data and continue processing.
314 */
315 if (getBackendKeyData(conn, msgLength))
316 return;
317 break;
319 if (conn->error_result ||
320 (conn->result != NULL &&
322 {
323 /*
324 * We've already choked for some reason. Just discard
325 * the data till we get to the end of the query.
326 */
327 conn->inCursor += msgLength;
328 }
329 else if (conn->result == NULL ||
332 {
333 /* First 'T' in a query sequence */
334 if (getRowDescriptions(conn, msgLength))
335 return;
336 }
337 else
338 {
339 /*
340 * A new 'T' message is treated as the start of
341 * another PGresult. (It is not clear that this is
342 * really possible with the current backend.) We stop
343 * parsing until the application accepts the current
344 * result.
345 */
347 return;
348 }
349 break;
350 case PqMsg_NoData:
351
352 /*
353 * NoData indicates that we will not be seeing a
354 * RowDescription message because the statement or portal
355 * inquired about doesn't return rows.
356 *
357 * If we're doing a Describe, we have to pass something
358 * back to the client, so set up a COMMAND_OK result,
359 * instead of PGRES_TUPLES_OK. Otherwise we can just
360 * ignore this message.
361 */
362 if (conn->cmd_queue_head &&
364 {
366 {
369 if (!conn->result)
370 {
371 libpq_append_conn_error(conn, "out of memory");
373 }
374 }
376 }
377 break;
379 if (getParamDescriptions(conn, msgLength))
380 return;
381 break;
382 case PqMsg_DataRow:
383 if (conn->result != NULL &&
386 {
387 /* Read another tuple of a normal query response */
388 if (getAnotherTuple(conn, msgLength))
389 return;
390 }
391 else if (conn->error_result ||
392 (conn->result != NULL &&
394 {
395 /*
396 * We've already choked for some reason. Just discard
397 * tuples till we get to the end of the query.
398 */
399 conn->inCursor += msgLength;
400 }
401 else
402 {
403 /* Set up to report error at end of query */
404 libpq_append_conn_error(conn, "server sent data (\"D\" message) without prior row description (\"T\" message)");
406 /* Discard the unexpected message */
407 conn->inCursor += msgLength;
408 }
409 break;
412 return;
414 break;
417 return;
420 break;
423 return;
426 break;
427 case PqMsg_CopyData:
428
429 /*
430 * If we see Copy Data, just silently drop it. This would
431 * only occur if application exits COPY OUT mode too
432 * early.
433 */
434 conn->inCursor += msgLength;
435 break;
436 case PqMsg_CopyDone:
437
438 /*
439 * If we see Copy Done, just silently drop it. This is
440 * the normal case during PQendcopy. We will keep
441 * swallowing data, expecting to see command-complete for
442 * the COPY command.
443 */
444 break;
445 default:
446 libpq_append_conn_error(conn, "unexpected response from server; first received character was \"%c\"", id);
447 /* build an error result holding the error message */
449 /* not sure if we will see more, so go to ready state */
451 /* Discard the unexpected message */
452 conn->inCursor += msgLength;
453 break;
454 } /* switch on protocol character */
455 }
456 /* Successfully consumed this message */
457 if (conn->inCursor == conn->inStart + 5 + msgLength)
458 {
459 /* Normal case: parsing agrees with specified length */
461 }
462 else if (conn->error_result && conn->status == CONNECTION_BAD)
463 {
464 /* The connection was abandoned and we already reported it */
465 return;
466 }
467 else
468 {
469 /* Trouble --- report it */
470 libpq_append_conn_error(conn, "message contents do not agree with length in message type \"%c\"", id);
471 /* build an error result holding the error message */
474 /* trust the specified message length as what to skip */
475 conn->inStart += 5 + msgLength;
476 }
477 }
478}
479
480/*
481 * handleFatalError: clean up after a nonrecoverable error
482 *
483 * This is for errors where we need to abandon the connection. The caller has
484 * already saved the error message in conn->errorMessage.
485 */
486static void
488{
489 /* build an error result holding the error message */
491 conn->asyncStatus = PGASYNC_READY; /* drop out of PQgetResult wait loop */
492 /* flush input data since we're giving up on processing it */
493 pqDropConnection(conn, true);
494 conn->status = CONNECTION_BAD; /* No more connection to backend */
495}
496
497/*
498 * handleSyncLoss: clean up after loss of message-boundary sync
499 *
500 * There isn't really a lot we can do here except abandon the connection.
501 */
502static void
503handleSyncLoss(PGconn *conn, char id, int msgLength)
504{
505 libpq_append_conn_error(conn, "lost synchronization with server: got message type \"%c\", length %d",
506 id, msgLength);
508}
509
510/*
511 * parseInput subroutine to read a 'T' (row descriptions) message.
512 * We'll build a new PGresult structure (unless called for a Describe
513 * command for a prepared statement) containing the attribute data.
514 * Returns: 0 if processed message successfully, EOF to suspend parsing
515 * (the latter case is not actually used currently).
516 */
517static int
519{
520 PGresult *result;
521 int nfields;
522 const char *errmsg;
523 int i;
524
525 /*
526 * When doing Describe for a prepared statement, there'll already be a
527 * PGresult created by getParamDescriptions, and we should fill data into
528 * that. Otherwise, create a new, empty PGresult.
529 */
530 if (!conn->cmd_queue_head ||
533 {
534 if (conn->result)
535 result = conn->result;
536 else
538 }
539 else
541 if (!result)
542 {
543 errmsg = NULL; /* means "out of memory", see below */
544 goto advance_and_error;
545 }
546
547 /* parseInput already read the 'T' label and message length. */
548 /* the next two bytes are the number of fields */
549 if (pqGetInt(&(result->numAttributes), 2, conn))
550 {
551 /* We should not run out of data here, so complain */
552 errmsg = libpq_gettext("insufficient data in \"T\" message");
553 goto advance_and_error;
554 }
555 nfields = result->numAttributes;
556
557 /* allocate space for the attribute descriptors */
558 if (nfields > 0)
559 {
560 result->attDescs = (PGresAttDesc *)
561 pqResultAlloc(result, nfields * sizeof(PGresAttDesc), true);
562 if (!result->attDescs)
563 {
564 errmsg = NULL; /* means "out of memory", see below */
565 goto advance_and_error;
566 }
567 MemSet(result->attDescs, 0, nfields * sizeof(PGresAttDesc));
568 }
569
570 /* result->binary is true only if ALL columns are binary */
571 result->binary = (nfields > 0) ? 1 : 0;
572
573 /* get type info */
574 for (i = 0; i < nfields; i++)
575 {
576 int tableid;
577 int columnid;
578 int typid;
579 int typlen;
580 int atttypmod;
581 int format;
582
583 if (pqGets(&conn->workBuffer, conn) ||
584 pqGetInt(&tableid, 4, conn) ||
585 pqGetInt(&columnid, 2, conn) ||
586 pqGetInt(&typid, 4, conn) ||
587 pqGetInt(&typlen, 2, conn) ||
588 pqGetInt(&atttypmod, 4, conn) ||
589 pqGetInt(&format, 2, conn))
590 {
591 /* We should not run out of data here, so complain */
592 errmsg = libpq_gettext("insufficient data in \"T\" message");
593 goto advance_and_error;
594 }
595
596 /*
597 * Since pqGetInt treats 2-byte integers as unsigned, we need to
598 * coerce these results to signed form.
599 */
600 columnid = (int) ((int16) columnid);
601 typlen = (int) ((int16) typlen);
602 format = (int) ((int16) format);
603
604 result->attDescs[i].name = pqResultStrdup(result,
606 if (!result->attDescs[i].name)
607 {
608 errmsg = NULL; /* means "out of memory", see below */
609 goto advance_and_error;
610 }
611 result->attDescs[i].tableid = tableid;
612 result->attDescs[i].columnid = columnid;
613 result->attDescs[i].format = format;
614 result->attDescs[i].typid = typid;
615 result->attDescs[i].typlen = typlen;
616 result->attDescs[i].atttypmod = atttypmod;
617
618 if (format != 1)
619 result->binary = 0;
620 }
621
622 /* Success! */
623 conn->result = result;
624
625 /*
626 * If we're doing a Describe, we're done, and ready to pass the result
627 * back to the client.
628 */
629 if ((!conn->cmd_queue_head) ||
632 {
634 return 0;
635 }
636
637 /*
638 * We could perform additional setup for the new result set here, but for
639 * now there's nothing else to do.
640 */
641
642 /* And we're done. */
643 return 0;
644
645advance_and_error:
646 /* Discard unsaved result, if any */
647 if (result && result != conn->result)
648 PQclear(result);
649
650 /*
651 * Replace partially constructed result with an error result. First
652 * discard the old result to try to win back some memory.
653 */
655
656 /*
657 * If preceding code didn't provide an error message, assume "out of
658 * memory" was meant. The advantage of having this special case is that
659 * freeing the old result first greatly improves the odds that gettext()
660 * will succeed in providing a translation.
661 */
662 if (!errmsg)
663 errmsg = libpq_gettext("out of memory for query result");
664
667
668 /*
669 * Show the message as fully consumed, else pqParseInput3 will overwrite
670 * our error with a complaint about that.
671 */
672 conn->inCursor = conn->inStart + 5 + msgLength;
673
674 /*
675 * Return zero to allow input parsing to continue. Subsequent "D"
676 * messages will be ignored until we get to end of data, since an error
677 * result is already set up.
678 */
679 return 0;
680}
681
682/*
683 * parseInput subroutine to read a 't' (ParameterDescription) message.
684 * We'll build a new PGresult structure containing the parameter data.
685 * Returns: 0 if processed message successfully, EOF to suspend parsing
686 * (the latter case is not actually used currently).
687 */
688static int
690{
691 PGresult *result;
692 const char *errmsg = NULL; /* means "out of memory", see below */
693 int nparams;
694 int i;
695
697 if (!result)
698 goto advance_and_error;
699
700 /* parseInput already read the 't' label and message length. */
701 /* the next two bytes are the number of parameters */
702 if (pqGetInt(&(result->numParameters), 2, conn))
703 goto not_enough_data;
704 nparams = result->numParameters;
705
706 /* allocate space for the parameter descriptors */
707 if (nparams > 0)
708 {
709 result->paramDescs = (PGresParamDesc *)
710 pqResultAlloc(result, nparams * sizeof(PGresParamDesc), true);
711 if (!result->paramDescs)
712 goto advance_and_error;
713 MemSet(result->paramDescs, 0, nparams * sizeof(PGresParamDesc));
714 }
715
716 /* get parameter info */
717 for (i = 0; i < nparams; i++)
718 {
719 int typid;
720
721 if (pqGetInt(&typid, 4, conn))
722 goto not_enough_data;
723 result->paramDescs[i].typid = typid;
724 }
725
726 /* Success! */
727 conn->result = result;
728
729 return 0;
730
731not_enough_data:
732 errmsg = libpq_gettext("insufficient data in \"t\" message");
733
734advance_and_error:
735 /* Discard unsaved result, if any */
736 if (result && result != conn->result)
737 PQclear(result);
738
739 /*
740 * Replace partially constructed result with an error result. First
741 * discard the old result to try to win back some memory.
742 */
744
745 /*
746 * If preceding code didn't provide an error message, assume "out of
747 * memory" was meant. The advantage of having this special case is that
748 * freeing the old result first greatly improves the odds that gettext()
749 * will succeed in providing a translation.
750 */
751 if (!errmsg)
752 errmsg = libpq_gettext("out of memory");
755
756 /*
757 * Show the message as fully consumed, else pqParseInput3 will overwrite
758 * our error with a complaint about that.
759 */
760 conn->inCursor = conn->inStart + 5 + msgLength;
761
762 /*
763 * Return zero to allow input parsing to continue. Essentially, we've
764 * replaced the COMMAND_OK result with an error result, but since this
765 * doesn't affect the protocol state, it's fine.
766 */
767 return 0;
768}
769
770/*
771 * parseInput subroutine to read a 'D' (row data) message.
772 * We fill rowbuf with column pointers and then call the row processor.
773 * Returns: 0 if processed message successfully, EOF to suspend parsing
774 * (the latter case is not actually used currently).
775 */
776static int
778{
779 PGresult *result = conn->result;
780 int nfields = result->numAttributes;
781 const char *errmsg;
782 PGdataValue *rowbuf;
783 int tupnfields; /* # fields from tuple */
784 int vlen; /* length of the current field value */
785 int i;
786
787 /* Get the field count and make sure it's what we expect */
788 if (pqGetInt(&tupnfields, 2, conn))
789 {
790 /* We should not run out of data here, so complain */
791 errmsg = libpq_gettext("insufficient data in \"D\" message");
792 goto advance_and_error;
793 }
794
795 if (tupnfields != nfields)
796 {
797 errmsg = libpq_gettext("unexpected field count in \"D\" message");
798 goto advance_and_error;
799 }
800
801 /* Resize row buffer if needed */
802 rowbuf = conn->rowBuf;
803 if (nfields > conn->rowBufLen)
804 {
805 rowbuf = (PGdataValue *) realloc(rowbuf,
806 nfields * sizeof(PGdataValue));
807 if (!rowbuf)
808 {
809 errmsg = NULL; /* means "out of memory", see below */
810 goto advance_and_error;
811 }
812 conn->rowBuf = rowbuf;
813 conn->rowBufLen = nfields;
814 }
815
816 /* Scan the fields */
817 for (i = 0; i < nfields; i++)
818 {
819 /* get the value length */
820 if (pqGetInt(&vlen, 4, conn))
821 {
822 /* We should not run out of data here, so complain */
823 errmsg = libpq_gettext("insufficient data in \"D\" message");
824 goto advance_and_error;
825 }
826 rowbuf[i].len = vlen;
827
828 /*
829 * rowbuf[i].value always points to the next address in the data
830 * buffer even if the value is NULL. This allows row processors to
831 * estimate data sizes more easily.
832 */
833 rowbuf[i].value = conn->inBuffer + conn->inCursor;
834
835 /* Skip over the data value */
836 if (vlen > 0)
837 {
838 if (pqSkipnchar(vlen, conn))
839 {
840 /* We should not run out of data here, so complain */
841 errmsg = libpq_gettext("insufficient data in \"D\" message");
842 goto advance_and_error;
843 }
844 }
845 }
846
847 /* Process the collected row */
848 errmsg = NULL;
850 return 0; /* normal, successful exit */
851
852 /* pqRowProcessor failed, fall through to report it */
853
854advance_and_error:
855
856 /*
857 * Replace partially constructed result with an error result. First
858 * discard the old result to try to win back some memory.
859 */
861
862 /*
863 * If preceding code didn't provide an error message, assume "out of
864 * memory" was meant. The advantage of having this special case is that
865 * freeing the old result first greatly improves the odds that gettext()
866 * will succeed in providing a translation.
867 */
868 if (!errmsg)
869 errmsg = libpq_gettext("out of memory for query result");
870
873
874 /*
875 * Show the message as fully consumed, else pqParseInput3 will overwrite
876 * our error with a complaint about that.
877 */
878 conn->inCursor = conn->inStart + 5 + msgLength;
879
880 /*
881 * Return zero to allow input parsing to continue. Subsequent "D"
882 * messages will be ignored until we get to end of data, since an error
883 * result is already set up.
884 */
885 return 0;
886}
887
888
889/*
890 * Attempt to read an Error or Notice response message.
891 * This is possible in several places, so we break it out as a subroutine.
892 *
893 * Entry: 'E' or 'N' message type and length have already been consumed.
894 * Exit: returns 0 if successfully consumed message.
895 * returns EOF if not enough data.
896 */
897int
899{
900 PGresult *res = NULL;
901 bool have_position = false;
902 PQExpBufferData workBuf;
903 char id;
904
905 /* If in pipeline mode, set error indicator for it */
906 if (isError && conn->pipelineStatus != PQ_PIPELINE_OFF)
908
909 /*
910 * If this is an error message, pre-emptively clear any incomplete query
911 * result we may have. We'd just throw it away below anyway, and
912 * releasing it before collecting the error might avoid out-of-memory.
913 */
914 if (isError)
916
917 /*
918 * Since the fields might be pretty long, we create a temporary
919 * PQExpBuffer rather than using conn->workBuffer. workBuffer is intended
920 * for stuff that is expected to be short. We shouldn't use
921 * conn->errorMessage either, since this might be only a notice.
922 */
923 initPQExpBuffer(&workBuf);
924
925 /*
926 * Make a PGresult to hold the accumulated fields. We temporarily lie
927 * about the result status, so that PQmakeEmptyPGresult doesn't uselessly
928 * copy conn->errorMessage.
929 *
930 * NB: This allocation can fail, if you run out of memory. The rest of the
931 * function handles that gracefully, and we still try to set the error
932 * message as the connection's error message.
933 */
935 if (res)
937
938 /*
939 * Read the fields and save into res.
940 *
941 * While at it, save the SQLSTATE in conn->last_sqlstate, and note whether
942 * we saw a PG_DIAG_STATEMENT_POSITION field.
943 */
944 for (;;)
945 {
946 if (pqGetc(&id, conn))
947 goto fail;
948 if (id == '\0')
949 break; /* terminator found */
950 if (pqGets(&workBuf, conn))
951 goto fail;
952 pqSaveMessageField(res, id, workBuf.data);
953 if (id == PG_DIAG_SQLSTATE)
954 strlcpy(conn->last_sqlstate, workBuf.data,
955 sizeof(conn->last_sqlstate));
956 else if (id == PG_DIAG_STATEMENT_POSITION)
957 have_position = true;
958 }
959
960 /*
961 * Save the active query text, if any, into res as well; but only if we
962 * might need it for an error cursor display, which is only true if there
963 * is a PG_DIAG_STATEMENT_POSITION field.
964 */
965 if (have_position && res && conn->cmd_queue_head && conn->cmd_queue_head->query)
967
968 /*
969 * Now build the "overall" error message for PQresultErrorMessage.
970 */
971 resetPQExpBuffer(&workBuf);
973
974 /*
975 * Either save error as current async result, or just emit the notice.
976 */
977 if (isError)
978 {
979 pqClearAsyncResult(conn); /* redundant, but be safe */
980 if (res)
981 {
982 pqSetResultError(res, &workBuf, 0);
983 conn->result = res;
984 }
985 else
986 {
987 /* Fall back to using the internal-error processing paths */
988 conn->error_result = true;
989 }
990
991 if (PQExpBufferDataBroken(workBuf))
992 libpq_append_conn_error(conn, "out of memory");
993 else
995 }
996 else
997 {
998 /* if we couldn't allocate the result set, just discard the NOTICE */
999 if (res)
1000 {
1001 /*
1002 * We can cheat a little here and not copy the message. But if we
1003 * were unlucky enough to run out of memory while filling workBuf,
1004 * insert "out of memory", as in pqSetResultError.
1005 */
1006 if (PQExpBufferDataBroken(workBuf))
1007 res->errMsg = libpq_gettext("out of memory\n");
1008 else
1009 res->errMsg = workBuf.data;
1010 if (res->noticeHooks.noticeRec != NULL)
1012 PQclear(res);
1013 }
1014 }
1015
1016 termPQExpBuffer(&workBuf);
1017 return 0;
1018
1019fail:
1020 PQclear(res);
1021 termPQExpBuffer(&workBuf);
1022 return EOF;
1023}
1024
1025/*
1026 * Construct an error message from the fields in the given PGresult,
1027 * appending it to the contents of "msg".
1028 */
1029void
1031 PGVerbosity verbosity, PGContextVisibility show_context)
1032{
1033 const char *val;
1034 const char *querytext = NULL;
1035 int querypos = 0;
1036
1037 /* If we couldn't allocate a PGresult, just say "out of memory" */
1038 if (res == NULL)
1039 {
1040 appendPQExpBufferStr(msg, libpq_gettext("out of memory\n"));
1041 return;
1042 }
1043
1044 /*
1045 * If we don't have any broken-down fields, just return the base message.
1046 * This mainly applies if we're given a libpq-generated error result.
1047 */
1048 if (res->errFields == NULL)
1049 {
1050 if (res->errMsg && res->errMsg[0])
1051 appendPQExpBufferStr(msg, res->errMsg);
1052 else
1053 appendPQExpBufferStr(msg, libpq_gettext("no error message available\n"));
1054 return;
1055 }
1056
1057 /* Else build error message from relevant fields */
1059 if (val)
1060 appendPQExpBuffer(msg, "%s: ", val);
1061
1062 if (verbosity == PQERRORS_SQLSTATE)
1063 {
1064 /*
1065 * If we have a SQLSTATE, print that and nothing else. If not (which
1066 * shouldn't happen for server-generated errors, but might possibly
1067 * happen for libpq-generated ones), fall back to TERSE format, as
1068 * that seems better than printing nothing at all.
1069 */
1071 if (val)
1072 {
1073 appendPQExpBuffer(msg, "%s\n", val);
1074 return;
1075 }
1076 verbosity = PQERRORS_TERSE;
1077 }
1078
1079 if (verbosity == PQERRORS_VERBOSE)
1080 {
1082 if (val)
1083 appendPQExpBuffer(msg, "%s: ", val);
1084 }
1086 if (val)
1089 if (val)
1090 {
1091 if (verbosity != PQERRORS_TERSE && res->errQuery != NULL)
1092 {
1093 /* emit position as a syntax cursor display */
1094 querytext = res->errQuery;
1095 querypos = atoi(val);
1096 }
1097 else
1098 {
1099 /* emit position as text addition to primary message */
1100 /* translator: %s represents a digit string */
1101 appendPQExpBuffer(msg, libpq_gettext(" at character %s"),
1102 val);
1103 }
1104 }
1105 else
1106 {
1108 if (val)
1109 {
1111 if (verbosity != PQERRORS_TERSE && querytext != NULL)
1112 {
1113 /* emit position as a syntax cursor display */
1114 querypos = atoi(val);
1115 }
1116 else
1117 {
1118 /* emit position as text addition to primary message */
1119 /* translator: %s represents a digit string */
1120 appendPQExpBuffer(msg, libpq_gettext(" at character %s"),
1121 val);
1122 }
1123 }
1124 }
1125 appendPQExpBufferChar(msg, '\n');
1126 if (verbosity != PQERRORS_TERSE)
1127 {
1128 if (querytext && querypos > 0)
1129 reportErrorPosition(msg, querytext, querypos,
1130 res->client_encoding);
1132 if (val)
1133 appendPQExpBuffer(msg, libpq_gettext("DETAIL: %s\n"), val);
1135 if (val)
1136 appendPQExpBuffer(msg, libpq_gettext("HINT: %s\n"), val);
1138 if (val)
1139 appendPQExpBuffer(msg, libpq_gettext("QUERY: %s\n"), val);
1140 if (show_context == PQSHOW_CONTEXT_ALWAYS ||
1141 (show_context == PQSHOW_CONTEXT_ERRORS &&
1143 {
1145 if (val)
1146 appendPQExpBuffer(msg, libpq_gettext("CONTEXT: %s\n"),
1147 val);
1148 }
1149 }
1150 if (verbosity == PQERRORS_VERBOSE)
1151 {
1153 if (val)
1155 libpq_gettext("SCHEMA NAME: %s\n"), val);
1157 if (val)
1159 libpq_gettext("TABLE NAME: %s\n"), val);
1161 if (val)
1163 libpq_gettext("COLUMN NAME: %s\n"), val);
1165 if (val)
1167 libpq_gettext("DATATYPE NAME: %s\n"), val);
1169 if (val)
1171 libpq_gettext("CONSTRAINT NAME: %s\n"), val);
1172 }
1173 if (verbosity == PQERRORS_VERBOSE)
1174 {
1175 const char *valf;
1176 const char *vall;
1177
1181 if (val || valf || vall)
1182 {
1183 appendPQExpBufferStr(msg, libpq_gettext("LOCATION: "));
1184 if (val)
1185 appendPQExpBuffer(msg, libpq_gettext("%s, "), val);
1186 if (valf && vall) /* unlikely we'd have just one */
1187 appendPQExpBuffer(msg, libpq_gettext("%s:%s"),
1188 valf, vall);
1189 appendPQExpBufferChar(msg, '\n');
1190 }
1191 }
1192}
1193
1194/*
1195 * Add an error-location display to the error message under construction.
1196 *
1197 * The cursor location is measured in logical characters; the query string
1198 * is presumed to be in the specified encoding.
1199 */
1200static void
1201reportErrorPosition(PQExpBuffer msg, const char *query, int loc, int encoding)
1202{
1203#define DISPLAY_SIZE 60 /* screen width limit, in screen cols */
1204#define MIN_RIGHT_CUT 10 /* try to keep this far away from EOL */
1205
1206 char *wquery;
1207 int slen,
1208 cno,
1209 i,
1210 *qidx,
1211 *scridx,
1212 qoffset,
1213 scroffset,
1214 ibeg,
1215 iend,
1216 loc_line;
1217 bool mb_encoding,
1218 beg_trunc,
1219 end_trunc;
1220
1221 /* Convert loc from 1-based to 0-based; no-op if out of range */
1222 loc--;
1223 if (loc < 0)
1224 return;
1225
1226 /* Need a writable copy of the query */
1227 wquery = strdup(query);
1228 if (wquery == NULL)
1229 return; /* fail silently if out of memory */
1230
1231 /*
1232 * Each character might occupy multiple physical bytes in the string, and
1233 * in some Far Eastern character sets it might take more than one screen
1234 * column as well. We compute the starting byte offset and starting
1235 * screen column of each logical character, and store these in qidx[] and
1236 * scridx[] respectively.
1237 */
1238
1239 /*
1240 * We need a safe allocation size.
1241 *
1242 * The only caller of reportErrorPosition() is pqBuildErrorMessage3(); it
1243 * gets its query from either a PQresultErrorField() or a PGcmdQueueEntry,
1244 * both of which must have fit into conn->inBuffer/outBuffer. So slen fits
1245 * inside an int, but we can't assume that (slen * sizeof(int)) fits
1246 * inside a size_t.
1247 */
1248 slen = strlen(wquery) + 1;
1249 if (slen > SIZE_MAX / sizeof(int))
1250 {
1251 free(wquery);
1252 return;
1253 }
1254
1255 qidx = (int *) malloc(slen * sizeof(int));
1256 if (qidx == NULL)
1257 {
1258 free(wquery);
1259 return;
1260 }
1261 scridx = (int *) malloc(slen * sizeof(int));
1262 if (scridx == NULL)
1263 {
1264 free(qidx);
1265 free(wquery);
1266 return;
1267 }
1268
1269 /* We can optimize a bit if it's a single-byte encoding */
1270 mb_encoding = (pg_encoding_max_length(encoding) != 1);
1271
1272 /*
1273 * Within the scanning loop, cno is the current character's logical
1274 * number, qoffset is its offset in wquery, and scroffset is its starting
1275 * logical screen column (all indexed from 0). "loc" is the logical
1276 * character number of the error location. We scan to determine loc_line
1277 * (the 1-based line number containing loc) and ibeg/iend (first character
1278 * number and last+1 character number of the line containing loc). Note
1279 * that qidx[] and scridx[] are filled only as far as iend.
1280 */
1281 qoffset = 0;
1282 scroffset = 0;
1283 loc_line = 1;
1284 ibeg = 0;
1285 iend = -1; /* -1 means not set yet */
1286
1287 for (cno = 0; wquery[qoffset] != '\0'; cno++)
1288 {
1289 char ch = wquery[qoffset];
1290
1291 qidx[cno] = qoffset;
1292 scridx[cno] = scroffset;
1293
1294 /*
1295 * Replace tabs with spaces in the writable copy. (Later we might
1296 * want to think about coping with their variable screen width, but
1297 * not today.)
1298 */
1299 if (ch == '\t')
1300 wquery[qoffset] = ' ';
1301
1302 /*
1303 * If end-of-line, count lines and mark positions. Each \r or \n
1304 * counts as a line except when \r \n appear together.
1305 */
1306 else if (ch == '\r' || ch == '\n')
1307 {
1308 if (cno < loc)
1309 {
1310 if (ch == '\r' ||
1311 cno == 0 ||
1312 wquery[qidx[cno - 1]] != '\r')
1313 loc_line++;
1314 /* extract beginning = last line start before loc. */
1315 ibeg = cno + 1;
1316 }
1317 else
1318 {
1319 /* set extract end. */
1320 iend = cno;
1321 /* done scanning. */
1322 break;
1323 }
1324 }
1325
1326 /* Advance */
1327 if (mb_encoding)
1328 {
1329 int w;
1330
1331 w = pg_encoding_dsplen(encoding, &wquery[qoffset]);
1332 /* treat any non-tab control chars as width 1 */
1333 if (w <= 0)
1334 w = 1;
1335 scroffset += w;
1336 qoffset += PQmblenBounded(&wquery[qoffset], encoding);
1337 }
1338 else
1339 {
1340 /* We assume wide chars only exist in multibyte encodings */
1341 scroffset++;
1342 qoffset++;
1343 }
1344 }
1345 /* Fix up if we didn't find an end-of-line after loc */
1346 if (iend < 0)
1347 {
1348 iend = cno; /* query length in chars, +1 */
1349 qidx[iend] = qoffset;
1350 scridx[iend] = scroffset;
1351 }
1352
1353 /* Print only if loc is within computed query length */
1354 if (loc <= cno)
1355 {
1356 /* If the line extracted is too long, we truncate it. */
1357 beg_trunc = false;
1358 end_trunc = false;
1359 if (scridx[iend] - scridx[ibeg] > DISPLAY_SIZE)
1360 {
1361 /*
1362 * We first truncate right if it is enough. This code might be
1363 * off a space or so on enforcing MIN_RIGHT_CUT if there's a wide
1364 * character right there, but that should be okay.
1365 */
1366 if (scridx[ibeg] + DISPLAY_SIZE >= scridx[loc] + MIN_RIGHT_CUT)
1367 {
1368 while (scridx[iend] - scridx[ibeg] > DISPLAY_SIZE)
1369 iend--;
1370 end_trunc = true;
1371 }
1372 else
1373 {
1374 /* Truncate right if not too close to loc. */
1375 while (scridx[loc] + MIN_RIGHT_CUT < scridx[iend])
1376 {
1377 iend--;
1378 end_trunc = true;
1379 }
1380
1381 /* Truncate left if still too long. */
1382 while (scridx[iend] - scridx[ibeg] > DISPLAY_SIZE)
1383 {
1384 ibeg++;
1385 beg_trunc = true;
1386 }
1387 }
1388 }
1389
1390 /* truncate working copy at desired endpoint */
1391 wquery[qidx[iend]] = '\0';
1392
1393 /* Begin building the finished message. */
1394 i = msg->len;
1395 appendPQExpBuffer(msg, libpq_gettext("LINE %d: "), loc_line);
1396 if (beg_trunc)
1397 appendPQExpBufferStr(msg, "...");
1398
1399 /*
1400 * While we have the prefix in the msg buffer, compute its screen
1401 * width.
1402 */
1403 scroffset = 0;
1404 for (; i < msg->len; i += PQmblenBounded(&msg->data[i], encoding))
1405 {
1406 int w = pg_encoding_dsplen(encoding, &msg->data[i]);
1407
1408 if (w <= 0)
1409 w = 1;
1410 scroffset += w;
1411 }
1412
1413 /* Finish up the LINE message line. */
1414 appendPQExpBufferStr(msg, &wquery[qidx[ibeg]]);
1415 if (end_trunc)
1416 appendPQExpBufferStr(msg, "...");
1417 appendPQExpBufferChar(msg, '\n');
1418
1419 /* Now emit the cursor marker line. */
1420 scroffset += scridx[loc] - scridx[ibeg];
1421 for (i = 0; i < scroffset; i++)
1422 appendPQExpBufferChar(msg, ' ');
1423 appendPQExpBufferChar(msg, '^');
1424 appendPQExpBufferChar(msg, '\n');
1425 }
1426
1427 /* Clean up. */
1428 free(scridx);
1429 free(qidx);
1430 free(wquery);
1431}
1432
1433
1434/*
1435 * Attempt to read a NegotiateProtocolVersion message. Sets conn->pversion
1436 * to the version that's negotiated by the server.
1437 *
1438 * Entry: 'v' message type and length have already been consumed.
1439 * Exit: returns 0 if successfully consumed message.
1440 * returns 1 on failure. The error message is filled in.
1441 */
1442int
1444{
1445 int their_version;
1446 int num;
1447
1448 if (pqGetInt(&their_version, 4, conn) != 0)
1449 goto eof;
1450
1451 if (pqGetInt(&num, 4, conn) != 0)
1452 goto eof;
1453
1454 /* Check the protocol version */
1455 if (their_version > conn->pversion)
1456 {
1457 libpq_append_conn_error(conn, "received invalid protocol negotiation message: server requested downgrade to a higher-numbered version");
1458 goto failure;
1459 }
1460
1461 if (their_version < PG_PROTOCOL(3, 0))
1462 {
1463 libpq_append_conn_error(conn, "received invalid protocol negotiation message: server requested downgrade to pre-3.0 protocol version");
1464 goto failure;
1465 }
1466
1467 /* 3.1 never existed, we went straight from 3.0 to 3.2 */
1468 if (their_version == PG_PROTOCOL(3, 1))
1469 {
1470 libpq_append_conn_error(conn, "received invalid protocol negotiation message: server requested downgrade to non-existent 3.1 protocol version");
1471 goto failure;
1472 }
1473
1474 if (num < 0)
1475 {
1476 libpq_append_conn_error(conn, "received invalid protocol negotiation message: server reported negative number of unsupported parameters");
1477 goto failure;
1478 }
1479
1480 if (their_version == conn->pversion && num == 0)
1481 {
1482 libpq_append_conn_error(conn, "received invalid protocol negotiation message: server negotiated but asks for no changes");
1483 goto failure;
1484 }
1485
1486 if (their_version < conn->min_pversion)
1487 {
1488 libpq_append_conn_error(conn, "server only supports protocol version %d.%d, but \"%s\" was set to %d.%d",
1489 PG_PROTOCOL_MAJOR(their_version),
1490 PG_PROTOCOL_MINOR(their_version),
1491 "min_protocol_version",
1494
1495 goto failure;
1496 }
1497
1498 /* the version is acceptable */
1499 conn->pversion = their_version;
1500
1501 /*
1502 * We don't currently request any protocol extensions, so we don't expect
1503 * the server to reply with any either.
1504 */
1505 for (int i = 0; i < num; i++)
1506 {
1507 if (pqGets(&conn->workBuffer, conn))
1508 {
1509 goto eof;
1510 }
1511 if (strncmp(conn->workBuffer.data, "_pq_.", 5) != 0)
1512 {
1513 libpq_append_conn_error(conn, "received invalid protocol negotiation message: server reported unsupported parameter name without a \"%s\" prefix (\"%s\")", "_pq_.", conn->workBuffer.data);
1514 goto failure;
1515 }
1516 libpq_append_conn_error(conn, "received invalid protocol negotiation message: server reported an unsupported parameter that was not requested (\"%s\")", conn->workBuffer.data);
1517 goto failure;
1518 }
1519
1520 return 0;
1521
1522eof:
1523 libpq_append_conn_error(conn, "received invalid protocol negotiation message: message too short");
1524failure:
1527 return 1;
1528}
1529
1530
1531/*
1532 * Attempt to read a ParameterStatus message.
1533 * This is possible in several places, so we break it out as a subroutine.
1534 *
1535 * Entry: 'S' message type and length have already been consumed.
1536 * Exit: returns 0 if successfully consumed message.
1537 * returns EOF if not enough data.
1538 */
1539static int
1541{
1542 PQExpBufferData valueBuf;
1543
1544 /* Get the parameter name */
1545 if (pqGets(&conn->workBuffer, conn))
1546 return EOF;
1547 /* Get the parameter value (could be large) */
1548 initPQExpBuffer(&valueBuf);
1549 if (pqGets(&valueBuf, conn))
1550 {
1551 termPQExpBuffer(&valueBuf);
1552 return EOF;
1553 }
1554 /* And save it */
1556 {
1557 libpq_append_conn_error(conn, "out of memory");
1559 }
1560 termPQExpBuffer(&valueBuf);
1561 return 0;
1562}
1563
1564/*
1565 * parseInput subroutine to read a BackendKeyData message.
1566 * Entry: 'v' message type and length have already been consumed.
1567 * Exit: returns 0 if successfully consumed message.
1568 * returns EOF if not enough data.
1569 */
1570static int
1572{
1573 int cancel_key_len;
1574
1575 if (conn->be_cancel_key)
1576 {
1578 conn->be_cancel_key = NULL;
1580 }
1581
1582 if (pqGetInt(&(conn->be_pid), 4, conn))
1583 return EOF;
1584
1585 cancel_key_len = 5 + msgLength - (conn->inCursor - conn->inStart);
1586
1587 if (cancel_key_len != 4 && conn->pversion == PG_PROTOCOL(3, 0))
1588 {
1589 libpq_append_conn_error(conn, "received invalid BackendKeyData message: cancel key with length %d not allowed in protocol version 3.0 (must be 4 bytes)", cancel_key_len);
1591 return 0;
1592 }
1593
1594 if (cancel_key_len < 4)
1595 {
1596 libpq_append_conn_error(conn, "received invalid BackendKeyData message: cancel key with length %d is too short (minimum 4 bytes)", cancel_key_len);
1598 return 0;
1599 }
1600
1601 if (cancel_key_len > 256)
1602 {
1603 libpq_append_conn_error(conn, "received invalid BackendKeyData message: cancel key with length %d is too long (maximum 256 bytes)", cancel_key_len);
1605 return 0;
1606 }
1607
1608 conn->be_cancel_key = malloc(cancel_key_len);
1609 if (conn->be_cancel_key == NULL)
1610 {
1611 libpq_append_conn_error(conn, "out of memory");
1613 return 0;
1614 }
1615 if (pqGetnchar(conn->be_cancel_key, cancel_key_len, conn))
1616 {
1618 conn->be_cancel_key = NULL;
1619 return EOF;
1620 }
1621 conn->be_cancel_key_len = cancel_key_len;
1622 return 0;
1623}
1624
1625
1626/*
1627 * Attempt to read a Notify response message.
1628 * This is possible in several places, so we break it out as a subroutine.
1629 *
1630 * Entry: 'A' message type and length have already been consumed.
1631 * Exit: returns 0 if successfully consumed Notify message.
1632 * returns EOF if not enough data.
1633 */
1634static int
1636{
1637 int be_pid;
1638 char *svname;
1639 int nmlen;
1640 int extralen;
1641 PGnotify *newNotify;
1642
1643 if (pqGetInt(&be_pid, 4, conn))
1644 return EOF;
1645 if (pqGets(&conn->workBuffer, conn))
1646 return EOF;
1647 /* must save name while getting extra string */
1648 svname = strdup(conn->workBuffer.data);
1649 if (!svname)
1650 {
1651 /*
1652 * Notify messages can arrive at any state, so we cannot associate the
1653 * error with any particular query. There's no way to return back an
1654 * "async error", so the best we can do is drop the connection. That
1655 * seems better than silently ignoring the notification.
1656 */
1657 libpq_append_conn_error(conn, "out of memory");
1659 return 0;
1660 }
1661 if (pqGets(&conn->workBuffer, conn))
1662 {
1663 free(svname);
1664 return EOF;
1665 }
1666
1667 /*
1668 * Store the strings right after the PGnotify structure so it can all be
1669 * freed at once. We don't use NAMEDATALEN because we don't want to tie
1670 * this interface to a specific server name length.
1671 */
1672 nmlen = strlen(svname);
1673 extralen = strlen(conn->workBuffer.data);
1674 newNotify = (PGnotify *) malloc(sizeof(PGnotify) + nmlen + extralen + 2);
1675 if (!newNotify)
1676 {
1677 free(svname);
1678 libpq_append_conn_error(conn, "out of memory");
1680 return 0;
1681 }
1682
1683 newNotify->relname = (char *) newNotify + sizeof(PGnotify);
1684 strcpy(newNotify->relname, svname);
1685 newNotify->extra = newNotify->relname + nmlen + 1;
1686 strcpy(newNotify->extra, conn->workBuffer.data);
1687 newNotify->be_pid = be_pid;
1688 newNotify->next = NULL;
1689 if (conn->notifyTail)
1690 conn->notifyTail->next = newNotify;
1691 else
1692 conn->notifyHead = newNotify;
1693 conn->notifyTail = newNotify;
1694
1695 free(svname);
1696 return 0;
1697}
1698
1699/*
1700 * getCopyStart - process CopyInResponse, CopyOutResponse or
1701 * CopyBothResponse message
1702 *
1703 * parseInput already read the message type and length.
1704 */
1705static int
1707{
1708 PGresult *result;
1709 int nfields;
1710 int i;
1711
1712 result = PQmakeEmptyPGresult(conn, copytype);
1713 if (!result)
1714 goto failure;
1715
1717 goto failure;
1718 result->binary = conn->copy_is_binary;
1719 /* the next two bytes are the number of fields */
1720 if (pqGetInt(&(result->numAttributes), 2, conn))
1721 goto failure;
1722 nfields = result->numAttributes;
1723
1724 /* allocate space for the attribute descriptors */
1725 if (nfields > 0)
1726 {
1727 result->attDescs = (PGresAttDesc *)
1728 pqResultAlloc(result, nfields * sizeof(PGresAttDesc), true);
1729 if (!result->attDescs)
1730 goto failure;
1731 MemSet(result->attDescs, 0, nfields * sizeof(PGresAttDesc));
1732 }
1733
1734 for (i = 0; i < nfields; i++)
1735 {
1736 int format;
1737
1738 if (pqGetInt(&format, 2, conn))
1739 goto failure;
1740
1741 /*
1742 * Since pqGetInt treats 2-byte integers as unsigned, we need to
1743 * coerce these results to signed form.
1744 */
1745 format = (int) ((int16) format);
1746 result->attDescs[i].format = format;
1747 }
1748
1749 /* Success! */
1750 conn->result = result;
1751 return 0;
1752
1753failure:
1754 PQclear(result);
1755 return EOF;
1756}
1757
1758/*
1759 * getReadyForQuery - process ReadyForQuery message
1760 */
1761static int
1763{
1764 char xact_status;
1765
1766 if (pqGetc(&xact_status, conn))
1767 return EOF;
1768 switch (xact_status)
1769 {
1770 case 'I':
1772 break;
1773 case 'T':
1775 break;
1776 case 'E':
1778 break;
1779 default:
1781 break;
1782 }
1783
1784 return 0;
1785}
1786
1787/*
1788 * getCopyDataMessage - fetch next CopyData message, process async messages
1789 *
1790 * Returns length word of CopyData message (> 0), or 0 if no complete
1791 * message available, -1 if end of copy, -2 if error.
1792 */
1793static int
1795{
1796 char id;
1797 int msgLength;
1798 int avail;
1799
1800 for (;;)
1801 {
1802 /*
1803 * Do we have the next input message? To make life simpler for async
1804 * callers, we keep returning 0 until the next message is fully
1805 * available, even if it is not Copy Data.
1806 */
1808 if (pqGetc(&id, conn))
1809 return 0;
1810 if (pqGetInt(&msgLength, 4, conn))
1811 return 0;
1812 if (msgLength < 4)
1813 {
1814 handleSyncLoss(conn, id, msgLength);
1815 return -2;
1816 }
1817 avail = conn->inEnd - conn->inCursor;
1818 if (avail < msgLength - 4)
1819 {
1820 /*
1821 * Before returning, enlarge the input buffer if needed to hold
1822 * the whole message. See notes in parseInput.
1823 */
1824 if (pqCheckInBufferSpace(conn->inCursor + (size_t) msgLength - 4,
1825 conn))
1826 {
1827 /*
1828 * Abandon the connection. There's not much else we can
1829 * safely do; we can't just ignore the message or we could
1830 * miss important changes to the connection state.
1831 * pqCheckInBufferSpace() already reported the error.
1832 */
1834 return -2;
1835 }
1836 return 0;
1837 }
1838
1839 /*
1840 * If it's a legitimate async message type, process it. (NOTIFY
1841 * messages are not currently possible here, but we handle them for
1842 * completeness.) Otherwise, if it's anything except Copy Data,
1843 * report end-of-copy.
1844 */
1845 switch (id)
1846 {
1848 if (getNotify(conn))
1849 return 0;
1850 break;
1852 if (pqGetErrorNotice3(conn, false))
1853 return 0;
1854 break;
1857 return 0;
1858 break;
1859 case PqMsg_CopyData:
1860 return msgLength;
1861 case PqMsg_CopyDone:
1862
1863 /*
1864 * If this is a CopyDone message, exit COPY_OUT mode and let
1865 * caller read status with PQgetResult(). If we're in
1866 * COPY_BOTH mode, return to COPY_IN mode.
1867 */
1870 else
1872 return -1;
1873 default: /* treat as end of copy */
1874
1875 /*
1876 * Any other message terminates either COPY_IN or COPY_BOTH
1877 * mode.
1878 */
1880 return -1;
1881 }
1882
1883 /* Drop the processed message and loop around for another */
1885 }
1886}
1887
1888/*
1889 * PQgetCopyData - read a row of data from the backend during COPY OUT
1890 * or COPY BOTH
1891 *
1892 * If successful, sets *buffer to point to a malloc'd row of data, and
1893 * returns row length (always > 0) as result.
1894 * Returns 0 if no row available yet (only possible if async is true),
1895 * -1 if end of copy (consult PQgetResult), or -2 if error (consult
1896 * PQerrorMessage).
1897 */
1898int
1899pqGetCopyData3(PGconn *conn, char **buffer, int async)
1900{
1901 int msgLength;
1902
1903 for (;;)
1904 {
1905 /*
1906 * Collect the next input message. To make life simpler for async
1907 * callers, we keep returning 0 until the next message is fully
1908 * available, even if it is not Copy Data.
1909 */
1910 msgLength = getCopyDataMessage(conn);
1911 if (msgLength < 0)
1912 return msgLength; /* end-of-copy or error */
1913 if (msgLength == 0)
1914 {
1915 /* Don't block if async read requested */
1916 if (async)
1917 return 0;
1918 /* Need to load more data */
1919 if (pqWait(true, false, conn) ||
1920 pqReadData(conn) < 0)
1921 return -2;
1922 continue;
1923 }
1924
1925 /*
1926 * Drop zero-length messages (shouldn't happen anyway). Otherwise
1927 * pass the data back to the caller.
1928 */
1929 msgLength -= 4;
1930 if (msgLength > 0)
1931 {
1932 *buffer = (char *) malloc(msgLength + 1);
1933 if (*buffer == NULL)
1934 {
1935 libpq_append_conn_error(conn, "out of memory");
1936 return -2;
1937 }
1938 memcpy(*buffer, &conn->inBuffer[conn->inCursor], msgLength);
1939 (*buffer)[msgLength] = '\0'; /* Add terminating null */
1940
1941 /* Mark message consumed */
1942 pqParseDone(conn, conn->inCursor + msgLength);
1943
1944 return msgLength;
1945 }
1946
1947 /* Empty, so drop it and loop around for another */
1949 }
1950}
1951
1952/*
1953 * PQgetline - gets a newline-terminated string from the backend.
1954 *
1955 * See fe-exec.c for documentation.
1956 */
1957int
1958pqGetline3(PGconn *conn, char *s, int maxlen)
1959{
1960 int status;
1961
1962 if (conn->sock == PGINVALID_SOCKET ||
1966 {
1967 libpq_append_conn_error(conn, "PQgetline: not doing text COPY OUT");
1968 *s = '\0';
1969 return EOF;
1970 }
1971
1972 while ((status = PQgetlineAsync(conn, s, maxlen - 1)) == 0)
1973 {
1974 /* need to load more data */
1975 if (pqWait(true, false, conn) ||
1976 pqReadData(conn) < 0)
1977 {
1978 *s = '\0';
1979 return EOF;
1980 }
1981 }
1982
1983 if (status < 0)
1984 {
1985 /* End of copy detected; gin up old-style terminator */
1986 strcpy(s, "\\.");
1987 return 0;
1988 }
1989
1990 /* Add null terminator, and strip trailing \n if present */
1991 if (s[status - 1] == '\n')
1992 {
1993 s[status - 1] = '\0';
1994 return 0;
1995 }
1996 else
1997 {
1998 s[status] = '\0';
1999 return 1;
2000 }
2001}
2002
2003/*
2004 * PQgetlineAsync - gets a COPY data row without blocking.
2005 *
2006 * See fe-exec.c for documentation.
2007 */
2008int
2010{
2011 int msgLength;
2012 int avail;
2013
2016 return -1; /* we are not doing a copy... */
2017
2018 /*
2019 * Recognize the next input message. To make life simpler for async
2020 * callers, we keep returning 0 until the next message is fully available
2021 * even if it is not Copy Data. This should keep PQendcopy from blocking.
2022 * (Note: unlike pqGetCopyData3, we do not change asyncStatus here.)
2023 */
2024 msgLength = getCopyDataMessage(conn);
2025 if (msgLength < 0)
2026 return -1; /* end-of-copy or error */
2027 if (msgLength == 0)
2028 return 0; /* no data yet */
2029
2030 /*
2031 * Move data from libpq's buffer to the caller's. In the case where a
2032 * prior call found the caller's buffer too small, we use
2033 * conn->copy_already_done to remember how much of the row was already
2034 * returned to the caller.
2035 */
2037 avail = msgLength - 4 - conn->copy_already_done;
2038 if (avail <= bufsize)
2039 {
2040 /* Able to consume the whole message */
2041 memcpy(buffer, &conn->inBuffer[conn->inCursor], avail);
2042 /* Mark message consumed */
2043 conn->inStart = conn->inCursor + avail;
2044 /* Reset state for next time */
2046 return avail;
2047 }
2048 else
2049 {
2050 /* We must return a partial message */
2051 memcpy(buffer, &conn->inBuffer[conn->inCursor], bufsize);
2052 /* The message is NOT consumed from libpq's buffer */
2054 return bufsize;
2055 }
2056}
2057
2058/*
2059 * PQendcopy
2060 *
2061 * See fe-exec.c for documentation.
2062 */
2063int
2065{
2066 PGresult *result;
2067
2071 {
2072 libpq_append_conn_error(conn, "no COPY in progress");
2073 return 1;
2074 }
2075
2076 /* Send the CopyDone message if needed */
2079 {
2080 if (pqPutMsgStart(PqMsg_CopyDone, conn) < 0 ||
2081 pqPutMsgEnd(conn) < 0)
2082 return 1;
2083
2084 /*
2085 * If we sent the COPY command in extended-query mode, we must issue a
2086 * Sync as well.
2087 */
2088 if (conn->cmd_queue_head &&
2090 {
2091 if (pqPutMsgStart(PqMsg_Sync, conn) < 0 ||
2092 pqPutMsgEnd(conn) < 0)
2093 return 1;
2094 }
2095 }
2096
2097 /*
2098 * make sure no data is waiting to be sent, abort if we are non-blocking
2099 * and the flush fails
2100 */
2102 return 1;
2103
2104 /* Return to active duty */
2106
2107 /*
2108 * Non blocking connections may have to abort at this point. If everyone
2109 * played the game there should be no problem, but in error scenarios the
2110 * expected messages may not have arrived yet. (We are assuming that the
2111 * backend's packetizing will ensure that CommandComplete arrives along
2112 * with the CopyDone; are there corner cases where that doesn't happen?)
2113 */
2115 return 1;
2116
2117 /* Wait for the completion response */
2118 result = PQgetResult(conn);
2119
2120 /* Expecting a successful result */
2121 if (result && result->resultStatus == PGRES_COMMAND_OK)
2122 {
2123 PQclear(result);
2124 return 0;
2125 }
2126
2127 /*
2128 * Trouble. For backwards-compatibility reasons, we issue the error
2129 * message as if it were a notice (would be nice to get rid of this
2130 * silliness, but too many apps probably don't handle errors from
2131 * PQendcopy reasonably). Note that the app can still obtain the error
2132 * status from the PGconn object.
2133 */
2134 if (conn->errorMessage.len > 0)
2135 {
2136 /* We have to strip the trailing newline ... pain in neck... */
2137 char svLast = conn->errorMessage.data[conn->errorMessage.len - 1];
2138
2139 if (svLast == '\n')
2140 conn->errorMessage.data[conn->errorMessage.len - 1] = '\0';
2142 conn->errorMessage.data[conn->errorMessage.len - 1] = svLast;
2143 }
2144
2145 PQclear(result);
2146
2147 return 1;
2148}
2149
2150
2151/*
2152 * PQfn - Send a function call to the POSTGRES backend.
2153 *
2154 * See fe-exec.c for documentation.
2155 */
2156PGresult *
2158 int *result_buf, int *actual_result_len,
2159 int result_is_int,
2160 const PQArgBlock *args, int nargs)
2161{
2162 bool needInput = false;
2164 char id;
2165 int msgLength;
2166 int avail;
2167 int i;
2168
2169 /* already validated by PQfn */
2171
2172 /* PQfn already validated connection state */
2173
2175 pqPutInt(fnid, 4, conn) < 0 || /* function id */
2176 pqPutInt(1, 2, conn) < 0 || /* # of format codes */
2177 pqPutInt(1, 2, conn) < 0 || /* format code: BINARY */
2178 pqPutInt(nargs, 2, conn) < 0) /* # of args */
2179 {
2180 /* error message should be set up already */
2181 return NULL;
2182 }
2183
2184 for (i = 0; i < nargs; ++i)
2185 { /* len.int4 + contents */
2186 if (pqPutInt(args[i].len, 4, conn))
2187 return NULL;
2188 if (args[i].len == -1)
2189 continue; /* it's NULL */
2190
2191 if (args[i].isint)
2192 {
2193 if (pqPutInt(args[i].u.integer, args[i].len, conn))
2194 return NULL;
2195 }
2196 else
2197 {
2198 if (pqPutnchar(args[i].u.ptr, args[i].len, conn))
2199 return NULL;
2200 }
2201 }
2202
2203 if (pqPutInt(1, 2, conn) < 0) /* result format code: BINARY */
2204 return NULL;
2205
2206 if (pqPutMsgEnd(conn) < 0 ||
2207 pqFlush(conn))
2208 return NULL;
2209
2210 for (;;)
2211 {
2212 if (needInput)
2213 {
2214 /* Wait for some data to arrive (or for the channel to close) */
2215 if (pqWait(true, false, conn) ||
2216 pqReadData(conn) < 0)
2217 break;
2218 }
2219
2220 /*
2221 * Scan the message. If we run out of data, loop around to try again.
2222 */
2223 needInput = true;
2224
2226 if (pqGetc(&id, conn))
2227 continue;
2228 if (pqGetInt(&msgLength, 4, conn))
2229 continue;
2230
2231 /*
2232 * Try to validate message type/length here. A length less than 4 is
2233 * definitely broken. Large lengths should only be believed for a few
2234 * message types.
2235 */
2236 if (msgLength < 4)
2237 {
2238 handleSyncLoss(conn, id, msgLength);
2239 break;
2240 }
2241 if (msgLength > 30000 && !VALID_LONG_MESSAGE_TYPE(id))
2242 {
2243 handleSyncLoss(conn, id, msgLength);
2244 break;
2245 }
2246
2247 /*
2248 * Can't process if message body isn't all here yet.
2249 */
2250 msgLength -= 4;
2251 avail = conn->inEnd - conn->inCursor;
2252 if (avail < msgLength)
2253 {
2254 /*
2255 * Before looping, enlarge the input buffer if needed to hold the
2256 * whole message. See notes in parseInput.
2257 */
2258 if (pqCheckInBufferSpace(conn->inCursor + (size_t) msgLength,
2259 conn))
2260 {
2261 /*
2262 * Abandon the connection. There's not much else we can
2263 * safely do; we can't just ignore the message or we could
2264 * miss important changes to the connection state.
2265 * pqCheckInBufferSpace() already reported the error.
2266 */
2268 break;
2269 }
2270 continue;
2271 }
2272
2273 /*
2274 * We should see V or E response to the command, but might get N
2275 * and/or A notices first. We also need to swallow the final Z before
2276 * returning.
2277 */
2278 switch (id)
2279 {
2281 if (pqGetInt(actual_result_len, 4, conn))
2282 continue;
2283 if (*actual_result_len != -1)
2284 {
2285 if (result_is_int)
2286 {
2287 if (pqGetInt(result_buf, *actual_result_len, conn))
2288 continue;
2289 }
2290 else
2291 {
2292 if (pqGetnchar(result_buf,
2293 *actual_result_len,
2294 conn))
2295 continue;
2296 }
2297 }
2298 /* correctly finished function result message */
2299 status = PGRES_COMMAND_OK;
2300 break;
2302 if (pqGetErrorNotice3(conn, true))
2303 continue;
2304 status = PGRES_FATAL_ERROR;
2305 break;
2307 /* handle notify and go back to processing return values */
2308 if (getNotify(conn))
2309 continue;
2310 break;
2312 /* handle notice and go back to processing return values */
2313 if (pqGetErrorNotice3(conn, false))
2314 continue;
2315 break;
2318 continue;
2319
2320 /* consume the message */
2321 pqParseDone(conn, conn->inStart + 5 + msgLength);
2322
2323 /*
2324 * If we already have a result object (probably an error), use
2325 * that. Otherwise, if we saw a function result message,
2326 * report COMMAND_OK. Otherwise, the backend violated the
2327 * protocol, so complain.
2328 */
2330 {
2331 if (status == PGRES_COMMAND_OK)
2332 {
2333 conn->result = PQmakeEmptyPGresult(conn, status);
2334 if (!conn->result)
2335 {
2336 libpq_append_conn_error(conn, "out of memory");
2338 }
2339 }
2340 else
2341 {
2342 libpq_append_conn_error(conn, "protocol error: no function result");
2344 }
2345 }
2346 /* and we're out */
2347 return pqPrepareAsyncResult(conn);
2350 continue;
2351 break;
2352 default:
2353 /* The backend violates the protocol. */
2354 libpq_append_conn_error(conn, "protocol error: id=0x%x", id);
2356
2357 /*
2358 * We can't call parsing done due to the protocol violation
2359 * (so message tracing wouldn't work), but trust the specified
2360 * message length as what to skip.
2361 */
2362 conn->inStart += 5 + msgLength;
2363 return pqPrepareAsyncResult(conn);
2364 }
2365
2366 /* Completed parsing this message, keep going */
2367 pqParseDone(conn, conn->inStart + 5 + msgLength);
2368 needInput = false;
2369 }
2370
2371 /*
2372 * We fall out of the loop only upon failing to read data.
2373 * conn->errorMessage has been set by pqWait or pqReadData. We want to
2374 * append it to any already-received error message.
2375 */
2377 return pqPrepareAsyncResult(conn);
2378}
2379
2380
2381/*
2382 * Construct startup packet
2383 *
2384 * Returns a malloc'd packet buffer, or NULL if out of memory
2385 */
2386char *
2389{
2390 char *startpacket;
2391 size_t len;
2392
2394 if (len == 0 || len > INT_MAX)
2395 return NULL;
2396
2397 *packetlen = len;
2398 startpacket = (char *) malloc(*packetlen);
2399 if (!startpacket)
2400 return NULL;
2401
2402 len = build_startup_packet(conn, startpacket, options);
2403 Assert(*packetlen == len);
2404
2405 return startpacket;
2406}
2407
2408/*
2409 * Build a startup packet given a filled-in PGconn structure.
2410 *
2411 * We need to figure out how much space is needed, then fill it in.
2412 * To avoid duplicate logic, this routine is called twice: the first time
2413 * (with packet == NULL) just counts the space needed, the second time
2414 * (with packet == allocated space) fills it in. Return value is the number
2415 * of bytes used, or zero in the unlikely event of size_t overflow.
2416 */
2417static size_t
2418build_startup_packet(const PGconn *conn, char *packet,
2420{
2421 size_t packet_len = 0;
2422 const PQEnvironmentOption *next_eo;
2423 const char *val;
2424
2425 /* Protocol version comes first. */
2426 if (packet)
2427 {
2429
2430 memcpy(packet + packet_len, &pv, sizeof(ProtocolVersion));
2431 }
2432 packet_len += sizeof(ProtocolVersion);
2433
2434 /* Add user name, database name, options */
2435
2436#define ADD_STARTUP_OPTION(optname, optval) \
2437 do { \
2438 if (packet) \
2439 strcpy(packet + packet_len, optname); \
2440 if (pg_add_size_overflow(packet_len, strlen(optname) + 1, &packet_len)) \
2441 return 0; \
2442 if (packet) \
2443 strcpy(packet + packet_len, optval); \
2444 if (pg_add_size_overflow(packet_len, strlen(optval) + 1, &packet_len)) \
2445 return 0; \
2446 } while(0)
2447
2448 if (conn->pguser && conn->pguser[0])
2449 ADD_STARTUP_OPTION("user", conn->pguser);
2450 if (conn->dbName && conn->dbName[0])
2451 ADD_STARTUP_OPTION("database", conn->dbName);
2452 if (conn->replication && conn->replication[0])
2453 ADD_STARTUP_OPTION("replication", conn->replication);
2454 if (conn->pgoptions && conn->pgoptions[0])
2455 ADD_STARTUP_OPTION("options", conn->pgoptions);
2456 if (conn->send_appname)
2457 {
2458 /* Use appname if present, otherwise use fallback */
2460 if (val && val[0])
2461 ADD_STARTUP_OPTION("application_name", val);
2462 }
2463
2465 ADD_STARTUP_OPTION("client_encoding", conn->client_encoding_initial);
2466
2467 /* Add any environment-driven GUC settings needed */
2468 for (next_eo = options; next_eo->envName; next_eo++)
2469 {
2470 if ((val = getenv(next_eo->envName)) != NULL)
2471 {
2472 if (pg_strcasecmp(val, "default") != 0)
2473 ADD_STARTUP_OPTION(next_eo->pgName, val);
2474 }
2475 }
2476
2477 /* Add trailing terminator */
2478 if (packet)
2479 packet[packet_len] = '\0';
2480 if (pg_add_size_overflow(packet_len, 1, &packet_len))
2481 return 0;
2482
2483 return packet_len;
2484}
int16_t int16
Definition: c.h:538
#define MemSet(start, val, len)
Definition: c.h:1024
int errmsg(const char *fmt,...)
Definition: elog.c:1080
void pqDropConnection(PGconn *conn, bool flushInput)
Definition: fe-connect.c:532
void * pqResultAlloc(PGresult *res, size_t nBytes, bool isBinary)
Definition: fe-exec.c:564
void pqSaveMessageField(PGresult *res, char code, const char *value)
Definition: fe-exec.c:1066
PGresult * pqPrepareAsyncResult(PGconn *conn)
Definition: fe-exec.c:857
void pqCommandQueueAdvance(PGconn *conn, bool isReadyForQuery, bool gotSync)
Definition: fe-exec.c:3159
void pqSetResultError(PGresult *res, PQExpBuffer errorMessage, int offset)
Definition: fe-exec.c:698
void pqSaveErrorResult(PGconn *conn)
Definition: fe-exec.c:809
int pqRowProcessor(PGconn *conn, const char **errmsgp)
Definition: fe-exec.c:1223
int PQgetlineAsync(PGconn *conn, char *buffer, int bufsize)
Definition: fe-exec.c:2918
PGresult * PQmakeEmptyPGresult(PGconn *conn, ExecStatusType status)
Definition: fe-exec.c:160
void pqInternalNotice(const PGNoticeHooks *hooks, const char *fmt,...)
Definition: fe-exec.c:944
void pqClearAsyncResult(PGconn *conn)
Definition: fe-exec.c:785
int PQisBusy(PGconn *conn)
Definition: fe-exec.c:2048
int pqSaveParameterStatus(PGconn *conn, const char *name, const char *value)
Definition: fe-exec.c:1091
char * pqResultStrdup(PGresult *res, const char *str)
Definition: fe-exec.c:681
int pqReadData(PGconn *conn)
Definition: fe-misc.c:606
int pqPutInt(int value, size_t bytes, PGconn *conn)
Definition: fe-misc.c:253
int pqFlush(PGconn *conn)
Definition: fe-misc.c:994
void pqParseDone(PGconn *conn, int newInStart)
Definition: fe-misc.c:443
int pqPutMsgStart(char msg_type, PGconn *conn)
Definition: fe-misc.c:473
int pqSkipnchar(size_t len, PGconn *conn)
Definition: fe-misc.c:187
int pqGetc(char *result, PGconn *conn)
Definition: fe-misc.c:77
int pqGetInt(int *result, size_t bytes, PGconn *conn)
Definition: fe-misc.c:216
int pqWait(int forRead, int forWrite, PGconn *conn)
Definition: fe-misc.c:1019
int pqGets(PQExpBuffer buf, PGconn *conn)
Definition: fe-misc.c:136
int pqPutnchar(const void *s, size_t len, PGconn *conn)
Definition: fe-misc.c:202
int pqCheckInBufferSpace(size_t bytes_needed, PGconn *conn)
Definition: fe-misc.c:351
int pqGetnchar(void *s, size_t len, PGconn *conn)
Definition: fe-misc.c:165
int PQmblenBounded(const char *s, int encoding)
Definition: fe-misc.c:1266
int pqPutMsgEnd(PGconn *conn)
Definition: fe-misc.c:532
#define DISPLAY_SIZE
void pqBuildErrorMessage3(PQExpBuffer msg, const PGresult *res, PGVerbosity verbosity, PGContextVisibility show_context)
void pqParseInput3(PGconn *conn)
Definition: fe-protocol3.c:70
char * pqBuildStartupPacket3(PGconn *conn, int *packetlen, const PQEnvironmentOption *options)
int pqEndcopy3(PGconn *conn)
static int getNotify(PGconn *conn)
static int getAnotherTuple(PGconn *conn, int msgLength)
Definition: fe-protocol3.c:777
static int getRowDescriptions(PGconn *conn, int msgLength)
Definition: fe-protocol3.c:518
static void reportErrorPosition(PQExpBuffer msg, const char *query, int loc, int encoding)
PGresult * pqFunctionCall3(PGconn *conn, Oid fnid, int *result_buf, int *actual_result_len, int result_is_int, const PQArgBlock *args, int nargs)
#define MIN_RIGHT_CUT
int pqGetlineAsync3(PGconn *conn, char *buffer, int bufsize)
int pqGetCopyData3(PGconn *conn, char **buffer, int async)
int pqGetNegotiateProtocolVersion3(PGconn *conn)
static int getParameterStatus(PGconn *conn)
static size_t build_startup_packet(const PGconn *conn, char *packet, const PQEnvironmentOption *options)
static void handleFatalError(PGconn *conn)
Definition: fe-protocol3.c:487
#define VALID_LONG_MESSAGE_TYPE(id)
Definition: fe-protocol3.c:38
static int getCopyStart(PGconn *conn, ExecStatusType copytype)
static void handleSyncLoss(PGconn *conn, char id, int msgLength)
Definition: fe-protocol3.c:503
static int getReadyForQuery(PGconn *conn)
#define ADD_STARTUP_OPTION(optname, optval)
static int getBackendKeyData(PGconn *conn, int msgLength)
static int getCopyDataMessage(PGconn *conn)
static int getParamDescriptions(PGconn *conn, int msgLength)
Definition: fe-protocol3.c:689
int pqGetline3(PGconn *conn, char *s, int maxlen)
int pqGetErrorNotice3(PGconn *conn, bool isError)
Definition: fe-protocol3.c:898
Assert(PointerIsAligned(start, uint64))
#define realloc(a, b)
Definition: header.h:60
#define free(a)
Definition: header.h:65
#define malloc(a)
Definition: header.h:50
#define bufsize
Definition: indent_globs.h:36
long val
Definition: informix.c:689
static bool pg_add_size_overflow(size_t a, size_t b, size_t *result)
Definition: int.h:608
int i
Definition: isn.c:77
#define PQgetResult
Definition: libpq-be-fe.h:246
#define PQclear
Definition: libpq-be-fe.h:245
#define PQresultErrorField
Definition: libpq-be-fe.h:249
@ CONNECTION_BAD
Definition: libpq-fe.h:85
ExecStatusType
Definition: libpq-fe.h:123
@ PGRES_COPY_IN
Definition: libpq-fe.h:132
@ PGRES_COPY_BOTH
Definition: libpq-fe.h:137
@ PGRES_COMMAND_OK
Definition: libpq-fe.h:125
@ PGRES_TUPLES_CHUNK
Definition: libpq-fe.h:142
@ PGRES_FATAL_ERROR
Definition: libpq-fe.h:136
@ PGRES_COPY_OUT
Definition: libpq-fe.h:131
@ PGRES_EMPTY_QUERY
Definition: libpq-fe.h:124
@ PGRES_PIPELINE_SYNC
Definition: libpq-fe.h:139
@ PGRES_NONFATAL_ERROR
Definition: libpq-fe.h:135
@ PGRES_TUPLES_OK
Definition: libpq-fe.h:128
PGContextVisibility
Definition: libpq-fe.h:163
@ PQSHOW_CONTEXT_ALWAYS
Definition: libpq-fe.h:166
@ PQSHOW_CONTEXT_ERRORS
Definition: libpq-fe.h:165
@ PQTRANS_INTRANS
Definition: libpq-fe.h:149
@ PQTRANS_IDLE
Definition: libpq-fe.h:147
@ PQTRANS_UNKNOWN
Definition: libpq-fe.h:151
@ PQTRANS_INERROR
Definition: libpq-fe.h:150
@ PQ_PIPELINE_OFF
Definition: libpq-fe.h:187
@ PQ_PIPELINE_ABORTED
Definition: libpq-fe.h:189
@ PQ_PIPELINE_ON
Definition: libpq-fe.h:188
PGVerbosity
Definition: libpq-fe.h:155
@ PQERRORS_VERBOSE
Definition: libpq-fe.h:158
@ PQERRORS_TERSE
Definition: libpq-fe.h:156
@ PQERRORS_SQLSTATE
Definition: libpq-fe.h:159
@ PGASYNC_COPY_OUT
Definition: libpq-int.h:223
@ PGASYNC_READY
Definition: libpq-int.h:217
@ PGASYNC_COPY_BOTH
Definition: libpq-int.h:224
@ PGASYNC_IDLE
Definition: libpq-int.h:215
@ PGASYNC_COPY_IN
Definition: libpq-int.h:222
@ PGASYNC_BUSY
Definition: libpq-int.h:216
@ PGQUERY_SIMPLE
Definition: libpq-int.h:320
@ PGQUERY_DESCRIBE
Definition: libpq-int.h:323
@ PGQUERY_CLOSE
Definition: libpq-int.h:325
@ PGQUERY_PREPARE
Definition: libpq-int.h:322
#define CMDSTATUS_LEN
Definition: libpq-int.h:83
#define pqIsnonblocking(conn)
Definition: libpq-int.h:939
#define pgHavePendingResult(conn)
Definition: libpq-int.h:932
void libpq_append_conn_error(PGconn *conn, const char *fmt,...)
Definition: oauth-utils.c:95
#define libpq_gettext(x)
Definition: oauth-utils.h:86
static char format
#define pg_hton32(x)
Definition: pg_bswap.h:121
const void size_t len
int32 encoding
Definition: pg_database.h:41
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:32
#define PGINVALID_SOCKET
Definition: port.h:31
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
#define PG_DIAG_INTERNAL_QUERY
Definition: postgres_ext.h:63
#define PG_DIAG_SCHEMA_NAME
Definition: postgres_ext.h:65
#define PG_DIAG_CONSTRAINT_NAME
Definition: postgres_ext.h:69
#define PG_DIAG_DATATYPE_NAME
Definition: postgres_ext.h:68
unsigned int Oid
Definition: postgres_ext.h:32
#define PG_DIAG_SOURCE_LINE
Definition: postgres_ext.h:71
#define PG_DIAG_STATEMENT_POSITION
Definition: postgres_ext.h:61
#define PG_DIAG_SOURCE_FILE
Definition: postgres_ext.h:70
#define PG_DIAG_MESSAGE_HINT
Definition: postgres_ext.h:60
#define PG_DIAG_SQLSTATE
Definition: postgres_ext.h:57
#define PG_DIAG_TABLE_NAME
Definition: postgres_ext.h:66
#define PG_DIAG_MESSAGE_PRIMARY
Definition: postgres_ext.h:58
#define PG_DIAG_COLUMN_NAME
Definition: postgres_ext.h:67
#define PG_DIAG_MESSAGE_DETAIL
Definition: postgres_ext.h:59
#define PG_DIAG_CONTEXT
Definition: postgres_ext.h:64
#define PG_DIAG_SEVERITY
Definition: postgres_ext.h:55
#define PG_DIAG_SOURCE_FUNCTION
Definition: postgres_ext.h:72
#define PG_DIAG_INTERNAL_POSITION
Definition: postgres_ext.h:62
#define PG_PROTOCOL_MAJOR(v)
Definition: pqcomm.h:86
uint32 ProtocolVersion
Definition: pqcomm.h:116
#define PG_PROTOCOL(m, n)
Definition: pqcomm.h:89
#define PG_PROTOCOL_MINOR(v)
Definition: pqcomm.h:87
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:90
void resetPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:146
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:265
void appendPQExpBufferChar(PQExpBuffer str, char ch)
Definition: pqexpbuffer.c:378
void appendPQExpBufferStr(PQExpBuffer str, const char *data)
Definition: pqexpbuffer.c:367
void termPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:129
#define PQExpBufferDataBroken(buf)
Definition: pqexpbuffer.h:67
#define PqMsg_CloseComplete
Definition: protocol.h:40
#define PqMsg_CopyDone
Definition: protocol.h:64
#define PqMsg_NotificationResponse
Definition: protocol.h:41
#define PqMsg_BindComplete
Definition: protocol.h:39
#define PqMsg_CopyData
Definition: protocol.h:65
#define PqMsg_ParameterDescription
Definition: protocol.h:58
#define PqMsg_FunctionCall
Definition: protocol.h:23
#define PqMsg_FunctionCallResponse
Definition: protocol.h:53
#define PqMsg_ReadyForQuery
Definition: protocol.h:55
#define PqMsg_CopyInResponse
Definition: protocol.h:45
#define PqMsg_EmptyQueryResponse
Definition: protocol.h:47
#define PqMsg_RowDescription
Definition: protocol.h:52
#define PqMsg_CopyBothResponse
Definition: protocol.h:54
#define PqMsg_ParameterStatus
Definition: protocol.h:51
#define PqMsg_NoData
Definition: protocol.h:56
#define PqMsg_Sync
Definition: protocol.h:27
#define PqMsg_BackendKeyData
Definition: protocol.h:48
#define PqMsg_CommandComplete
Definition: protocol.h:42
#define PqMsg_ErrorResponse
Definition: protocol.h:44
#define PqMsg_DataRow
Definition: protocol.h:43
#define PqMsg_NoticeResponse
Definition: protocol.h:49
#define PqMsg_CopyOutResponse
Definition: protocol.h:46
#define PqMsg_ParseComplete
Definition: protocol.h:38
PGconn * conn
Definition: streamutil.c:52
PQnoticeReceiver noticeRec
Definition: libpq-int.h:149
void * noticeRecArg
Definition: libpq-int.h:150
PGQueryClass queryclass
Definition: libpq-int.h:345
const char * pgName
Definition: libpq-int.h:265
const char * envName
Definition: libpq-int.h:264
const char * value
Definition: libpq-int.h:303
struct pgNotify * next
Definition: libpq-fe.h:234
int be_pid
Definition: libpq-fe.h:231
char * relname
Definition: libpq-fe.h:230
char * extra
Definition: libpq-fe.h:232
uint8 * be_cancel_key
Definition: libpq-int.h:554
char * replication
Definition: libpq-int.h:391
PGnotify * notifyHead
Definition: libpq-int.h:476
PGdataValue * rowBuf
Definition: libpq-int.h:593
pgsocket sock
Definition: libpq-int.h:499
char * inBuffer
Definition: libpq-int.h:576
ProtocolVersion pversion
Definition: libpq-int.h:503
char * pgoptions
Definition: libpq-int.h:387
bool send_appname
Definition: libpq-int.h:543
PGTransactionStatusType xactStatus
Definition: libpq-int.h:464
int inCursor
Definition: libpq-int.h:579
int be_pid
Definition: libpq-int.h:552
ProtocolVersion min_pversion
Definition: libpq-int.h:548
char * dbName
Definition: libpq-int.h:390
int inEnd
Definition: libpq-int.h:580
char * fbappname
Definition: libpq-int.h:389
PGnotify * notifyTail
Definition: libpq-int.h:477
int copy_already_done
Definition: libpq-int.h:475
PQExpBufferData workBuffer
Definition: libpq-int.h:687
int inStart
Definition: libpq-int.h:578
char * pguser
Definition: libpq-int.h:395
PGresult * result
Definition: libpq-int.h:606
PGVerbosity verbosity
Definition: libpq-int.h:560
char * client_encoding_initial
Definition: libpq-int.h:386
char * appname
Definition: libpq-int.h:388
PQExpBufferData errorMessage
Definition: libpq-int.h:683
bool error_result
Definition: libpq-int.h:607
int rowBufLen
Definition: libpq-int.h:594
char last_sqlstate[6]
Definition: libpq-int.h:465
PGAsyncStatusType asyncStatus
Definition: libpq-int.h:463
PGpipelineStatus pipelineStatus
Definition: libpq-int.h:469
char copy_is_binary
Definition: libpq-int.h:474
PGNoticeHooks noticeHooks
Definition: libpq-int.h:454
PGcmdQueueEntry * cmd_queue_head
Definition: libpq-int.h:489
int be_cancel_key_len
Definition: libpq-int.h:553
PGContextVisibility show_context
Definition: libpq-int.h:561
ConnStatusType status
Definition: libpq-int.h:462
int binary
Definition: libpq-int.h:176
PGNoticeHooks noticeHooks
Definition: libpq-int.h:183
char * errMsg
Definition: libpq-int.h:193
int numParameters
Definition: libpq-int.h:172
PGresAttDesc * attDescs
Definition: libpq-int.h:168
int numAttributes
Definition: libpq-int.h:167
char cmdStatus[CMDSTATUS_LEN]
Definition: libpq-int.h:175
PGMessageField * errFields
Definition: libpq-int.h:194
PGresParamDesc * paramDescs
Definition: libpq-int.h:173
ExecStatusType resultStatus
Definition: libpq-int.h:174
char * errQuery
Definition: libpq-int.h:195
int client_encoding
Definition: libpq-int.h:186
char * name
Definition: libpq-fe.h:307
int columnid
Definition: libpq-fe.h:309
int atttypmod
Definition: libpq-fe.h:313
int pg_encoding_dsplen(int encoding, const char *mbstr)
Definition: wchar.c:2176
int pg_encoding_max_length(int encoding)
Definition: wchar.c:2213