doc: add ABI documentation
[dpdk.git] / mk / rte.lib.mk
1 #   BSD LICENSE
2 #
3 #   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
4 #   All rights reserved.
5 #
6 #   Redistribution and use in source and binary forms, with or without
7 #   modification, are permitted provided that the following conditions
8 #   are met:
9 #
10 #     * Redistributions of source code must retain the above copyright
11 #       notice, this list of conditions and the following disclaimer.
12 #     * Redistributions in binary form must reproduce the above copyright
13 #       notice, this list of conditions and the following disclaimer in
14 #       the documentation and/or other materials provided with the
15 #       distribution.
16 #     * Neither the name of Intel Corporation nor the names of its
17 #       contributors may be used to endorse or promote products derived
18 #       from this software without specific prior written permission.
19 #
20 #   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 #   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 #   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 #   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 #   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 #   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 #   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 #   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 #   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
32 include $(RTE_SDK)/mk/internal/rte.compile-pre.mk
33 include $(RTE_SDK)/mk/internal/rte.install-pre.mk
34 include $(RTE_SDK)/mk/internal/rte.clean-pre.mk
35 include $(RTE_SDK)/mk/internal/rte.build-pre.mk
36 include $(RTE_SDK)/mk/internal/rte.depdirs-pre.mk
37
38 # VPATH contains at least SRCDIR
39 VPATH += $(SRCDIR)
40 ifeq ($(RTE_BUILD_SHARED_LIB),y)
41
42 LIB := $(patsubst %.a,%.so.$(LIBABIVER),$(LIB))
43 CPU_LDFLAGS += --version-script=$(SRCDIR)/$(EXPORT_MAP)
44
45 endif
46
47
48 _BUILD = $(LIB)
49 _INSTALL = $(INSTALL-FILES-y) $(SYMLINK-FILES-y) $(RTE_OUTPUT)/lib/$(LIB)
50 _CLEAN = doclean
51
52 .PHONY: all
53 all: install
54
55 .PHONY: install
56 install: build _postinstall
57
58 _postinstall: build
59
60 .PHONY: build
61 build: _postbuild
62
63 exe2cmd = $(strip $(call dotfile,$(patsubst %,%.cmd,$(1))))
64
65 ifeq ($(LINK_USING_CC),1)
66 # Override the definition of LD here, since we're linking with CC
67 LD := $(CC) $(CPU_CFLAGS)
68 _CPU_LDFLAGS := $(call linkerprefix,$(CPU_LDFLAGS))
69 else
70 _CPU_LDFLAGS := $(CPU_LDFLAGS)
71 endif
72
73 O_TO_A = $(AR) crus $(LIB) $(OBJS-y)
74 O_TO_A_STR = $(subst ','\'',$(O_TO_A)) #'# fix syntax highlight
75 O_TO_A_DISP = $(if $(V),"$(O_TO_A_STR)","  AR $(@)")
76 O_TO_A_CMD = "cmd_$@ = $(O_TO_A_STR)"
77 O_TO_A_DO = @set -e; \
78         echo $(O_TO_A_DISP); \
79         $(O_TO_A) && \
80         echo $(O_TO_A_CMD) > $(call exe2cmd,$(@))
81
82 O_TO_S = $(LD) $(_CPU_LDFLAGS) -shared $(OBJS-y) -o $(LIB)
83 O_TO_S_STR = $(subst ','\'',$(O_TO_S)) #'# fix syntax highlight
84 O_TO_S_DISP = $(if $(V),"$(O_TO_S_STR)","  LD $(@)")
85 O_TO_S_DO = @set -e; \
86         echo $(O_TO_S_DISP); \
87         $(O_TO_S) && \
88         echo $(O_TO_S_CMD) > $(call exe2cmd,$(@))
89
90 ifeq ($(RTE_BUILD_SHARED_LIB),n)
91 O_TO_C = $(AR) crus $(LIB_ONE) $(OBJS-y)
92 O_TO_C_STR = $(subst ','\'',$(O_TO_C)) #'# fix syntax highlight
93 O_TO_C_DISP = $(if $(V),"$(O_TO_C_STR)","  AR_C $(@)")
94 O_TO_C_DO = @set -e; \
95         $(lib_dir) \
96         $(copy_obj)
97 else
98 O_TO_C = $(LD) -shared $(OBJS-y) -o $(LIB_ONE)
99 O_TO_C_STR = $(subst ','\'',$(O_TO_C)) #'# fix syntax highlight
100 O_TO_C_DISP = $(if $(V),"$(O_TO_C_STR)","  LD_C $(@)")
101 O_TO_C_DO = @set -e; \
102         $(lib_dir) \
103         $(copy_obj)
104 endif
105
106 copy_obj = cp -f $(OBJS-y) $(RTE_OUTPUT)/build/lib;
107 lib_dir = [ -d $(RTE_OUTPUT)/lib ] || mkdir -p $(RTE_OUTPUT)/lib;
108 -include .$(LIB).cmd
109
110 #
111 # Archive objects in .a file if needed
112 #
113 ifeq ($(RTE_BUILD_SHARED_LIB),y)
114 $(LIB): $(OBJS-y) $(DEP_$(LIB)) FORCE
115 ifeq ($(LIBABIVER),)
116         @echo "Must Specify a $(LIB) ABI version"
117         @false
118 endif
119         @[ -d $(dir $@) ] || mkdir -p $(dir $@)
120         $(if $(D),\
121                 @echo -n "$< -> $@ " ; \
122                 echo -n "file_missing=$(call boolean,$(file_missing)) " ; \
123                 echo -n "cmdline_changed=$(call boolean,$(call cmdline_changed,$(O_TO_S_STR))) " ; \
124                 echo -n "depfile_missing=$(call boolean,$(depfile_missing)) " ; \
125                 echo "depfile_newer=$(call boolean,$(depfile_newer)) ")
126         $(if $(or \
127                 $(file_missing),\
128                 $(call cmdline_changed,$(O_TO_S_STR)),\
129                 $(depfile_missing),\
130                 $(depfile_newer)),\
131                 $(O_TO_S_DO))
132
133 ifeq ($(RTE_BUILD_COMBINE_LIBS),y)
134         $(if $(or \
135         $(file_missing),\
136         $(call cmdline_changed,$(O_TO_C_STR)),\
137         $(depfile_missing),\
138         $(depfile_newer)),\
139         $(O_TO_C_DO))
140 endif
141 else
142 $(LIB): $(OBJS-y) $(DEP_$(LIB)) FORCE
143         @[ -d $(dir $@) ] || mkdir -p $(dir $@)
144         $(if $(D),\
145             @echo -n "$< -> $@ " ; \
146             echo -n "file_missing=$(call boolean,$(file_missing)) " ; \
147             echo -n "cmdline_changed=$(call boolean,$(call cmdline_changed,$(O_TO_A_STR))) " ; \
148             echo -n "depfile_missing=$(call boolean,$(depfile_missing)) " ; \
149             echo "depfile_newer=$(call boolean,$(depfile_newer)) ")
150         $(if $(or \
151             $(file_missing),\
152             $(call cmdline_changed,$(O_TO_A_STR)),\
153             $(depfile_missing),\
154             $(depfile_newer)),\
155             $(O_TO_A_DO))
156 ifeq ($(RTE_BUILD_COMBINE_LIBS),y)
157         $(if $(or \
158         $(file_missing),\
159         $(call cmdline_changed,$(O_TO_C_STR)),\
160         $(depfile_missing),\
161         $(depfile_newer)),\
162         $(O_TO_C_DO))
163 endif
164 endif
165
166 #
167 # install lib in $(RTE_OUTPUT)/lib
168 #
169 $(RTE_OUTPUT)/lib/$(LIB): $(LIB)
170         $(eval LIBSONAME := $(basename $(LIB)))
171         @echo "  INSTALL-LIB $(LIB)"
172         @[ -d $(RTE_OUTPUT)/lib ] || mkdir -p $(RTE_OUTPUT)/lib
173         $(Q)cp -f $(LIB) $(RTE_OUTPUT)/lib
174 ifeq ($(RTE_BUILD_SHARED_LIB),y)
175         $(Q)ln -s -f $< $(RTE_OUTPUT)/lib/$(LIBSONAME)
176 endif
177
178 #
179 # Clean all generated files
180 #
181 .PHONY: clean
182 clean: _postclean
183
184 .PHONY: doclean
185 doclean:
186         $(Q)rm -rf $(LIB) $(OBJS-all) $(DEPS-all) $(DEPSTMP-all) \
187           $(CMDS-all) $(INSTALL-FILES-all)
188         $(Q)rm -f $(_BUILD_TARGETS) $(_INSTALL_TARGETS) $(_CLEAN_TARGETS)
189
190 include $(RTE_SDK)/mk/internal/rte.compile-post.mk
191 include $(RTE_SDK)/mk/internal/rte.install-post.mk
192 include $(RTE_SDK)/mk/internal/rte.clean-post.mk
193 include $(RTE_SDK)/mk/internal/rte.build-post.mk
194 include $(RTE_SDK)/mk/internal/rte.depdirs-post.mk
195
196 .PHONY: FORCE
197 FORCE: