summaryrefslogtreecommitdiffstats
path: root/src/vlib/physmem_funcs.h
blob: bff66aa57265768d7bbbb913f2db1d251a5fcf50 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
 * Copyright (c) 2015-2016 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

option version = "1.0.0";

/** \brief Punt traffic to the host
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param is_add - add punt if non-zero, else delete
    @param ipv - L3 protocol 4 - IPv4, 6 - IPv6, ~0 - All
    @param l4_protocol - L4 protocol to be punted, only UDP (0x11) is supported
    @param l4_port - TCP/UDP port to be punted
*/
autoreply define punt {
    u32 client_index;
    u32 context;
    u8 is_add;
    u8 ipv;
    u8 l4_protocol;
    u16 l4_port;
};

/** \brief Punt traffic to the host via socket
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param header_version - expected meta data header version (currently 1)
    @param is_ip4 - L3 protocol 1 - IPv4, 0 - IPv6
    @param l4_protocol - L4 protocol to be punted, only UDP (0x11) is supported
    @param l4_port - TCP/UDP port to be punted
*/
define punt_socket_register {
    u32 client_index;
    u32 context;
    u32 header_version;
    u8 is_ip4;
    u8 l4_protocol;
    u16 l4_port;
    u8 pathname[108]; /* Linux sun_path defined to be 108 bytes, see unix(7) */
};

define punt_socket_register_reply
{
  u32 context;
  i32 retval;
  u8 pathname[64];
};

autoreply define punt_socket_deregister {
    u32 client_index;
    u32 context;
    u8 is_ip4;
    u8 l4_protocol;
    u16 l4_port;
};

/*
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
e Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /* * physmem.h: virtual <-> physical memory mapping for VLIB buffers * * Copyright (c) 2008 Eliot Dresselhaus * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef included_vlib_physmem_funcs_h #define included_vlib_physmem_funcs_h always_inline vlib_physmem_region_t * vlib_physmem_get_region (vlib_main_t * vm, u8 index) { vlib_physmem_main_t *vpm = &physmem_main; return pool_elt_at_index (vpm->regions, index); } always_inline u64 vlib_physmem_offset_to_physical (vlib_main_t * vm, vlib_physmem_region_index_t idx, uword o) { vlib_physmem_region_t *pr = vlib_physmem_get_region (vm, idx); uword page_index = o >> pr->log2_page_size; ASSERT (o < pr->size); ASSERT (pr->page_table[page_index] != 0); return (vec_elt (pr->page_table, page_index) + (o & pr->page_mask)); } always_inline int vlib_physmem_is_virtual (vlib_main_t * vm, vlib_physmem_region_index_t idx, uword p) { vlib_physmem_region_t *pr = vlib_physmem_get_region (vm, idx); return p >= pointer_to_uword (pr->mem) && p < (pointer_to_uword (pr->mem) + pr->size); } always_inline uword vlib_physmem_offset_of (vlib_main_t * vm, vlib_physmem_region_index_t idx, void *p) { vlib_physmem_region_t *pr = vlib_physmem_get_region (vm, idx); uword a = pointer_to_uword (p); uword o; ASSERT (vlib_physmem_is_virtual (vm, idx, a)); o = a - pointer_to_uword (pr->mem); /* Offset must fit in 32 bits. */ ASSERT ((uword) o == a - pointer_to_uword (pr->mem)); return o; } always_inline void * vlib_physmem_at_offset (vlib_main_t * vm, vlib_physmem_region_index_t idx, uword offset) { vlib_physmem_region_t *pr = vlib_physmem_get_region (vm, idx); ASSERT (offset < pr->size); return uword_to_pointer (pointer_to_uword (pr->mem) + offset, void *); } always_inline void * vlib_physmem_alloc_aligned (vlib_main_t * vm, vlib_physmem_region_index_t idx, clib_error_t ** error, uword n_bytes, uword alignment) { void *r = vm->os_physmem_alloc_aligned (vm, idx, n_bytes, alignment); if (!r) *error = clib_error_return (0, "failed to allocate %wd bytes of I/O memory", n_bytes); else *error = 0; return r; } /* By default allocate I/O memory with cache line alignment. */ always_inline void * vlib_physmem_alloc (vlib_main_t * vm, vlib_physmem_region_index_t idx, clib_error_t ** error, uword n_bytes) { return vlib_physmem_alloc_aligned (vm, idx, error, n_bytes, CLIB_CACHE_LINE_BYTES); } always_inline void vlib_physmem_free (vlib_main_t * vm, vlib_physmem_region_index_t idx, void *mem) { if (mem) vm->os_physmem_free (vm, idx, mem); } always_inline u64 vlib_physmem_virtual_to_physical (vlib_main_t * vm, vlib_physmem_region_index_t idx, void *mem) { vlib_physmem_main_t *vpm = &physmem_main; vlib_physmem_region_t *pr = pool_elt_at_index (vpm->regions, idx); uword o = mem - pr->mem; return vlib_physmem_offset_to_physical (vm, idx, o); } always_inline clib_error_t * vlib_physmem_region_alloc (vlib_main_t * vm, char *name, u32 size, u8 numa_node, u32 flags, vlib_physmem_region_index_t * idx) { return vm->os_physmem_region_alloc (vm, name, size, numa_node, flags, idx); } always_inline void vlib_physmem_region_free (struct vlib_main_t *vm, vlib_physmem_region_index_t idx) { vm->os_physmem_region_free (vm, idx); } #endif /* included_vlib_physmem_funcs_h */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */