76fdd5d2121db027239de45491cfc7b974fc8ca6
[platform/upstream/libwebsockets.git] / lib / output.c
1 /*
2  * libwebsockets - small server side websockets and web server implementation
3  *
4  * Copyright (C) 2010-2014 Andy Green <andy@warmcat.com>
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Lesser General Public
8  *  License as published by the Free Software Foundation:
9  *  version 2.1 of the License.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Lesser General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Lesser General Public
17  *  License along with this library; if not, write to the Free Software
18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
19  *  MA  02110-1301  USA
20  */
21
22 #include "private-libwebsockets.h"
23
24 static int
25 lws_0405_frame_mask_generate(struct lws *wsi)
26 {
27         int n;
28
29         /* fetch the per-frame nonce */
30
31         n = lws_get_random(lws_get_ctx(wsi),
32                                            wsi->u.ws.frame_masking_nonce_04, 4);
33         if (n != 4) {
34                 lwsl_parser("Unable to read from random device %s %d\n",
35                                                      SYSTEM_RANDOM_FILEPATH, n);
36                 return 1;
37         }
38
39         /* start masking from first byte of masking key buffer */
40         wsi->u.ws.frame_mask_index = 0;
41
42         return 0;
43 }
44
45 #ifdef _DEBUG
46
47 LWS_VISIBLE void lwsl_hexdump(void *vbuf, size_t len)
48 {
49         unsigned char *buf = (unsigned char *)vbuf;
50         unsigned int n, m, start;
51         char line[80];
52         char *p;
53
54         lwsl_parser("\n");
55
56         for (n = 0; n < len;) {
57                 start = n;
58                 p = line;
59
60                 p += sprintf(p, "%04X: ", start);
61
62                 for (m = 0; m < 16 && n < len; m++)
63                         p += sprintf(p, "%02X ", buf[n++]);
64                 while (m++ < 16)
65                         p += sprintf(p, "   ");
66
67                 p += sprintf(p, "   ");
68
69                 for (m = 0; m < 16 && (start + m) < len; m++) {
70                         if (buf[start + m] >= ' ' && buf[start + m] < 127)
71                                 *p++ = buf[start + m];
72                         else
73                                 *p++ = '.';
74                 }
75                 while (m++ < 16)
76                         *p++ = ' ';
77
78                 *p++ = '\n';
79                 *p = '\0';
80                 lwsl_debug("%s", line);
81         }
82         lwsl_debug("\n");
83 }
84
85 #endif
86
87 /*
88  * notice this returns number of bytes consumed, or -1
89  */
90
91 int lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len)
92 {
93         struct lws_context *context = lws_get_ctx(wsi);
94         size_t real_len = len;
95         int n, m;
96
97         if (!len)
98                 return 0;
99         /* just ignore sends after we cleared the truncation buffer */
100         if (wsi->state == WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE &&
101             !wsi->truncated_send_len)
102                 return len;
103
104         if (wsi->truncated_send_len && (buf < wsi->truncated_send_malloc ||
105             buf > (wsi->truncated_send_malloc + wsi->truncated_send_len +
106                    wsi->truncated_send_offset))) {
107                 lwsl_err("****** %x Sending new, pending truncated ...\n", wsi);
108                 assert(0);
109         }
110
111         m = lws_ext_callback_for_each_active(wsi,
112                         LWS_EXT_CALLBACK_PACKET_TX_DO_SEND, &buf, len);
113         if (m < 0)
114                 return -1;
115         if (m) /* handled */ {
116                 n = m;
117                 goto handle_truncated_send;
118         }
119
120         if (!lws_socket_is_valid(wsi->sock))
121                 lwsl_warn("** error invalid sock but expected to send\n");
122
123         /* nope, send it on the socket directly */
124         lws_latency_pre(context, wsi);
125         n = lws_ssl_capable_write(wsi, buf, len);
126         lws_latency(context, wsi, "send lws_issue_raw", n, (unsigned int)n == len);
127
128         switch (n) {
129         case LWS_SSL_CAPABLE_ERROR:
130                 lwsl_err("%s: wsi %p: LWS_SSL_CAPABLE_ERROR\n", __func__, (void *)wsi);
131                 /* we're going to close, let close know sends aren't possible */
132                 wsi->socket_is_permanently_unusable = 1;
133                 return -1;
134         case LWS_SSL_CAPABLE_MORE_SERVICE:
135                 /* nothing got sent, not fatal, retry the whole thing later */
136                 n = 0;
137                 break;
138         }
139
140 handle_truncated_send:
141         /*
142          * we were already handling a truncated send?
143          */
144         if (wsi->truncated_send_len) {
145                 lwsl_info("***** %x partial send moved on by %d (vs %d)\n",
146                                                              wsi, n, real_len);
147                 wsi->truncated_send_offset += n;
148                 wsi->truncated_send_len -= n;
149
150                 if (!wsi->truncated_send_len) {
151                         lwsl_info("***** %x partial send completed\n", wsi);
152                         /* done with it, but don't free it */
153                         n = real_len;
154                         if (wsi->state == WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE) {
155                                 lwsl_info("***** %x signalling to close now\n", wsi);
156                                 return -1; /* retry closing now */
157                         }
158                 }
159                 /* always callback on writeable */
160                 lws_callback_on_writable(lws_get_ctx(wsi), wsi);
161
162                 return n;
163         }
164
165         if ((unsigned int)n == real_len)
166                 /* what we just sent went out cleanly */
167                 return n;
168
169         if (n && wsi->u.ws.clean_buffer)
170                 /*
171                  * This buffer unaffected by extension rewriting.
172                  * It means the user code is expected to deal with
173                  * partial sends.  (lws knows the header was already
174                  * sent, so on next send will just resume sending
175                  * payload)
176                  */
177                  return n;
178
179         /*
180          * Newly truncated send.  Buffer the remainder (it will get
181          * first priority next time the socket is writable)
182          */
183         lwsl_info("***** %x new partial sent %d from %d total\n",
184                   wsi, n, real_len);
185
186         /*
187          *  - if we still have a suitable malloc lying around, use it
188          *  - or, if too small, reallocate it
189          *  - or, if no buffer, create it
190          */
191         if (!wsi->truncated_send_malloc ||
192             real_len - n > wsi->truncated_send_allocation) {
193                 lws_free(wsi->truncated_send_malloc);
194
195                 wsi->truncated_send_allocation = real_len - n;
196                 wsi->truncated_send_malloc = lws_malloc(real_len - n);
197                 if (!wsi->truncated_send_malloc) {
198                         lwsl_err("truncated send: unable to malloc %d\n",
199                                  real_len - n);
200                         return -1;
201                 }
202         }
203         wsi->truncated_send_offset = 0;
204         wsi->truncated_send_len = real_len - n;
205         memcpy(wsi->truncated_send_malloc, buf + n, real_len - n);
206
207         /* since something buffered, force it to get another chance to send */
208         lws_callback_on_writable(lws_get_ctx(wsi), wsi);
209
210         return real_len;
211 }
212
213 /**
214  * lws_write() - Apply protocol then write data to client
215  * @wsi:        Websocket instance (available from user callback)
216  * @buf:        The data to send.  For data being sent on a websocket
217  *              connection (ie, not default http), this buffer MUST have
218  *              LWS_SEND_BUFFER_PRE_PADDING bytes valid BEFORE the pointer
219  *              and an additional LWS_SEND_BUFFER_POST_PADDING bytes valid
220  *              in the buffer after (buf + len).  This is so the protocol
221  *              header and trailer data can be added in-situ.
222  * @len:        Count of the data bytes in the payload starting from buf
223  * @protocol:   Use LWS_WRITE_HTTP to reply to an http connection, and one
224  *              of LWS_WRITE_BINARY or LWS_WRITE_TEXT to send appropriate
225  *              data on a websockets connection.  Remember to allow the extra
226  *              bytes before and after buf if LWS_WRITE_BINARY or LWS_WRITE_TEXT
227  *              are used.
228  *
229  *      This function provides the way to issue data back to the client
230  *      for both http and websocket protocols.
231  *
232  *      In the case of sending using websocket protocol, be sure to allocate
233  *      valid storage before and after buf as explained above.  This scheme
234  *      allows maximum efficiency of sending data and protocol in a single
235  *      packet while not burdening the user code with any protocol knowledge.
236  *
237  *      Return may be -1 for a fatal error needing connection close, or a
238  *      positive number reflecting the amount of bytes actually sent.  This
239  *      can be less than the requested number of bytes due to OS memory
240  *      pressure at any given time.
241  */
242
243 LWS_VISIBLE int lws_write(struct lws *wsi, unsigned char *buf,
244                           size_t len, enum lws_write_protocol protocol)
245 {
246         int masked7 = wsi->mode == LWS_CONNMODE_WS_CLIENT;
247         unsigned char is_masked_bit = 0;
248         unsigned char *dropmask = NULL;
249         struct lws_tokens eff_buf;
250         int post = 0, pre = 0, n;
251         size_t orig_len = len;
252
253         if (len == 0 && protocol != LWS_WRITE_CLOSE &&
254             protocol != LWS_WRITE_PING && protocol != LWS_WRITE_PONG) {
255                 lwsl_warn("zero length lws_write attempt\n");
256                 return 0;
257         }
258
259         if (protocol == LWS_WRITE_HTTP ||
260             protocol == LWS_WRITE_HTTP_FINAL ||
261             protocol == LWS_WRITE_HTTP_HEADERS)
262                 goto send_raw;
263
264         /* websocket protocol, either binary or text */
265
266         if (wsi->state != WSI_STATE_ESTABLISHED &&
267             !(wsi->state == WSI_STATE_RETURNED_CLOSE_ALREADY &&
268               protocol == LWS_WRITE_CLOSE))
269                 return -1;
270
271         /* if we are continuing a frame that already had its header done */
272
273         if (wsi->u.ws.inside_frame)
274                 goto do_more_inside_frame;
275
276         wsi->u.ws.clean_buffer = 1;
277
278         /*
279          * give a chance to the extensions to modify payload
280          * pre-TX mangling is not allowed to truncate
281          */
282         eff_buf.token = (char *)buf;
283         eff_buf.token_len = len;
284
285         switch (protocol) {
286         case LWS_WRITE_PING:
287         case LWS_WRITE_PONG:
288         case LWS_WRITE_CLOSE:
289                 break;
290         default:
291                 if (lws_ext_callback_for_each_active(wsi,
292                                LWS_EXT_CALLBACK_PAYLOAD_TX, &eff_buf, 0) < 0)
293                         return -1;
294         }
295
296         /*
297          * an extension did something we need to keep... for example, if
298          * compression extension, it has already updated its state according
299          * to this being issued
300          */
301         if ((char *)buf != eff_buf.token)
302                 /*
303                  * extension recreated it:
304                  * need to buffer this if not all sent
305                  */
306                 wsi->u.ws.clean_buffer = 0;
307
308         buf = (unsigned char *)eff_buf.token;
309         len = eff_buf.token_len;
310
311         switch (wsi->ietf_spec_revision) {
312         case 13:
313                 if (masked7) {
314                         pre += 4;
315                         dropmask = &buf[0 - pre];
316                         is_masked_bit = 0x80;
317                 }
318
319                 switch (protocol & 0xf) {
320                 case LWS_WRITE_TEXT:
321                         n = LWS_WS_OPCODE_07__TEXT_FRAME;
322                         break;
323                 case LWS_WRITE_BINARY:
324                         n = LWS_WS_OPCODE_07__BINARY_FRAME;
325                         break;
326                 case LWS_WRITE_CONTINUATION:
327                         n = LWS_WS_OPCODE_07__CONTINUATION;
328                         break;
329
330                 case LWS_WRITE_CLOSE:
331                         n = LWS_WS_OPCODE_07__CLOSE;
332
333                         /*
334                          * 06+ has a 2-byte status code in network order
335                          * we can do this because we demand post-buf
336                          */
337
338                         if (wsi->u.ws.close_reason) {
339                                 /* reason codes count as data bytes */
340                                 buf -= 2;
341                                 buf[0] = (unsigned char)(wsi->u.ws.close_reason >> 8);
342                                 buf[1] = (unsigned char)wsi->u.ws.close_reason;
343                                 len += 2;
344                         }
345                         break;
346                 case LWS_WRITE_PING:
347                         n = LWS_WS_OPCODE_07__PING;
348                         break;
349                 case LWS_WRITE_PONG:
350                         n = LWS_WS_OPCODE_07__PONG;
351                         break;
352                 default:
353                         lwsl_warn("lws_write: unknown write opc / protocol\n");
354                         return -1;
355                 }
356
357                 if (!(protocol & LWS_WRITE_NO_FIN))
358                         n |= 1 << 7;
359
360                 if (len < 126) {
361                         pre += 2;
362                         buf[-pre] = n;
363                         buf[-pre + 1] = (unsigned char)(len | is_masked_bit);
364                 } else {
365                         if (len < 65536) {
366                                 pre += 4;
367                                 buf[-pre] = n;
368                                 buf[-pre + 1] = 126 | is_masked_bit;
369                                 buf[-pre + 2] = (unsigned char)(len >> 8);
370                                 buf[-pre + 3] = (unsigned char)len;
371                         } else {
372                                 pre += 10;
373                                 buf[-pre] = n;
374                                 buf[-pre + 1] = 127 | is_masked_bit;
375 #if defined __LP64__
376                                         buf[-pre + 2] = (len >> 56) & 0x7f;
377                                         buf[-pre + 3] = len >> 48;
378                                         buf[-pre + 4] = len >> 40;
379                                         buf[-pre + 5] = len >> 32;
380 #else
381                                         buf[-pre + 2] = 0;
382                                         buf[-pre + 3] = 0;
383                                         buf[-pre + 4] = 0;
384                                         buf[-pre + 5] = 0;
385 #endif
386                                 buf[-pre + 6] = (unsigned char)(len >> 24);
387                                 buf[-pre + 7] = (unsigned char)(len >> 16);
388                                 buf[-pre + 8] = (unsigned char)(len >> 8);
389                                 buf[-pre + 9] = (unsigned char)len;
390                         }
391                 }
392                 break;
393         }
394
395 do_more_inside_frame:
396
397         /*
398          * Deal with masking if we are in client -> server direction and
399          * the protocol demands it
400          */
401
402         if (wsi->mode == LWS_CONNMODE_WS_CLIENT) {
403
404                 if (!wsi->u.ws.inside_frame)
405                         if (lws_0405_frame_mask_generate(wsi)) {
406                                 lwsl_err("frame mask generation failed\n");
407                                 return -1;
408                         }
409
410                 /*
411                  * in v7, just mask the payload
412                  */
413                 if (dropmask) { /* never set if already inside frame */
414                         for (n = 4; n < (int)len + 4; n++)
415                                 dropmask[n] = dropmask[n] ^
416                                 wsi->u.ws.frame_masking_nonce_04[
417                                         (wsi->u.ws.frame_mask_index++) & 3];
418
419                         /* copy the frame nonce into place */
420                         memcpy(dropmask, wsi->u.ws.frame_masking_nonce_04, 4);
421                 }
422         }
423
424 send_raw:
425         switch (protocol) {
426         case LWS_WRITE_CLOSE:
427 /*              lwsl_hexdump(&buf[-pre], len + post); */
428         case LWS_WRITE_HTTP:
429         case LWS_WRITE_HTTP_FINAL:
430         case LWS_WRITE_HTTP_HEADERS:
431         case LWS_WRITE_PONG:
432         case LWS_WRITE_PING:
433 #ifdef LWS_USE_HTTP2
434                 if (wsi->mode == LWS_CONNMODE_HTTP2_SERVING) {
435                         unsigned char flags = 0;
436
437                         n = LWS_HTTP2_FRAME_TYPE_DATA;
438                         if (protocol == LWS_WRITE_HTTP_HEADERS) {
439                                 n = LWS_HTTP2_FRAME_TYPE_HEADERS;
440                                 flags = LWS_HTTP2_FLAG_END_HEADERS;
441                                 if (wsi->u.http2.send_END_STREAM)
442                                         flags |= LWS_HTTP2_FLAG_END_STREAM;
443                         }
444
445                         if ((protocol == LWS_WRITE_HTTP || protocol == LWS_WRITE_HTTP_FINAL) && wsi->u.http.content_length) {
446                                 wsi->u.http.content_remain -= len;
447                                 lwsl_info("%s: content_remain = %lu\n", __func__, wsi->u.http.content_remain);
448                                 if (!wsi->u.http.content_remain) {
449                                         lwsl_info("%s: selecting final write mode\n", __func__);
450                                         protocol = LWS_WRITE_HTTP_FINAL;
451                                 }
452                         }
453
454                         if (protocol == LWS_WRITE_HTTP_FINAL && wsi->u.http2.END_STREAM) {
455                                 lwsl_info("%s: setting END_STREAM\n", __func__);
456                                 flags |= LWS_HTTP2_FLAG_END_STREAM;
457                         }
458
459                         return lws_http2_frame_write(wsi, n, flags, wsi->u.http2.my_stream_id, len, buf);
460                 }
461 #endif
462                 return lws_issue_raw(wsi, (unsigned char *)buf - pre,
463                                                               len + pre + post);
464         default:
465                 break;
466         }
467
468         wsi->u.ws.inside_frame = 1;
469
470         /*
471          * give any active extensions a chance to munge the buffer
472          * before send.  We pass in a pointer to an lws_tokens struct
473          * prepared with the default buffer and content length that's in
474          * there.  Rather than rewrite the default buffer, extensions
475          * that expect to grow the buffer can adapt .token to
476          * point to their own per-connection buffer in the extension
477          * user allocation.  By default with no extensions or no
478          * extension callback handling, just the normal input buffer is
479          * used then so it is efficient.
480          *
481          * callback returns 1 in case it wants to spill more buffers
482          *
483          * This takes care of holding the buffer if send is incomplete, ie,
484          * if wsi->u.ws.clean_buffer is 0 (meaning an extension meddled with
485          * the buffer).  If wsi->u.ws.clean_buffer is 1, it will instead
486          * return to the user code how much OF THE USER BUFFER was consumed.
487          */
488
489         n = lws_issue_raw_ext_access(wsi, buf - pre, len + pre + post);
490         if (n <= 0)
491                 return n;
492
493         if (n == (int)len + pre + post) {
494                 /* everything in the buffer was handled (or rebuffered...) */
495                 wsi->u.ws.inside_frame = 0;
496                 return orig_len;
497         }
498
499         /*
500          * it is how many bytes of user buffer got sent... may be < orig_len
501          * in which case callback when writable has already been arranged
502          * and user code can call lws_write() again with the rest
503          * later.
504          */
505
506         return n - (pre + post);
507 }
508
509 LWS_VISIBLE int lws_serve_http_file_fragment(struct lws_context *context,
510                                              struct lws *wsi)
511 {
512         unsigned long amount;
513         int n, m;
514
515         while (!lws_send_pipe_choked(wsi)) {
516
517                 if (wsi->truncated_send_len) {
518                         if (lws_issue_raw(wsi, wsi->truncated_send_malloc +
519                                           wsi->truncated_send_offset,
520                                           wsi->truncated_send_len) < 0) {
521                                 lwsl_info("%s: closing\n", __func__);
522                                 return -1;
523                         }
524                         continue;
525                 }
526
527                 if (wsi->u.http.filepos == wsi->u.http.filelen)
528                         goto all_sent;
529
530                 if (lws_plat_file_read(wsi, wsi->u.http.fd, &amount,
531                                        context->service_buffer,
532                                        sizeof(context->service_buffer)) < 0)
533                         return -1; /* caller will close */
534
535                 n = (int)amount;
536                 if (n) {
537                         lws_set_timeout(wsi, PENDING_TIMEOUT_HTTP_CONTENT,
538                                         AWAITING_TIMEOUT);
539                         wsi->u.http.filepos += n;
540                         m = lws_write(wsi, context->service_buffer, n,
541                                       wsi->u.http.filepos == wsi->u.http.filelen ?
542                                         LWS_WRITE_HTTP_FINAL : LWS_WRITE_HTTP);
543                         if (m < 0)
544                                 return -1;
545
546                         if (m != n)
547                                 /* adjust for what was not sent */
548                                 if (lws_plat_file_seek_cur(wsi,
549                                                            wsi->u.http.fd,
550                                                            m - n) ==
551                                                              (unsigned long)-1)
552                                         return -1;
553                 }
554 all_sent:
555                 if (!wsi->truncated_send_len &&
556                      wsi->u.http.filepos == wsi->u.http.filelen) {
557                         wsi->state = WSI_STATE_HTTP;
558
559                         /* we might be in keepalive, so close it off here */
560                         lws_plat_file_close(wsi, wsi->u.http.fd);
561                         wsi->u.http.fd = LWS_INVALID_FILE;
562
563                         if (wsi->protocol->callback)
564                                 /* ignore callback returned value */
565                                 user_callback_handle_rxflow(
566                                         wsi->protocol->callback, context, wsi,
567                                         LWS_CALLBACK_HTTP_FILE_COMPLETION,
568                                         wsi->user_space, NULL, 0);
569                         return 1;  /* >0 indicates completed */
570                 }
571         }
572
573         lwsl_info("choked before able to send whole file (post)\n");
574         lws_callback_on_writable(context, wsi);
575
576         return 0; /* indicates further processing must be done */
577 }
578
579 #if LWS_POSIX
580 LWS_VISIBLE int
581 lws_ssl_capable_read_no_ssl(struct lws_context *context,
582                             struct lws *wsi, unsigned char *buf, int len)
583 {
584         int n;
585
586         (void)context;
587
588         n = recv(wsi->sock, (char *)buf, len, 0);
589         if (n >= 0)
590                 return n;
591 #if LWS_POSIX
592         if (LWS_ERRNO == LWS_EAGAIN ||
593             LWS_ERRNO == LWS_EWOULDBLOCK ||
594             LWS_ERRNO == LWS_EINTR)
595                 return LWS_SSL_CAPABLE_MORE_SERVICE;
596 #endif
597         lwsl_warn("error on reading from skt\n");
598         return LWS_SSL_CAPABLE_ERROR;
599 }
600
601 LWS_VISIBLE int
602 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len)
603 {
604         int n = 0;
605
606 #if LWS_POSIX
607         n = send(wsi->sock, (char *)buf, len, MSG_NOSIGNAL);
608         if (n >= 0)
609                 return n;
610
611         if (LWS_ERRNO == LWS_EAGAIN ||
612             LWS_ERRNO == LWS_EWOULDBLOCK ||
613             LWS_ERRNO == LWS_EINTR) {
614                 if (LWS_ERRNO == LWS_EWOULDBLOCK)
615                         lws_set_blocking_send(wsi);
616
617                 return LWS_SSL_CAPABLE_MORE_SERVICE;
618         }
619 #else
620         (void)n;
621         (void)wsi;
622         (void)buf;
623         (void)len;
624         // !!!
625 #endif
626
627         lwsl_debug("ERROR writing len %d to skt %d\n", len, n);
628         return LWS_SSL_CAPABLE_ERROR;
629 }
630 #endif
631 LWS_VISIBLE int
632 lws_ssl_pending_no_ssl(struct lws *wsi)
633 {
634         (void)wsi;
635         return 0;
636 }