include/linux/skmsg.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright (c) 2017 - 2018 Covalent IO, Inc. http://covalent.io */
   3
   4 #ifndef _LINUX_SKMSG_H
   5 #define _LINUX_SKMSG_H
   6
   7 #include <linux/bpf.h>
   8 #include <linux/filter.h>
   9 #include <linux/scatterlist.h>
  10 #include <linux/skbuff.h>
  11
  12 #include <net/sock.h>
  13 #include <net/tcp.h>
  14 #include <net/strparser.h>
  15
  16 #define MAX_MSG_FRAGS                   MAX_SKB_FRAGS
  17 #define NR_MSG_FRAG_IDS                 (MAX_MSG_FRAGS + 1)
  18
  19 enum __sk_action {
  20         __SK_DROP = 0,
  21         __SK_PASS,
  22         __SK_REDIRECT,
  23         __SK_NONE,
  24 };
  25
  26 struct sk_msg_sg {
  27         u32                             start;
  28         u32                             curr;
  29         u32                             end;
  30         u32                             size;
  31         u32                             copybreak;
  32         unsigned long                   copy;
  33         /* The extra two elements:
  34          * 1) used for chaining the front and sections when the list becomes
  35          *    partitioned (e.g. end < start). The crypto APIs require the
  36          *    chaining;
  37          * 2) to chain tailer SG entries after the message.
  38          */
  39         struct scatterlist              data[MAX_MSG_FRAGS + 2];
  40 };
  41 static_assert(BITS_PER_LONG >= NR_MSG_FRAG_IDS);
  42
  43 /* UAPI in filter.c depends on struct sk_msg_sg being first element. */
  44 struct sk_msg {
  45         struct sk_msg_sg                sg;
  46         void                            *data;
  47         void                            *data_end;
  48         u32                             apply_bytes;
  49         u32                             cork_bytes;
  50         u32                             flags;
  51         struct sk_buff                  *skb;
  52         struct sock                     *sk_redir;
  53         struct sock                     *sk;
  54         struct list_head                list;
  55 };
  56
  57 struct sk_psock_progs {
  58         struct bpf_prog                 *msg_parser;
  59         struct bpf_prog                 *stream_parser;
  60         struct bpf_prog                 *stream_verdict;
  61         struct bpf_prog                 *skb_verdict;
  62 };
  63
  64 enum sk_psock_state_bits {
  65         SK_PSOCK_TX_ENABLED,
  66 };
  67
  68 struct sk_psock_link {
  69         struct list_head                list;
  70         struct bpf_map                  *map;
  71         void                            *link_raw;
  72 };
  73
  74 struct sk_psock_work_state {
  75         struct sk_buff                  *skb;
  76         u32                             len;
  77         u32                             off;
  78 };
  79
  80 struct sk_psock {
  81         struct sock                     *sk;
  82         struct sock                     *sk_redir;
  83         u32                             apply_bytes;
  84         u32                             cork_bytes;
  85         u32                             eval;
  86         struct sk_msg                   *cork;
  87         struct sk_psock_progs           progs;
  88 #if IS_ENABLED(CONFIG_BPF_STREAM_PARSER)
  89         struct strparser                strp;
  90 #endif
  91         struct sk_buff_head             ingress_skb;
  92         struct list_head                ingress_msg;
  93         spinlock_t                      ingress_lock;
  94         unsigned long                   state;
  95         struct list_head                link;
  96         spinlock_t                      link_lock;
  97         refcount_t                      refcnt;
  98         void (*saved_unhash)(struct sock *sk);
  99         void (*saved_close)(struct sock *sk, long timeout);
 100         void (*saved_write_space)(struct sock *sk);
 101         void (*saved_data_ready)(struct sock *sk);
 102         int  (*psock_update_sk_prot)(struct sock *sk, bool restore);
 103         struct proto                    *sk_proto;
 104         struct mutex                    work_mutex;
 105         struct sk_psock_work_state      work_state;
 106         struct work_struct              work;
 107         struct rcu_work                 rwork;
 108 };
 109
 110 int sk_msg_alloc(struct sock *sk, struct sk_msg *msg, int len,
 111                  int elem_first_coalesce);
 112 int sk_msg_clone(struct sock *sk, struct sk_msg *dst, struct sk_msg *src,
 113                  u32 off, u32 len);
 114 void sk_msg_trim(struct sock *sk, struct sk_msg *msg, int len);
 115 int sk_msg_free(struct sock *sk, struct sk_msg *msg);
 116 int sk_msg_free_nocharge(struct sock *sk, struct sk_msg *msg);
 117 void sk_msg_free_partial(struct sock *sk, struct sk_msg *msg, u32 bytes);
 118 void sk_msg_free_partial_nocharge(struct sock *sk, struct sk_msg *msg,
 119                                   u32 bytes);
 120
 121 void sk_msg_return(struct sock *sk, struct sk_msg *msg, int bytes);
 122 void sk_msg_return_zero(struct sock *sk, struct sk_msg *msg, int bytes);
 123
 124 int sk_msg_zerocopy_from_iter(struct sock *sk, struct iov_iter *from,
 125                               struct sk_msg *msg, u32 bytes);
 126 int sk_msg_memcopy_from_iter(struct sock *sk, struct iov_iter *from,
 127                              struct sk_msg *msg, u32 bytes);
 128 int sk_msg_wait_data(struct sock *sk, struct sk_psock *psock, int flags,
 129                      long timeo, int *err);
 130 int sk_msg_recvmsg(struct sock *sk, struct sk_psock *psock, struct msghdr *msg,
 131                    int len, int flags);
 132
 133 static inline void sk_msg_check_to_free(struct sk_msg *msg, u32 i, u32 bytes)
 134 {
 135         WARN_ON(i == msg->sg.end && bytes);
 136 }
 137
 138 static inline void sk_msg_apply_bytes(struct sk_psock *psock, u32 bytes)
 139 {
 140         if (psock->apply_bytes) {
 141                 if (psock->apply_bytes < bytes)
 142                         psock->apply_bytes = 0;
 143                 else
 144                         psock->apply_bytes -= bytes;
 145         }
 146 }
 147
 148 static inline u32 sk_msg_iter_dist(u32 start, u32 end)
 149 {
 150         return end >= start ? end - start : end + (NR_MSG_FRAG_IDS - start);
 151 }
 152
 153 #define sk_msg_iter_var_prev(var)                       \
 154         do {                                            \
 155                 if (var == 0)                           \
 156                         var = NR_MSG_FRAG_IDS - 1;      \
 157                 else                                    \
 158                         var--;                          \
 159         } while (0)
 160
 161 #define sk_msg_iter_var_next(var)                       \
 162         do {                                            \
 163                 var++;                                  \
 164                 if (var == NR_MSG_FRAG_IDS)             \
 165                         var = 0;                        \
 166         } while (0)
 167
 168 #define sk_msg_iter_prev(msg, which)                    \
 169         sk_msg_iter_var_prev(msg->sg.which)
 170
 171 #define sk_msg_iter_next(msg, which)                    \
 172         sk_msg_iter_var_next(msg->sg.which)
 173
 174 static inline void sk_msg_clear_meta(struct sk_msg *msg)
 175 {
 176         memset(&msg->sg, 0, offsetofend(struct sk_msg_sg, copy));
 177 }
 178
 179 static inline void sk_msg_init(struct sk_msg *msg)
 180 {
 181         BUILD_BUG_ON(ARRAY_SIZE(msg->sg.data) - 1 != NR_MSG_FRAG_IDS);
 182         memset(msg, 0, sizeof(*msg));
 183         sg_init_marker(msg->sg.data, NR_MSG_FRAG_IDS);
 184 }
 185
 186 static inline void sk_msg_xfer(struct sk_msg *dst, struct sk_msg *src,
 187                                int which, u32 size)
 188 {
 189         dst->sg.data[which] = src->sg.data[which];
 190         dst->sg.data[which].length  = size;
 191         dst->sg.size               += size;
 192         src->sg.size               -= size;
 193         src->sg.data[which].length -= size;
 194         src->sg.data[which].offset += size;
 195 }
 196
 197 static inline void sk_msg_xfer_full(struct sk_msg *dst, struct sk_msg *src)
 198 {
 199         memcpy(dst, src, sizeof(*src));
 200         sk_msg_init(src);
 201 }
 202
 203 static inline bool sk_msg_full(const struct sk_msg *msg)
 204 {
 205         return sk_msg_iter_dist(msg->sg.start, msg->sg.end) == MAX_MSG_FRAGS;
 206 }
 207
 208 static inline u32 sk_msg_elem_used(const struct sk_msg *msg)
 209 {
 210         return sk_msg_iter_dist(msg->sg.start, msg->sg.end);
 211 }
 212
 213 static inline struct scatterlist *sk_msg_elem(struct sk_msg *msg, int which)
 214 {
 215         return &msg->sg.data[which];
 216 }
 217
 218 static inline struct scatterlist sk_msg_elem_cpy(struct sk_msg *msg, int which)
 219 {
 220         return msg->sg.data[which];
 221 }
 222
 223 static inline struct page *sk_msg_page(struct sk_msg *msg, int which)
 224 {
 225         return sg_page(sk_msg_elem(msg, which));
 226 }
 227
 228 static inline bool sk_msg_to_ingress(const struct sk_msg *msg)
 229 {
 230         return msg->flags & BPF_F_INGRESS;
 231 }
 232
 233 static inline void sk_msg_compute_data_pointers(struct sk_msg *msg)
 234 {
 235         struct scatterlist *sge = sk_msg_elem(msg, msg->sg.start);
 236
 237         if (test_bit(msg->sg.start, &msg->sg.copy)) {
 238                 msg->data = NULL;
 239                 msg->data_end = NULL;
 240         } else {
 241                 msg->data = sg_virt(sge);
 242                 msg->data_end = msg->data + sge->length;
 243         }
 244 }
 245
 246 static inline void sk_msg_page_add(struct sk_msg *msg, struct page *page,
 247                                    u32 len, u32 offset)
 248 {
 249         struct scatterlist *sge;
 250
 251         get_page(page);
 252         sge = sk_msg_elem(msg, msg->sg.end);
 253         sg_set_page(sge, page, len, offset);
 254         sg_unmark_end(sge);
 255
 256         __set_bit(msg->sg.end, &msg->sg.copy);
 257         msg->sg.size += len;
 258         sk_msg_iter_next(msg, end);
 259 }
 260
 261 static inline void sk_msg_sg_copy(struct sk_msg *msg, u32 i, bool copy_state)
 262 {
 263         do {
 264                 if (copy_state)
 265                         __set_bit(i, &msg->sg.copy);
 266                 else
 267                         __clear_bit(i, &msg->sg.copy);
 268                 sk_msg_iter_var_next(i);
 269                 if (i == msg->sg.end)
 270                         break;
 271         } while (1);
 272 }
 273
 274 static inline void sk_msg_sg_copy_set(struct sk_msg *msg, u32 start)
 275 {
 276         sk_msg_sg_copy(msg, start, true);
 277 }
 278
 279 static inline void sk_msg_sg_copy_clear(struct sk_msg *msg, u32 start)
 280 {
 281         sk_msg_sg_copy(msg, start, false);
 282 }
 283
 284 static inline struct sk_psock *sk_psock(const struct sock *sk)
 285 {
 286         return rcu_dereference_sk_user_data(sk);
 287 }
 288
 289 static inline void sk_psock_queue_msg(struct sk_psock *psock,
 290                                       struct sk_msg *msg)
 291 {
 292         spin_lock_bh(&psock->ingress_lock);
 293         list_add_tail(&msg->list, &psock->ingress_msg);
 294         spin_unlock_bh(&psock->ingress_lock);
 295 }
 296
 297 static inline struct sk_msg *sk_psock_dequeue_msg(struct sk_psock *psock)
 298 {
 299         struct sk_msg *msg;
 300
 301         spin_lock_bh(&psock->ingress_lock);
 302         msg = list_first_entry_or_null(&psock->ingress_msg, struct sk_msg, list);
 303         if (msg)
 304                 list_del(&msg->list);
 305         spin_unlock_bh(&psock->ingress_lock);
 306         return msg;
 307 }
 308
 309 static inline struct sk_msg *sk_psock_peek_msg(struct sk_psock *psock)
 310 {
 311         struct sk_msg *msg;
 312
 313         spin_lock_bh(&psock->ingress_lock);
 314         msg = list_first_entry_or_null(&psock->ingress_msg, struct sk_msg, list);
 315         spin_unlock_bh(&psock->ingress_lock);
 316         return msg;
 317 }
 318
 319 static inline struct sk_msg *sk_psock_next_msg(struct sk_psock *psock,
 320                                                struct sk_msg *msg)
 321 {
 322         struct sk_msg *ret;
 323
 324         spin_lock_bh(&psock->ingress_lock);
 325         if (list_is_last(&msg->list, &psock->ingress_msg))
 326                 ret = NULL;
 327         else
 328                 ret = list_next_entry(msg, list);
 329         spin_unlock_bh(&psock->ingress_lock);
 330         return ret;
 331 }
 332
 333 static inline bool sk_psock_queue_empty(const struct sk_psock *psock)
 334 {
 335         return psock ? list_empty(&psock->ingress_msg) : true;
 336 }
 337
 338 static inline void kfree_sk_msg(struct sk_msg *msg)
 339 {
 340         if (msg->skb)
 341                 consume_skb(msg->skb);
 342         kfree(msg);
 343 }
 344
 345 static inline void sk_psock_report_error(struct sk_psock *psock, int err)
 346 {
 347         struct sock *sk = psock->sk;
 348
 349         sk->sk_err = err;
 350         sk->sk_error_report(sk);
 351 }
 352
 353 struct sk_psock *sk_psock_init(struct sock *sk, int node);
 354 void sk_psock_stop(struct sk_psock *psock, bool wait);
 355
 356 #if IS_ENABLED(CONFIG_BPF_STREAM_PARSER)
 357 int sk_psock_init_strp(struct sock *sk, struct sk_psock *psock);
 358 void sk_psock_start_strp(struct sock *sk, struct sk_psock *psock);
 359 void sk_psock_stop_strp(struct sock *sk, struct sk_psock *psock);
 360 #else
 361 static inline int sk_psock_init_strp(struct sock *sk, struct sk_psock *psock)
 362 {
 363         return -EOPNOTSUPP;
 364 }
 365
 366 static inline void sk_psock_start_strp(struct sock *sk, struct sk_psock *psock)
 367 {
 368 }
 369
 370 static inline void sk_psock_stop_strp(struct sock *sk, struct sk_psock *psock)
 371 {
 372 }
 373 #endif
 374
 375 void sk_psock_start_verdict(struct sock *sk, struct sk_psock *psock);
 376 void sk_psock_stop_verdict(struct sock *sk, struct sk_psock *psock);
 377
 378 int sk_psock_msg_verdict(struct sock *sk, struct sk_psock *psock,
 379                          struct sk_msg *msg);
 380
 381 static inline struct sk_psock_link *sk_psock_init_link(void)
 382 {
 383         return kzalloc(sizeof(struct sk_psock_link),
 384                        GFP_ATOMIC | __GFP_NOWARN);
 385 }
 386
 387 static inline void sk_psock_free_link(struct sk_psock_link *link)
 388 {
 389         kfree(link);
 390 }
 391
 392 struct sk_psock_link *sk_psock_link_pop(struct sk_psock *psock);
 393
 394 static inline void sk_psock_cork_free(struct sk_psock *psock)
 395 {
 396         if (psock->cork) {
 397                 sk_msg_free(psock->sk, psock->cork);
 398                 kfree(psock->cork);
 399                 psock->cork = NULL;
 400         }
 401 }
 402
 403 static inline void sk_psock_restore_proto(struct sock *sk,
 404                                           struct sk_psock *psock)
 405 {
 406         if (psock->psock_update_sk_prot)
 407                 psock->psock_update_sk_prot(sk, true);
 408 }
 409
 410 static inline void sk_psock_set_state(struct sk_psock *psock,
 411                                       enum sk_psock_state_bits bit)
 412 {
 413         set_bit(bit, &psock->state);
 414 }
 415
 416 static inline void sk_psock_clear_state(struct sk_psock *psock,
 417                                         enum sk_psock_state_bits bit)
 418 {
 419         clear_bit(bit, &psock->state);
 420 }
 421
 422 static inline bool sk_psock_test_state(const struct sk_psock *psock,
 423                                        enum sk_psock_state_bits bit)
 424 {
 425         return test_bit(bit, &psock->state);
 426 }
 427
 428 static inline struct sk_psock *sk_psock_get(struct sock *sk)
 429 {
 430         struct sk_psock *psock;
 431
 432         rcu_read_lock();
 433         psock = sk_psock(sk);
 434         if (psock && !refcount_inc_not_zero(&psock->refcnt))
 435                 psock = NULL;
 436         rcu_read_unlock();
 437         return psock;
 438 }
 439
 440 void sk_psock_drop(struct sock *sk, struct sk_psock *psock);
 441
 442 static inline void sk_psock_put(struct sock *sk, struct sk_psock *psock)
 443 {
 444         if (refcount_dec_and_test(&psock->refcnt))
 445                 sk_psock_drop(sk, psock);
 446 }
 447
 448 static inline void sk_psock_data_ready(struct sock *sk, struct sk_psock *psock)
 449 {
 450         if (psock->saved_data_ready)
 451                 psock->saved_data_ready(sk);
 452         else
 453                 sk->sk_data_ready(sk);
 454 }
 455
 456 static inline void psock_set_prog(struct bpf_prog **pprog,
 457                                   struct bpf_prog *prog)
 458 {
 459         prog = xchg(pprog, prog);
 460         if (prog)
 461                 bpf_prog_put(prog);
 462 }
 463
 464 static inline int psock_replace_prog(struct bpf_prog **pprog,
 465                                      struct bpf_prog *prog,
 466                                      struct bpf_prog *old)
 467 {
 468         if (cmpxchg(pprog, old, prog) != old)
 469                 return -ENOENT;
 470
 471         if (old)
 472                 bpf_prog_put(old);
 473
 474         return 0;
 475 }
 476
 477 static inline void psock_progs_drop(struct sk_psock_progs *progs)
 478 {
 479         psock_set_prog(&progs->msg_parser, NULL);
 480         psock_set_prog(&progs->stream_parser, NULL);
 481         psock_set_prog(&progs->stream_verdict, NULL);
 482         psock_set_prog(&progs->skb_verdict, NULL);
 483 }
 484
 485 int sk_psock_tls_strp_read(struct sk_psock *psock, struct sk_buff *skb);
 486
 487 static inline bool sk_psock_strp_enabled(struct sk_psock *psock)
 488 {
 489         if (!psock)
 490                 return false;
 491         return !!psock->saved_data_ready;
 492 }
 493
 494 #if IS_ENABLED(CONFIG_NET_SOCK_MSG)
 495
 496 /* We only have one bit so far. */
 497 #define BPF_F_PTR_MASK ~(BPF_F_INGRESS)
 498
 499 static inline bool skb_bpf_ingress(const struct sk_buff *skb)
 500 {
 501         unsigned long sk_redir = skb->_sk_redir;
 502
 503         return sk_redir & BPF_F_INGRESS;
 504 }
 505
 506 static inline void skb_bpf_set_ingress(struct sk_buff *skb)
 507 {
 508         skb->_sk_redir |= BPF_F_INGRESS;
 509 }
 510
 511 static inline void skb_bpf_set_redir(struct sk_buff *skb, struct sock *sk_redir,
 512                                      bool ingress)
 513 {
 514         skb->_sk_redir = (unsigned long)sk_redir;
 515         if (ingress)
 516                 skb->_sk_redir |= BPF_F_INGRESS;
 517 }
 518
 519 static inline struct sock *skb_bpf_redirect_fetch(const struct sk_buff *skb)
 520 {
 521         unsigned long sk_redir = skb->_sk_redir;
 522
 523         return (struct sock *)(sk_redir & BPF_F_PTR_MASK);
 524 }
 525
 526 static inline void skb_bpf_redirect_clear(struct sk_buff *skb)
 527 {
 528         skb->_sk_redir = 0;
 529 }
 530 #endif /* CONFIG_NET_SOCK_MSG */
 531 #endif /* _LINUX_SKMSG_H */