Line data Source code
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 :
48 : static void handleFatalError(PGconn *conn);
49 : static void handleSyncLoss(PGconn *conn, char id, int msgLength);
50 : static int getRowDescriptions(PGconn *conn, int msgLength);
51 : static int getParamDescriptions(PGconn *conn, int msgLength);
52 : static int getAnotherTuple(PGconn *conn, int msgLength);
53 : static int getParameterStatus(PGconn *conn);
54 : static int getBackendKeyData(PGconn *conn, int msgLength);
55 : static int getNotify(PGconn *conn);
56 : static int getCopyStart(PGconn *conn, ExecStatusType copytype);
57 : static int getReadyForQuery(PGconn *conn);
58 : static void reportErrorPosition(PQExpBuffer msg, const char *query,
59 : int loc, int encoding);
60 : static size_t build_startup_packet(const PGconn *conn, char *packet,
61 : const PQEnvironmentOption *options);
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 : */
69 : void
70 3587514 : pqParseInput3(PGconn *conn)
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 : */
85 13240064 : conn->inCursor = conn->inStart;
86 13240064 : if (pqGetc(&id, conn))
87 2718038 : return;
88 10522026 : if (pqGetInt(&msgLength, 4, conn))
89 3752 : 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 10518274 : if (msgLength < 4)
97 : {
98 0 : handleSyncLoss(conn, id, msgLength);
99 0 : return;
100 : }
101 10518274 : if (msgLength > 30000 && !VALID_LONG_MESSAGE_TYPE(id))
102 : {
103 0 : handleSyncLoss(conn, id, msgLength);
104 0 : return;
105 : }
106 :
107 : /*
108 : * Can't process if message body isn't all here yet.
109 : */
110 10518274 : msgLength -= 4;
111 10518274 : avail = conn->inEnd - conn->inCursor;
112 10518274 : 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 113352 : 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 : */
131 0 : handleFatalError(conn);
132 : }
133 113352 : 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 : */
152 10404922 : if (id == PqMsg_NotificationResponse)
153 : {
154 82 : if (getNotify(conn))
155 0 : return;
156 : }
157 10404840 : else if (id == PqMsg_NoticeResponse)
158 : {
159 157266 : if (pqGetErrorNotice3(conn, false))
160 0 : return;
161 : }
162 10247574 : else if (conn->asyncStatus != PGASYNC_BUSY)
163 : {
164 : /* If not IDLE state, just wait ... */
165 752372 : if (conn->asyncStatus != PGASYNC_IDLE)
166 752372 : 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 0 : if (id == PqMsg_ErrorResponse)
178 : {
179 0 : if (pqGetErrorNotice3(conn, false /* treat as notice */ ))
180 0 : return;
181 : }
182 0 : else if (id == PqMsg_ParameterStatus)
183 : {
184 0 : if (getParameterStatus(conn))
185 0 : return;
186 : }
187 : else
188 : {
189 : /* Any other case is unexpected and we summarily skip it */
190 0 : pqInternalNotice(&conn->noticeHooks,
191 : "message type 0x%02x arrived from server while idle",
192 : id);
193 : /* Discard the unexpected message */
194 0 : conn->inCursor += msgLength;
195 : }
196 : }
197 : else
198 : {
199 : /*
200 : * In BUSY state, we can process everything.
201 : */
202 9495202 : switch (id)
203 : {
204 624434 : case PqMsg_CommandComplete:
205 624434 : if (pqGets(&conn->workBuffer, conn))
206 0 : return;
207 624434 : if (!pgHavePendingResult(conn))
208 : {
209 311656 : conn->result = PQmakeEmptyPGresult(conn,
210 : PGRES_COMMAND_OK);
211 311656 : if (!conn->result)
212 : {
213 0 : libpq_append_conn_error(conn, "out of memory");
214 0 : pqSaveErrorResult(conn);
215 : }
216 : }
217 624434 : if (conn->result)
218 624434 : strlcpy(conn->result->cmdStatus, conn->workBuffer.data,
219 : CMDSTATUS_LEN);
220 624434 : conn->asyncStatus = PGASYNC_READY;
221 624434 : break;
222 44778 : case PqMsg_ErrorResponse:
223 44778 : if (pqGetErrorNotice3(conn, true))
224 0 : return;
225 44778 : conn->asyncStatus = PGASYNC_READY;
226 44778 : break;
227 658608 : case PqMsg_ReadyForQuery:
228 658608 : if (getReadyForQuery(conn))
229 0 : return;
230 658608 : if (conn->pipelineStatus != PQ_PIPELINE_OFF)
231 : {
232 532 : conn->result = PQmakeEmptyPGresult(conn,
233 : PGRES_PIPELINE_SYNC);
234 532 : if (!conn->result)
235 : {
236 0 : libpq_append_conn_error(conn, "out of memory");
237 0 : pqSaveErrorResult(conn);
238 : }
239 : else
240 : {
241 532 : conn->pipelineStatus = PQ_PIPELINE_ON;
242 532 : conn->asyncStatus = PGASYNC_READY;
243 : }
244 : }
245 : else
246 : {
247 : /* Advance the command queue and set us idle */
248 658076 : pqCommandQueueAdvance(conn, true, false);
249 658076 : conn->asyncStatus = PGASYNC_IDLE;
250 : }
251 658608 : break;
252 1418 : case PqMsg_EmptyQueryResponse:
253 1418 : if (!pgHavePendingResult(conn))
254 : {
255 1418 : conn->result = PQmakeEmptyPGresult(conn,
256 : PGRES_EMPTY_QUERY);
257 1418 : if (!conn->result)
258 : {
259 0 : libpq_append_conn_error(conn, "out of memory");
260 0 : pqSaveErrorResult(conn);
261 : }
262 : }
263 1418 : conn->asyncStatus = PGASYNC_READY;
264 1418 : break;
265 11132 : case PqMsg_ParseComplete:
266 : /* If we're doing PQprepare, we're done; else ignore */
267 11132 : if (conn->cmd_queue_head &&
268 11132 : conn->cmd_queue_head->queryclass == PGQUERY_PREPARE)
269 : {
270 4464 : if (!pgHavePendingResult(conn))
271 : {
272 4464 : conn->result = PQmakeEmptyPGresult(conn,
273 : PGRES_COMMAND_OK);
274 4464 : if (!conn->result)
275 : {
276 0 : libpq_append_conn_error(conn, "out of memory");
277 0 : pqSaveErrorResult(conn);
278 : }
279 : }
280 4464 : conn->asyncStatus = PGASYNC_READY;
281 : }
282 11132 : break;
283 22302 : case PqMsg_BindComplete:
284 : /* Nothing to do for this message type */
285 22302 : break;
286 34 : case PqMsg_CloseComplete:
287 : /* If we're doing PQsendClose, we're done; else ignore */
288 34 : if (conn->cmd_queue_head &&
289 34 : conn->cmd_queue_head->queryclass == PGQUERY_CLOSE)
290 : {
291 34 : if (!pgHavePendingResult(conn))
292 : {
293 34 : conn->result = PQmakeEmptyPGresult(conn,
294 : PGRES_COMMAND_OK);
295 34 : if (!conn->result)
296 : {
297 0 : libpq_append_conn_error(conn, "out of memory");
298 0 : pqSaveErrorResult(conn);
299 : }
300 : }
301 34 : conn->asyncStatus = PGASYNC_READY;
302 : }
303 34 : break;
304 423216 : case PqMsg_ParameterStatus:
305 423216 : if (getParameterStatus(conn))
306 0 : return;
307 423216 : break;
308 27262 : case PqMsg_BackendKeyData:
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 27262 : if (getBackendKeyData(conn, msgLength))
316 0 : return;
317 27262 : break;
318 320332 : case PqMsg_RowDescription:
319 320332 : if (conn->error_result ||
320 320332 : (conn->result != NULL &&
321 128 : conn->result->resultStatus == PGRES_FATAL_ERROR))
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 0 : conn->inCursor += msgLength;
328 : }
329 320332 : else if (conn->result == NULL ||
330 128 : (conn->cmd_queue_head &&
331 128 : conn->cmd_queue_head->queryclass == PGQUERY_DESCRIBE))
332 : {
333 : /* First 'T' in a query sequence */
334 320332 : if (getRowDescriptions(conn, msgLength))
335 0 : 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 : */
346 0 : conn->asyncStatus = PGASYNC_READY;
347 0 : return;
348 : }
349 320332 : break;
350 12638 : 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 12638 : if (conn->cmd_queue_head &&
363 12638 : conn->cmd_queue_head->queryclass == PGQUERY_DESCRIBE)
364 : {
365 12 : if (!pgHavePendingResult(conn))
366 : {
367 0 : conn->result = PQmakeEmptyPGresult(conn,
368 : PGRES_COMMAND_OK);
369 0 : if (!conn->result)
370 : {
371 0 : libpq_append_conn_error(conn, "out of memory");
372 0 : pqSaveErrorResult(conn);
373 : }
374 : }
375 12 : conn->asyncStatus = PGASYNC_READY;
376 : }
377 12638 : break;
378 140 : case PqMsg_ParameterDescription:
379 140 : if (getParamDescriptions(conn, msgLength))
380 0 : return;
381 140 : break;
382 7326902 : case PqMsg_DataRow:
383 7326902 : if (conn->result != NULL &&
384 7326902 : (conn->result->resultStatus == PGRES_TUPLES_OK ||
385 186 : conn->result->resultStatus == PGRES_TUPLES_CHUNK))
386 : {
387 : /* Read another tuple of a normal query response */
388 7326902 : if (getAnotherTuple(conn, msgLength))
389 0 : return;
390 : }
391 0 : else if (conn->error_result ||
392 0 : (conn->result != NULL &&
393 0 : conn->result->resultStatus == PGRES_FATAL_ERROR))
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 0 : conn->inCursor += msgLength;
400 : }
401 : else
402 : {
403 : /* Set up to report error at end of query */
404 0 : libpq_append_conn_error(conn, "server sent data (\"D\" message) without prior row description (\"T\" message)");
405 0 : pqSaveErrorResult(conn);
406 : /* Discard the unexpected message */
407 0 : conn->inCursor += msgLength;
408 : }
409 7326902 : break;
410 1126 : case PqMsg_CopyInResponse:
411 1126 : if (getCopyStart(conn, PGRES_COPY_IN))
412 0 : return;
413 1126 : conn->asyncStatus = PGASYNC_COPY_IN;
414 1126 : break;
415 9410 : case PqMsg_CopyOutResponse:
416 9410 : if (getCopyStart(conn, PGRES_COPY_OUT))
417 0 : return;
418 9410 : conn->asyncStatus = PGASYNC_COPY_OUT;
419 9410 : conn->copy_already_done = 0;
420 9410 : break;
421 1386 : case PqMsg_CopyBothResponse:
422 1386 : if (getCopyStart(conn, PGRES_COPY_BOTH))
423 0 : return;
424 1386 : conn->asyncStatus = PGASYNC_COPY_BOTH;
425 1386 : conn->copy_already_done = 0;
426 1386 : break;
427 6 : 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 6 : conn->inCursor += msgLength;
435 6 : break;
436 10078 : 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 10078 : break;
445 0 : default:
446 0 : libpq_append_conn_error(conn, "unexpected response from server; first received character was \"%c\"", id);
447 : /* build an error result holding the error message */
448 0 : pqSaveErrorResult(conn);
449 : /* not sure if we will see more, so go to ready state */
450 0 : conn->asyncStatus = PGASYNC_READY;
451 : /* Discard the unexpected message */
452 0 : conn->inCursor += msgLength;
453 0 : break;
454 : } /* switch on protocol character */
455 : }
456 : /* Successfully consumed this message */
457 9652550 : if (conn->inCursor == conn->inStart + 5 + msgLength)
458 : {
459 : /* Normal case: parsing agrees with specified length */
460 9652550 : pqParseDone(conn, conn->inCursor);
461 : }
462 0 : else if (conn->error_result && conn->status == CONNECTION_BAD)
463 : {
464 : /* The connection was abandoned and we already reported it */
465 0 : return;
466 : }
467 : else
468 : {
469 : /* Trouble --- report it */
470 0 : 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 */
472 0 : pqSaveErrorResult(conn);
473 0 : conn->asyncStatus = PGASYNC_READY;
474 : /* trust the specified message length as what to skip */
475 0 : 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 : */
486 : static void
487 0 : handleFatalError(PGconn *conn)
488 : {
489 : /* build an error result holding the error message */
490 0 : pqSaveErrorResult(conn);
491 0 : conn->asyncStatus = PGASYNC_READY; /* drop out of PQgetResult wait loop */
492 : /* flush input data since we're giving up on processing it */
493 0 : pqDropConnection(conn, true);
494 0 : conn->status = CONNECTION_BAD; /* No more connection to backend */
495 0 : }
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 : */
502 : static void
503 0 : handleSyncLoss(PGconn *conn, char id, int msgLength)
504 : {
505 0 : libpq_append_conn_error(conn, "lost synchronization with server: got message type \"%c\", length %d",
506 : id, msgLength);
507 0 : handleFatalError(conn);
508 0 : }
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 : */
517 : static int
518 320332 : getRowDescriptions(PGconn *conn, int msgLength)
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 320332 : if (!conn->cmd_queue_head ||
531 320332 : (conn->cmd_queue_head &&
532 320332 : conn->cmd_queue_head->queryclass == PGQUERY_DESCRIBE))
533 : {
534 130 : if (conn->result)
535 128 : result = conn->result;
536 : else
537 2 : result = PQmakeEmptyPGresult(conn, PGRES_COMMAND_OK);
538 : }
539 : else
540 320202 : result = PQmakeEmptyPGresult(conn, PGRES_TUPLES_OK);
541 320332 : if (!result)
542 : {
543 0 : errmsg = NULL; /* means "out of memory", see below */
544 0 : 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 320332 : if (pqGetInt(&(result->numAttributes), 2, conn))
550 : {
551 : /* We should not run out of data here, so complain */
552 0 : errmsg = libpq_gettext("insufficient data in \"T\" message");
553 0 : goto advance_and_error;
554 : }
555 320332 : nfields = result->numAttributes;
556 :
557 : /* allocate space for the attribute descriptors */
558 320332 : if (nfields > 0)
559 : {
560 319952 : result->attDescs = (PGresAttDesc *)
561 319952 : pqResultAlloc(result, nfields * sizeof(PGresAttDesc), true);
562 319952 : if (!result->attDescs)
563 : {
564 0 : errmsg = NULL; /* means "out of memory", see below */
565 0 : goto advance_and_error;
566 : }
567 4353440 : MemSet(result->attDescs, 0, nfields * sizeof(PGresAttDesc));
568 : }
569 :
570 : /* result->binary is true only if ALL columns are binary */
571 320332 : result->binary = (nfields > 0) ? 1 : 0;
572 :
573 : /* get type info */
574 1345284 : 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 2049904 : if (pqGets(&conn->workBuffer, conn) ||
584 2049904 : pqGetInt(&tableid, 4, conn) ||
585 2049904 : pqGetInt(&columnid, 2, conn) ||
586 2049904 : pqGetInt(&typid, 4, conn) ||
587 2049904 : pqGetInt(&typlen, 2, conn) ||
588 2049904 : pqGetInt(&atttypmod, 4, conn) ||
589 1024952 : pqGetInt(&format, 2, conn))
590 : {
591 : /* We should not run out of data here, so complain */
592 0 : errmsg = libpq_gettext("insufficient data in \"T\" message");
593 0 : 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 1024952 : columnid = (int) ((int16) columnid);
601 1024952 : typlen = (int) ((int16) typlen);
602 1024952 : format = (int) ((int16) format);
603 :
604 2049904 : result->attDescs[i].name = pqResultStrdup(result,
605 1024952 : conn->workBuffer.data);
606 1024952 : if (!result->attDescs[i].name)
607 : {
608 0 : errmsg = NULL; /* means "out of memory", see below */
609 0 : goto advance_and_error;
610 : }
611 1024952 : result->attDescs[i].tableid = tableid;
612 1024952 : result->attDescs[i].columnid = columnid;
613 1024952 : result->attDescs[i].format = format;
614 1024952 : result->attDescs[i].typid = typid;
615 1024952 : result->attDescs[i].typlen = typlen;
616 1024952 : result->attDescs[i].atttypmod = atttypmod;
617 :
618 1024952 : if (format != 1)
619 1024866 : result->binary = 0;
620 : }
621 :
622 : /* Success! */
623 320332 : 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 320332 : if ((!conn->cmd_queue_head) ||
630 320332 : (conn->cmd_queue_head &&
631 320332 : conn->cmd_queue_head->queryclass == PGQUERY_DESCRIBE))
632 : {
633 130 : conn->asyncStatus = PGASYNC_READY;
634 130 : 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 320202 : return 0;
644 :
645 0 : advance_and_error:
646 : /* Discard unsaved result, if any */
647 0 : if (result && result != conn->result)
648 0 : 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 : */
654 0 : pqClearAsyncResult(conn);
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 0 : if (!errmsg)
663 0 : errmsg = libpq_gettext("out of memory for query result");
664 :
665 0 : appendPQExpBuffer(&conn->errorMessage, "%s\n", errmsg);
666 0 : pqSaveErrorResult(conn);
667 :
668 : /*
669 : * Show the message as fully consumed, else pqParseInput3 will overwrite
670 : * our error with a complaint about that.
671 : */
672 0 : 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 0 : 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 : */
688 : static int
689 140 : getParamDescriptions(PGconn *conn, int msgLength)
690 : {
691 : PGresult *result;
692 140 : const char *errmsg = NULL; /* means "out of memory", see below */
693 : int nparams;
694 : int i;
695 :
696 140 : result = PQmakeEmptyPGresult(conn, PGRES_COMMAND_OK);
697 140 : if (!result)
698 0 : 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 140 : if (pqGetInt(&(result->numParameters), 2, conn))
703 0 : goto not_enough_data;
704 140 : nparams = result->numParameters;
705 :
706 : /* allocate space for the parameter descriptors */
707 140 : if (nparams > 0)
708 : {
709 8 : result->paramDescs = (PGresParamDesc *)
710 8 : pqResultAlloc(result, nparams * sizeof(PGresParamDesc), true);
711 8 : if (!result->paramDescs)
712 0 : goto advance_and_error;
713 14 : MemSet(result->paramDescs, 0, nparams * sizeof(PGresParamDesc));
714 : }
715 :
716 : /* get parameter info */
717 154 : for (i = 0; i < nparams; i++)
718 : {
719 : int typid;
720 :
721 14 : if (pqGetInt(&typid, 4, conn))
722 0 : goto not_enough_data;
723 14 : result->paramDescs[i].typid = typid;
724 : }
725 :
726 : /* Success! */
727 140 : conn->result = result;
728 :
729 140 : return 0;
730 :
731 0 : not_enough_data:
732 0 : errmsg = libpq_gettext("insufficient data in \"t\" message");
733 :
734 0 : advance_and_error:
735 : /* Discard unsaved result, if any */
736 0 : if (result && result != conn->result)
737 0 : 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 : */
743 0 : pqClearAsyncResult(conn);
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 0 : if (!errmsg)
752 0 : errmsg = libpq_gettext("out of memory");
753 0 : appendPQExpBuffer(&conn->errorMessage, "%s\n", errmsg);
754 0 : pqSaveErrorResult(conn);
755 :
756 : /*
757 : * Show the message as fully consumed, else pqParseInput3 will overwrite
758 : * our error with a complaint about that.
759 : */
760 0 : 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 0 : 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 : */
776 : static int
777 7326902 : getAnotherTuple(PGconn *conn, int msgLength)
778 : {
779 7326902 : PGresult *result = conn->result;
780 7326902 : 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 7326902 : if (pqGetInt(&tupnfields, 2, conn))
789 : {
790 : /* We should not run out of data here, so complain */
791 0 : errmsg = libpq_gettext("insufficient data in \"D\" message");
792 0 : goto advance_and_error;
793 : }
794 :
795 7326902 : if (tupnfields != nfields)
796 : {
797 0 : errmsg = libpq_gettext("unexpected field count in \"D\" message");
798 0 : goto advance_and_error;
799 : }
800 :
801 : /* Resize row buffer if needed */
802 7326902 : rowbuf = conn->rowBuf;
803 7326902 : if (nfields > conn->rowBufLen)
804 : {
805 416 : rowbuf = (PGdataValue *) realloc(rowbuf,
806 : nfields * sizeof(PGdataValue));
807 416 : if (!rowbuf)
808 : {
809 0 : errmsg = NULL; /* means "out of memory", see below */
810 0 : goto advance_and_error;
811 : }
812 416 : conn->rowBuf = rowbuf;
813 416 : conn->rowBufLen = nfields;
814 : }
815 :
816 : /* Scan the fields */
817 44305620 : for (i = 0; i < nfields; i++)
818 : {
819 : /* get the value length */
820 36978718 : if (pqGetInt(&vlen, 4, conn))
821 : {
822 : /* We should not run out of data here, so complain */
823 0 : errmsg = libpq_gettext("insufficient data in \"D\" message");
824 0 : goto advance_and_error;
825 : }
826 36978718 : 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 36978718 : rowbuf[i].value = conn->inBuffer + conn->inCursor;
834 :
835 : /* Skip over the data value */
836 36978718 : if (vlen > 0)
837 : {
838 34616680 : if (pqSkipnchar(vlen, conn))
839 : {
840 : /* We should not run out of data here, so complain */
841 0 : errmsg = libpq_gettext("insufficient data in \"D\" message");
842 0 : goto advance_and_error;
843 : }
844 : }
845 : }
846 :
847 : /* Process the collected row */
848 7326902 : errmsg = NULL;
849 7326902 : if (pqRowProcessor(conn, &errmsg))
850 7326902 : return 0; /* normal, successful exit */
851 :
852 : /* pqRowProcessor failed, fall through to report it */
853 :
854 0 : advance_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 : */
860 0 : pqClearAsyncResult(conn);
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 0 : if (!errmsg)
869 0 : errmsg = libpq_gettext("out of memory for query result");
870 :
871 0 : appendPQExpBuffer(&conn->errorMessage, "%s\n", errmsg);
872 0 : pqSaveErrorResult(conn);
873 :
874 : /*
875 : * Show the message as fully consumed, else pqParseInput3 will overwrite
876 : * our error with a complaint about that.
877 : */
878 0 : 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 0 : 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 : */
897 : int
898 202880 : pqGetErrorNotice3(PGconn *conn, bool isError)
899 : {
900 202880 : PGresult *res = NULL;
901 202880 : bool have_position = false;
902 : PQExpBufferData workBuf;
903 : char id;
904 :
905 : /* If in pipeline mode, set error indicator for it */
906 202880 : if (isError && conn->pipelineStatus != PQ_PIPELINE_OFF)
907 98 : conn->pipelineStatus = PQ_PIPELINE_ABORTED;
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 202880 : if (isError)
915 45546 : pqClearAsyncResult(conn);
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 202880 : 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 : */
934 202880 : res = PQmakeEmptyPGresult(conn, PGRES_EMPTY_QUERY);
935 202880 : if (res)
936 202880 : res->resultStatus = isError ? PGRES_FATAL_ERROR : PGRES_NONFATAL_ERROR;
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 1811554 : if (pqGetc(&id, conn))
947 0 : goto fail;
948 1811554 : if (id == '\0')
949 202880 : break; /* terminator found */
950 1608674 : if (pqGets(&workBuf, conn))
951 0 : goto fail;
952 1608674 : pqSaveMessageField(res, id, workBuf.data);
953 1608674 : if (id == PG_DIAG_SQLSTATE)
954 202880 : strlcpy(conn->last_sqlstate, workBuf.data,
955 : sizeof(conn->last_sqlstate));
956 1405794 : else if (id == PG_DIAG_STATEMENT_POSITION)
957 11034 : 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 202880 : if (have_position && res && conn->cmd_queue_head && conn->cmd_queue_head->query)
966 11034 : res->errQuery = pqResultStrdup(res, conn->cmd_queue_head->query);
967 :
968 : /*
969 : * Now build the "overall" error message for PQresultErrorMessage.
970 : */
971 202880 : resetPQExpBuffer(&workBuf);
972 202880 : pqBuildErrorMessage3(&workBuf, res, conn->verbosity, conn->show_context);
973 :
974 : /*
975 : * Either save error as current async result, or just emit the notice.
976 : */
977 202880 : if (isError)
978 : {
979 45546 : pqClearAsyncResult(conn); /* redundant, but be safe */
980 45546 : if (res)
981 : {
982 45546 : pqSetResultError(res, &workBuf, 0);
983 45546 : conn->result = res;
984 : }
985 : else
986 : {
987 : /* Fall back to using the internal-error processing paths */
988 0 : conn->error_result = true;
989 : }
990 :
991 45546 : if (PQExpBufferDataBroken(workBuf))
992 0 : libpq_append_conn_error(conn, "out of memory");
993 : else
994 45546 : appendPQExpBufferStr(&conn->errorMessage, workBuf.data);
995 : }
996 : else
997 : {
998 : /* if we couldn't allocate the result set, just discard the NOTICE */
999 157334 : 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 157334 : if (PQExpBufferDataBroken(workBuf))
1007 0 : res->errMsg = libpq_gettext("out of memory\n");
1008 : else
1009 157334 : res->errMsg = workBuf.data;
1010 157334 : if (res->noticeHooks.noticeRec != NULL)
1011 157334 : res->noticeHooks.noticeRec(res->noticeHooks.noticeRecArg, res);
1012 157334 : PQclear(res);
1013 : }
1014 : }
1015 :
1016 202880 : termPQExpBuffer(&workBuf);
1017 202880 : return 0;
1018 :
1019 0 : fail:
1020 0 : PQclear(res);
1021 0 : termPQExpBuffer(&workBuf);
1022 0 : 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 : */
1029 : void
1030 202886 : pqBuildErrorMessage3(PQExpBuffer msg, const PGresult *res,
1031 : PGVerbosity verbosity, PGContextVisibility show_context)
1032 : {
1033 : const char *val;
1034 202886 : const char *querytext = NULL;
1035 202886 : int querypos = 0;
1036 :
1037 : /* If we couldn't allocate a PGresult, just say "out of memory" */
1038 202886 : if (res == NULL)
1039 : {
1040 0 : appendPQExpBufferStr(msg, libpq_gettext("out of memory\n"));
1041 0 : 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 202886 : if (res->errFields == NULL)
1049 : {
1050 0 : if (res->errMsg && res->errMsg[0])
1051 0 : appendPQExpBufferStr(msg, res->errMsg);
1052 : else
1053 0 : appendPQExpBufferStr(msg, libpq_gettext("no error message available\n"));
1054 0 : return;
1055 : }
1056 :
1057 : /* Else build error message from relevant fields */
1058 202886 : val = PQresultErrorField(res, PG_DIAG_SEVERITY);
1059 202886 : if (val)
1060 202886 : appendPQExpBuffer(msg, "%s: ", val);
1061 :
1062 202886 : 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 : */
1070 66 : val = PQresultErrorField(res, PG_DIAG_SQLSTATE);
1071 66 : if (val)
1072 : {
1073 66 : appendPQExpBuffer(msg, "%s\n", val);
1074 66 : return;
1075 : }
1076 0 : verbosity = PQERRORS_TERSE;
1077 : }
1078 :
1079 202820 : if (verbosity == PQERRORS_VERBOSE)
1080 : {
1081 6 : val = PQresultErrorField(res, PG_DIAG_SQLSTATE);
1082 6 : if (val)
1083 6 : appendPQExpBuffer(msg, "%s: ", val);
1084 : }
1085 202820 : val = PQresultErrorField(res, PG_DIAG_MESSAGE_PRIMARY);
1086 202820 : if (val)
1087 202820 : appendPQExpBufferStr(msg, val);
1088 202820 : val = PQresultErrorField(res, PG_DIAG_STATEMENT_POSITION);
1089 202820 : if (val)
1090 : {
1091 11034 : if (verbosity != PQERRORS_TERSE && res->errQuery != NULL)
1092 : {
1093 : /* emit position as a syntax cursor display */
1094 11028 : querytext = res->errQuery;
1095 11028 : querypos = atoi(val);
1096 : }
1097 : else
1098 : {
1099 : /* emit position as text addition to primary message */
1100 : /* translator: %s represents a digit string */
1101 6 : appendPQExpBuffer(msg, libpq_gettext(" at character %s"),
1102 : val);
1103 : }
1104 : }
1105 : else
1106 : {
1107 191786 : val = PQresultErrorField(res, PG_DIAG_INTERNAL_POSITION);
1108 191786 : if (val)
1109 : {
1110 100 : querytext = PQresultErrorField(res, PG_DIAG_INTERNAL_QUERY);
1111 100 : if (verbosity != PQERRORS_TERSE && querytext != NULL)
1112 : {
1113 : /* emit position as a syntax cursor display */
1114 100 : querypos = atoi(val);
1115 : }
1116 : else
1117 : {
1118 : /* emit position as text addition to primary message */
1119 : /* translator: %s represents a digit string */
1120 0 : appendPQExpBuffer(msg, libpq_gettext(" at character %s"),
1121 : val);
1122 : }
1123 : }
1124 : }
1125 202820 : appendPQExpBufferChar(msg, '\n');
1126 202820 : if (verbosity != PQERRORS_TERSE)
1127 : {
1128 202206 : if (querytext && querypos > 0)
1129 11128 : reportErrorPosition(msg, querytext, querypos,
1130 11128 : res->client_encoding);
1131 202206 : val = PQresultErrorField(res, PG_DIAG_MESSAGE_DETAIL);
1132 202206 : if (val)
1133 12172 : appendPQExpBuffer(msg, libpq_gettext("DETAIL: %s\n"), val);
1134 202206 : val = PQresultErrorField(res, PG_DIAG_MESSAGE_HINT);
1135 202206 : if (val)
1136 134774 : appendPQExpBuffer(msg, libpq_gettext("HINT: %s\n"), val);
1137 202206 : val = PQresultErrorField(res, PG_DIAG_INTERNAL_QUERY);
1138 202206 : if (val)
1139 100 : appendPQExpBuffer(msg, libpq_gettext("QUERY: %s\n"), val);
1140 202206 : if (show_context == PQSHOW_CONTEXT_ALWAYS ||
1141 201936 : (show_context == PQSHOW_CONTEXT_ERRORS &&
1142 201936 : res->resultStatus == PGRES_FATAL_ERROR))
1143 : {
1144 45392 : val = PQresultErrorField(res, PG_DIAG_CONTEXT);
1145 45392 : if (val)
1146 2518 : appendPQExpBuffer(msg, libpq_gettext("CONTEXT: %s\n"),
1147 : val);
1148 : }
1149 : }
1150 202820 : if (verbosity == PQERRORS_VERBOSE)
1151 : {
1152 6 : val = PQresultErrorField(res, PG_DIAG_SCHEMA_NAME);
1153 6 : if (val)
1154 0 : appendPQExpBuffer(msg,
1155 0 : libpq_gettext("SCHEMA NAME: %s\n"), val);
1156 6 : val = PQresultErrorField(res, PG_DIAG_TABLE_NAME);
1157 6 : if (val)
1158 0 : appendPQExpBuffer(msg,
1159 0 : libpq_gettext("TABLE NAME: %s\n"), val);
1160 6 : val = PQresultErrorField(res, PG_DIAG_COLUMN_NAME);
1161 6 : if (val)
1162 0 : appendPQExpBuffer(msg,
1163 0 : libpq_gettext("COLUMN NAME: %s\n"), val);
1164 6 : val = PQresultErrorField(res, PG_DIAG_DATATYPE_NAME);
1165 6 : if (val)
1166 0 : appendPQExpBuffer(msg,
1167 0 : libpq_gettext("DATATYPE NAME: %s\n"), val);
1168 6 : val = PQresultErrorField(res, PG_DIAG_CONSTRAINT_NAME);
1169 6 : if (val)
1170 0 : appendPQExpBuffer(msg,
1171 0 : libpq_gettext("CONSTRAINT NAME: %s\n"), val);
1172 : }
1173 202820 : if (verbosity == PQERRORS_VERBOSE)
1174 : {
1175 : const char *valf;
1176 : const char *vall;
1177 :
1178 6 : valf = PQresultErrorField(res, PG_DIAG_SOURCE_FILE);
1179 6 : vall = PQresultErrorField(res, PG_DIAG_SOURCE_LINE);
1180 6 : val = PQresultErrorField(res, PG_DIAG_SOURCE_FUNCTION);
1181 6 : if (val || valf || vall)
1182 : {
1183 6 : appendPQExpBufferStr(msg, libpq_gettext("LOCATION: "));
1184 6 : if (val)
1185 6 : appendPQExpBuffer(msg, libpq_gettext("%s, "), val);
1186 6 : if (valf && vall) /* unlikely we'd have just one */
1187 6 : appendPQExpBuffer(msg, libpq_gettext("%s:%s"),
1188 : valf, vall);
1189 6 : 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 : */
1200 : static void
1201 11128 : reportErrorPosition(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 11128 : loc--;
1223 11128 : if (loc < 0)
1224 0 : return;
1225 :
1226 : /* Need a writable copy of the query */
1227 11128 : wquery = strdup(query);
1228 11128 : if (wquery == NULL)
1229 0 : 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 11128 : slen = strlen(wquery) + 1;
1249 11128 : if (slen > SIZE_MAX / sizeof(int))
1250 : {
1251 0 : free(wquery);
1252 0 : return;
1253 : }
1254 :
1255 11128 : qidx = (int *) malloc(slen * sizeof(int));
1256 11128 : if (qidx == NULL)
1257 : {
1258 0 : free(wquery);
1259 0 : return;
1260 : }
1261 11128 : scridx = (int *) malloc(slen * sizeof(int));
1262 11128 : if (scridx == NULL)
1263 : {
1264 0 : free(qidx);
1265 0 : free(wquery);
1266 0 : return;
1267 : }
1268 :
1269 : /* We can optimize a bit if it's a single-byte encoding */
1270 11128 : 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 11128 : qoffset = 0;
1282 11128 : scroffset = 0;
1283 11128 : loc_line = 1;
1284 11128 : ibeg = 0;
1285 11128 : iend = -1; /* -1 means not set yet */
1286 :
1287 608150 : for (cno = 0; wquery[qoffset] != '\0'; cno++)
1288 : {
1289 598210 : char ch = wquery[qoffset];
1290 :
1291 598210 : qidx[cno] = qoffset;
1292 598210 : 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 598210 : if (ch == '\t')
1300 978 : 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 597232 : else if (ch == '\r' || ch == '\n')
1307 : {
1308 3900 : if (cno < loc)
1309 : {
1310 2712 : if (ch == '\r' ||
1311 2706 : cno == 0 ||
1312 2706 : wquery[qidx[cno - 1]] != '\r')
1313 2712 : loc_line++;
1314 : /* extract beginning = last line start before loc. */
1315 2712 : ibeg = cno + 1;
1316 : }
1317 : else
1318 : {
1319 : /* set extract end. */
1320 1188 : iend = cno;
1321 : /* done scanning. */
1322 1188 : break;
1323 : }
1324 : }
1325 :
1326 : /* Advance */
1327 597022 : if (mb_encoding)
1328 : {
1329 : int w;
1330 :
1331 596646 : w = pg_encoding_dsplen(encoding, &wquery[qoffset]);
1332 : /* treat any non-tab control chars as width 1 */
1333 596646 : if (w <= 0)
1334 2712 : w = 1;
1335 596646 : scroffset += w;
1336 596646 : qoffset += PQmblenBounded(&wquery[qoffset], encoding);
1337 : }
1338 : else
1339 : {
1340 : /* We assume wide chars only exist in multibyte encodings */
1341 376 : scroffset++;
1342 376 : qoffset++;
1343 : }
1344 : }
1345 : /* Fix up if we didn't find an end-of-line after loc */
1346 11128 : if (iend < 0)
1347 : {
1348 9940 : iend = cno; /* query length in chars, +1 */
1349 9940 : qidx[iend] = qoffset;
1350 9940 : scridx[iend] = scroffset;
1351 : }
1352 :
1353 : /* Print only if loc is within computed query length */
1354 11128 : if (loc <= cno)
1355 : {
1356 : /* If the line extracted is too long, we truncate it. */
1357 11110 : beg_trunc = false;
1358 11110 : end_trunc = false;
1359 11110 : 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 2982 : if (scridx[ibeg] + DISPLAY_SIZE >= scridx[loc] + MIN_RIGHT_CUT)
1367 : {
1368 27532 : while (scridx[iend] - scridx[ibeg] > DISPLAY_SIZE)
1369 25824 : iend--;
1370 1708 : end_trunc = true;
1371 : }
1372 : else
1373 : {
1374 : /* Truncate right if not too close to loc. */
1375 15084 : while (scridx[loc] + MIN_RIGHT_CUT < scridx[iend])
1376 : {
1377 13810 : iend--;
1378 13810 : end_trunc = true;
1379 : }
1380 :
1381 : /* Truncate left if still too long. */
1382 26430 : while (scridx[iend] - scridx[ibeg] > DISPLAY_SIZE)
1383 : {
1384 25156 : ibeg++;
1385 25156 : beg_trunc = true;
1386 : }
1387 : }
1388 : }
1389 :
1390 : /* truncate working copy at desired endpoint */
1391 11110 : wquery[qidx[iend]] = '\0';
1392 :
1393 : /* Begin building the finished message. */
1394 11110 : i = msg->len;
1395 11110 : appendPQExpBuffer(msg, libpq_gettext("LINE %d: "), loc_line);
1396 11110 : if (beg_trunc)
1397 1274 : appendPQExpBufferStr(msg, "...");
1398 :
1399 : /*
1400 : * While we have the prefix in the msg buffer, compute its screen
1401 : * width.
1402 : */
1403 11110 : scroffset = 0;
1404 103824 : for (; i < msg->len; i += PQmblenBounded(&msg->data[i], encoding))
1405 : {
1406 92714 : int w = pg_encoding_dsplen(encoding, &msg->data[i]);
1407 :
1408 92714 : if (w <= 0)
1409 0 : w = 1;
1410 92714 : scroffset += w;
1411 : }
1412 :
1413 : /* Finish up the LINE message line. */
1414 11110 : appendPQExpBufferStr(msg, &wquery[qidx[ibeg]]);
1415 11110 : if (end_trunc)
1416 2624 : appendPQExpBufferStr(msg, "...");
1417 11110 : appendPQExpBufferChar(msg, '\n');
1418 :
1419 : /* Now emit the cursor marker line. */
1420 11110 : scroffset += scridx[loc] - scridx[ibeg];
1421 350006 : for (i = 0; i < scroffset; i++)
1422 338896 : appendPQExpBufferChar(msg, ' ');
1423 11110 : appendPQExpBufferChar(msg, '^');
1424 11110 : appendPQExpBufferChar(msg, '\n');
1425 : }
1426 :
1427 : /* Clean up. */
1428 11128 : free(scridx);
1429 11128 : free(qidx);
1430 11128 : 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 : */
1442 : int
1443 0 : pqGetNegotiateProtocolVersion3(PGconn *conn)
1444 : {
1445 : int their_version;
1446 : int num;
1447 :
1448 0 : if (pqGetInt(&their_version, 4, conn) != 0)
1449 0 : goto eof;
1450 :
1451 0 : if (pqGetInt(&num, 4, conn) != 0)
1452 0 : goto eof;
1453 :
1454 : /* Check the protocol version */
1455 0 : if (their_version > conn->pversion)
1456 : {
1457 0 : libpq_append_conn_error(conn, "received invalid protocol negotiation message: server requested downgrade to a higher-numbered version");
1458 0 : goto failure;
1459 : }
1460 :
1461 0 : if (their_version < PG_PROTOCOL(3, 0))
1462 : {
1463 0 : libpq_append_conn_error(conn, "received invalid protocol negotiation message: server requested downgrade to pre-3.0 protocol version");
1464 0 : goto failure;
1465 : }
1466 :
1467 : /* 3.1 never existed, we went straight from 3.0 to 3.2 */
1468 0 : if (their_version == PG_PROTOCOL(3, 1))
1469 : {
1470 0 : libpq_append_conn_error(conn, "received invalid protocol negotiation message: server requested downgrade to non-existent 3.1 protocol version");
1471 0 : goto failure;
1472 : }
1473 :
1474 0 : if (num < 0)
1475 : {
1476 0 : libpq_append_conn_error(conn, "received invalid protocol negotiation message: server reported negative number of unsupported parameters");
1477 0 : goto failure;
1478 : }
1479 :
1480 0 : if (their_version == conn->pversion && num == 0)
1481 : {
1482 0 : libpq_append_conn_error(conn, "received invalid protocol negotiation message: server negotiated but asks for no changes");
1483 0 : goto failure;
1484 : }
1485 :
1486 0 : if (their_version < conn->min_pversion)
1487 : {
1488 0 : 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",
1492 0 : PG_PROTOCOL_MAJOR(conn->min_pversion),
1493 0 : PG_PROTOCOL_MINOR(conn->min_pversion));
1494 :
1495 0 : goto failure;
1496 : }
1497 :
1498 : /* the version is acceptable */
1499 0 : 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 0 : for (int i = 0; i < num; i++)
1506 : {
1507 0 : if (pqGets(&conn->workBuffer, conn))
1508 : {
1509 0 : goto eof;
1510 : }
1511 0 : if (strncmp(conn->workBuffer.data, "_pq_.", 5) != 0)
1512 : {
1513 0 : 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 0 : goto failure;
1515 : }
1516 0 : libpq_append_conn_error(conn, "received invalid protocol negotiation message: server reported an unsupported parameter that was not requested (\"%s\")", conn->workBuffer.data);
1517 0 : goto failure;
1518 : }
1519 :
1520 0 : return 0;
1521 :
1522 0 : eof:
1523 0 : libpq_append_conn_error(conn, "received invalid protocol negotiation message: message too short");
1524 0 : failure:
1525 0 : conn->asyncStatus = PGASYNC_READY;
1526 0 : pqSaveErrorResult(conn);
1527 0 : 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 : */
1539 : static int
1540 423216 : getParameterStatus(PGconn *conn)
1541 : {
1542 : PQExpBufferData valueBuf;
1543 :
1544 : /* Get the parameter name */
1545 423216 : if (pqGets(&conn->workBuffer, conn))
1546 0 : return EOF;
1547 : /* Get the parameter value (could be large) */
1548 423216 : initPQExpBuffer(&valueBuf);
1549 423216 : if (pqGets(&valueBuf, conn))
1550 : {
1551 0 : termPQExpBuffer(&valueBuf);
1552 0 : return EOF;
1553 : }
1554 : /* And save it */
1555 423216 : if (!pqSaveParameterStatus(conn, conn->workBuffer.data, valueBuf.data))
1556 : {
1557 0 : libpq_append_conn_error(conn, "out of memory");
1558 0 : handleFatalError(conn);
1559 : }
1560 423216 : termPQExpBuffer(&valueBuf);
1561 423216 : 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 : */
1570 : static int
1571 27262 : getBackendKeyData(PGconn *conn, int msgLength)
1572 : {
1573 : int cancel_key_len;
1574 :
1575 27262 : if (conn->be_cancel_key)
1576 : {
1577 0 : free(conn->be_cancel_key);
1578 0 : conn->be_cancel_key = NULL;
1579 0 : conn->be_cancel_key_len = 0;
1580 : }
1581 :
1582 27262 : if (pqGetInt(&(conn->be_pid), 4, conn))
1583 0 : return EOF;
1584 :
1585 27262 : cancel_key_len = 5 + msgLength - (conn->inCursor - conn->inStart);
1586 :
1587 27262 : if (cancel_key_len != 4 && conn->pversion == PG_PROTOCOL(3, 0))
1588 : {
1589 0 : 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);
1590 0 : handleFatalError(conn);
1591 0 : return 0;
1592 : }
1593 :
1594 27262 : if (cancel_key_len < 4)
1595 : {
1596 0 : libpq_append_conn_error(conn, "received invalid BackendKeyData message: cancel key with length %d is too short (minimum 4 bytes)", cancel_key_len);
1597 0 : handleFatalError(conn);
1598 0 : return 0;
1599 : }
1600 :
1601 27262 : if (cancel_key_len > 256)
1602 : {
1603 0 : libpq_append_conn_error(conn, "received invalid BackendKeyData message: cancel key with length %d is too long (maximum 256 bytes)", cancel_key_len);
1604 0 : handleFatalError(conn);
1605 0 : return 0;
1606 : }
1607 :
1608 27262 : conn->be_cancel_key = malloc(cancel_key_len);
1609 27262 : if (conn->be_cancel_key == NULL)
1610 : {
1611 0 : libpq_append_conn_error(conn, "out of memory");
1612 0 : handleFatalError(conn);
1613 0 : return 0;
1614 : }
1615 27262 : if (pqGetnchar(conn->be_cancel_key, cancel_key_len, conn))
1616 : {
1617 0 : free(conn->be_cancel_key);
1618 0 : conn->be_cancel_key = NULL;
1619 0 : return EOF;
1620 : }
1621 27262 : conn->be_cancel_key_len = cancel_key_len;
1622 27262 : 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 : */
1634 : static int
1635 82 : getNotify(PGconn *conn)
1636 : {
1637 : int be_pid;
1638 : char *svname;
1639 : int nmlen;
1640 : int extralen;
1641 : PGnotify *newNotify;
1642 :
1643 82 : if (pqGetInt(&be_pid, 4, conn))
1644 0 : return EOF;
1645 82 : if (pqGets(&conn->workBuffer, conn))
1646 0 : return EOF;
1647 : /* must save name while getting extra string */
1648 82 : svname = strdup(conn->workBuffer.data);
1649 82 : 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 0 : libpq_append_conn_error(conn, "out of memory");
1658 0 : handleFatalError(conn);
1659 0 : return 0;
1660 : }
1661 82 : if (pqGets(&conn->workBuffer, conn))
1662 : {
1663 0 : free(svname);
1664 0 : 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 82 : nmlen = strlen(svname);
1673 82 : extralen = strlen(conn->workBuffer.data);
1674 82 : newNotify = (PGnotify *) malloc(sizeof(PGnotify) + nmlen + extralen + 2);
1675 82 : if (!newNotify)
1676 : {
1677 0 : free(svname);
1678 0 : libpq_append_conn_error(conn, "out of memory");
1679 0 : handleFatalError(conn);
1680 0 : return 0;
1681 : }
1682 :
1683 82 : newNotify->relname = (char *) newNotify + sizeof(PGnotify);
1684 82 : strcpy(newNotify->relname, svname);
1685 82 : newNotify->extra = newNotify->relname + nmlen + 1;
1686 82 : strcpy(newNotify->extra, conn->workBuffer.data);
1687 82 : newNotify->be_pid = be_pid;
1688 82 : newNotify->next = NULL;
1689 82 : if (conn->notifyTail)
1690 42 : conn->notifyTail->next = newNotify;
1691 : else
1692 40 : conn->notifyHead = newNotify;
1693 82 : conn->notifyTail = newNotify;
1694 :
1695 82 : free(svname);
1696 82 : 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 : */
1705 : static int
1706 11922 : getCopyStart(PGconn *conn, ExecStatusType copytype)
1707 : {
1708 : PGresult *result;
1709 : int nfields;
1710 : int i;
1711 :
1712 11922 : result = PQmakeEmptyPGresult(conn, copytype);
1713 11922 : if (!result)
1714 0 : goto failure;
1715 :
1716 11922 : if (pqGetc(&conn->copy_is_binary, conn))
1717 0 : goto failure;
1718 11922 : result->binary = conn->copy_is_binary;
1719 : /* the next two bytes are the number of fields */
1720 11922 : if (pqGetInt(&(result->numAttributes), 2, conn))
1721 0 : goto failure;
1722 11922 : nfields = result->numAttributes;
1723 :
1724 : /* allocate space for the attribute descriptors */
1725 11922 : if (nfields > 0)
1726 : {
1727 9924 : result->attDescs = (PGresAttDesc *)
1728 9924 : pqResultAlloc(result, nfields * sizeof(PGresAttDesc), true);
1729 9924 : if (!result->attDescs)
1730 0 : goto failure;
1731 109484 : MemSet(result->attDescs, 0, nfields * sizeof(PGresAttDesc));
1732 : }
1733 :
1734 46416 : for (i = 0; i < nfields; i++)
1735 : {
1736 : int format;
1737 :
1738 34494 : if (pqGetInt(&format, 2, conn))
1739 0 : 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 34494 : format = (int) ((int16) format);
1746 34494 : result->attDescs[i].format = format;
1747 : }
1748 :
1749 : /* Success! */
1750 11922 : conn->result = result;
1751 11922 : return 0;
1752 :
1753 0 : failure:
1754 0 : PQclear(result);
1755 0 : return EOF;
1756 : }
1757 :
1758 : /*
1759 : * getReadyForQuery - process ReadyForQuery message
1760 : */
1761 : static int
1762 660748 : getReadyForQuery(PGconn *conn)
1763 : {
1764 : char xact_status;
1765 :
1766 660748 : if (pqGetc(&xact_status, conn))
1767 0 : return EOF;
1768 660748 : switch (xact_status)
1769 : {
1770 502774 : case 'I':
1771 502774 : conn->xactStatus = PQTRANS_IDLE;
1772 502774 : break;
1773 156134 : case 'T':
1774 156134 : conn->xactStatus = PQTRANS_INTRANS;
1775 156134 : break;
1776 1840 : case 'E':
1777 1840 : conn->xactStatus = PQTRANS_INERROR;
1778 1840 : break;
1779 0 : default:
1780 0 : conn->xactStatus = PQTRANS_UNKNOWN;
1781 0 : break;
1782 : }
1783 :
1784 660748 : 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 : */
1793 : static int
1794 5929570 : getCopyDataMessage(PGconn *conn)
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 : */
1807 5929638 : conn->inCursor = conn->inStart;
1808 5929638 : if (pqGetc(&id, conn))
1809 565594 : return 0;
1810 5364044 : if (pqGetInt(&msgLength, 4, conn))
1811 1600 : return 0;
1812 5362444 : if (msgLength < 4)
1813 : {
1814 0 : handleSyncLoss(conn, id, msgLength);
1815 0 : return -2;
1816 : }
1817 5362444 : avail = conn->inEnd - conn->inCursor;
1818 5362444 : 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 422830 : 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 : */
1833 0 : handleFatalError(conn);
1834 0 : return -2;
1835 : }
1836 422830 : 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 4939614 : switch (id)
1846 : {
1847 0 : case PqMsg_NotificationResponse:
1848 0 : if (getNotify(conn))
1849 0 : return 0;
1850 0 : break;
1851 68 : case PqMsg_NoticeResponse:
1852 68 : if (pqGetErrorNotice3(conn, false))
1853 0 : return 0;
1854 68 : break;
1855 0 : case PqMsg_ParameterStatus:
1856 0 : if (getParameterStatus(conn))
1857 0 : return 0;
1858 0 : break;
1859 4929738 : case PqMsg_CopyData:
1860 4929738 : return msgLength;
1861 9710 : 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 : */
1868 9710 : if (conn->asyncStatus == PGASYNC_COPY_BOTH)
1869 22 : conn->asyncStatus = PGASYNC_COPY_IN;
1870 : else
1871 9688 : conn->asyncStatus = PGASYNC_BUSY;
1872 9710 : return -1;
1873 98 : default: /* treat as end of copy */
1874 :
1875 : /*
1876 : * Any other message terminates either COPY_IN or COPY_BOTH
1877 : * mode.
1878 : */
1879 98 : conn->asyncStatus = PGASYNC_BUSY;
1880 98 : return -1;
1881 : }
1882 :
1883 : /* Drop the processed message and loop around for another */
1884 68 : pqParseDone(conn, conn->inCursor);
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 : */
1898 : int
1899 5680564 : pqGetCopyData3(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 5929570 : msgLength = getCopyDataMessage(conn);
1911 5929570 : if (msgLength < 0)
1912 9808 : return msgLength; /* end-of-copy or error */
1913 5919762 : if (msgLength == 0)
1914 : {
1915 : /* Don't block if async read requested */
1916 990024 : if (async)
1917 741018 : return 0;
1918 : /* Need to load more data */
1919 498012 : if (pqWait(true, false, conn) ||
1920 249006 : pqReadData(conn) < 0)
1921 0 : return -2;
1922 249006 : continue;
1923 : }
1924 :
1925 : /*
1926 : * Drop zero-length messages (shouldn't happen anyway). Otherwise
1927 : * pass the data back to the caller.
1928 : */
1929 4929738 : msgLength -= 4;
1930 4929738 : if (msgLength > 0)
1931 : {
1932 4929738 : *buffer = (char *) malloc(msgLength + 1);
1933 4929738 : if (*buffer == NULL)
1934 : {
1935 0 : libpq_append_conn_error(conn, "out of memory");
1936 0 : return -2;
1937 : }
1938 4929738 : memcpy(*buffer, &conn->inBuffer[conn->inCursor], msgLength);
1939 4929738 : (*buffer)[msgLength] = '\0'; /* Add terminating null */
1940 :
1941 : /* Mark message consumed */
1942 4929738 : pqParseDone(conn, conn->inCursor + msgLength);
1943 :
1944 4929738 : return msgLength;
1945 : }
1946 :
1947 : /* Empty, so drop it and loop around for another */
1948 0 : pqParseDone(conn, conn->inCursor);
1949 : }
1950 : }
1951 :
1952 : /*
1953 : * PQgetline - gets a newline-terminated string from the backend.
1954 : *
1955 : * See fe-exec.c for documentation.
1956 : */
1957 : int
1958 0 : pqGetline3(PGconn *conn, char *s, int maxlen)
1959 : {
1960 : int status;
1961 :
1962 0 : if (conn->sock == PGINVALID_SOCKET ||
1963 0 : (conn->asyncStatus != PGASYNC_COPY_OUT &&
1964 0 : conn->asyncStatus != PGASYNC_COPY_BOTH) ||
1965 0 : conn->copy_is_binary)
1966 : {
1967 0 : libpq_append_conn_error(conn, "PQgetline: not doing text COPY OUT");
1968 0 : *s = '\0';
1969 0 : return EOF;
1970 : }
1971 :
1972 0 : while ((status = PQgetlineAsync(conn, s, maxlen - 1)) == 0)
1973 : {
1974 : /* need to load more data */
1975 0 : if (pqWait(true, false, conn) ||
1976 0 : pqReadData(conn) < 0)
1977 : {
1978 0 : *s = '\0';
1979 0 : return EOF;
1980 : }
1981 : }
1982 :
1983 0 : if (status < 0)
1984 : {
1985 : /* End of copy detected; gin up old-style terminator */
1986 0 : strcpy(s, "\\.");
1987 0 : return 0;
1988 : }
1989 :
1990 : /* Add null terminator, and strip trailing \n if present */
1991 0 : if (s[status - 1] == '\n')
1992 : {
1993 0 : s[status - 1] = '\0';
1994 0 : return 0;
1995 : }
1996 : else
1997 : {
1998 0 : s[status] = '\0';
1999 0 : return 1;
2000 : }
2001 : }
2002 :
2003 : /*
2004 : * PQgetlineAsync - gets a COPY data row without blocking.
2005 : *
2006 : * See fe-exec.c for documentation.
2007 : */
2008 : int
2009 0 : pqGetlineAsync3(PGconn *conn, char *buffer, int bufsize)
2010 : {
2011 : int msgLength;
2012 : int avail;
2013 :
2014 0 : if (conn->asyncStatus != PGASYNC_COPY_OUT
2015 0 : && conn->asyncStatus != PGASYNC_COPY_BOTH)
2016 0 : 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 0 : msgLength = getCopyDataMessage(conn);
2025 0 : if (msgLength < 0)
2026 0 : return -1; /* end-of-copy or error */
2027 0 : if (msgLength == 0)
2028 0 : 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 : */
2036 0 : conn->inCursor += conn->copy_already_done;
2037 0 : avail = msgLength - 4 - conn->copy_already_done;
2038 0 : if (avail <= bufsize)
2039 : {
2040 : /* Able to consume the whole message */
2041 0 : memcpy(buffer, &conn->inBuffer[conn->inCursor], avail);
2042 : /* Mark message consumed */
2043 0 : conn->inStart = conn->inCursor + avail;
2044 : /* Reset state for next time */
2045 0 : conn->copy_already_done = 0;
2046 0 : return avail;
2047 : }
2048 : else
2049 : {
2050 : /* We must return a partial message */
2051 0 : memcpy(buffer, &conn->inBuffer[conn->inCursor], bufsize);
2052 : /* The message is NOT consumed from libpq's buffer */
2053 0 : conn->copy_already_done += bufsize;
2054 0 : return bufsize;
2055 : }
2056 : }
2057 :
2058 : /*
2059 : * PQendcopy
2060 : *
2061 : * See fe-exec.c for documentation.
2062 : */
2063 : int
2064 382 : pqEndcopy3(PGconn *conn)
2065 : {
2066 : PGresult *result;
2067 :
2068 382 : if (conn->asyncStatus != PGASYNC_COPY_IN &&
2069 368 : conn->asyncStatus != PGASYNC_COPY_OUT &&
2070 0 : conn->asyncStatus != PGASYNC_COPY_BOTH)
2071 : {
2072 0 : libpq_append_conn_error(conn, "no COPY in progress");
2073 0 : return 1;
2074 : }
2075 :
2076 : /* Send the CopyDone message if needed */
2077 382 : if (conn->asyncStatus == PGASYNC_COPY_IN ||
2078 368 : conn->asyncStatus == PGASYNC_COPY_BOTH)
2079 : {
2080 28 : if (pqPutMsgStart(PqMsg_CopyDone, conn) < 0 ||
2081 14 : pqPutMsgEnd(conn) < 0)
2082 0 : 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 14 : if (conn->cmd_queue_head &&
2089 14 : conn->cmd_queue_head->queryclass != PGQUERY_SIMPLE)
2090 : {
2091 0 : if (pqPutMsgStart(PqMsg_Sync, conn) < 0 ||
2092 0 : pqPutMsgEnd(conn) < 0)
2093 0 : 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 : */
2101 382 : if (pqFlush(conn) && pqIsnonblocking(conn))
2102 0 : return 1;
2103 :
2104 : /* Return to active duty */
2105 382 : conn->asyncStatus = PGASYNC_BUSY;
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 : */
2114 382 : if (pqIsnonblocking(conn) && PQisBusy(conn))
2115 0 : return 1;
2116 :
2117 : /* Wait for the completion response */
2118 382 : result = PQgetResult(conn);
2119 :
2120 : /* Expecting a successful result */
2121 382 : if (result && result->resultStatus == PGRES_COMMAND_OK)
2122 : {
2123 382 : PQclear(result);
2124 382 : 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 0 : if (conn->errorMessage.len > 0)
2135 : {
2136 : /* We have to strip the trailing newline ... pain in neck... */
2137 0 : char svLast = conn->errorMessage.data[conn->errorMessage.len - 1];
2138 :
2139 0 : if (svLast == '\n')
2140 0 : conn->errorMessage.data[conn->errorMessage.len - 1] = '\0';
2141 0 : pqInternalNotice(&conn->noticeHooks, "%s", conn->errorMessage.data);
2142 0 : conn->errorMessage.data[conn->errorMessage.len - 1] = svLast;
2143 : }
2144 :
2145 0 : PQclear(result);
2146 :
2147 0 : 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 : */
2156 : PGresult *
2157 2140 : pqFunctionCall3(PGconn *conn, Oid fnid,
2158 : int *result_buf, int *actual_result_len,
2159 : int result_is_int,
2160 : const PQArgBlock *args, int nargs)
2161 : {
2162 2140 : bool needInput = false;
2163 2140 : ExecStatusType status = PGRES_FATAL_ERROR;
2164 : char id;
2165 : int msgLength;
2166 : int avail;
2167 : int i;
2168 :
2169 : /* already validated by PQfn */
2170 : Assert(conn->pipelineStatus == PQ_PIPELINE_OFF);
2171 :
2172 : /* PQfn already validated connection state */
2173 :
2174 4280 : if (pqPutMsgStart(PqMsg_FunctionCall, conn) < 0 ||
2175 4280 : pqPutInt(fnid, 4, conn) < 0 || /* function id */
2176 4280 : pqPutInt(1, 2, conn) < 0 || /* # of format codes */
2177 4280 : pqPutInt(1, 2, conn) < 0 || /* format code: BINARY */
2178 2140 : pqPutInt(nargs, 2, conn) < 0) /* # of args */
2179 : {
2180 : /* error message should be set up already */
2181 0 : return NULL;
2182 : }
2183 :
2184 6200 : for (i = 0; i < nargs; ++i)
2185 : { /* len.int4 + contents */
2186 4060 : if (pqPutInt(args[i].len, 4, conn))
2187 0 : return NULL;
2188 4060 : if (args[i].len == -1)
2189 0 : continue; /* it's NULL */
2190 :
2191 4060 : if (args[i].isint)
2192 : {
2193 3074 : if (pqPutInt(args[i].u.integer, args[i].len, conn))
2194 0 : return NULL;
2195 : }
2196 : else
2197 : {
2198 986 : if (pqPutnchar(args[i].u.ptr, args[i].len, conn))
2199 0 : return NULL;
2200 : }
2201 : }
2202 :
2203 2140 : if (pqPutInt(1, 2, conn) < 0) /* result format code: BINARY */
2204 0 : return NULL;
2205 :
2206 4280 : if (pqPutMsgEnd(conn) < 0 ||
2207 2140 : pqFlush(conn))
2208 0 : return NULL;
2209 :
2210 : for (;;)
2211 : {
2212 6896 : if (needInput)
2213 : {
2214 : /* Wait for some data to arrive (or for the channel to close) */
2215 5232 : if (pqWait(true, false, conn) ||
2216 2616 : 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 6896 : needInput = true;
2224 :
2225 6896 : conn->inCursor = conn->inStart;
2226 6896 : if (pqGetc(&id, conn))
2227 2140 : continue;
2228 4756 : if (pqGetInt(&msgLength, 4, conn))
2229 0 : 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 4756 : if (msgLength < 4)
2237 : {
2238 0 : handleSyncLoss(conn, id, msgLength);
2239 0 : break;
2240 : }
2241 4756 : if (msgLength > 30000 && !VALID_LONG_MESSAGE_TYPE(id))
2242 : {
2243 0 : handleSyncLoss(conn, id, msgLength);
2244 0 : break;
2245 : }
2246 :
2247 : /*
2248 : * Can't process if message body isn't all here yet.
2249 : */
2250 4756 : msgLength -= 4;
2251 4756 : avail = conn->inEnd - conn->inCursor;
2252 4756 : 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 476 : 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 : */
2267 0 : handleFatalError(conn);
2268 0 : break;
2269 : }
2270 476 : 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 4280 : switch (id)
2279 : {
2280 2140 : case PqMsg_FunctionCallResponse:
2281 2140 : if (pqGetInt(actual_result_len, 4, conn))
2282 0 : continue;
2283 2140 : if (*actual_result_len != -1)
2284 : {
2285 2140 : if (result_is_int)
2286 : {
2287 1388 : if (pqGetInt(result_buf, *actual_result_len, conn))
2288 0 : continue;
2289 : }
2290 : else
2291 : {
2292 752 : if (pqGetnchar(result_buf,
2293 752 : *actual_result_len,
2294 : conn))
2295 0 : continue;
2296 : }
2297 : }
2298 : /* correctly finished function result message */
2299 2140 : status = PGRES_COMMAND_OK;
2300 2140 : break;
2301 0 : case PqMsg_ErrorResponse:
2302 0 : if (pqGetErrorNotice3(conn, true))
2303 0 : continue;
2304 0 : status = PGRES_FATAL_ERROR;
2305 0 : break;
2306 0 : case PqMsg_NotificationResponse:
2307 : /* handle notify and go back to processing return values */
2308 0 : if (getNotify(conn))
2309 0 : continue;
2310 0 : break;
2311 0 : case PqMsg_NoticeResponse:
2312 : /* handle notice and go back to processing return values */
2313 0 : if (pqGetErrorNotice3(conn, false))
2314 0 : continue;
2315 0 : break;
2316 2140 : case PqMsg_ReadyForQuery:
2317 2140 : if (getReadyForQuery(conn))
2318 0 : continue;
2319 :
2320 : /* consume the message */
2321 2140 : 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 : */
2329 2140 : if (!pgHavePendingResult(conn))
2330 : {
2331 2140 : if (status == PGRES_COMMAND_OK)
2332 : {
2333 2140 : conn->result = PQmakeEmptyPGresult(conn, status);
2334 2140 : if (!conn->result)
2335 : {
2336 0 : libpq_append_conn_error(conn, "out of memory");
2337 0 : pqSaveErrorResult(conn);
2338 : }
2339 : }
2340 : else
2341 : {
2342 0 : libpq_append_conn_error(conn, "protocol error: no function result");
2343 0 : pqSaveErrorResult(conn);
2344 : }
2345 : }
2346 : /* and we're out */
2347 2140 : return pqPrepareAsyncResult(conn);
2348 0 : case PqMsg_ParameterStatus:
2349 0 : if (getParameterStatus(conn))
2350 0 : continue;
2351 0 : break;
2352 0 : default:
2353 : /* The backend violates the protocol. */
2354 0 : libpq_append_conn_error(conn, "protocol error: id=0x%x", id);
2355 0 : pqSaveErrorResult(conn);
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 0 : conn->inStart += 5 + msgLength;
2363 0 : return pqPrepareAsyncResult(conn);
2364 : }
2365 :
2366 : /* Completed parsing this message, keep going */
2367 2140 : pqParseDone(conn, conn->inStart + 5 + msgLength);
2368 2140 : 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 : */
2376 0 : pqSaveErrorResult(conn);
2377 0 : 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 : */
2386 : char *
2387 28150 : pqBuildStartupPacket3(PGconn *conn, int *packetlen,
2388 : const PQEnvironmentOption *options)
2389 : {
2390 : char *startpacket;
2391 : size_t len;
2392 :
2393 28150 : len = build_startup_packet(conn, NULL, options);
2394 28150 : if (len == 0 || len > INT_MAX)
2395 0 : return NULL;
2396 :
2397 28150 : *packetlen = len;
2398 28150 : startpacket = (char *) malloc(*packetlen);
2399 28150 : if (!startpacket)
2400 0 : return NULL;
2401 :
2402 28150 : len = build_startup_packet(conn, startpacket, options);
2403 : Assert(*packetlen == len);
2404 :
2405 28150 : 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 : */
2417 : static size_t
2418 56300 : build_startup_packet(const PGconn *conn, char *packet,
2419 : const PQEnvironmentOption *options)
2420 : {
2421 56300 : size_t packet_len = 0;
2422 : const PQEnvironmentOption *next_eo;
2423 : const char *val;
2424 :
2425 : /* Protocol version comes first. */
2426 56300 : if (packet)
2427 : {
2428 28150 : ProtocolVersion pv = pg_hton32(conn->pversion);
2429 :
2430 28150 : memcpy(packet + packet_len, &pv, sizeof(ProtocolVersion));
2431 : }
2432 56300 : 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 56300 : if (conn->pguser && conn->pguser[0])
2449 56300 : ADD_STARTUP_OPTION("user", conn->pguser);
2450 56300 : if (conn->dbName && conn->dbName[0])
2451 56300 : ADD_STARTUP_OPTION("database", conn->dbName);
2452 56300 : if (conn->replication && conn->replication[0])
2453 6120 : ADD_STARTUP_OPTION("replication", conn->replication);
2454 56300 : if (conn->pgoptions && conn->pgoptions[0])
2455 16352 : ADD_STARTUP_OPTION("options", conn->pgoptions);
2456 56300 : if (conn->send_appname)
2457 : {
2458 : /* Use appname if present, otherwise use fallback */
2459 56300 : val = conn->appname ? conn->appname : conn->fbappname;
2460 56300 : if (val && val[0])
2461 56288 : ADD_STARTUP_OPTION("application_name", val);
2462 : }
2463 :
2464 56300 : if (conn->client_encoding_initial && conn->client_encoding_initial[0])
2465 3492 : ADD_STARTUP_OPTION("client_encoding", conn->client_encoding_initial);
2466 :
2467 : /* Add any environment-driven GUC settings needed */
2468 225200 : for (next_eo = options; next_eo->envName; next_eo++)
2469 : {
2470 168900 : if ((val = getenv(next_eo->envName)) != NULL)
2471 : {
2472 20328 : if (pg_strcasecmp(val, "default") != 0)
2473 20328 : ADD_STARTUP_OPTION(next_eo->pgName, val);
2474 : }
2475 : }
2476 :
2477 : /* Add trailing terminator */
2478 56300 : if (packet)
2479 28150 : packet[packet_len] = '\0';
2480 56300 : if (pg_add_size_overflow(packet_len, 1, &packet_len))
2481 0 : return 0;
2482 :
2483 56300 : return packet_len;
2484 : }
|
