include/net/phonet/phonet.h
Source file repositories/reference/linux-study-clean/include/net/phonet/phonet.h
File Facts
- System
- Linux kernel
- Corpus path
include/net/phonet/phonet.h- Extension
.h- Size
- 3289 bytes
- Lines
- 134
- Domain
- Networking Core
- Bucket
- Sockets, Protocols, Packet Path, And Network Policy
- Inferred role
- Networking Core: operation-table or driver-model contract
- Status
- pattern implementation candidate
Why This File Exists
Networking stack implementation surface: socket APIs, protocol dispatch, packet flow, routing, filtering, and network namespaces.
- Networking stack implementation surface: socket APIs, protocol dispatch, packet flow, routing, filtering, and network namespaces.
- Defines an operation table; this is where Linux turns generic core objects into subsystem-specific behavior.
- Touches user memory; correctness depends on fault-safe copying and privilege boundary handling.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/phonet.hlinux/skbuff.hnet/sock.h
Detected Declarations
struct pn_sockstruct phonet_protocolfunction pn_skb_get_src_sockaddrfunction pn_skb_get_dst_sockaddrfunction sk_is_phonetfunction phonet_sk_ioctl
Annotated Snippet
extern const struct proto_ops phonet_dgram_ops;
void pn_sock_init(void);
struct sock *pn_find_sock_by_sa(struct net *net, const struct sockaddr_pn *sa);
void pn_deliver_sock_broadcast(struct net *net, struct sk_buff *skb);
void phonet_get_local_port_range(int *min, int *max);
int pn_sock_hash(struct sock *sk);
void pn_sock_unhash(struct sock *sk);
int pn_sock_get_port(struct sock *sk, unsigned short sport);
struct sock *pn_find_sock_by_res(struct net *net, u8 res);
int pn_sock_bind_res(struct sock *sock, u8 res);
int pn_sock_unbind_res(struct sock *sk, u8 res);
void pn_sock_unbind_all_res(struct sock *sk);
int pn_skb_send(struct sock *sk, struct sk_buff *skb,
const struct sockaddr_pn *target);
static inline struct phonethdr *pn_hdr(struct sk_buff *skb)
{
return (struct phonethdr *)skb_network_header(skb);
}
static inline struct phonetmsg *pn_msg(struct sk_buff *skb)
{
return (struct phonetmsg *)skb_transport_header(skb);
}
/*
* Get the other party's sockaddr from received skb. The skb begins
* with a Phonet header.
*/
static inline
void pn_skb_get_src_sockaddr(struct sk_buff *skb, struct sockaddr_pn *sa)
{
struct phonethdr *ph = pn_hdr(skb);
u16 obj = pn_object(ph->pn_sdev, ph->pn_sobj);
sa->spn_family = AF_PHONET;
pn_sockaddr_set_object(sa, obj);
pn_sockaddr_set_resource(sa, ph->pn_res);
memset(sa->spn_zero, 0, sizeof(sa->spn_zero));
}
static inline
void pn_skb_get_dst_sockaddr(struct sk_buff *skb, struct sockaddr_pn *sa)
{
struct phonethdr *ph = pn_hdr(skb);
u16 obj = pn_object(ph->pn_rdev, ph->pn_robj);
sa->spn_family = AF_PHONET;
pn_sockaddr_set_object(sa, obj);
pn_sockaddr_set_resource(sa, ph->pn_res);
memset(sa->spn_zero, 0, sizeof(sa->spn_zero));
}
/* Protocols in Phonet protocol family. */
struct phonet_protocol {
const struct proto_ops *ops;
struct proto *prot;
int sock_type;
};
int phonet_proto_register(unsigned int protocol,
const struct phonet_protocol *pp);
void phonet_proto_unregister(unsigned int protocol,
const struct phonet_protocol *pp);
int phonet_sysctl_init(void);
void phonet_sysctl_exit(void);
int isi_register(void);
void isi_unregister(void);
static inline bool sk_is_phonet(struct sock *sk)
{
return sk->sk_family == PF_PHONET;
}
static inline int phonet_sk_ioctl(struct sock *sk, unsigned int cmd,
void __user *arg)
{
int karg;
switch (cmd) {
case SIOCPNADDRESOURCE:
case SIOCPNDELRESOURCE:
if (get_user(karg, (int __user *)arg))
return -EFAULT;
return sk->sk_prot->ioctl(sk, cmd, &karg);
Annotation
- Immediate include surface: `linux/phonet.h`, `linux/skbuff.h`, `net/sock.h`.
- Detected declarations: `struct pn_sock`, `struct phonet_protocol`, `function pn_skb_get_src_sockaddr`, `function pn_skb_get_dst_sockaddr`, `function sk_is_phonet`, `function phonet_sk_ioctl`.
- Atlas domain: Networking Core / Sockets, Protocols, Packet Path, And Network Policy.
- Implementation status: pattern implementation candidate.
- This snippet crosses the user/kernel memory boundary; validate fault handling and access checks before translating the pattern.
Implementation Notes
- This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
- Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
- Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.