summaryrefslogtreecommitdiff
path: root/domain.h
blob: 6e6c765e21bb058ad71f2fa1124ec67f5bdffc28 (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*
 * Copyright (C) 2013 Kay Sievers
 * Copyright (C) 2013 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
 * Copyright (C) 2013 Daniel Mack <daniel@zonque.org>
 * Copyright (C) 2013 Linux Foundation
 *
 * kdbus is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at
 * your option) any later version.
 */

#ifndef __KDBUS_DOMAIN_H
#define __KDBUS_DOMAIN_H

#include <linux/hashtable.h>
#include <linux/idr.h>

/**
 * struct kdbus_domain - domain for buses
 * @kref:		Reference counter
 * @disconnected:	Invalidated data
 * @name:		Name of the domain
 * @devpath:		/dev base directory path
 * @parent:		Parent domain
 * @id:			Global id of this domain
 * @major:		Device major number for all nodes
 * @mode:		Device node access mode
 * @idr:		Map of endpoint minors to buses
 * @dev:		Control device node, minor == 0
 * @lock:		Domain data lock
 * @bus_seq_last:	Last used bus id sequence number
 * @msg_seq_last:	Last used message id sequence number
 * @domain_list:	List of child domains
 * @domain_entry:	Entry in parent domain
 * @bus_list:		Buses in this domain
 * @user_hash:		Accounting of user resources
 * @user_idr:		Map of all users; smallest possible index
 *
 * A domain provides a "control" device node. Every domain has its
 * own major number for its endpoint device nodes.
 *
 * The initial domain is created at initialization time, is unnamed and
 * stays around for forver.
 *
 * A domain is created by opening the "control" device node of the
 * parent domain and issuing the KDBUS_CMD_DOMAIN_MAKE iotcl. Closing this
 * file immediately destroys the entire domain.
 */
struct kdbus_domain {
	struct kref kref;
	bool disconnected;
	const char *name;
	const char *devpath;
	struct kdbus_domain *parent;
	u64 id;
	unsigned int major;
	umode_t mode;
	struct idr idr;
	struct device *dev;
	struct mutex lock;
	u64 bus_seq_last;
	atomic64_t msg_seq_last;
	struct list_head domain_list;
	struct list_head domain_entry;
	struct list_head bus_list;
	DECLARE_HASHTABLE(user_hash, 6);
	struct idr user_idr;
	void *security;
};

/**
 * struct kdbus_domain_user - resource accounting for users
 * @kref:		Reference counter
 * @domain:			Domain of the user
 * @hentry:		Entry in domain user map
 * @idr:		Smalles possible index number of all users
 * @uid:		UID of the user
 * @buses:		Number of buses the user has created
 * @connections:	Number of connections the user has created
 */
struct kdbus_domain_user {
	struct kref kref;
	struct kdbus_domain *domain;
	struct hlist_node hentry;
	unsigned int idr;
	kuid_t uid;
	atomic_t buses;
	atomic_t connections;
};

extern struct kdbus_domain *kdbus_domain_init;
extern struct bus_type kdbus_subsys;

struct kdbus_domain *kdbus_domain_ref(struct kdbus_domain *domain);
struct kdbus_domain *kdbus_domain_unref(struct kdbus_domain *domain);
void kdbus_domain_disconnect(struct kdbus_domain *domain);
int kdbus_domain_new(struct kdbus_domain *parent, const char *name,
		     umode_t mode, struct kdbus_domain **domain);
int kdbus_domain_make_user(struct kdbus_cmd_make *cmd, char **name);
struct kdbus_domain *kdbus_domain_find_by_major(unsigned int major);

struct kdbus_domain_user
*kdbus_domain_user_find_or_new(struct kdbus_domain *domain, kuid_t uid);
struct kdbus_domain_user *kdbus_domain_user_ref(struct kdbus_domain_user *u);
struct kdbus_domain_user *kdbus_domain_user_unref(struct kdbus_domain_user *u);
#endif