Skip to content

Commit

Permalink
bsd-user: style tweak: Use preferred block comments
Browse files Browse the repository at this point in the history
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Warner Losh <imp@bsdimp.com>
  • Loading branch information
bsdimp committed May 11, 2021
1 parent 036a013 commit c2bdd9a
Showing 1 changed file with 43 additions and 31 deletions.
74 changes: 43 additions & 31 deletions bsd-user/qemu.h
Expand Up @@ -47,9 +47,10 @@ extern enum BSDType bsd_type;
#define THREAD
#endif

/* This struct is used to hold certain information about the image.
* Basically, it replicates in user space what would be certain
* task_struct fields in the kernel
/*
* This struct is used to hold certain information about the image. Basically,
* it replicates in user space what would be certain task_struct fields in the
* kernel
*/
struct image_info {
abi_ulong load_addr;
Expand Down Expand Up @@ -78,12 +79,13 @@ struct sigqueue {
struct emulated_sigtable {
int pending; /* true if signal is pending */
struct sigqueue *first;
struct sigqueue info; /* in order to always have memory for the
first signal, we put it here */
/* in order to always have memory for the first signal, we put it here */
struct sigqueue info;
};

/* NOTE: we force a big alignment so that the stack stored after is
aligned too */
/*
* NOTE: we force a big alignment so that the stack stored after is aligned too
*/
typedef struct TaskState {
pid_t ts_tid; /* tid (or pid) of this task */

Expand All @@ -103,7 +105,6 @@ void init_task_state(TaskState *ts);
extern const char *qemu_uname_release;
extern unsigned long mmap_min_addr;

/* ??? See if we can avoid exposing so much of the loader internals. */
/*
* MAX_ARG_PAGES defines the number of pages allocated for arguments
* and envelope for the new program. 32 should suffice, this gives
Expand Down Expand Up @@ -224,9 +225,11 @@ static inline bool access_ok(int type, abi_ulong addr, abi_ulong size)
return page_check_range((target_ulong)addr, size, type) == 0;
}

/* NOTE __get_user and __put_user use host pointers and don't check access. */
/* These are usually used to access struct data members once the
* struct has been locked - usually with lock_user_struct().
/*
* NOTE __get_user and __put_user use host pointers and don't check access.
*
* These are usually used to access struct data members once the struct has been
* locked - usually with lock_user_struct().
*/
#define __put_user(x, hptr)\
({\
Expand Down Expand Up @@ -267,17 +270,18 @@ static inline bool access_ok(int type, abi_ulong addr, abi_ulong size)
x = (typeof(*hptr))tswap64(*(uint64_t *)(hptr));\
break;\
default:\
/* avoid warning */\
x = 0;\
abort();\
} \
0;\
})

/* put_user()/get_user() take a guest address and check access */
/* These are usually used to access an atomic data type, such as an int,
* that has been passed by address. These internally perform locking
* and unlocking on the data type.
/*
* put_user()/get_user() take a guest address and check access
*
* These are usually used to access an atomic data type, such as an int, that
* has been passed by address. These internally perform locking and unlocking
* on the data type.
*/
#define put_user(x, gaddr, target_type) \
({ \
Expand All @@ -301,7 +305,6 @@ static inline bool access_ok(int type, abi_ulong addr, abi_ulong size)
__ret = __get_user((x), __hptr); \
unlock_user(__hptr, __gaddr, 0); \
} else { \
/* avoid warning */ \
(x) = 0; \
__ret = -TARGET_EFAULT; \
} \
Expand Down Expand Up @@ -330,22 +333,28 @@ static inline bool access_ok(int type, abi_ulong addr, abi_ulong size)
#define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
#define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)

/* copy_from_user() and copy_to_user() are usually used to copy data
/*
* copy_from_user() and copy_to_user() are usually used to copy data
* buffers between the target and host. These internally perform
* locking/unlocking of the memory.
*/
abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);

/* Functions for accessing guest memory. The tget and tput functions
read/write single values, byteswapping as necessary. The lock_user function
gets a pointer to a contiguous area of guest memory, but does not perform
any byteswapping. lock_user may return either a pointer to the guest
memory, or a temporary buffer. */
/*
* Functions for accessing guest memory. The tget and tput functions
* read/write single values, byteswapping as necessary. The lock_user function
* gets a pointer to a contiguous area of guest memory, but does not perform
* any byteswapping. lock_user may return either a pointer to the guest
* memory, or a temporary buffer.
*/

/* Lock an area of guest memory into the host. If copy is true then the
host area will have the same contents as the guest. */
static inline void *lock_user(int type, abi_ulong guest_addr, long len, int copy)
/*
* Lock an area of guest memory into the host. If copy is true then the
* host area will have the same contents as the guest.
*/
static inline void *lock_user(int type, abi_ulong guest_addr, long len,
int copy)
{
if (!access_ok(type, guest_addr, len))
return NULL;
Expand All @@ -364,9 +373,10 @@ static inline void *lock_user(int type, abi_ulong guest_addr, long len, int copy
#endif
}

/* Unlock an area of guest memory. The first LEN bytes must be
flushed back to guest memory. host_ptr = NULL is explicitly
allowed and does nothing. */
/*
* Unlock an area of guest memory. The first LEN bytes must be flushed back to
* guest memory. host_ptr = NULL is explicitly allowed and does nothing.
*/
static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
long len)
{
Expand All @@ -382,8 +392,10 @@ static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
#endif
}

/* Return the length of a string in target memory or -TARGET_EFAULT if
access error. */
/*
* Return the length of a string in target memory or -TARGET_EFAULT if access
* error.
*/
abi_long target_strlen(abi_ulong gaddr);

/* Like lock_user but for null terminated strings. */
Expand Down

0 comments on commit c2bdd9a

Please sign in to comment.